{"schemaVersion":1,"title":"Syidax Charts API Reference","documents":[{"path":"/docs","title":"Charts API Reference","summary":"Explore Syidax Charts configuration, data types, and runtime APIs.","kind":"guide","sections":[{"id":"start","title":"Getting started","blocks":[{"kind":"paragraph","text":"Charts are Web Components. Pass simple values through HTML attributes and arrays, objects, and callbacks through JavaScript properties. Choose the shared sy-chart entry point or individual chart tags to suit your app."},{"kind":"links","items":[{"path":"/docs/getting-started","title":"Installation and your first chart","description":"Connect packages, register elements, assign data, and update dimensions"},{"path":"/docs/concepts","title":"Configuration and data model","description":"Shared facade and direct tags; attributes and properties"},{"path":"/docs/branding","title":"Themes and logos","description":"Shared branding, four corner positions, and Pro customization"},{"path":"/docs/accessibility","title":"Accessibility","description":"Alternative data, keyboard access, and meaningful color"}]}]},{"id":"reference","title":"Browse the API","blocks":[{"kind":"links","items":[{"path":"/docs/options","title":"Configuration options","description":"All shared sy-chart options, types, and defaults"},{"path":"/docs/components","title":"API by chart type","description":"Data contracts, properties, events, and methods for individual tags"},{"path":"/docs/methods","title":"Methods","description":"Asynchronous APIs to control a running chart and read results"},{"path":"/docs/events","title":"Events","description":"Event names and CustomEvent.detail types"},{"path":"/docs/types","title":"Types","description":"Input and result objects and their related types"}]}]},{"id":"examples","title":"Live examples","blocks":[{"kind":"paragraph","text":"Open Components to change options and see charts render. Read API descriptions and contracts here, and copy complete code for the current settings from Components."},{"kind":"links","items":[{"path":"/charts/demos","title":"Open Components","description":"Live preview · JavaScript · React · Vue · Angular"}]}]},{"id":"plain-text","title":"Text resources","blocks":[{"kind":"paragraph","text":"All documentation is available as HTML readable without JavaScript. Each page's Markdown link provides the same content as plain text. JSON includes the document structure and API types, defaults, and arguments."},{"kind":"links","items":[{"path":"/docs/llms.txt","title":"Documentation index · llms.txt","description":"An index of Markdown URLs for AI tools"},{"path":"/docs/reference.json","title":"Complete reference · JSON","description":"Read content and API metadata together"}]}]}]},{"path":"/docs/getting-started","title":"Installation and your first chart","summary":"Connect the package, register the chart elements you need, and assign data.","kind":"guide","sections":[{"id":"install","title":"Install the package","blocks":[{"kind":"paragraph","text":"Install Community or Pro from public npm in your app project, according to the features you use."},{"kind":"code","source":"npm install @syidax/advanced@1.0.1","language":"sh"},{"kind":"code","source":"npm install @syidax/advanced-pro@1.0.1","language":"sh"},{"kind":"paragraph","text":"Apps using Pro features install @syidax/advanced-pro and use that package for CSS, component, and license imports."},{"kind":"links","items":[{"path":"/charts/installation","title":"Installation files and runnable HTML examples","description":"Install Community or Pro from public npm"}]}]},{"id":"register","title":"Register elements and connect data","blocks":[{"kind":"paragraph","text":"The code below shows an app entry point and HTML for a bundler-based project. Register the components you need directly. Assign arrays to element properties rather than string attributes."},{"kind":"code","source":"import '@syidax/advanced/css/chart';\nimport { defineCustomElement } from '@syidax/advanced/components/sy-line-chart.js';\n\ndefineCustomElement();\nawait customElements.whenDefined('sy-line-chart');\nconst chart = document.querySelector('#vis');\nchart.series = [{ name: 'Revenue', values: [12, 18, 15, 24] }];\nchart.xAxis = { kind: 'category', categories: ['Jan', 'Feb', 'Mar', 'Apr'] };\nchart.legend = true;","language":"javascript"},{"kind":"code","source":"<div id=\"chart-container\">\n  <sy-line-chart id=\"vis\" height=\"360\" aria-label=\"Monthly revenue\"></sy-line-chart>\n</div>","language":"html"}]},{"id":"resize","title":"Sizing and cleanup","blocks":[{"kind":"paragraph","text":"Observe the container size and update width. When an SPA screen is removed, disconnect observers and remove listeners registered by your app."},{"kind":"code","source":"const container = document.querySelector('#chart-container');\nconst observer = new ResizeObserver(([entry]) => {\n  chart.width = Math.max(160, Math.floor(entry.contentRect.width));\n});\nobserver.observe(container);\n\nfunction dispose() {\n  observer.disconnect();\n}","language":"javascript"}]},{"id":"pro","title":"Pro license","blocks":[{"kind":"paragraph","text":"Use Pro charts, renderers, and branding after registering a certificate with the required entitlements. Deliver only the issued, signed certificate to the app; never include a signing private key."},{"kind":"code","source":"import { registerLicense } from '@syidax/advanced-pro/license';\n\nconst response = await fetch('/licenses/syidax.json');\nif (!response.ok) throw new Error('Unable to load the license.');\nconst result = await registerLicense(await response.json());\nif (!result.ok) throw new Error('Unable to register the license.');\n// Connect Pro charts after registration completes.","language":"javascript"}]}]},{"path":"/docs/concepts","title":"Configuration and data model","summary":"The shared sy-chart and individual tags are different entry points. Check the supported property names and types for each.","kind":"guide","sections":[{"id":"elements","title":"Shared facade and direct tags","blocks":[{"kind":"paragraph","text":"sy-chart is a shared entry point that selects a chart with type. A direct tag such as sy-line-chart exposes that chart's API. Not every facade option works with every type. Choose a chart, then review its data contract alongside the related types of the shared options."},{"kind":"code","source":"<sy-chart type=\"line\" height=\"360\"></sy-chart>\n<sy-line-chart height=\"360\"></sy-line-chart>","language":"html"},{"kind":"table","headers":["Direct tag","Direct property","sy-chart property"],"rows":[["sy-icicle","direction","icicleDirection"],["sy-dendrogram","direction","dendrogramDirection"],["sy-flow-lines","routePath","flowLinesPath"],["sy-theme-river","offset","themeRiverOffset"]]},{"kind":"links","items":[{"path":"/docs/options","title":"Shared configuration","description":""},{"path":"/docs/components","title":"Contracts for direct tags","description":""}]}]},{"id":"attributes","title":"Attributes and properties","blocks":[{"kind":"paragraph","text":"Set simple values in HTML, such as height=\"360\". In JavaScript, use case-sensitive property names, such as chart.height = 360. Pass objects, arrays, TypedArrays, and functions as JavaScript properties. Each option page lists both names and the exact type."},{"kind":"code","source":"chart.height = 360;\nchart.xAxis = { kind: 'category', categories: ['A', 'B'] };\nchart.series = [{ name: 'Quantity', values: [12, 18] }];","language":"javascript"}]},{"id":"contracts","title":"Read types and defaults","blocks":[{"kind":"paragraph","text":"undefined means unset, unlike 0, false, or an empty array. A question mark (?) marks an optional field or argument. Defaults are shown as declared in the source; the effective result may depend on the selected chart, theme, and data. Select an object type name to read its complete declaration and related types."}]},{"id":"runtime","title":"Methods and events","blocks":[{"kind":"paragraph","text":"Call public methods after the element is defined. Methods return Promises, so use await to read their results. Subscribe with addEventListener and read CustomEvent.detail. Event names are case-sensitive."},{"kind":"links","items":[{"path":"/docs/methods","title":"Method list","description":""},{"path":"/docs/events","title":"Event list","description":""}]}]},{"id":"export","title":"Export and menus","blocks":[{"kind":"paragraph","text":"Enable the built-in export menu with contextmenu. contextMenuItems appends custom items after the built-in items. Image exports such as PNG and SVG follow the logo policy; data files such as CSV do not include logos."},{"kind":"links","items":[{"path":"/docs/options/contextMenuItems","title":"contextMenuItems","description":""},{"path":"/docs/branding","title":"Logo policy","description":""}]}]}]},{"path":"/docs/branding","title":"Themes and logos","summary":"Configure the page theme, chart appearance, and shared branding together.","kind":"guide","sections":[{"id":"theme","title":"Theme","blocks":[{"kind":"paragraph","text":"Set the chart theme with the theme property. Update it when your app switches between light and dark themes. The default logo and its outline adapt to the chart theme."},{"kind":"links","items":[{"path":"/docs/options/theme","title":"theme · Supported types and defaults","description":""}]}]},{"id":"position","title":"Community logo and position","blocks":[{"kind":"paragraph","text":"Community charts display the Syidax symbol and wordmark inside the data area. Choose one of four corners with brand-position; the default is bottom-right. Screen rendering and image exports use the same corner. For Data Zoom, Navigator, and Visual Map, configure the logo on the connected target chart."},{"kind":"code","source":"<sy-line-chart brand-position=\"bottom-left\"></sy-line-chart>","language":"html"},{"kind":"links","items":[{"path":"/docs/options/brandPosition","title":"brandPosition","description":""}]}]},{"id":"custom","title":"Pro customization","blocks":[{"kind":"paragraph","text":"With a valid chart.branding entitlement, set brand-logo=\"none\" to remove the logo, or supply your own image through brandLogo. Use a PNG, JPEG, or WebP data URL of up to 100 KB. External image URLs and SVG are not supported. Without the entitlement, the default logo remains."},{"kind":"code","source":"<sy-line-chart brand-logo=\"none\"></sy-line-chart>","language":"html"},{"kind":"links","items":[{"path":"/docs/options/brandLogo","title":"brandLogo","description":""},{"path":"/charts/branding","title":"Preview logo settings","description":""}]}]}]},{"path":"/docs/accessibility","title":"Accessibility","summary":"Communicate a chart's meaning beyond color, motion, and pointer interaction.","kind":"guide","sections":[{"id":"meaning","title":"Titles and alternative data","blocks":[{"kind":"paragraph","text":"Describe the metric, unit, period, and data source in text beside the chart. Provide a table or download when precise numerical comparisons matter. Make aria-labels and descriptions convey the meaning of the actual data."}]},{"id":"keyboard","title":"Keyboard interaction","blocks":[{"kind":"paragraph","text":"Check supported zoom, selection, and legend actions with the keyboard. Make essential tooltip information available in text or a table as well. Consult each chart's API for its supported events and methods."}]},{"id":"motion","title":"Color and motion","blocks":[{"kind":"paragraph","text":"Use series names and marker shapes so groups are not distinguished by color alone. Check background and label contrast, and disable animated when users prefer reduced motion."},{"kind":"code","source":"chart.animated = !matchMedia('(prefers-reduced-motion: reduce)').matches;","language":"javascript"}]}]},{"path":"/docs/options","title":"Configuration options","summary":"Browse sy-chart options by purpose. Check their defaults and the types supported by each chart.","kind":"options","sections":[{"id":"data","title":"Data & series","blocks":[{"kind":"links","items":[{"path":"/docs/options/type","title":"type","description":"The chart type rendered by the shared sy-chart component. Data structures and supported options vary by type. Check the specific chart's contract first."},{"path":"/docs/options/typeLoadTimeout","title":"typeLoadTimeout","description":"Budget (ms) for the chart type's element to become ready once it is rendered : a lazy chunk that never arrives turns into the load-failed notice (reason `timeout`) with a Retry control. 0 or less = no limit."},{"path":"/docs/options/series","title":"series","description":"Display multiple series together. Set a name, values, color, and display options for each series. Each series follows the data type of the selected chart."},{"path":"/docs/options/activeSeriesIndex","title":"activeSeriesIndex","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/seriesState","title":"seriesState","description":"Pass as a JavaScript property. type: LineChartSeriesStateOptions."},{"path":"/docs/options/values","title":"values","description":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},{"path":"/docs/options/seriesActiveTrigger","title":"seriesActiveTrigger","description":"Allowed values: hover, click, custom. Default: undefined."},{"path":"/docs/options/seriesName","title":"seriesName","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/seriesPadding","title":"seriesPadding","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/source","title":"source","description":"the tabular dataset the series read through `encode` (a Dataset, a source, or rows); it wins over `values` / `series`. Named `source` because `dataset` is the element's own data-* map."},{"path":"/docs/options/sourceTransforms","title":"sourceTransforms","description":"transforms applied to `source` before encoding (filter / sort / regression / boxplot / sample)."},{"path":"/docs/options/encode","title":"encode","description":"which dimensions feed the series (one encode per series); an ordinal x labels the category axis."},{"path":"/docs/options/data","title":"data","description":"Chart-specific data. Use the input structure for the chart, such as a tree, nodes and links, or OHLC records. Not every type in this union applies to every chart."},{"path":"/docs/options/categories","title":"categories","description":"Radar category spoke labels (property)."}]}]},{"id":"axes","title":"Axes & coordinates","blocks":[{"kind":"links","items":[{"path":"/docs/options/xAxis","title":"xAxis","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"path":"/docs/options/yAxis","title":"yAxis","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"path":"/docs/options/gridLines","title":"gridLines","description":"Allowed values: auto, off. Default: undefined."},{"path":"/docs/options/xLabelMode","title":"xLabelMode","description":"How crowded category-axis labels are decluttered. `'auto'` (default) keeps labels horizontal and thins any that would collide. `'all'` shows everything, `'thin'`/`'rotate'` force one strategy, `'none'` hides the labels."},{"path":"/docs/options/xLabelRotation","title":"xLabelRotation","description":"Explicit category-label rotation in degrees (respected as a floor on top of auto-declutter)."},{"path":"/docs/options/xLabelMaxCount","title":"xLabelMaxCount","description":"Hard cap on the number of category-axis labels shown (kept evenly spaced)."},{"path":"/docs/options/camera3d","title":"camera3d","description":"Camera and orbit settings shared by the 3D families. Assign objects as properties or JSON attributes."},{"path":"/docs/options/orbit3d","title":"orbit3d","description":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."}]}]},{"id":"tooltip","title":"Tooltips & interaction","blocks":[{"kind":"links","items":[{"path":"/docs/options/hitTolerance","title":"hitTolerance","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/markerClickable","title":"markerClickable","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/markerActiveTrigger","title":"markerActiveTrigger","description":"Allowed values: hover, click, custom. Default: 'hover'."},{"path":"/docs/options/tooltip","title":"tooltip","description":"Tooltip settings for pointer-driven values, position, and content."},{"path":"/docs/options/crosshair","title":"crosshair","description":"Bare crosshair or {} enables defaults. Object props and JSON attributes override options. Omit/remove the attribute to disable."},{"path":"/docs/options/zoom","title":"zoom","description":"cartesian zoom (line / area / column / bar / scatter): `'x'` | `'y'` | `'xy'` | `true` enable the drag rectangle + keyboard on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Forwarded to the active family element."},{"path":"/docs/options/brush","title":"brush","description":"brush selection on the cartesian families (forwarded like `zoom`)."},{"path":"/docs/options/drawings","title":"drawings","description":"the drawing document (a list, an envelope or a JSON string), forwarded to the cartesian families."},{"path":"/docs/options/drawingMode","title":"drawingMode","description":"'none' | 'draw' | 'select': the pointer disposition of the cartesian families (draw places `drawingTool`)."},{"path":"/docs/options/drawingTool","title":"drawingTool","description":"the tool a draw mode places (default 'segment')."},{"path":"/docs/options/drawingSpace","title":"drawingSpace","description":"the space new drawings are anchored in ('data' | 'pixel'), forwarded to the cartesian families."},{"path":"/docs/options/visualMap","title":"visualMap","description":"a visual map binding (a `sy-visual-map` snapshot + the data dimension), forwarded to the cartesian family."},{"path":"/docs/options/allowSelect","title":"allowSelect","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/tooltipEnabled","title":"tooltipEnabled","description":"Pie tooltip toggle. Named `tooltipEnabled` to avoid the cartesian `tooltipShow` event."},{"path":"/docs/options/tooltipFormat","title":"tooltipFormat","description":"Pie tooltip HTML formatter (property-only — functions can't be set via attribute)."},{"path":"/docs/options/enableMouseTracking","title":"enableMouseTracking","description":"Pie mouse-tracking toggle. Mirrors Highcharts plotOptions.pie.enableMouseTracking."},{"path":"/docs/options/stickyTracking","title":"stickyTracking","description":"Keep hover/tooltip until another slice is entered (Highcharts stickyTracking)."},{"path":"/docs/options/crosshairSnapDistance","title":"crosshairSnapDistance","description":"Geo Map: point-center capture distance in CSS pixels when crosshair.snap is enabled."}]}]},{"id":"legend","title":"Legend","blocks":[{"kind":"links","items":[{"path":"/docs/options/legend","title":"legend","description":"Show the legend. Undefined lets each chart use its own default (marimekko/dot-plot default on; the cartesian charts default off)."},{"path":"/docs/options/legendPosition","title":"legendPosition","description":"Where the legend is positioned."},{"path":"/docs/options/legendItems","title":"legendItems","description":"Pass as a JavaScript property. type: LegendItem[]."},{"path":"/docs/options/legendFloatAlign","title":"legendFloatAlign","description":"Allowed values: start, center, end. Default: 'end'."},{"path":"/docs/options/legendFloatVerticalAlign","title":"legendFloatVerticalAlign","description":"Allowed values: top, bottom, middle. Default: 'top'."},{"path":"/docs/options/legendDraggable","title":"legendDraggable","description":"Set as an HTML attribute or JavaScript property. type: boolean."}]}]},{"id":"appearance","title":"Appearance & styling","blocks":[{"kind":"links","items":[{"path":"/docs/options/color","title":"color","description":"Pass as a JavaScript property. type: string | ReadonlyArray<string>."},{"path":"/docs/options/thickness","title":"thickness","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/marker","title":"marker","description":"Pass as a JavaScript property. type: LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>."},{"path":"/docs/options/markerSize","title":"markerSize","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/markerLineWidth","title":"markerLineWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/markerFilter","title":"markerFilter","description":"Pass as a JavaScript property. type: LineChartMarkerFilter."},{"path":"/docs/options/lineDash","title":"lineDash","description":"Pass as a JavaScript property. type: number[]."},{"path":"/docs/options/connectNulls","title":"connectNulls","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/smooth","title":"smooth","description":"Allowed values: none, monotone, cardinal. Default: 'none'."},{"path":"/docs/options/smoothTension","title":"smoothTension","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/step","title":"step","description":"Allowed values: none, left, right, center. Default: 'none'."},{"path":"/docs/options/fillColor","title":"fillColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/fillOpacity","title":"fillOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/fillGradient","title":"fillGradient","description":"Pass as a JavaScript property. type: unknown."},{"path":"/docs/options/fillPattern","title":"fillPattern","description":"Pass as a JavaScript property. type: unknown."},{"path":"/docs/options/patternKind","title":"patternKind","description":"Allowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined."},{"path":"/docs/options/patternColor","title":"patternColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/patternBackground","title":"patternBackground","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/patternSize","title":"patternSize","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/patternThickness","title":"patternThickness","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/borderRadius","title":"borderRadius","description":"Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue."},{"path":"/docs/options/borderScope","title":"borderScope","description":"Allowed values: point, stack, outline. Default: undefined."},{"path":"/docs/options/borderColor","title":"borderColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/borderWidth","title":"borderWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/borderDashStyle","title":"borderDashStyle","description":"Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined."},{"path":"/docs/options/inactiveOtherPoints","title":"inactiveOtherPoints","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/inactivePointOpacity","title":"inactivePointOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/palette","title":"palette","description":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: undefined."},{"path":"/docs/options/colors","title":"colors","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"path":"/docs/options/labelsMode","title":"labelsMode","description":"Allowed values: none, auto, inside, outside. Default: undefined."},{"path":"/docs/options/labelsContent","title":"labelsContent","description":"Allowed values: percent, value, name, name-percent, name-value. Default: undefined."},{"path":"/docs/options/labelsDistance","title":"labelsDistance","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/labelsFontSize","title":"labelsFontSize","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/labelsMinSweep","title":"labelsMinSweep","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/labelsConnector","title":"labelsConnector","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/inactiveOtherSlices","title":"inactiveOtherSlices","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/inactiveSliceOpacity","title":"inactiveSliceOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/labelsFontWeight","title":"labelsFontWeight","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/labelsColor","title":"labelsColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/labelsConnectorColor","title":"labelsConnectorColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/labelsConnectorWidth","title":"labelsConnectorWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/labelsConnectorPadding","title":"labelsConnectorPadding","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/labelsConnectorShape","title":"labelsConnectorShape","description":"Allowed values: straight, crooked. Default: undefined."},{"path":"/docs/options/labelsAllowOverlap","title":"labelsAllowOverlap","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/labelColor","title":"labelColor","description":"Tilemap: in-tile label colour."},{"path":"/docs/options/colorAxis","title":"colorAxis","description":"Tilemap: value→colour axis (`true`/`'auto'`/object). Property-only; off by default."},{"path":"/docs/options/colorLegend","title":"colorLegend","description":"Tilemap: show the colour-axis gradient legend (on while the axis is on)."},{"path":"/docs/options/fillAlpha","title":"fillAlpha","description":"The fill opacity of a bubble (the border stays opaque)."},{"path":"/docs/options/labelMode","title":"labelMode","description":"Waterfall (): the value labels' mode — value / running / both (`show-labels` switches them on); `labelFormat(bar)` replaces the text."},{"path":"/docs/options/labelFormat","title":"labelFormat","description":"Pass as a JavaScript property. type: (bar: unknown) => string."},{"path":"/docs/options/markerRadius","title":"markerRadius","description":"Radar vertex marker radius in px."},{"path":"/docs/options/labelPlacement","title":"labelPlacement","description":"Funnel/pyramid data-label placement."},{"path":"/docs/options/inactiveOtherSections","title":"inactiveOtherSections","description":"Dim non-active funnel/pyramid sections when a section is active."},{"path":"/docs/options/inactiveSectionOpacity","title":"inactiveSectionOpacity","description":"Opacity applied to non-active funnel/pyramid sections."},{"path":"/docs/options/markerColor","title":"markerColor","description":"Lollipop marker fill override (defaults to `color`)."},{"path":"/docs/options/colorful","title":"colorful","description":"Variwide: colour each column from the categorical palette."}]}]},{"id":"layout","title":"Size, titles & state","blocks":[{"kind":"links","items":[{"path":"/docs/options/width","title":"width","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"path":"/docs/options/height","title":"height","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"path":"/docs/options/chartTitle","title":"chartTitle","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"path":"/docs/options/chartSubtitle","title":"chartSubtitle","description":"The subtitle inside the chart."},{"path":"/docs/options/emptyColor","title":"emptyColor","description":"Heatmap: the colour of an empty cell (default transparent)."},{"path":"/docs/options/padding","title":"padding","description":"(ledger E2 / E7) — the value-domain padding fraction of the Pro cartesian families (box plot, bubble, candlestick / OHLC, density map, error bar, waterfall: each wrapper defaults to 0.05). Left unset, the wrapper's own default applies; the Community cartesian families size their domains through their axis inputs instead."},{"path":"/docs/options/themeRiverAxes","title":"themeRiverAxes","description":"ThemeRiver time and stacked-magnitude axes."},{"path":"/docs/options/themeRiverOffset","title":"themeRiverOffset","description":"Allowed values: silhouette, zero, expand. Default: 'silhouette'."},{"path":"/docs/options/themeRiverOrder","title":"themeRiverOrder","description":"Allowed values: input, reverse. Default: 'input'."},{"path":"/docs/options/themeRiverColors","title":"themeRiverColors","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"path":"/docs/options/themeRiverOpacity","title":"themeRiverOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/themeRiverHiddenSeries","title":"themeRiverHiddenSeries","description":"Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>."},{"path":"/docs/options/errorColor","title":"errorColor","description":"Error bar: the whisker + cap colour; bar mode (a column from zero); the caps' switch."},{"path":"/docs/options/loading","title":"loading","description":"Loading overlay ()."},{"path":"/docs/options/loadingText","title":"loadingText","description":"Loading overlay text override; falls back to the locale string."},{"path":"/docs/options/emptyText","title":"emptyText","description":"Empty-state text override; falls back to the locale string ()."},{"path":"/docs/options/showEmpty","title":"showEmpty","description":"Auto empty state when no finite data point exists. Default `true`."},{"path":"/docs/options/error","title":"error","description":"Error state (). `true` uses the locale default; a string is the message."},{"path":"/docs/options/errorText","title":"errorText","description":"Error body text override (used when `error` is boolean `true`)."},{"path":"/docs/options/theme","title":"theme","description":"The theme used for chart colors and typography. Pass a theme name or a supported theme object. Page and chart themes are separate; update both in your app."},{"path":"/docs/options/locale","title":"locale","description":"Locale name (`en` | `ko` | `ja` | `zh`) or a partial override object ()."}]}]},{"id":"animation","title":"Animation & engine","blocks":[{"kind":"links","items":[{"path":"/docs/options/engine","title":"engine","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"path":"/docs/options/proThreshold","title":"proThreshold","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/unavailable","title":"unavailable","description":"Allowed values: fallback, error. Default: 'fallback'."},{"path":"/docs/options/streamSource","title":"streamSource","description":"A stream source for live data. Check the contract for the specific type."},{"path":"/docs/options/streamWindow","title":"streamWindow","description":"The streaming data range to keep visible."},{"path":"/docs/options/streamMax","title":"streamMax","description":"The maximum number of streaming data points to retain."},{"path":"/docs/options/frameBudget","title":"frameBudget","description":"milliseconds a drawn frame may take before the next scheduled frame is skipped (line family; 0 disables skipping)."},{"path":"/docs/options/streamWindowMs","title":"streamWindowMs","description":"an absolute stream window: only points appended within the last N ms are visible, sliding every frame (line family; overrides `stream-window`)."},{"path":"/docs/options/streamTimestamps","title":"streamTimestamps","description":"the line family's ring stamps its points (`on`, the default — an absolute `stream-window-ms` needs them) unless `off` opts out (8 MB less at a 1M capacity for charts that only use a count window)."},{"path":"/docs/options/animated","title":"animated","description":"Whether to animate initial display and data changes."},{"path":"/docs/options/animationDuration","title":"animationDuration","description":"Animation duration in milliseconds."},{"path":"/docs/options/animationEasing","title":"animationEasing","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"path":"/docs/options/animationType","title":"animationType","description":"Allowed values: initial, update. Default: undefined."},{"path":"/docs/options/progressive","title":"progressive","description":"scatter, Standard engine: paint a heavy frame in chunks (false / 0 = off, true = 5,000 per chunk, a number = points per chunk)."},{"path":"/docs/options/progressiveThreshold","title":"progressiveThreshold","description":"below this many drawn points the frame paints at once (default 20,000)."},{"path":"/docs/options/renderPath","title":"renderPath","description":"Heatmap (): the draw path — `auto` / `plane` / `cells`. `border-radius` / `border-width` / `border-color` style the cells."},{"path":"/docs/options/lod","title":"lod","description":"Heatmap (): the plane path's level of detail — `auto` / `point` / `area`."},{"path":"/docs/options/areaReduce","title":"areaReduce","description":"Heatmap / spectrogram (): how the area LOD folds the cells a pixel covers — `mean` (the heatmap default) or `max` (the spectrogram default, peak-hold)."}]}]},{"id":"export","title":"Export & branding","blocks":[{"kind":"links","items":[{"path":"/docs/options/brandLogo","title":"brandLogo","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"path":"/docs/options/brandPosition","title":"brandPosition","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"path":"/docs/options/contextmenu","title":"contextmenu","description":"Enables the shared right-click context menu on empty chart area. Default `false`."},{"path":"/docs/options/contextMenuItems","title":"contextMenuItems","description":"Append custom menu items after the built-in image and data export items. This array does not replace the default menu. Pass objects with action callbacks as a JavaScript property."},{"path":"/docs/options/exportFilename","title":"exportFilename","description":"Base filename (no extension) for exports; falls back to the title or type."},{"path":"/docs/options/exportScale","title":"exportScale","description":"Output pixel scale for PNG export (1–8). Default 2 (retina)."},{"path":"/docs/options/exportBackground","title":"exportBackground","description":"Backdrop painted behind PNG/SVG exports; falls back to the theme background."}]}]},{"id":"specific","title":"Chart-specific options","blocks":[{"kind":"links","items":[{"path":"/docs/options/barPadding","title":"barPadding","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/baseline","title":"baseline","description":"Reference value for cartesian charts. Column / bar / area use it as the visual anchor; line uses it as a value-axis reference marker. Always explicit (default `0`) so the baseline stays visible regardless of `type`."},{"path":"/docs/options/stacking","title":"stacking","description":"Allowed values: normal, percent. Default: undefined."},{"path":"/docs/options/innerSize","title":"innerSize","description":"Pass as a JavaScript property. type: number | string."},{"path":"/docs/options/startAngleProp","title":"startAngleProp","description":"Pie/gauge/item start angle; Chord uses degrees with a default of -90 (top)."},{"path":"/docs/options/endAngleProp","title":"endAngleProp","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/centerText","title":"centerText","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/centerSubtext","title":"centerSubtext","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/slicedOffset","title":"slicedOffset","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/activeSliceIndex","title":"activeSliceIndex","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/size","title":"size","description":"Pie outer diameter. Number = px; '%' = fraction of the smaller plot side."},{"path":"/docs/options/centerX","title":"centerX","description":"Pass as a JavaScript property. type: number | string."},{"path":"/docs/options/centerY","title":"centerY","description":"Pass as a JavaScript property. type: number | string."},{"path":"/docs/options/minSize","title":"minSize","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/donutThickness","title":"donutThickness","description":"Donut ring thickness in px. Named `donutThickness` to avoid the cartesian `thickness` prop."},{"path":"/docs/options/symbol","title":"symbol","description":"Item dot symbol — `circle` (default) / `square` / `diamond`; per-datum `symbol` overrides."},{"path":"/docs/options/rows","title":"rows","description":"Item concentric ring count; auto (smallest that fits) when unset."},{"path":"/docs/options/itemPadding","title":"itemPadding","description":"Item cell whitespace fraction around each dot, 0..0.9 (Highcharts itemPadding)."},{"path":"/docs/options/minFontSize","title":"minFontSize","description":"Word cloud: smallest rendered font in px (Highcharts minFontSize)."},{"path":"/docs/options/maxFontSize","title":"maxFontSize","description":"Word cloud: font px of the heaviest word (Highcharts maxFontSize)."},{"path":"/docs/options/weightScale","title":"weightScale","description":"Word cloud: weight→fontSize curve — `linear` (default) / `sqrt` / `log`."},{"path":"/docs/options/spiral","title":"spiral","description":"Word cloud: spiral search pattern — `rectangular` (default) / `archimedean`."},{"path":"/docs/options/orientations","title":"orientations","description":"Word cloud: number of distinct orientations in the rotation cycle (default 2)."},{"path":"/docs/options/rotationFrom","title":"rotationFrom","description":"Word cloud: rotation cycle start in degrees (default 0)."},{"path":"/docs/options/rotationTo","title":"rotationTo","description":"Word cloud: rotation cycle end in degrees (default 90)."},{"path":"/docs/options/wordPadding","title":"wordPadding","description":"Word cloud: empty px kept between word boxes (default 2)."},{"path":"/docs/options/paths","title":"paths","description":"Pictorial: SVG path definitions the icons cycle through per category. Property-only."},{"path":"/docs/options/iconPadding","title":"iconPadding","description":"Pictorial: fraction of each band kept as whitespace around its icon, 0..0.9."},{"path":"/docs/options/trackOpacity","title":"trackOpacity","description":"Pictorial: opacity of the unfilled remainder silhouette (0 hides the track)."},{"path":"/docs/options/tileShape","title":"tileShape","description":"Tilemap: tile glyph — `hexagon` (default) / `square`; circle/diamond land ."},{"path":"/docs/options/showLabels","title":"showLabels","description":"Tilemap: render each tile's label inside the tile when it fits."},{"path":"/docs/options/matrix","title":"matrix","description":"Heatmap: a dense matrix — `{ columns, rows, values }` (row-major) or rows of columns. Property-only."},{"path":"/docs/options/xCategories","title":"xCategories","description":"Heatmap: column labels (array, or a comma list). Given explicitly, they fix the column count."},{"path":"/docs/options/yCategories","title":"yCategories","description":"Heatmap: row labels (row 0 is the top row)."},{"path":"/docs/options/headerHeight","title":"headerHeight","description":"Treemap branch header band in CSS pixels."},{"path":"/docs/options/drilldown","title":"drilldown","description":"Enable Treemap branch navigation and accessible hierarchy controls."},{"path":"/docs/options/dendrogramDirection","title":"dendrogramDirection","description":"Dendrogram depth direction; sibling order remains in normalized input order."},{"path":"/docs/options/icicleDirection","title":"icicleDirection","description":"Icicle depth direction; sibling order remains in normalized input order."},{"path":"/docs/options/parallelCoordinatesAxes","title":"parallelCoordinatesAxes","description":"Independent axis ticks, captions, local guides and label styles."},{"path":"/docs/options/parallelCoordinatesBrush","title":"parallelCoordinatesBrush","description":"Pass as a JavaScript property. type: ParallelCoordinatesBrushInput."},{"path":"/docs/options/parallelCoordinatesDimensions","title":"parallelCoordinatesDimensions","description":"Numeric dimensions in display order. Omit to infer them from row values."},{"path":"/docs/options/parallelCoordinatesLineWidth","title":"parallelCoordinatesLineWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/parallelCoordinatesLineOpacity","title":"parallelCoordinatesLineOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/parallelCoordinatesInactiveRowOpacity","title":"parallelCoordinatesInactiveRowOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/parallelCoordinatesAxisLabels","title":"parallelCoordinatesAxisLabels","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/lighting3d","title":"lighting3d","description":"Pass as a JavaScript property. type: Scene3DLightingOptions."},{"path":"/docs/options/material3d","title":"material3d","description":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},{"path":"/docs/options/flowLinesStyle","title":"flowLinesStyle","description":"FlowLines route widths, colors, arrows and endpoint markers."},{"path":"/docs/options/flowLinesPath","title":"flowLinesPath","description":"Allowed values: great-circle, straight. Default: 'great-circle'."},{"path":"/docs/options/flowLinesLocationLabels","title":"flowLinesLocationLabels","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"path":"/docs/options/flowLinesLabels","title":"flowLinesLabels","description":"Allowed values: auto, show, hide. Default: 'hide'."},{"path":"/docs/options/flowLinesLabelValue","title":"flowLinesLabelValue","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/bar3dAxes","title":"bar3dAxes","description":"Pass as a JavaScript property. type: Bar3DAxesOptions|boolean|string."},{"path":"/docs/options/scatter3dAxes","title":"scatter3dAxes","description":"Pass as a JavaScript property. type: Scatter3DAxesOptions|boolean|string."},{"path":"/docs/options/bar3dSize","title":"bar3dSize","description":"Pass as a JavaScript property. type: Scene3DVector."},{"path":"/docs/options/scatter3dSize","title":"scatter3dSize","description":"Pass as a JavaScript property. type: Scene3DVector."},{"path":"/docs/options/bar3dColors","title":"bar3dColors","description":"Pass as a JavaScript property. type: HeatmapColorInput."},{"path":"/docs/options/scatter3dColors","title":"scatter3dColors","description":"Pass as a JavaScript property. type: HeatmapColorInput."},{"path":"/docs/options/bar3dColorDomain","title":"bar3dColorDomain","description":"Pass as a JavaScript property. type: Bar3DDomain."},{"path":"/docs/options/scatter3dColorDomain","title":"scatter3dColorDomain","description":"Pass as a JavaScript property. type: Scatter3DDomain."},{"path":"/docs/options/bar3dMissingColor","title":"bar3dMissingColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/scatter3dMissingColor","title":"scatter3dMissingColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/bar3dOpacity","title":"bar3dOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/bar3dWidth","title":"bar3dWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/bar3dDepth","title":"bar3dDepth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/bar3dXCategories","title":"bar3dXCategories","description":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},{"path":"/docs/options/bar3dYCategories","title":"bar3dYCategories","description":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},{"path":"/docs/options/scatter3dOpacity","title":"scatter3dOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/scatter3dMarker","title":"scatter3dMarker","description":"Allowed values: sphere, cube. Default: 'sphere'."},{"path":"/docs/options/scatter3dMarkerRadius","title":"scatter3dMarkerRadius","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/scatter3dMarkerDetail","title":"scatter3dMarkerDetail","description":"Set as an HTML attribute or JavaScript property. type: 0|1|2."},{"path":"/docs/options/surface3dAxes","title":"surface3dAxes","description":"Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string."},{"path":"/docs/options/surface3dSize","title":"surface3dSize","description":"Pass as a JavaScript property. type: Scene3DVector."},{"path":"/docs/options/surface3dColors","title":"surface3dColors","description":"Pass as a JavaScript property. type: HeatmapColorInput."},{"path":"/docs/options/surface3dColorDomain","title":"surface3dColorDomain","description":"Pass as a JavaScript property. type: Surface3DDomain."},{"path":"/docs/options/surface3dMissingColor","title":"surface3dMissingColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/surface3dOpacity","title":"surface3dOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/surface3dWireframe","title":"surface3dWireframe","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/surface3dWireWidth","title":"surface3dWireWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/surface3dWireColor","title":"surface3dWireColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/ganttBarHeight","title":"ganttBarHeight","description":"Maximum Gantt task bar height in CSS pixels."},{"path":"/docs/options/ganttRowGap","title":"ganttRowGap","description":"Gantt row gap in CSS pixels."},{"path":"/docs/options/ganttTimeDomain","title":"ganttTimeDomain","description":"Explicit full Gantt time domain in epoch milliseconds."},{"path":"/docs/options/ganttCriticalPath","title":"ganttCriticalPath","description":"Pass as a JavaScript property. type: GanttCriticalPathInput."},{"path":"/docs/options/ganttTaskEditing","title":"ganttTaskEditing","description":"Gantt task move/resize with elapsed-time snapping and optional bounds. Disabled by default."},{"path":"/docs/options/ganttBaseline","title":"ganttBaseline","description":"Gantt reference-date strips and automatic domain inclusion. Visible by default when supplied."},{"path":"/docs/options/ganttDependencies","title":"ganttDependencies","description":"Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>."},{"path":"/docs/options/ganttDependencyStyle","title":"ganttDependencyStyle","description":"Pass as a JavaScript property. type: GanttDependencyStyleInput."},{"path":"/docs/options/ganttTimeAxis","title":"ganttTimeAxis","description":"Pass as a JavaScript property. type: GanttTimeAxisInput."},{"path":"/docs/options/ganttCrosshairTimeUnit","title":"ganttCrosshairTimeUnit","description":"Gantt crosshair time badge precision; default hour. Uses ganttTimeAxis.utc."},{"path":"/docs/options/ganttBarRadius","title":"ganttBarRadius","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/ganttProgressShow","title":"ganttProgressShow","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/ganttProgressColor","title":"ganttProgressColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/taskLabelFormat","title":"taskLabelFormat","description":"Pass as a JavaScript property. type: (task:GanttTask)=>string."},{"path":"/docs/options/taskLabels","title":"taskLabels","description":"Allowed values: auto, show, hide. Default: undefined."},{"path":"/docs/options/kernel","title":"kernel","description":"Density map: the kernel profile (`gaussian`, `epanechnikov`, `quartic`, `triangular`, `uniform`)."},{"path":"/docs/options/bandwidth","title":"bandwidth","description":"Density map: the bandwidth — a number (both axes), `\"x,y\"`, `{ x, y }`, or `auto` (Silverman's rule)."},{"path":"/docs/options/bandwidthUnit","title":"bandwidthUnit","description":"Density map: the unit of an explicit bandwidth — `data` (default) or `px`."},{"path":"/docs/options/cellSize","title":"cellSize","description":"Density map: CSS px per estimate cell (the grid follows the plot)."},{"path":"/docs/options/threshold","title":"threshold","description":"Density map: cells under this fraction of the peak density are empty."},{"path":"/docs/options/computePath","title":"computePath","description":"Density map: where the estimate runs — `auto` (the GPU once the renderer is up), `cpu`, `gpu`."},{"path":"/docs/options/fade","title":"fade","description":"Density map: the fade band above the threshold cut, as a fraction of the peak ()."},{"path":"/docs/options/densityUnit","title":"densityUnit","description":"Density map: how densities read — the cell's mass, or mass per unit area ()."},{"path":"/docs/options/sampleRate","title":"sampleRate","description":"Spectrogram: the sampling rate in Hz — the frequency axis spans 0 … sample-rate / 2."},{"path":"/docs/options/freqMin","title":"freqMin","description":"Spectrogram: the frequency axis ends in Hz (they win over `sample-rate`)."},{"path":"/docs/options/freqMax","title":"freqMax","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/hopSeconds","title":"hopSeconds","description":"Spectrogram: seconds per frame (the hop) — the time axis."},{"path":"/docs/options/timeOrigin","title":"timeOrigin","description":"Spectrogram: seconds at the first frame."},{"path":"/docs/options/valueScale","title":"valueScale","description":"Spectrogram: `db` (the frames are decibels) or `linear` (magnitudes, converted with 20 · log10)."},{"path":"/docs/options/dbFloor","title":"dbFloor","description":"Spectrogram: the dB a zero magnitude reads on the linear scale (default −120)."},{"path":"/docs/options/year","title":"year","description":"Calendar heatmap: the year (Jan 1 … Dec 31) unless `start-date` / `end-date` say otherwise."},{"path":"/docs/options/startDate","title":"startDate","description":"Calendar heatmap: the range ends (ISO dates); they win over `year`; neither → the entries' span."},{"path":"/docs/options/endDate","title":"endDate","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/weekStart","title":"weekStart","description":"Calendar heatmap: the first day of the week (the top row) — `monday` or `sunday`."},{"path":"/docs/options/aggregate","title":"aggregate","description":"Calendar heatmap: how several entries on one day fold — `sum`, `max`, `min`, `mean`, `last`."},{"path":"/docs/options/noDataValue","title":"noDataValue","description":"Calendar heatmap: what a day without entries reads — a number (default 0 → the ramp's first colour) or `nan` (→ `empty-color`)."},{"path":"/docs/options/monthLabels","title":"monthLabels","description":"Calendar heatmap: month labels along the top."},{"path":"/docs/options/weekdayLabels","title":"weekdayLabels","description":"Calendar heatmap: weekday labels down the left — `short` (rows 0 / 2 / 4), `all`, `none`."},{"path":"/docs/options/monthLines","title":"monthLines","description":"Calendar heatmap: month boundaries as step lines between the cells."},{"path":"/docs/options/upColor","title":"upColor","description":"Candlestick: the colour of a rising bar (close > open)."},{"path":"/docs/options/downColor","title":"downColor","description":"Candlestick: the colour of a falling bar (close < open)."},{"path":"/docs/options/flatColor","title":"flatColor","description":"Candlestick: the colour of a doji (close = open)."},{"path":"/docs/options/candleWidth","title":"candleWidth","description":"Candlestick: the body's share of the bar pitch (0 … 1, default 0.7)."},{"path":"/docs/options/wickWidth","title":"wickWidth","description":"Candlestick: the wick width in CSS px."},{"path":"/docs/options/bodyStyle","title":"bodyStyle","description":"Candlestick (): `solid`, `hollow`, or `hollow-up` (rising bars hollow, falling filled)."},{"path":"/docs/options/wickColor","title":"wickColor","description":"Candlestick (): the wick colour; `auto` follows the body colour."},{"path":"/docs/options/timeScale","title":"timeScale","description":"Candlestick (): `ordinal` (one slot per bar — no weekend / holiday gaps; the default) or `linear` (wall time)."},{"path":"/docs/options/session","title":"session","description":"Candlestick (): the exchange session the labels read — `24x7`, `us-equity`, or a JSON object `{ timezone, sessions, holidays, closedWeekdays }`."},{"path":"/docs/options/volume","title":"volume","description":"Candlestick (): `pane` adds a volume pane below the price (a feed without volumes gets none); `off` by default."},{"path":"/docs/options/volumeHeight","title":"volumeHeight","description":"Candlestick (): the volume pane's share of the plot height (0.05 … 0.8; default 0.25)."},{"path":"/docs/options/volumeUpColor","title":"volumeUpColor","description":"Candlestick (): the volume bar colours (`auto` = up-color / down-color) and their alpha (default 0.45)."},{"path":"/docs/options/volumeDownColor","title":"volumeDownColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/volumeAlpha","title":"volumeAlpha","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/barStyle","title":"barStyle","description":"Candlestick / OHLC (): the bar style — `candle` / `ohlc` / `hlc` on a candlestick, `ohlc` / `hlc` on `type=\"ohlc\"`."},{"path":"/docs/options/overlays","title":"overlays","description":"Candlestick (): moving-average overlays — spec objects `{ kind, period, color?, width?, label? }`, a JSON string, or the compact `\"sma:20 ema:50\"`."},{"path":"/docs/options/boxColor","title":"boxColor","description":"Box plot: the box colour — the border, and at `box-fill-alpha` the fill; `auto` whiskers / outliers follow it."},{"path":"/docs/options/boxFillAlpha","title":"boxFillAlpha","description":"Box plot: the fill's alpha (default 0.35)."},{"path":"/docs/options/medianColor","title":"medianColor","description":"Box plot: the median line colour."},{"path":"/docs/options/whiskerColor","title":"whiskerColor","description":"Box plot: the whisker / outlier colours (`auto` = the box colour)."},{"path":"/docs/options/outlierColor","title":"outlierColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/boxWidth","title":"boxWidth","description":"Box plot: the box's share of the slot pitch (0 … 1, default 0.6)."},{"path":"/docs/options/whiskerRule","title":"whiskerRule","description":"Box plot: `tukey` (1.5 × IQR, the default), `min-max` (no outliers), or a number of IQRs."},{"path":"/docs/options/quantileMethod","title":"quantileMethod","description":"Box plot (): the quantile method — `linear` (R-7, the default), `exclusive` (R-6), `nearest`, `lower`, `higher`, `midpoint`."},{"path":"/docs/options/whiskerPercentile","title":"whiskerPercentile","description":"Box plot (): the `percentile` whisker rule's p (0 … 50, default 5)."},{"path":"/docs/options/notched","title":"notched","description":"Box plot (): the stepped notch (median ± 1.57 × IQR / √n)."},{"path":"/docs/options/showMean","title":"showMean","description":"Box plot (): the mean marker — a small square in `mean-color` (`auto` = the median colour)."},{"path":"/docs/options/meanColor","title":"meanColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/capWidth","title":"capWidth","description":"Box plot (): The whisker caps' share of the box (0 hides them)."},{"path":"/docs/options/whiskerWidth","title":"whiskerWidth","description":"Box plot (): The whisker / border thickness in CSS px."},{"path":"/docs/options/medianWidth","title":"medianWidth","description":"Box plot (): The median line thickness in CSS px."},{"path":"/docs/options/outlierRadius","title":"outlierRadius","description":"Box plot (): The outlier disc radius in CSS px."},{"path":"/docs/options/boxMinPx","title":"boxMinPx","description":"Box plot (): The narrowest box in CSS px."},{"path":"/docs/options/boxMaxPx","title":"boxMaxPx","description":"Box plot (): The widest box in CSS px."},{"path":"/docs/options/notchWidth","title":"notchWidth","description":"Box plot (): The notch's share of the box width (notched)."},{"path":"/docs/options/meanSize","title":"meanSize","description":"Box plot (): The mean marker size in CSS px (show-mean)."},{"path":"/docs/options/minRadius","title":"minRadius","description":"The radius range in CSS px the z range maps onto."},{"path":"/docs/options/maxRadius","title":"maxRadius","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/sizeScale","title":"sizeScale","description":"`area` (the disc area proportional to z; the default) or `radius`."},{"path":"/docs/options/layout","title":"layout","description":"Bubble: `xy` or `pack`. Network Graph: deterministic `circular`, `force`, or top-to-bottom `hierarchical` placement."},{"path":"/docs/options/clustering","title":"clustering","description":"Network Graph: `none` or `louvain` community detection over the current graph; with the automatic palette, node colours follow the group. Independent of `layout`."},{"path":"/docs/options/bundling","title":"bundling","description":"Network Graph: `none` or `force` edge bundling of the connecting lines toward compatible neighbours; `bundle-strength` 0 … 1 scales the attraction (default 0.5)."},{"path":"/docs/options/bundleStrength","title":"bundleStrength","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/nodeDrag","title":"nodeDrag","description":"Network Graph — nodes can be dragged with a pointer and nudged with Ctrl / ⌘ + arrows; a dragged node stays pinned. `node-drag=\"false\"` turns it off."},{"path":"/docs/options/packPadding","title":"packPadding","description":"Bubble pack gap in CSS px, and `contain` (shrink only) or `fill` fitting."},{"path":"/docs/options/packFit","title":"packFit","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/shading","title":"shading","description":"the bubble shading: `flat` or `sphere` (a highlight and a darker rim), and its strength 0 … 1."},{"path":"/docs/options/shadeStrength","title":"shadeStrength","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/totalColor","title":"totalColor","description":"Waterfall: the subtotal / total bars' colour, the connectors' colour and thickness, their switch."},{"path":"/docs/options/connectorColor","title":"connectorColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/connectorWidth","title":"connectorWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/showConnectors","title":"showConnectors","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/barWidth","title":"barWidth","description":"Waterfall: the bar's share of the slot pitch (0.6), clamped between bar-min-px and bar-max-px."},{"path":"/docs/options/barMinPx","title":"barMinPx","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/barMaxPx","title":"barMaxPx","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/showTotal","title":"showTotal","description":"Waterfall (): append the auto grand total after the last step (unless it already is a total), named `total-label`."},{"path":"/docs/options/totalLabel","title":"totalLabel","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/detectResult","title":"detectResult","description":"Waterfall: recognise a last step given as a plain value equal to the running total as the result bar (default on)."},{"path":"/docs/options/lastResult","title":"lastResult","description":"Waterfall: true makes the last merged step a result using the preceding running total and total-color; false disables auto detection; omitted uses detect-result. Explicit datum kinds remain effective when false."},{"path":"/docs/options/nodeRadius","title":"nodeRadius","description":"Network Graph: circle marker radius and connection width in CSS px."},{"path":"/docs/options/projection","title":"projection","description":"Geo Map: identity keeps the coordinate frame; mercator selects spherical Mercator."},{"path":"/docs/options/features","title":"features","description":"Geo Map: polygon FeatureCollection below the point layer."},{"path":"/docs/options/polygonColor","title":"polygonColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/polygonOpacity","title":"polygonOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/mapColorAxis","title":"mapColorAxis","description":"Geo Map choropleth domain, feature property and palette."},{"path":"/docs/options/mapBubble","title":"mapBubble","description":"Value-scaled geographic point bubbles."},{"path":"/docs/options/mapHeat","title":"mapHeat","description":"Pass as a JavaScript property. type: GeoMapHeatInput."},{"path":"/docs/options/mapLayers","title":"mapLayers","description":"Geo Map presentation masks; omitted layers remain visible."},{"path":"/docs/options/mapLegend","title":"mapLegend","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/featureLabels","title":"featureLabels","description":"Geo Map: region/connection name visibility and optional numeric values."},{"path":"/docs/options/featureLabelValue","title":"featureLabelValue","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/featureTooltipFormat","title":"featureTooltipFormat","description":"Geo Map: custom region/connection tooltip text from owned feature metadata."},{"path":"/docs/options/connectionWidth","title":"connectionWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/connectionColor","title":"connectionColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/connectionOpacity","title":"connectionOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/connectionPath","title":"connectionPath","description":"Geo Map: great-circle arcs or flat-map straight routes; on globes, straight lifts the equirectangular route onto the surface."},{"path":"/docs/options/mapRegion","title":"mapRegion","description":"Geo Map: fit a continent in 2D, or face it on an orthographic globe."},{"path":"/docs/options/mapBackground","title":"mapBackground","description":"Geo Map: bundled Natural Earth land/coastlines, or no background."},{"path":"/docs/options/mapFixed","title":"mapFixed","description":"Geo Map: lock geographic dragging inside the fixed map frame. Flat maps wrap longitude; Albers/Orthographic rotate. Zoom is separate. Default false."},{"path":"/docs/options/linkWidth","title":"linkWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/linkDistance","title":"linkDistance","description":"Network Graph force layout: spring rest distance in CSS px (default 80)."},{"path":"/docs/options/repulsion","title":"repulsion","description":"Network Graph force layout: non-negative node repulsion strength (default 2400)."},{"path":"/docs/options/padAngle","title":"padAngle","description":"Chord: the gap between neighbouring node arcs in degrees (default 2)."},{"path":"/docs/options/nodeWidth","title":"nodeWidth","description":"The nodes' width and the gap between stacked nodes (CSS px)."},{"path":"/docs/options/nodePadding","title":"nodePadding","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/nodeAlign","title":"nodeAlign","description":"Where a node without a forward path stands: justify / left / right / center."},{"path":"/docs/options/linkColor","title":"linkColor","description":"The ribbons' colour (source / target / a CSS colour) and opacity."},{"path":"/docs/options/linkOpacity","title":"linkOpacity","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/layoutIterations","title":"layoutIterations","description":"Sankey relaxation passes (default 6) or Network Graph force steps (default 200). Zero keeps the initial placement."},{"path":"/docs/options/linkCurvature","title":"linkCurvature","description":"the ribbons' centre line: 0 straight … 1 the full S-curve."},{"path":"/docs/options/nodeLabels","title":"nodeLabels","description":"the node labels (auto / show / hide) and the throughput suffix."},{"path":"/docs/options/nodeLabelValue","title":"nodeLabelValue","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/neighbourDim","title":"neighbourDim","description":"with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (1 = no dim)."},{"path":"/docs/options/showBars","title":"showBars","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/showCaps","title":"showCaps","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/samples","title":"samples","description":"Spectrogram (): raw samples (a property) — the FFT pipeline frames them; ignored while `data` is set."},{"path":"/docs/options/fftSize","title":"fftSize","description":"Spectrogram (): the FFT size, a power of two (default 1,024)."},{"path":"/docs/options/fftHop","title":"fftHop","description":"Spectrogram (): samples between frame starts (default fft-size / 2)."},{"path":"/docs/options/fftWindow","title":"fftWindow","description":"Spectrogram (): the analysis window — `hann`, `hamming`, `blackman`, `rect`."},{"path":"/docs/options/stemUnit","title":"stemUnit","description":"Stem-leaf: stem unit — one stem spans this much (default 10)."},{"path":"/docs/options/stemSplit","title":"stemSplit","description":"Stem-leaf: 1 (default) or 2 — each stem splits into 0–4 / 5–9 half-rows."},{"path":"/docs/options/activeColor","title":"activeColor","description":"Stem-leaf: accent for the hovered/focused leaf."},{"path":"/docs/options/showKey","title":"showKey","description":"Stem-leaf: show the reading key (`2 | 3 = 23`) under the plot."},{"path":"/docs/options/bins","title":"bins","description":"Histogram: bin rule — `square-root` (default) / `sturges` / `rice` / literal count."},{"path":"/docs/options/measure","title":"measure","description":"Histogram (): what a bar's height means — count / percent / density."},{"path":"/docs/options/cumulative","title":"cumulative","description":"Histogram (): running sums (the empirical CDF for density)."},{"path":"/docs/options/barGap","title":"barGap","description":"Histogram (): a CSS-px gap between the bars."},{"path":"/docs/options/binWidth","title":"binWidth","description":"Histogram: explicit bin width — wins over `bins`."},{"path":"/docs/options/domainMin","title":"domainMin","description":"Histogram: domain overrides (outside observations clamp into the edge bins)."},{"path":"/docs/options/domainMax","title":"domainMax","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/edgeColor","title":"edgeColor","description":"Histogram: 1px separator between gapless bars."},{"path":"/docs/options/diameter","title":"diameter","description":"Wafer map: wafer diameter in mm."},{"path":"/docs/options/edgeExclusion","title":"edgeExclusion","description":"Wafer map: unusable edge band in mm."},{"path":"/docs/options/indicator","title":"indicator","description":"Wafer map: orientation-mark kind (`notch` / `flat` / `none`)."},{"path":"/docs/options/waferOrientation","title":"waferOrientation","description":"Wafer map: where the orientation mark points."},{"path":"/docs/options/dieWidth","title":"dieWidth","description":"Wafer map: die size in mm."},{"path":"/docs/options/dieHeight","title":"dieHeight","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/scribeX","title":"scribeX","description":"Wafer map: scribe-street widths in mm."},{"path":"/docs/options/scribeY","title":"scribeY","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/showPartial","title":"showPartial","description":"Wafer map: draw edge (partial) dies."},{"path":"/docs/options/dieIndexOrigin","title":"dieIndexOrigin","description":"Wafer map: die-index convention (`top-left` bounding-box corner / `center` signed)."},{"path":"/docs/options/dieIndexBase","title":"dieIndexBase","description":"Wafer map: first index value (0 or 1)."},{"path":"/docs/options/showDieIndex","title":"showDieIndex","description":"Wafer map: print `ix,iy` inside each die (auto-hides on small dies)."},{"path":"/docs/options/mode","title":"mode","description":"Wafer map: colouring mode (`grid` accent / `bin` categorical bin map)."},{"path":"/docs/options/binColors","title":"binColors","description":"Wafer map: explicit per-bin colours (`{ [bin]: colour }`, property)."},{"path":"/docs/options/passBin","title":"passBin","description":"Wafer map: the pass bin code (default 1)."},{"path":"/docs/options/passColor","title":"passColor","description":"Wafer map: pass-bin fill."},{"path":"/docs/options/failColor","title":"failColor","description":"Wafer map: fail fill for `mode=\"binary\"`."},{"path":"/docs/options/showStats","title":"showStats","description":"Wafer map: show the statistics line under the value legend."},{"path":"/docs/options/overlay","title":"overlay","description":"Wafer map: overlay layer (`none` / `defect`)."},{"path":"/docs/options/defects","title":"defects","description":"Wafer map: inspection defects (`{x, y, class?, size?}`, wafer mm, property)."},{"path":"/docs/options/defectColor","title":"defectColor","description":"Wafer map: dot colour for unclassified defects."},{"path":"/docs/options/grid","title":"grid","description":"Wafer map: grid chrome — `die` (scribe only) or `shot` (+ reticle boundaries)."},{"path":"/docs/options/shotCols","title":"shotCols","description":"Wafer map: dies per exposure shot."},{"path":"/docs/options/shotRows","title":"shotRows","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/shotOffsetX","title":"shotOffsetX","description":"Wafer map: shot-grid alignment shift in whole dies."},{"path":"/docs/options/shotOffsetY","title":"shotOffsetY","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/shotColor","title":"shotColor","description":"Wafer map: shot boundary stroke."},{"path":"/docs/options/binLegend","title":"binLegend","description":"Wafer map: show the bin legend under the wafer."},{"path":"/docs/options/sectorPadding","title":"sectorPadding","description":"Polar rose: fraction of each angular slot kept as whitespace, 0..0.8."},{"path":"/docs/options/variableRadius","title":"variableRadius","description":"Pie variable-radius mode — each datum's `z` drives the slice's outer radius (Highcharts variablepie)."},{"path":"/docs/options/sizeBy","title":"sizeBy","description":"Variable-radius z→radius mapping: `'area'` (default, radius ∝ √z̄) or `'radius'` (linear)."},{"path":"/docs/options/zMin","title":"zMin","description":"Variable-radius z-domain lower bound (defaults to the data minimum)."},{"path":"/docs/options/zMax","title":"zMax","description":"Variable-radius z-domain upper bound (defaults to the data maximum)."},{"path":"/docs/options/minPointSize","title":"minPointSize","description":"Smallest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts minPointSize)."},{"path":"/docs/options/maxPointSize","title":"maxPointSize","description":"Largest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts maxPointSize)."},{"path":"/docs/options/gridShape","title":"gridShape","description":"Radar grid web shape — `polygon` (spider) or `circle`."},{"path":"/docs/options/gridColor","title":"gridColor","description":"Radar grid ring/spoke stroke colour."},{"path":"/docs/options/lineWidth","title":"lineWidth","description":"Radar polygon outline width in px."},{"path":"/docs/options/showMarkers","title":"showMarkers","description":"Shows radar vertex markers."},{"path":"/docs/options/showRingLabels","title":"showRingLabels","description":"Shows labels beside radar rings."},{"path":"/docs/options/ringLabelColor","title":"ringLabelColor","description":"Radar ring label colour."},{"path":"/docs/options/ringLabelFontSize","title":"ringLabelFontSize","description":"Radar ring label font size in px."},{"path":"/docs/options/ringLabelFormat","title":"ringLabelFormat","description":"Radar ring label format string."},{"path":"/docs/options/categoryLabelColor","title":"categoryLabelColor","description":"Radar category spoke label colour."},{"path":"/docs/options/categoryLabelFontSize","title":"categoryLabelFontSize","description":"Radar category spoke label font size in px."},{"path":"/docs/options/editable","title":"editable","description":"Enables drag-to-edit radar points."},{"path":"/docs/options/neckWidth","title":"neckWidth","description":"Funnel neck width as a fraction of the full width (funnel only)."},{"path":"/docs/options/neckHeight","title":"neckHeight","description":"Funnel neck height as a fraction of the total height (the straight bottom band)."},{"path":"/docs/options/gap","title":"gap","description":"Vertical gap between funnel/pyramid sections (px)."},{"path":"/docs/options/showPercent","title":"showPercent","description":"Show the percentage in funnel/pyramid labels."},{"path":"/docs/options/activeSectionIndex","title":"activeSectionIndex","description":"Controlled active funnel/pyramid section index. Negative/undefined falls back to hover/focus."},{"path":"/docs/options/lineColor","title":"lineColor","description":"Cumulative-line colour (pareto only)."},{"path":"/docs/options/referenceValue","title":"referenceValue","description":"80/20 reference percentage on the cumulative axis (pareto only)."},{"path":"/docs/options/showReference","title":"showReference","description":"Show the pareto reference line."},{"path":"/docs/options/referenceColor","title":"referenceColor","description":"Pareto reference-line colour."},{"path":"/docs/options/sortDescending","title":"sortDescending","description":"Sort pareto categories by value, largest first. Default true."},{"path":"/docs/options/valueAxisLabel","title":"valueAxisLabel","description":"Left value-axis label (pareto)."},{"path":"/docs/options/cumulativeAxisLabel","title":"cumulativeAxisLabel","description":"Right cumulative-axis label (pareto)."},{"path":"/docs/options/orientation","title":"orientation","description":"Lollipop layout direction: `horizontal` (Cleveland, default) or `vertical`."},{"path":"/docs/options/lowName","title":"lowName","description":"Dumbbell legend label for the low-end markers."},{"path":"/docs/options/highName","title":"highName","description":"Dumbbell legend label for the high-end markers."},{"path":"/docs/options/lowColor","title":"lowColor","description":"Dumbbell low-end marker colour."},{"path":"/docs/options/highColor","title":"highColor","description":"Dumbbell high-end marker colour."},{"path":"/docs/options/weights","title":"weights","description":"Variwide column width metric (the 2nd dimension), one per category."},{"path":"/docs/options/columnGap","title":"columnGap","description":"Variwide gap between columns as a fraction of each slot (0..0.45)."},{"path":"/docs/options/leftValues","title":"leftValues","description":"Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`."},{"path":"/docs/options/rightValues","title":"rightValues","description":"Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`."},{"path":"/docs/options/leftColor","title":"leftColor","description":"Tornado left-series bar colour."},{"path":"/docs/options/rightColor","title":"rightColor","description":"Tornado right-series bar colour."},{"path":"/docs/options/leftLabel","title":"leftLabel","description":"Tornado left-series label."},{"path":"/docs/options/rightLabel","title":"rightLabel","description":"Tornado right-series label."},{"path":"/docs/options/showColumnShare","title":"showColumnShare","description":"Marimekko: show the per-column total percentage under each column."},{"path":"/docs/options/groups","title":"groups","description":"Comparison series = legend labels + colour order (one per value index)."},{"path":"/docs/options/showRowLines","title":"showRowLines","description":"Dot-plot: draw a faint guide line across each row between its min and max dot."},{"path":"/docs/options/value","title":"value","description":"Gauge primary scalar value."},{"path":"/docs/options/min","title":"min","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/max","title":"max","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/needles","title":"needles","description":"Multi-needle override (dial variant). Property-only."},{"path":"/docs/options/rings","title":"rings","description":"Gauge activity-variant rings — each with its own value/max (property-only)."},{"path":"/docs/options/time","title":"time","description":"Gauge clock-variant time — 'now' (live) or 'HH:MM(:SS)'."},{"path":"/docs/options/showSeconds","title":"showSeconds","description":"Gauge clock-variant second hand."},{"path":"/docs/options/variant","title":"variant","description":"Allowed values: solid, dial, activity, vuMeter, speedometer, clock. Default: undefined."},{"path":"/docs/options/innerRadius","title":"innerRadius","description":"Solid-variant inner radius. Number = px; `'%'` = fraction of outerRadius."},{"path":"/docs/options/stops","title":"stops","description":"Solid-variant colour stops. Property-only."},{"path":"/docs/options/needleShape","title":"needleShape","description":"Allowed values: needle, arrow, line, wedge. Default: undefined."},{"path":"/docs/options/needleLength","title":"needleLength","description":"Pass as a JavaScript property. type: number | string."},{"path":"/docs/options/needleRearLength","title":"needleRearLength","description":"Pass as a JavaScript property. type: number | string."},{"path":"/docs/options/needleWidth","title":"needleWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/pivotRadius","title":"pivotRadius","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/pivotColor","title":"pivotColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/plotBands","title":"plotBands","description":"Gauge plot bands — an array (property), or `'auto'` for %-of-max zones."},{"path":"/docs/options/bandThickness","title":"bandThickness","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/bandTrackColor","title":"bandTrackColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/valueDisplay","title":"valueDisplay","description":"Allowed values: percent, value. Default: undefined."},{"path":"/docs/options/rounded","title":"rounded","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/trackColor","title":"trackColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/showTicks","title":"showTicks","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/tickInterval","title":"tickInterval","description":"Allowed values: auto. Default: undefined."},{"path":"/docs/options/minorTicks","title":"minorTicks","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/tickLength","title":"tickLength","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/minorTickLength","title":"minorTickLength","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/tickWidth","title":"tickWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/minorTickWidth","title":"minorTickWidth","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/tickColor","title":"tickColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/showTickLabels","title":"showTickLabels","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/tickLabelDistance","title":"tickLabelDistance","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/tickLabelColor","title":"tickLabelColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/tickLabelFontSize","title":"tickLabelFontSize","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/tickLabelFormat","title":"tickLabelFormat","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/showValue","title":"showValue","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"path":"/docs/options/valueFormat","title":"valueFormat","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/valueColor","title":"valueColor","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/valueFontSize","title":"valueFontSize","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/unit","title":"unit","description":"Set as an HTML attribute or JavaScript property. type: string."},{"path":"/docs/options/analogDamping","title":"analogDamping","description":"Gauge `analog` needle settle shaping (forwarded to <sy-gauge-chart>)."},{"path":"/docs/options/analogFrequency","title":"analogFrequency","description":"Set as an HTML attribute or JavaScript property. type: number."},{"path":"/docs/options/analogOvershootAngle","title":"analogOvershootAngle","description":"Set as an HTML attribute or JavaScript property. type: number."}]}]}]},{"path":"/docs/options/type","title":"type","summary":"The chart type rendered by the shared sy-chart component. Data structures and supported options vary by type. Check the specific chart's contract first.","kind":"option","group":"data","member":{"name":"type","attribute":"type","type":"ChartType","kind":"property","values":["area","ohlc","line","bar","candlestick","flow-lines","theme-river","bar-3d","scatter-3d","surface-3d","column","scatter","pie","item","polar","gauge","radar","funnel","pyramid","pareto","lollipop","dumbbell","variwide","tornado","marimekko","dot-plot","word-cloud","pictorial","tilemap","stem-leaf","histogram","wafer-map","heatmap","density-map","spectrogram","calendar-heatmap","box-plot","bubble","waterfall","error-bar","sankey","chord","network-graph","treemap","sunburst","icicle","gantt","parallel-coordinates","dendrogram","geo-map"],"default":"'line'","description":"The chart type rendered by the shared sy-chart component. Data structures and supported options vary by type. Check the specific chart's contract first."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`type`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartType`"],["Default","`'line'`"],["Literals in the type","`area`, `ohlc`, `line`, `bar`, `candlestick`, `flow-lines`, `theme-river`, `bar-3d`, `scatter-3d`, `surface-3d`, `column`, `scatter`, `pie`, `item`, `polar`, `gauge`, `radar`, `funnel`, `pyramid`, `pareto`, `lollipop`, `dumbbell`, `variwide`, `tornado`, `marimekko`, `dot-plot`, `word-cloud`, `pictorial`, `tilemap`, `stem-leaf`, `histogram`, `wafer-map`, `heatmap`, `density-map`, `spectrogram`, `calendar-heatmap`, `box-plot`, `bubble`, `waterfall`, `error-bar`, `sankey`, `chord`, `network-graph`, `treemap`, `sunburst`, `icicle`, `gantt`, `parallel-coordinates`, `dendrogram`, `geo-map`"]]},{"kind":"links","items":[{"path":"/docs/types/ChartType","title":"ChartType","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-visual-map and create the element before configuring it.\nchart.type = \"continuous\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/visual-map","title":"Visual Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/visual-map#property-type","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/typeLoadTimeout","title":"typeLoadTimeout","summary":"Budget (ms) for the chart type's element to become ready once it is rendered : a lazy chunk that never arrives turns into the load-failed notice (reason `timeout`) with a Retry control. 0 or less = no limit.","kind":"option","group":"data","member":{"name":"typeLoadTimeout","attribute":"type-load-timeout","type":"number","kind":"number","values":[],"default":"30_000","description":"Budget (ms) for the chart type's element to become ready once it is rendered : a lazy chunk that never arrives turns into the load-failed notice (reason `timeout`) with a Retry control. 0 or less = no limit."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`typeLoadTimeout`"],["HTML attribute","`type-load-timeout`"],["Type","`number`"],["Default","`30_000`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/brandLogo","title":"brandLogo","summary":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it.","kind":"option","group":"export","member":{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-brandLogo","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-brandLogo","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-brandLogo","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-brandLogo","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-brandLogo","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-brandLogo","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-brandLogo","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-brandLogo","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-brandLogo","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-brandLogo","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-brandLogo","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-brandLogo","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-brandLogo","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-brandLogo","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-brandLogo","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-brandLogo","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-brandLogo","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-brandLogo","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-brandLogo","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-brandLogo","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-brandLogo","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-brandLogo","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-brandLogo","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-brandLogo","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-brandLogo","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-brandLogo","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-brandLogo","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-brandLogo","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-brandLogo","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-brandLogo","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-brandLogo","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-brandLogo","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-brandLogo","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-brandLogo","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-brandLogo","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-brandLogo","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-brandLogo","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-brandLogo","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-brandLogo","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-brandLogo","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-brandLogo","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-brandLogo","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-brandLogo","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-brandLogo","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-brandLogo","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-brandLogo","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-brandLogo","title":"sy-stock-volume","description":""},{"path":"/docs/components/stock-flags#property-brandLogo","title":"sy-stock-flags","description":""},{"path":"/docs/components/surface-3d#property-brandLogo","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-brandLogo","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-brandLogo","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-brandLogo","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-brandLogo","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-brandLogo","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-brandLogo","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-brandLogo","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/brandPosition","title":"brandPosition","summary":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports.","kind":"option","group":"export","member":{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.brandPosition = 'bottom-right';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-brandPosition","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-brandPosition","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-brandPosition","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-brandPosition","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-brandPosition","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-brandPosition","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-brandPosition","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-brandPosition","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-brandPosition","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-brandPosition","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-brandPosition","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-brandPosition","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-brandPosition","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-brandPosition","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-brandPosition","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-brandPosition","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-brandPosition","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-brandPosition","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-brandPosition","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-brandPosition","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-brandPosition","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-brandPosition","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-brandPosition","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-brandPosition","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-brandPosition","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-brandPosition","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-brandPosition","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-brandPosition","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-brandPosition","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-brandPosition","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-brandPosition","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-brandPosition","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-brandPosition","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-brandPosition","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-brandPosition","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-brandPosition","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-brandPosition","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-brandPosition","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-brandPosition","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-brandPosition","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-brandPosition","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-brandPosition","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-brandPosition","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-brandPosition","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-brandPosition","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-brandPosition","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-brandPosition","title":"sy-stock-volume","description":""},{"path":"/docs/components/stock-flags#property-brandPosition","title":"sy-stock-flags","description":""},{"path":"/docs/components/surface-3d#property-brandPosition","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-brandPosition","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-brandPosition","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-brandPosition","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-brandPosition","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-brandPosition","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-brandPosition","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-brandPosition","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/series","title":"series","summary":"Display multiple series together. Set a name, values, color, and display options for each series. Each series follows the data type of the selected chart.","kind":"option","group":"data","member":{"name":"series","attribute":"series","type":"LineChartSeries[] | ScatterChartSeries[]","kind":"property","values":[],"default":"undefined","description":"Display multiple series together. Set a name, values, color, and display options for each series. Each series follows the data type of the selected chart."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartSeries[] | ScatterChartSeries[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","description":"Type definition"},{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.series = [\n  {\n    \"name\": \"Organic\",\n    \"color\": \"#8263d9\",\n    \"values\": [\n      24,\n      29,\n      27,\n      38,\n      43,\n      40,\n      52,\n      58,\n      53,\n      68,\n      76,\n      84\n    ]\n  },\n  {\n    \"name\": \"Direct\",\n    \"color\": \"#239c91\",\n    \"values\": [\n      15,\n      19,\n      17,\n      24,\n      22,\n      29,\n      32,\n      30,\n      39,\n      42,\n      40,\n      51\n    ]\n  },\n  {\n    \"name\": \"Referral\",\n    \"color\": \"#e99954\",\n    \"values\": [\n      8,\n      11,\n      9,\n      15,\n      13,\n      19,\n      17,\n      23,\n      22,\n      28,\n      25,\n      33\n    ]\n  }\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-series","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-series","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-series","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-series","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-series","title":"sy-scatter-chart","description":""},{"path":"/docs/components/marimekko#property-series","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/navigator#property-series","title":"sy-navigator","description":""}]}]}]},{"path":"/docs/options/activeSeriesIndex","title":"activeSeriesIndex","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"data","member":{"name":"activeSeriesIndex","attribute":"active-series-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSeriesIndex`"],["HTML attribute","`active-series-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-activeSeriesIndex","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-activeSeriesIndex","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-activeSeriesIndex","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-activeSeriesIndex","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-activeSeriesIndex","title":"sy-scatter-chart","description":""},{"path":"/docs/components/radar#property-activeSeriesIndex","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/seriesState","title":"seriesState","summary":"Pass as a JavaScript property. type: LineChartSeriesStateOptions.","kind":"option","group":"data","member":{"name":"seriesState","attribute":"series-state","type":"LineChartSeriesStateOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LineChartSeriesStateOptions."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesState`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartSeriesStateOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeriesStateOptions","title":"LineChartSeriesStateOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-seriesState","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-seriesState","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-seriesState","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-seriesState","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-seriesState","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/values","title":"values","summary":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties.","kind":"option","group":"data","member":{"name":"values","attribute":"values","type":"LineChartValues | ScatterChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartValues | ScatterChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartValues","title":"LineChartValues","description":"Type definition"},{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-pie-chart and create the element before configuring it.\nchart.values = [\n  {\n    \"name\": \"Product A\",\n    \"value\": 42,\n    \"color\": \"#8263d9\"\n  },\n  {\n    \"name\": \"Product B\",\n    \"value\": 28,\n    \"color\": \"#239c91\"\n  },\n  {\n    \"name\": \"Product C\",\n    \"value\": 18,\n    \"color\": \"#e99954\"\n  },\n  {\n    \"name\": \"Other\",\n    \"value\": 12,\n    \"color\": \"#d76c8f\"\n  }\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/pie","title":"Pie · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-values","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-values","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-values","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-values","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-values","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-values","title":"sy-scatter-chart","description":""},{"path":"/docs/components/lollipop#property-values","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/variwide#property-values","title":"sy-variwide-chart","description":""},{"path":"/docs/components/pareto#property-values","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-values","title":"sy-histogram-chart","description":""},{"path":"/docs/components/stem-leaf#property-values","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/pictorial#property-values","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-values","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-values","title":"sy-word-cloud","description":""},{"path":"/docs/components/wafer-map#property-values","title":"sy-wafer-map","description":""},{"path":"/docs/components/yield-zone-chart#property-values","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/width","title":"width","summary":"Chart width in pixels. If the container width changes, update width from a ResizeObserver.","kind":"option","group":"layout","member":{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"600","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.width = 600;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-width","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-width","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-width","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-width","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-width","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-width","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-width","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-width","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-width","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-width","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-width","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-width","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-width","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-width","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-width","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-width","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-width","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-width","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-width","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-width","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-width","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-width","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-width","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-width","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-width","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-width","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-width","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-width","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-width","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-width","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-width","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-width","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-width","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-width","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-width","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-width","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-width","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-width","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-width","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-width","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-width","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-width","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-width","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-width","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-width","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-width","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-width","title":"sy-stock-volume","description":""},{"path":"/docs/components/stock-flags#property-width","title":"sy-stock-flags","description":""},{"path":"/docs/components/surface-3d#property-width","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-width","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-width","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-width","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-width","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-width","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-width","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-width","title":"sy-yield-zone-chart","description":""},{"path":"/docs/components/data-zoom#property-width","title":"sy-data-zoom","description":""},{"path":"/docs/components/navigator#property-width","title":"sy-navigator","description":""},{"path":"/docs/components/visual-map#property-width","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/height","title":"height","summary":"Chart height in pixels. Allow space for axes, titles, and the legend.","kind":"option","group":"layout","member":{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"300","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.height = 300;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-height","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-height","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-height","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-height","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-height","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-height","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-height","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-height","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-height","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-height","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-height","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-height","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-height","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-height","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-height","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-height","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-height","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-height","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-height","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-height","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-height","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-height","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-height","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-height","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-height","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-height","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-height","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-height","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-height","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-height","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-height","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-height","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-height","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-height","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-height","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-height","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-height","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-height","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-height","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-height","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-height","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-height","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-height","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-height","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-height","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-height","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-height","title":"sy-stock-volume","description":""},{"path":"/docs/components/stock-flags#property-height","title":"sy-stock-flags","description":""},{"path":"/docs/components/surface-3d#property-height","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-height","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-height","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-height","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-height","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-height","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-height","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-height","title":"sy-yield-zone-chart","description":""},{"path":"/docs/components/data-zoom#property-height","title":"sy-data-zoom","description":""},{"path":"/docs/components/navigator#property-height","title":"sy-navigator","description":""},{"path":"/docs/components/visual-map#property-height","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/color","title":"color","summary":"Pass as a JavaScript property. type: string | ReadonlyArray<string>.","kind":"option","group":"appearance","member":{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"Pass as a JavaScript property. type: string | ReadonlyArray<string>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-visual-map and create the element before configuring it.\nchart.color = [\n  \"#eee6ff\",\n  \"#8263d9\",\n  \"#34265d\"\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/visual-map","title":"Visual Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-color","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-color","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-color","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-color","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-color","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-color","title":"sy-bubble-chart","description":""},{"path":"/docs/components/radar#property-color","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-color","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-color","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-color","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-color","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-color","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-color","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-color","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-color","title":"sy-histogram-chart","description":""},{"path":"/docs/components/error-bar#property-color","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-color","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/gauge#property-color","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-color","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-color","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-color","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/treemap#property-color","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-color","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-color","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-color","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-color","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-color","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-color","title":"sy-network-graph","description":""},{"path":"/docs/components/parallel-coordinates#property-color","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-color","title":"sy-geo-map","description":""},{"path":"/docs/components/gantt#property-color","title":"sy-gantt-chart","description":""},{"path":"/docs/components/visual-map#property-color","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/thickness","title":"thickness","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"thickness","attribute":"thickness","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`thickness`"],["HTML attribute","`thickness`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.thickness = 2.5;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-thickness","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-thickness","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-thickness","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-thickness","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-thickness","title":"sy-pie-chart","description":""},{"path":"/docs/components/gauge#property-thickness","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/marker","title":"marker","summary":"Pass as a JavaScript property. type: LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>.","kind":"option","group":"appearance","member":{"name":"marker","attribute":"marker","type":"LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>","kind":"property","values":[],"default":"'none'","description":"Pass as a JavaScript property. type: LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartMarker | ScatterChartMarkerSymbol | string | ReadonlyArray<string>`"],["Default","`'none'`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartMarker","title":"LineChartMarker","description":"Type definition"},{"path":"/docs/types/ScatterChartMarkerSymbol","title":"ScatterChartMarkerSymbol","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.marker = \"circle\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-marker","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-marker","title":"sy-area-chart","description":""},{"path":"/docs/components/scatter#property-marker","title":"sy-scatter-chart","description":""},{"path":"/docs/components/lollipop#property-marker","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-marker","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#property-marker","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/pareto#property-marker","title":"sy-pareto-chart","description":""},{"path":"/docs/components/scatter-3d#property-marker","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/options/markerSize","title":"markerSize","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"4","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.markerSize = 4;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-markerSize","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-markerSize","title":"sy-area-chart","description":""},{"path":"/docs/components/scatter#property-markerSize","title":"sy-scatter-chart","description":""},{"path":"/docs/components/polar#property-markerSize","title":"sy-polar-chart","description":""},{"path":"/docs/components/lollipop#property-markerSize","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-markerSize","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#property-markerSize","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/pareto#property-markerSize","title":"sy-pareto-chart","description":""},{"path":"/docs/components/error-bar#property-markerSize","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/markerLineWidth","title":"markerLineWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"markerLineWidth","attribute":"marker-line-width","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerLineWidth`"],["HTML attribute","`marker-line-width`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.markerLineWidth = 0;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/scatter#property-markerLineWidth","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/hitTolerance","title":"hitTolerance","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"tooltip","member":{"name":"hitTolerance","attribute":"hit-tolerance","type":"number","kind":"number","values":[],"default":"8","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`hitTolerance`"],["HTML attribute","`hit-tolerance`"],["Type","`number`"],["Default","`8`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.hitTolerance = 8;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/scatter#property-hitTolerance","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/markerFilter","title":"markerFilter","summary":"Pass as a JavaScript property. type: LineChartMarkerFilter.","kind":"option","group":"appearance","member":{"name":"markerFilter","attribute":"marker-filter","type":"LineChartMarkerFilter","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LineChartMarkerFilter."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerFilter`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartMarkerFilter`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartMarkerFilter","title":"LineChartMarkerFilter","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-markerFilter","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-markerFilter","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/markerClickable","title":"markerClickable","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"tooltip","member":{"name":"markerClickable","attribute":"marker-clickable","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerClickable`"],["HTML attribute","`marker-clickable`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.markerClickable = true;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-markerClickable","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/markerActiveTrigger","title":"markerActiveTrigger","summary":"Allowed values: hover, click, custom. Default: 'hover'.","kind":"option","group":"tooltip","member":{"name":"markerActiveTrigger","attribute":"marker-active-trigger","type":"LineChartMarkerActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"'hover'","description":"Allowed values: hover, click, custom. Default: 'hover'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerActiveTrigger`"],["HTML attribute","`marker-active-trigger`"],["Type","`LineChartMarkerActiveTrigger`"],["Default","`'hover'`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartMarkerActiveTrigger","title":"LineChartMarkerActiveTrigger","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.markerActiveTrigger = 'hover';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-markerActiveTrigger","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/seriesActiveTrigger","title":"seriesActiveTrigger","summary":"Allowed values: hover, click, custom. Default: undefined.","kind":"option","group":"data","member":{"name":"seriesActiveTrigger","attribute":"series-active-trigger","type":"LineChartMarkerActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"undefined","description":"Allowed values: hover, click, custom. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesActiveTrigger`"],["HTML attribute","`series-active-trigger`"],["Type","`LineChartMarkerActiveTrigger`"],["Default","`undefined`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartMarkerActiveTrigger","title":"LineChartMarkerActiveTrigger","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-seriesActiveTrigger","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-seriesActiveTrigger","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-seriesActiveTrigger","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-seriesActiveTrigger","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-seriesActiveTrigger","title":"sy-scatter-chart","description":""},{"path":"/docs/components/radar#property-seriesActiveTrigger","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/lineDash","title":"lineDash","summary":"Pass as a JavaScript property. type: number[].","kind":"option","group":"appearance","member":{"name":"lineDash","attribute":"line-dash","type":"number[]","kind":"property","values":[],"default":"[]","description":"Pass as a JavaScript property. type: number[]."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineDash`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number[]`"],["Default","`[]`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-lineDash","title":"sy-line-chart","description":""},{"path":"/docs/components/parallel-coordinates#property-lineDash","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/options/connectNulls","title":"connectNulls","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"appearance","member":{"name":"connectNulls","attribute":"connect-nulls","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectNulls`"],["HTML attribute","`connect-nulls`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.connectNulls = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-connectNulls","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-connectNulls","title":"sy-area-chart","description":""},{"path":"/docs/components/parallel-coordinates#property-connectNulls","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/options/smooth","title":"smooth","summary":"Allowed values: none, monotone, cardinal. Default: 'none'.","kind":"option","group":"appearance","member":{"name":"smooth","attribute":"smooth","type":"LineChartSmooth","kind":"string","values":["none","monotone","cardinal"],"default":"'none'","description":"Allowed values: none, monotone, cardinal. Default: 'none'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`smooth`"],["HTML attribute","`smooth`"],["Type","`LineChartSmooth`"],["Default","`'none'`"],["Allowed values","`none`, `monotone`, `cardinal`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartSmooth","title":"LineChartSmooth","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.smooth = \"none\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-smooth","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/smoothTension","title":"smoothTension","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"smoothTension","attribute":"smooth-tension","type":"number","kind":"number","values":[],"default":"0.5","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`smoothTension`"],["HTML attribute","`smooth-tension`"],["Type","`number`"],["Default","`0.5`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.smoothTension = 0.5;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-smoothTension","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/step","title":"step","summary":"Allowed values: none, left, right, center. Default: 'none'.","kind":"option","group":"appearance","member":{"name":"step","attribute":"step","type":"LineChartStep","kind":"string","values":["none","left","right","center"],"default":"'none'","description":"Allowed values: none, left, right, center. Default: 'none'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`step`"],["HTML attribute","`step`"],["Type","`LineChartStep`"],["Default","`'none'`"],["Allowed values","`none`, `left`, `right`, `center`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartStep","title":"LineChartStep","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.step = 'none';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-step","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/engine","title":"engine","summary":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type.","kind":"option","group":"animation","member":{"name":"engine","attribute":"engine","type":"LineChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`LineChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartEngineMode","title":"LineChartEngineMode","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.engine = \"standard\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-engine","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-engine","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-engine","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-engine","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-engine","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-engine","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-engine","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-engine","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-engine","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-engine","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-engine","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-engine","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-engine","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-engine","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-engine","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-engine","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-engine","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-engine","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-engine","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-engine","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-engine","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-engine","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-engine","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-engine","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-engine","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-engine","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-engine","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-engine","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-engine","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-engine","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-engine","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-engine","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-engine","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-engine","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-engine","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-engine","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-engine","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-engine","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-engine","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-engine","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-engine","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-engine","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-engine","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-engine","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-engine","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-engine","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-engine","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-engine","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-engine","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-engine","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/proThreshold","title":"proThreshold","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"animation","member":{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"100_000","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`100_000`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-proThreshold","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-proThreshold","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-proThreshold","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-proThreshold","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-proThreshold","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-proThreshold","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-proThreshold","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-proThreshold","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-proThreshold","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-proThreshold","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-proThreshold","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-proThreshold","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-proThreshold","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-proThreshold","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-proThreshold","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-proThreshold","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-proThreshold","title":"sy-histogram-chart","description":""},{"path":"/docs/components/gauge#property-proThreshold","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-proThreshold","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-proThreshold","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-proThreshold","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/unavailable","title":"unavailable","summary":"Allowed values: fallback, error. Default: 'fallback'.","kind":"option","group":"animation","member":{"name":"unavailable","attribute":"unavailable","type":"LineChartUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`LineChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartUnavailableBehaviour","title":"LineChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.unavailable = 'fallback';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-unavailable","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-unavailable","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-unavailable","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-unavailable","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-unavailable","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-unavailable","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-unavailable","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-unavailable","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-unavailable","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-unavailable","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-unavailable","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-unavailable","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-unavailable","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-unavailable","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-unavailable","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-unavailable","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-unavailable","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-unavailable","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-unavailable","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-unavailable","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-unavailable","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-unavailable","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-unavailable","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-unavailable","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-unavailable","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-unavailable","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-unavailable","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-unavailable","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-unavailable","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-unavailable","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-unavailable","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-unavailable","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-unavailable","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-unavailable","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-unavailable","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-unavailable","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-unavailable","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-unavailable","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-unavailable","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-unavailable","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-unavailable","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-unavailable","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-unavailable","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-unavailable","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-unavailable","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-unavailable","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-unavailable","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-unavailable","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-unavailable","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-unavailable","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/streamSource","title":"streamSource","summary":"A stream source for live data. Check the contract for the specific type.","kind":"option","group":"animation","member":{"name":"streamSource","attribute":"stream-source","type":"ChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartStreamSource","title":"ChartStreamSource","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-streamSource","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-streamSource","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-streamSource","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-streamSource","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-streamSource","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-streamSource","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-streamSource","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-streamSource","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-streamSource","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-streamSource","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-streamSource","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-streamSource","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-streamSource","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-streamSource","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-streamSource","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-streamSource","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-streamSource","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-streamSource","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-streamSource","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-streamSource","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-streamSource","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-streamSource","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-streamSource","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-streamSource","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-streamSource","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-streamSource","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-streamSource","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-streamSource","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-streamSource","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-streamSource","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-streamSource","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-streamSource","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-streamSource","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-streamSource","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-streamSource","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-streamSource","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-streamSource","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-streamSource","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-streamSource","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-streamSource","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-streamSource","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-streamSource","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-streamSource","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-streamSource","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-streamSource","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-streamSource","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-streamSource","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-streamSource","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-streamSource","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-streamSource","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/streamWindow","title":"streamWindow","summary":"The streaming data range to keep visible.","kind":"option","group":"animation","member":{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-streamWindow","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-streamWindow","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-streamWindow","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-streamWindow","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-streamWindow","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-streamWindow","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-streamWindow","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-streamWindow","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-streamWindow","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-streamWindow","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-streamWindow","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-streamWindow","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-streamWindow","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-streamWindow","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-streamWindow","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-streamWindow","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-streamWindow","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-streamWindow","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-streamWindow","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-streamWindow","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-streamWindow","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-streamWindow","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-streamWindow","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-streamWindow","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-streamWindow","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-streamWindow","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-streamWindow","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-streamWindow","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-streamWindow","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-streamWindow","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-streamWindow","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-streamWindow","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-streamWindow","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-streamWindow","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-streamWindow","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-streamWindow","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-streamWindow","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-streamWindow","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-streamWindow","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-streamWindow","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-streamWindow","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-streamWindow","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-streamWindow","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-streamWindow","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-streamWindow","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/gantt#property-streamWindow","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-streamWindow","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/streamMax","title":"streamMax","summary":"The maximum number of streaming data points to retain.","kind":"option","group":"animation","member":{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-streamMax","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-streamMax","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-streamMax","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-streamMax","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-streamMax","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-streamMax","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-streamMax","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-streamMax","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-streamMax","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-streamMax","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-streamMax","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-streamMax","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-streamMax","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-streamMax","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-streamMax","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-streamMax","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-streamMax","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-streamMax","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-streamMax","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-streamMax","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-streamMax","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-streamMax","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-streamMax","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-streamMax","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-streamMax","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-streamMax","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-streamMax","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-streamMax","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-streamMax","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-streamMax","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-streamMax","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-streamMax","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-streamMax","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-streamMax","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-streamMax","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-streamMax","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-streamMax","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-streamMax","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-streamMax","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-streamMax","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-streamMax","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-streamMax","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-streamMax","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-streamMax","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-streamMax","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-streamMax","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-streamMax","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-streamMax","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-streamMax","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-streamMax","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/frameBudget","title":"frameBudget","summary":"milliseconds a drawn frame may take before the next scheduled frame is skipped (line family; 0 disables skipping).","kind":"option","group":"animation","member":{"name":"frameBudget","attribute":"frame-budget","type":"number","kind":"number","values":[],"default":"undefined","description":"milliseconds a drawn frame may take before the next scheduled frame is skipped (line family; 0 disables skipping)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`frameBudget`"],["HTML attribute","`frame-budget`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-frameBudget","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/streamWindowMs","title":"streamWindowMs","summary":"an absolute stream window: only points appended within the last N ms are visible, sliding every frame (line family; overrides `stream-window`).","kind":"option","group":"animation","member":{"name":"streamWindowMs","attribute":"stream-window-ms","type":"number","kind":"number","values":[],"default":"undefined","description":"an absolute stream window: only points appended within the last N ms are visible, sliding every frame (line family; overrides `stream-window`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindowMs`"],["HTML attribute","`stream-window-ms`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-streamWindowMs","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/streamTimestamps","title":"streamTimestamps","summary":"the line family's ring stamps its points (`on`, the default — an absolute `stream-window-ms` needs them) unless `off` opts out (8 MB less at a 1M capacity for charts that only use a count window).","kind":"option","group":"animation","member":{"name":"streamTimestamps","attribute":"stream-timestamps","type":"'on' | 'off'","kind":"string","values":["off","on"],"default":"undefined","description":"the line family's ring stamps its points (`on`, the default — an absolute `stream-window-ms` needs them) unless `off` opts out (8 MB less at a 1M capacity for charts that only use a count window)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamTimestamps`"],["HTML attribute","`stream-timestamps`"],["Type","`'on' | 'off'`"],["Default","`undefined`"],["Allowed values","`off`, `on`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-streamTimestamps","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/options/animated","title":"animated","summary":"Whether to animate initial display and data changes.","kind":"option","group":"animation","member":{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.animated = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-animated","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-animated","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-animated","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-animated","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-animated","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-animated","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-animated","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-animated","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-animated","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-animated","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-animated","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-animated","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-animated","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-animated","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-animated","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-animated","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-animated","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-animated","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-animated","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-animated","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-animated","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-animated","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-animated","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-animated","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-animated","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-animated","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-animated","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-animated","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-animated","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-animated","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-animated","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-animated","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-animated","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-animated","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-animated","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-animated","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-animated","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-animated","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-animated","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-animated","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-animated","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-animated","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-animated","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-animated","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-animated","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-animated","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-animated","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-animated","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-animated","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-animated","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/animationDuration","title":"animationDuration","summary":"Animation duration in milliseconds.","kind":"option","group":"animation","member":{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"200","description":"Animation duration in milliseconds."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`200`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.animationDuration = 200;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-animationDuration","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-animationDuration","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-animationDuration","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-animationDuration","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-animationDuration","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-animationDuration","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-animationDuration","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-animationDuration","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-animationDuration","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-animationDuration","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-animationDuration","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-animationDuration","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-animationDuration","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-animationDuration","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-animationDuration","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-animationDuration","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-animationDuration","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-animationDuration","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-animationDuration","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-animationDuration","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-animationDuration","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-animationDuration","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-animationDuration","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-animationDuration","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-animationDuration","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-animationDuration","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-animationDuration","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-animationDuration","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-animationDuration","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-animationDuration","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-animationDuration","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-animationDuration","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-animationDuration","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-animationDuration","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-animationDuration","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-animationDuration","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-animationDuration","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-animationDuration","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-animationDuration","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-animationDuration","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-animationDuration","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-animationDuration","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-animationDuration","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-animationDuration","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-animationDuration","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-animationDuration","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-animationDuration","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-animationDuration","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-animationDuration","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-animationDuration","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/animationEasing","title":"animationEasing","summary":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'.","kind":"option","group":"animation","member":{"name":"animationEasing","attribute":"animation-easing","type":"LineChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`LineChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartEasing","title":"LineChartEasing","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.animationEasing = 'ease-out';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-animationEasing","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-animationEasing","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-animationEasing","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-animationEasing","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-animationEasing","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-animationEasing","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-animationEasing","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-animationEasing","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-animationEasing","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-animationEasing","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-animationEasing","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-animationEasing","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-animationEasing","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-animationEasing","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-animationEasing","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-animationEasing","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-animationEasing","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-animationEasing","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-animationEasing","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-animationEasing","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-animationEasing","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-animationEasing","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-animationEasing","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-animationEasing","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-animationEasing","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-animationEasing","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-animationEasing","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-animationEasing","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-animationEasing","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-animationEasing","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-animationEasing","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-animationEasing","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-animationEasing","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-animationEasing","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-animationEasing","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-animationEasing","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-animationEasing","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-animationEasing","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-animationEasing","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-animationEasing","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-animationEasing","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-animationEasing","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-animationEasing","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-animationEasing","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-animationEasing","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-animationEasing","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-animationEasing","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-animationEasing","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-animationEasing","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-animationEasing","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/animationType","title":"animationType","summary":"Allowed values: initial, update. Default: undefined.","kind":"option","group":"animation","member":{"name":"animationType","attribute":"animation-type","type":"ChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartAnimationType","title":"ChartAnimationType","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-animationType","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-animationType","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-animationType","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-animationType","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-animationType","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-animationType","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-animationType","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-animationType","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-animationType","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-animationType","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-animationType","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-animationType","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-animationType","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-animationType","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-animationType","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-animationType","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-animationType","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-animationType","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-animationType","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-animationType","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-animationType","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-animationType","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-animationType","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-animationType","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-animationType","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-animationType","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-animationType","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-animationType","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-animationType","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-animationType","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-animationType","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-animationType","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-animationType","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-animationType","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-animationType","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-animationType","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-animationType","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-animationType","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-animationType","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-animationType","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-animationType","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-animationType","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-animationType","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-animationType","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-animationType","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-animationType","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-animationType","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-animationType","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-animationType","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-animationType","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/legend","title":"legend","summary":"Show the legend. Undefined lets each chart use its own default (marimekko/dot-plot default on; the cartesian charts default off).","kind":"option","group":"legend","member":{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Show the legend. Undefined lets each chart use its own default (marimekko/dot-plot default on; the cartesian charts default off)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.legend = true;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-legend","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-legend","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-legend","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-legend","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-legend","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-legend","title":"sy-scatter-chart","description":""},{"path":"/docs/components/polar#property-legend","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-legend","title":"sy-radar-chart","description":""},{"path":"/docs/components/dumbbell#property-legend","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#property-legend","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/marimekko#property-legend","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-legend","title":"sy-pareto-chart","description":""},{"path":"/docs/components/gauge#property-legend","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-legend","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-legend","title":"sy-funnel-chart","description":""},{"path":"/docs/components/item#property-legend","title":"sy-item-chart","description":""},{"path":"/docs/components/theme-river#property-legend","title":"sy-theme-river","description":""},{"path":"/docs/components/flow-lines#property-legend","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#property-legend","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-legend","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-legend","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/options/legendPosition","title":"legendPosition","summary":"Where the legend is positioned.","kind":"option","group":"legend","member":{"name":"legendPosition","attribute":"legend-position","type":"LineChartLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Where the legend is positioned."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`LineChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartLegendPosition","title":"LineChartLegendPosition","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.legendPosition = 'bottom';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-legendPosition","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-legendPosition","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-legendPosition","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-legendPosition","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-legendPosition","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-legendPosition","title":"sy-scatter-chart","description":""},{"path":"/docs/components/polar#property-legendPosition","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-legendPosition","title":"sy-radar-chart","description":""},{"path":"/docs/components/dumbbell#property-legendPosition","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#property-legendPosition","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/marimekko#property-legendPosition","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-legendPosition","title":"sy-pareto-chart","description":""},{"path":"/docs/components/gauge#property-legendPosition","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-legendPosition","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-legendPosition","title":"sy-funnel-chart","description":""},{"path":"/docs/components/item#property-legendPosition","title":"sy-item-chart","description":""},{"path":"/docs/components/tilemap#property-legendPosition","title":"sy-tilemap","description":""},{"path":"/docs/components/wafer-map#property-legendPosition","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/legendItems","title":"legendItems","summary":"Pass as a JavaScript property. type: LegendItem[].","kind":"option","group":"legend","member":{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-legendItems","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-legendItems","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-legendItems","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-legendItems","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-legendItems","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-legendItems","title":"sy-scatter-chart","description":""},{"path":"/docs/components/polar#property-legendItems","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-legendItems","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-legendItems","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-legendItems","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-legendItems","title":"sy-funnel-chart","description":""},{"path":"/docs/components/item#property-legendItems","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/seriesName","title":"seriesName","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"data","member":{"name":"seriesName","attribute":"series-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesName`"],["HTML attribute","`series-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-seriesName","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-seriesName","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-seriesName","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-seriesName","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-seriesName","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/legendFloatAlign","title":"legendFloatAlign","summary":"Allowed values: start, center, end. Default: 'end'.","kind":"option","group":"legend","member":{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"Allowed values: start, center, end. Default: 'end'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.legendFloatAlign = 'end';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-legendFloatAlign","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-legendFloatAlign","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-legendFloatAlign","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-legendFloatAlign","title":"sy-bar-chart","description":""},{"path":"/docs/components/polar#property-legendFloatAlign","title":"sy-polar-chart","description":""},{"path":"/docs/components/item#property-legendFloatAlign","title":"sy-item-chart","description":""},{"path":"/docs/components/tilemap#property-legendFloatAlign","title":"sy-tilemap","description":""},{"path":"/docs/components/wafer-map#property-legendFloatAlign","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/legendFloatVerticalAlign","title":"legendFloatVerticalAlign","summary":"Allowed values: top, bottom, middle. Default: 'top'.","kind":"option","group":"legend","member":{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"Allowed values: top, bottom, middle. Default: 'top'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.legendFloatVerticalAlign = 'top';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-legendFloatVerticalAlign","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-legendFloatVerticalAlign","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-legendFloatVerticalAlign","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-legendFloatVerticalAlign","title":"sy-bar-chart","description":""},{"path":"/docs/components/polar#property-legendFloatVerticalAlign","title":"sy-polar-chart","description":""},{"path":"/docs/components/item#property-legendFloatVerticalAlign","title":"sy-item-chart","description":""},{"path":"/docs/components/tilemap#property-legendFloatVerticalAlign","title":"sy-tilemap","description":""},{"path":"/docs/components/wafer-map#property-legendFloatVerticalAlign","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/legendDraggable","title":"legendDraggable","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"legend","member":{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.legendDraggable = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-legendDraggable","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-legendDraggable","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-legendDraggable","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-legendDraggable","title":"sy-bar-chart","description":""},{"path":"/docs/components/polar#property-legendDraggable","title":"sy-polar-chart","description":""},{"path":"/docs/components/item#property-legendDraggable","title":"sy-item-chart","description":""},{"path":"/docs/components/tilemap#property-legendDraggable","title":"sy-tilemap","description":""},{"path":"/docs/components/wafer-map#property-legendDraggable","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/fillColor","title":"fillColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"appearance","member":{"name":"fillColor","attribute":"fill-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillColor`"],["HTML attribute","`fill-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-fillColor","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/fillOpacity","title":"fillOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"fillOpacity","attribute":"fill-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillOpacity`"],["HTML attribute","`fill-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-fillOpacity","title":"sy-area-chart","description":""},{"path":"/docs/components/polar#property-fillOpacity","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-fillOpacity","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/fillGradient","title":"fillGradient","summary":"Pass as a JavaScript property. type: unknown.","kind":"option","group":"appearance","member":{"name":"fillGradient","attribute":"fill-gradient","type":"unknown","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: unknown."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillGradient`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`unknown`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-fillGradient","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/fillPattern","title":"fillPattern","summary":"Pass as a JavaScript property. type: unknown.","kind":"option","group":"appearance","member":{"name":"fillPattern","attribute":"fill-pattern","type":"unknown","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: unknown."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillPattern`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`unknown`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-fillPattern","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/patternKind","title":"patternKind","summary":"Allowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined.","kind":"option","group":"appearance","member":{"name":"patternKind","attribute":"pattern-kind","type":"AreaChartPatternKind","kind":"string","values":["dots","diagonal","cross-hatch","diagonal-forward","diagonal-backward","fill"],"default":"undefined","description":"Allowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternKind`"],["HTML attribute","`pattern-kind`"],["Type","`AreaChartPatternKind`"],["Default","`undefined`"],["Allowed values","`dots`, `diagonal`, `cross-hatch`, `diagonal-forward`, `diagonal-backward`, `fill`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartPatternKind","title":"AreaChartPatternKind","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-patternKind","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/patternColor","title":"patternColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"appearance","member":{"name":"patternColor","attribute":"pattern-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternColor`"],["HTML attribute","`pattern-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-patternColor","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/patternBackground","title":"patternBackground","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"appearance","member":{"name":"patternBackground","attribute":"pattern-background","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternBackground`"],["HTML attribute","`pattern-background`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-patternBackground","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/patternSize","title":"patternSize","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"patternSize","attribute":"pattern-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternSize`"],["HTML attribute","`pattern-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-patternSize","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/patternThickness","title":"patternThickness","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"patternThickness","attribute":"pattern-thickness","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternThickness`"],["HTML attribute","`pattern-thickness`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/area#property-patternThickness","title":"sy-area-chart","description":""}]}]}]},{"path":"/docs/options/barPadding","title":"barPadding","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"barPadding","attribute":"bar-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barPadding`"],["HTML attribute","`bar-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.barPadding = 0.1;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-barPadding","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-barPadding","title":"sy-bar-chart","description":""},{"path":"/docs/components/polar#property-barPadding","title":"sy-polar-chart","description":""},{"path":"/docs/components/tornado#property-barPadding","title":"sy-tornado-chart","description":""},{"path":"/docs/components/pareto#property-barPadding","title":"sy-pareto-chart","description":""}]}]}]},{"path":"/docs/options/seriesPadding","title":"seriesPadding","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"data","member":{"name":"seriesPadding","attribute":"series-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesPadding`"],["HTML attribute","`series-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.seriesPadding = 0.1;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-seriesPadding","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-seriesPadding","title":"sy-bar-chart","description":""}]}]}]},{"path":"/docs/options/baseline","title":"baseline","summary":"Reference value for cartesian charts. Column / bar / area use it as the visual anchor; line uses it as a value-axis reference marker. Always explicit (default `0`) so the baseline stays visible regardless of `type`.","kind":"option","group":"specific","member":{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Reference value for cartesian charts. Column / bar / area use it as the visual anchor; line uses it as a value-axis reference marker. Always explicit (default `0`) so the baseline stays visible regardless of `type`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.baseline = 0;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-baseline","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-baseline","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-baseline","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-baseline","title":"sy-bar-chart","description":""},{"path":"/docs/components/lollipop#property-baseline","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/variwide#property-baseline","title":"sy-variwide-chart","description":""},{"path":"/docs/components/pareto#property-baseline","title":"sy-pareto-chart","description":""},{"path":"/docs/components/gantt#property-baseline","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/stacking","title":"stacking","summary":"Allowed values: normal, percent. Default: undefined.","kind":"option","group":"specific","member":{"name":"stacking","attribute":"stacking","type":"CartesianSeriesStackingMode","kind":"string","values":["normal","percent"],"default":"undefined","description":"Allowed values: normal, percent. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stacking`"],["HTML attribute","`stacking`"],["Type","`CartesianSeriesStackingMode`"],["Default","`undefined`"],["Allowed values","`normal`, `percent`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesStackingMode","title":"CartesianSeriesStackingMode","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-stacking","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-stacking","title":"sy-bar-chart","description":""},{"path":"/docs/components/polar#property-stacking","title":"sy-polar-chart","description":""}]}]}]},{"path":"/docs/options/borderRadius","title":"borderRadius","summary":"Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue.","kind":"option","group":"appearance","member":{"name":"borderRadius","attribute":"border-radius","type":"CartesianSeriesCornerRadiusValue","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderRadius`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianSeriesCornerRadiusValue`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesCornerRadiusValue","title":"CartesianSeriesCornerRadiusValue","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-borderRadius","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-borderRadius","title":"sy-bar-chart","description":""}]}]}]},{"path":"/docs/options/borderScope","title":"borderScope","summary":"Allowed values: point, stack, outline. Default: undefined.","kind":"option","group":"appearance","member":{"name":"borderScope","attribute":"border-scope","type":"'point' | 'stack' | 'outline'","kind":"string","values":["point","stack","outline"],"default":"undefined","description":"Allowed values: point, stack, outline. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderScope`"],["HTML attribute","`border-scope`"],["Type","`'point' | 'stack' | 'outline'`"],["Default","`undefined`"],["Allowed values","`point`, `stack`, `outline`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-borderScope","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-borderScope","title":"sy-bar-chart","description":""}]}]}]},{"path":"/docs/options/borderColor","title":"borderColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"appearance","member":{"name":"borderColor","attribute":"border-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderColor`"],["HTML attribute","`border-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-borderColor","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-borderColor","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-borderColor","title":"sy-pie-chart","description":""},{"path":"/docs/components/bubble#property-borderColor","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/borderWidth","title":"borderWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"borderWidth","attribute":"border-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderWidth`"],["HTML attribute","`border-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-borderWidth","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-borderWidth","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-borderWidth","title":"sy-pie-chart","description":""},{"path":"/docs/components/bubble#property-borderWidth","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/borderDashStyle","title":"borderDashStyle","summary":"Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined.","kind":"option","group":"appearance","member":{"name":"borderDashStyle","attribute":"border-dash-style","type":"CartesianSeriesBorderDashStyle","kind":"string","values":["Solid","Dash","Dot","DashDot","LongDash","LongDashDot"],"default":"undefined","description":"Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderDashStyle`"],["HTML attribute","`border-dash-style`"],["Type","`CartesianSeriesBorderDashStyle`"],["Default","`undefined`"],["Allowed values","`Solid`, `Dash`, `Dot`, `DashDot`, `LongDash`, `LongDashDot`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBorderDashStyle","title":"CartesianSeriesBorderDashStyle","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-borderDashStyle","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-borderDashStyle","title":"sy-bar-chart","description":""}]}]}]},{"path":"/docs/options/inactiveOtherPoints","title":"inactiveOtherPoints","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"appearance","member":{"name":"inactiveOtherPoints","attribute":"inactive-other-points","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherPoints`"],["HTML attribute","`inactive-other-points`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.inactiveOtherPoints = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-inactiveOtherPoints","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-inactiveOtherPoints","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-inactiveOtherPoints","title":"sy-scatter-chart","description":""},{"path":"/docs/components/geo-map#property-inactiveOtherPoints","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-inactiveOtherPoints","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/options/inactivePointOpacity","title":"inactivePointOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"inactivePointOpacity","attribute":"inactive-point-opacity","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactivePointOpacity`"],["HTML attribute","`inactive-point-opacity`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.inactivePointOpacity = 0.2;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/column#property-inactivePointOpacity","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-inactivePointOpacity","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-inactivePointOpacity","title":"sy-scatter-chart","description":""},{"path":"/docs/components/geo-map#property-inactivePointOpacity","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-inactivePointOpacity","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/options/xAxis","title":"xAxis","summary":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array.","kind":"option","group":"axes","member":{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.xAxis = {\n  \"kind\": \"category\",\n  \"categories\": [\n    \"Jan\",\n    \"Feb\",\n    \"Mar\",\n    \"Apr\",\n    \"May\",\n    \"Jun\",\n    \"Jul\",\n    \"Aug\",\n    \"Sep\",\n    \"Oct\",\n    \"Nov\",\n    \"Dec\"\n  ]\n};","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-xAxis","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-xAxis","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-xAxis","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-xAxis","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-xAxis","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-xAxis","title":"sy-bubble-chart","description":""},{"path":"/docs/components/lollipop#property-xAxis","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-xAxis","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/variwide#property-xAxis","title":"sy-variwide-chart","description":""},{"path":"/docs/components/waterfall#property-xAxis","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-xAxis","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-xAxis","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-xAxis","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-xAxis","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#property-xAxis","title":"sy-heatmap","description":""},{"path":"/docs/components/density-map#property-xAxis","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-xAxis","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#property-xAxis","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/candlestick#property-xAxis","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-xAxis","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/source","title":"source","summary":"the tabular dataset the series read through `encode` (a Dataset, a source, or rows); it wins over `values` / `series`. Named `source` because `dataset` is the element's own data-* map.","kind":"option","group":"data","member":{"name":"source","attribute":"source","type":"Dataset | DatasetSourceInput | ReadonlyArray<DatasetRow> | null","kind":"property","values":[],"default":"undefined","description":"the tabular dataset the series read through `encode` (a Dataset, a source, or rows); it wins over `values` / `series`. Named `source` because `dataset` is the element's own data-* map."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`source`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Dataset | DatasetSourceInput | ReadonlyArray<DatasetRow> | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Dataset","title":"Dataset","description":"Type definition"},{"path":"/docs/types/DatasetSourceInput","title":"DatasetSourceInput","description":"Type definition"},{"path":"/docs/types/DatasetRow","title":"DatasetRow","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/sourceTransforms","title":"sourceTransforms","summary":"transforms applied to `source` before encoding (filter / sort / regression / boxplot / sample).","kind":"option","group":"data","member":{"name":"sourceTransforms","attribute":"source-transforms","type":"ReadonlyArray<DatasetTransform>","kind":"property","values":[],"default":"undefined","description":"transforms applied to `source` before encoding (filter / sort / regression / boxplot / sample)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sourceTransforms`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<DatasetTransform>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DatasetTransform","title":"DatasetTransform","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/encode","title":"encode","summary":"which dimensions feed the series (one encode per series); an ordinal x labels the category axis.","kind":"option","group":"data","member":{"name":"encode","attribute":"encode","type":"DatasetEncode | ReadonlyArray<DatasetEncode>","kind":"property","values":[],"default":"undefined","description":"which dimensions feed the series (one encode per series); an ordinal x labels the category axis."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`encode`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DatasetEncode | ReadonlyArray<DatasetEncode>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DatasetEncode","title":"DatasetEncode","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/progressive","title":"progressive","summary":"scatter, Standard engine: paint a heavy frame in chunks (false / 0 = off, true = 5,000 per chunk, a number = points per chunk).","kind":"option","group":"animation","member":{"name":"progressive","attribute":"progressive","type":"number | boolean","kind":"property","values":[],"default":"undefined","description":"scatter, Standard engine: paint a heavy frame in chunks (false / 0 = off, true = 5,000 per chunk, a number = points per chunk)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`progressive`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/scatter#property-progressive","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/progressiveThreshold","title":"progressiveThreshold","summary":"below this many drawn points the frame paints at once (default 20,000).","kind":"option","group":"animation","member":{"name":"progressiveThreshold","attribute":"progressive-threshold","type":"number","kind":"number","values":[],"default":"20000","description":"below this many drawn points the frame paints at once (default 20,000)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`progressiveThreshold`"],["HTML attribute","`progressive-threshold`"],["Type","`number`"],["Default","`20000`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.progressiveThreshold = 20000;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/scatter#property-progressiveThreshold","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/yAxis","title":"yAxis","summary":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths.","kind":"option","group":"axes","member":{"name":"yAxis","attribute":"y-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.yAxis = {\n  \"kind\": \"linear\",\n  \"min\": 0\n};","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-yAxis","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-yAxis","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-yAxis","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-yAxis","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-yAxis","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-yAxis","title":"sy-bubble-chart","description":""},{"path":"/docs/components/lollipop#property-yAxis","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-yAxis","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/variwide#property-yAxis","title":"sy-variwide-chart","description":""},{"path":"/docs/components/waterfall#property-yAxis","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-yAxis","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-yAxis","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-yAxis","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-yAxis","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#property-yAxis","title":"sy-heatmap","description":""},{"path":"/docs/components/density-map#property-yAxis","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-yAxis","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#property-yAxis","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/candlestick#property-yAxis","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-yAxis","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/chartTitle","title":"chartTitle","summary":"The title inside the chart. Explain the data's unit and meaning alongside it.","kind":"option","group":"layout","member":{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-chartTitle","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-chartTitle","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-chartTitle","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-chartTitle","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-chartTitle","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-chartTitle","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-chartTitle","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-chartTitle","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-chartTitle","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-chartTitle","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-chartTitle","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-chartTitle","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-chartTitle","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-chartTitle","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-chartTitle","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-chartTitle","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-chartTitle","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-chartTitle","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-chartTitle","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-chartTitle","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-chartTitle","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-chartTitle","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-chartTitle","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-chartTitle","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-chartTitle","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-chartTitle","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-chartTitle","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-chartTitle","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-chartTitle","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-chartTitle","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-chartTitle","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-chartTitle","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-chartTitle","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-chartTitle","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-chartTitle","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-chartTitle","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-chartTitle","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-chartTitle","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-chartTitle","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-chartTitle","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-chartTitle","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-chartTitle","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-chartTitle","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-chartTitle","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-chartTitle","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-chartTitle","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-chartTitle","title":"sy-stock-volume","description":""},{"path":"/docs/components/stock-flags#property-chartTitle","title":"sy-stock-flags","description":""},{"path":"/docs/components/surface-3d#property-chartTitle","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-chartTitle","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-chartTitle","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-chartTitle","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-chartTitle","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-chartTitle","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-chartTitle","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-chartTitle","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/chartSubtitle","title":"chartSubtitle","summary":"The subtitle inside the chart.","kind":"option","group":"layout","member":{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-chartSubtitle","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-chartSubtitle","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-chartSubtitle","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-chartSubtitle","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-chartSubtitle","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-chartSubtitle","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-chartSubtitle","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-chartSubtitle","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-chartSubtitle","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-chartSubtitle","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-chartSubtitle","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-chartSubtitle","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-chartSubtitle","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-chartSubtitle","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-chartSubtitle","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-chartSubtitle","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-chartSubtitle","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-chartSubtitle","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-chartSubtitle","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-chartSubtitle","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-chartSubtitle","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-chartSubtitle","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-chartSubtitle","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-chartSubtitle","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-chartSubtitle","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-chartSubtitle","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-chartSubtitle","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-chartSubtitle","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-chartSubtitle","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-chartSubtitle","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-chartSubtitle","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-chartSubtitle","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-chartSubtitle","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-chartSubtitle","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-chartSubtitle","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-chartSubtitle","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-chartSubtitle","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-chartSubtitle","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-chartSubtitle","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-chartSubtitle","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-chartSubtitle","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-chartSubtitle","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-chartSubtitle","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-chartSubtitle","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-chartSubtitle","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-chartSubtitle","title":"sy-stock-chart","description":""},{"path":"/docs/components/surface-3d#property-chartSubtitle","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-chartSubtitle","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-chartSubtitle","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-chartSubtitle","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-chartSubtitle","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-chartSubtitle","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-chartSubtitle","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-chartSubtitle","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/tooltip","title":"tooltip","summary":"Tooltip settings for pointer-driven values, position, and content.","kind":"option","group":"tooltip","member":{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput | PieChartTooltipInput | GaugeChartTooltipInput | RadarChartTooltipInput | FunnelChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput | PieChartTooltipInput | GaugeChartTooltipInput | RadarChartTooltipInput | FunnelChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"},{"path":"/docs/types/PieChartTooltipInput","title":"PieChartTooltipInput","description":"Type definition"},{"path":"/docs/types/GaugeChartTooltipInput","title":"GaugeChartTooltipInput","description":"Type definition"},{"path":"/docs/types/RadarChartTooltipInput","title":"RadarChartTooltipInput","description":"Type definition"},{"path":"/docs/types/FunnelChartTooltipInput","title":"FunnelChartTooltipInput","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-line-chart and create the element before configuring it.\nchart.tooltip = {\n  \"show\": true,\n  \"mode\": \"shared\"\n};","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/line","title":"Line · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-tooltip","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-tooltip","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-tooltip","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-tooltip","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#property-tooltip","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#property-tooltip","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-tooltip","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-tooltip","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-tooltip","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-tooltip","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-tooltip","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-tooltip","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-tooltip","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-tooltip","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-tooltip","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-tooltip","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-tooltip","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-tooltip","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-tooltip","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-tooltip","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-tooltip","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-tooltip","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-tooltip","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-tooltip","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-tooltip","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-tooltip","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-tooltip","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-tooltip","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-tooltip","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-tooltip","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-tooltip","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-tooltip","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-tooltip","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-tooltip","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-tooltip","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-tooltip","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-tooltip","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-tooltip","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-tooltip","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-tooltip","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-tooltip","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-tooltip","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-tooltip","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-tooltip","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-tooltip","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-tooltip","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-tooltip","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-tooltip","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-tooltip","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/crosshair","title":"crosshair","summary":"Bare crosshair or {} enables defaults. Object props and JSON attributes override options. Omit/remove the attribute to disable.","kind":"option","group":"tooltip","member":{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Bare crosshair or {} enables defaults. Object props and JSON attributes override options. Omit/remove the attribute to disable."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-crosshair","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-crosshair","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-crosshair","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-crosshair","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-crosshair","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-crosshair","title":"sy-bubble-chart","description":""},{"path":"/docs/components/radar#property-crosshair","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-crosshair","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-crosshair","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-crosshair","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-crosshair","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-crosshair","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-crosshair","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-crosshair","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-crosshair","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-crosshair","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-crosshair","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-crosshair","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#property-crosshair","title":"sy-heatmap","description":""},{"path":"/docs/components/density-map#property-crosshair","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-crosshair","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#property-crosshair","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/theme-river#property-crosshair","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-crosshair","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-crosshair","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-crosshair","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-crosshair","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-crosshair","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-crosshair","title":"sy-stock-chart","description":""},{"path":"/docs/components/surface-3d#property-crosshair","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-crosshair","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-crosshair","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-crosshair","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/gridLines","title":"gridLines","summary":"Allowed values: auto, off. Default: undefined.","kind":"option","group":"axes","member":{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-gridLines","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-gridLines","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-gridLines","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-gridLines","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-gridLines","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-gridLines","title":"sy-bubble-chart","description":""},{"path":"/docs/components/lollipop#property-gridLines","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-gridLines","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-gridLines","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-gridLines","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-gridLines","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-gridLines","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-gridLines","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-gridLines","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-gridLines","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-gridLines","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-gridLines","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#property-gridLines","title":"sy-heatmap","description":""},{"path":"/docs/components/density-map#property-gridLines","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-gridLines","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#property-gridLines","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/candlestick#property-gridLines","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-gridLines","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/zoom","title":"zoom","summary":"cartesian zoom (line / area / column / bar / scatter): `'x'` | `'y'` | `'xy'` | `true` enable the drag rectangle + keyboard on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Forwarded to the active family element.","kind":"option","group":"tooltip","member":{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"cartesian zoom (line / area / column / bar / scatter): `'x'` | `'y'` | `'xy'` | `true` enable the drag rectangle + keyboard on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Forwarded to the active family element."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-zoom","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-zoom","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-zoom","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-zoom","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-zoom","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-zoom","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-zoom","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#property-zoom","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#property-zoom","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-zoom","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-zoom","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-zoom","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-zoom","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-zoom","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-zoom","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-zoom","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#property-zoom","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-zoom","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-zoom","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-zoom","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-zoom","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-zoom","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-zoom","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-zoom","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-zoom","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-zoom","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-zoom","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-zoom","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-zoom","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-zoom","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-zoom","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-zoom","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-zoom","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/gantt#property-zoom","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-zoom","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/brush","title":"brush","summary":"brush selection on the cartesian families (forwarded like `zoom`).","kind":"option","group":"tooltip","member":{"name":"brush","attribute":"brush","type":"CartesianBrushInput","kind":"property","values":["auto","off","true","false","rect","lasso"],"default":"undefined","description":"brush selection on the cartesian families (forwarded like `zoom`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianBrushInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `rect`, `lasso`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-brush","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-brush","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-brush","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-brush","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-brush","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/drawings","title":"drawings","summary":"the drawing document (a list, an envelope or a JSON string), forwarded to the cartesian families.","kind":"option","group":"tooltip","member":{"name":"drawings","attribute":"drawings","type":"ChartDrawingsInput","kind":"property","values":[],"default":"undefined","description":"the drawing document (a list, an envelope or a JSON string), forwarded to the cartesian families."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartDrawingsInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-drawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-drawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-drawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-drawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-drawings","title":"sy-scatter-chart","description":""},{"path":"/docs/components/stock-chart#property-drawings","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/options/drawingMode","title":"drawingMode","summary":"'none' | 'draw' | 'select': the pointer disposition of the cartesian families (draw places `drawingTool`).","kind":"option","group":"tooltip","member":{"name":"drawingMode","attribute":"drawing-mode","type":"DrawingModeInput","kind":"property","values":["none","off","true","false","draw","select"],"default":"undefined","description":"'none' | 'draw' | 'select': the pointer disposition of the cartesian families (draw places `drawingTool`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingMode`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DrawingModeInput`"],["Default","`undefined`"],["Literals in the type","`none`, `off`, `true`, `false`, `draw`, `select`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-drawingMode","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-drawingMode","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-drawingMode","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-drawingMode","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-drawingMode","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/drawingTool","title":"drawingTool","summary":"the tool a draw mode places (default 'segment').","kind":"option","group":"tooltip","member":{"name":"drawingTool","attribute":"drawing-tool","type":"string","kind":"string","values":[],"default":"undefined","description":"the tool a draw mode places (default 'segment')."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingTool`"],["HTML attribute","`drawing-tool`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-drawingTool","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-drawingTool","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-drawingTool","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-drawingTool","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-drawingTool","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/drawingSpace","title":"drawingSpace","summary":"the space new drawings are anchored in ('data' | 'pixel'), forwarded to the cartesian families.","kind":"option","group":"tooltip","member":{"name":"drawingSpace","attribute":"drawing-space","type":"DrawingSpace","kind":"string","values":["data","pixel"],"default":"undefined","description":"the space new drawings are anchored in ('data' | 'pixel'), forwarded to the cartesian families."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingSpace`"],["HTML attribute","`drawing-space`"],["Type","`DrawingSpace`"],["Default","`undefined`"],["Allowed values","`data`, `pixel`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-drawingSpace","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-drawingSpace","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-drawingSpace","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-drawingSpace","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-drawingSpace","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/options/visualMap","title":"visualMap","summary":"a visual map binding (a `sy-visual-map` snapshot + the data dimension), forwarded to the cartesian family.","kind":"option","group":"tooltip","member":{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual map binding (a `sy-visual-map` snapshot + the data dimension), forwarded to the cartesian family."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/line#property-visualMap","title":"sy-line-chart","description":""},{"path":"/docs/components/area#property-visualMap","title":"sy-area-chart","description":""},{"path":"/docs/components/column#property-visualMap","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#property-visualMap","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#property-visualMap","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#property-visualMap","title":"sy-bubble-chart","description":""},{"path":"/docs/components/heatmap#property-visualMap","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-visualMap","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-visualMap","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-visualMap","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/xLabelMode","title":"xLabelMode","summary":"How crowded category-axis labels are decluttered. `'auto'` (default) keeps labels horizontal and thins any that would collide. `'all'` shows everything, `'thin'`/`'rotate'` force one strategy, `'none'` hides the labels.","kind":"option","group":"axes","member":{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis labels are decluttered. `'auto'` (default) keeps labels horizontal and thins any that would collide. `'all'` shows everything, `'thin'`/`'rotate'` force one strategy, `'none'` hides the labels."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/lollipop#property-xLabelMode","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-xLabelMode","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-xLabelMode","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-xLabelMode","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-xLabelMode","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-xLabelMode","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-xLabelMode","title":"sy-pareto-chart","description":""},{"path":"/docs/components/pictorial#property-xLabelMode","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/xLabelRotation","title":"xLabelRotation","summary":"Explicit category-label rotation in degrees (respected as a floor on top of auto-declutter).","kind":"option","group":"axes","member":{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor on top of auto-declutter)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/lollipop#property-xLabelRotation","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-xLabelRotation","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-xLabelRotation","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-xLabelRotation","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-xLabelRotation","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-xLabelRotation","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-xLabelRotation","title":"sy-pareto-chart","description":""},{"path":"/docs/components/pictorial#property-xLabelRotation","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/xLabelMaxCount","title":"xLabelMaxCount","summary":"Hard cap on the number of category-axis labels shown (kept evenly spaced).","kind":"option","group":"axes","member":{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category-axis labels shown (kept evenly spaced)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/lollipop#property-xLabelMaxCount","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-xLabelMaxCount","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-xLabelMaxCount","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-xLabelMaxCount","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-xLabelMaxCount","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-xLabelMaxCount","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-xLabelMaxCount","title":"sy-pareto-chart","description":""},{"path":"/docs/components/pictorial#property-xLabelMaxCount","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/innerSize","title":"innerSize","summary":"Pass as a JavaScript property. type: number | string.","kind":"option","group":"specific","member":{"name":"innerSize","attribute":"inner-size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`innerSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-innerSize","title":"sy-pie-chart","description":""},{"path":"/docs/components/item#property-innerSize","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/startAngleProp","title":"startAngleProp","summary":"Pie/gauge/item start angle; Chord uses degrees with a default of -90 (top).","kind":"option","group":"specific","member":{"name":"startAngleProp","attribute":"start-angle","type":"number","kind":"number","values":[],"default":"undefined","description":"Pie/gauge/item start angle; Chord uses degrees with a default of -90 (top)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startAngleProp`"],["HTML attribute","`start-angle`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/endAngleProp","title":"endAngleProp","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"endAngleProp","attribute":"end-angle","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`endAngleProp`"],["HTML attribute","`end-angle`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/centerText","title":"centerText","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"centerText","attribute":"center-text","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerText`"],["HTML attribute","`center-text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-centerText","title":"sy-pie-chart","description":""},{"path":"/docs/components/gauge#property-centerText","title":"sy-gauge-chart","description":""},{"path":"/docs/components/item#property-centerText","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/centerSubtext","title":"centerSubtext","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"centerSubtext","attribute":"center-subtext","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerSubtext`"],["HTML attribute","`center-subtext`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-centerSubtext","title":"sy-pie-chart","description":""},{"path":"/docs/components/gauge#property-centerSubtext","title":"sy-gauge-chart","description":""},{"path":"/docs/components/item#property-centerSubtext","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/slicedOffset","title":"slicedOffset","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"slicedOffset","attribute":"sliced-offset","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`slicedOffset`"],["HTML attribute","`sliced-offset`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-slicedOffset","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/palette","title":"palette","summary":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: undefined.","kind":"option","group":"appearance","member":{"name":"palette","attribute":"palette","type":"PieChartPaletteName","kind":"string","values":["tableau10","tableau20","observable10","paired12","set3_12"],"default":"undefined","description":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`palette`"],["HTML attribute","`palette`"],["Type","`PieChartPaletteName`"],["Default","`undefined`"],["Allowed values","`tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartPaletteName","title":"PieChartPaletteName","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-palette","title":"sy-pie-chart","description":""},{"path":"/docs/components/polar#property-palette","title":"sy-polar-chart","description":""},{"path":"/docs/components/item#property-palette","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-palette","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-palette","title":"sy-tilemap","description":""},{"path":"/docs/components/wafer-map#property-palette","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/colors","title":"colors","summary":"Pass as a JavaScript property. type: ReadonlyArray<string>.","kind":"option","group":"appearance","member":{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-funnel-chart and create the element before configuring it.\nchart.colors = [\n  \"#8263d9\",\n  \"#239c91\",\n  \"#e99954\",\n  \"#d76c8f\",\n  \"#4d89c4\",\n  \"#95a551\"\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/funnel","title":"Funnel · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-colors","title":"sy-pie-chart","description":""},{"path":"/docs/components/polar#property-colors","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-colors","title":"sy-radar-chart","description":""},{"path":"/docs/components/heatmap#property-colors","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-colors","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-colors","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-colors","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-colors","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-colors","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-colors","title":"sy-funnel-chart","description":""},{"path":"/docs/components/item#property-colors","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-colors","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-colors","title":"sy-tilemap","description":""},{"path":"/docs/components/theme-river#property-colors","title":"sy-theme-river","description":""},{"path":"/docs/components/surface-3d#property-colors","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-colors","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-colors","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/options/labelsMode","title":"labelsMode","summary":"Allowed values: none, auto, inside, outside. Default: undefined.","kind":"option","group":"appearance","member":{"name":"labelsMode","attribute":"labels-mode","type":"PieChartLabelMode","kind":"string","values":["none","auto","inside","outside"],"default":"undefined","description":"Allowed values: none, auto, inside, outside. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsMode`"],["HTML attribute","`labels-mode`"],["Type","`PieChartLabelMode`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `inside`, `outside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartLabelMode","title":"PieChartLabelMode","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsMode","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsContent","title":"labelsContent","summary":"Allowed values: percent, value, name, name-percent, name-value. Default: undefined.","kind":"option","group":"appearance","member":{"name":"labelsContent","attribute":"labels-content","type":"PieChartLabelContent","kind":"property","values":["percent","value","name","name-percent","name-value"],"default":"undefined","description":"Allowed values: percent, value, name, name-percent, name-value. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsContent`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PieChartLabelContent`"],["Default","`undefined`"],["Literals in the type","`percent`, `value`, `name`, `name-percent`, `name-value`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartLabelContent","title":"PieChartLabelContent","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-pie-chart and create the element before configuring it.\nchart.labelsContent = \"name-percent\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/pie","title":"Pie · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsContent","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsDistance","title":"labelsDistance","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"labelsDistance","attribute":"labels-distance","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsDistance`"],["HTML attribute","`labels-distance`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsDistance","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsFontSize","title":"labelsFontSize","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"labelsFontSize","attribute":"labels-font-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsFontSize`"],["HTML attribute","`labels-font-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsFontSize","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsMinSweep","title":"labelsMinSweep","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"labelsMinSweep","attribute":"labels-min-sweep","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsMinSweep`"],["HTML attribute","`labels-min-sweep`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsMinSweep","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsConnector","title":"labelsConnector","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"appearance","member":{"name":"labelsConnector","attribute":"labels-connector","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnector`"],["HTML attribute","`labels-connector`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsConnector","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/allowSelect","title":"allowSelect","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"tooltip","member":{"name":"allowSelect","attribute":"allow-select","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`allowSelect`"],["HTML attribute","`allow-select`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-allowSelect","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/inactiveOtherSlices","title":"inactiveOtherSlices","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"appearance","member":{"name":"inactiveOtherSlices","attribute":"inactive-other-slices","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherSlices`"],["HTML attribute","`inactive-other-slices`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-inactiveOtherSlices","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/inactiveSliceOpacity","title":"inactiveSliceOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"inactiveSliceOpacity","attribute":"inactive-slice-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveSliceOpacity`"],["HTML attribute","`inactive-slice-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-inactiveSliceOpacity","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/activeSliceIndex","title":"activeSliceIndex","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"activeSliceIndex","attribute":"active-slice-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSliceIndex`"],["HTML attribute","`active-slice-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-activeSliceIndex","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsFontWeight","title":"labelsFontWeight","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"labelsFontWeight","attribute":"labels-font-weight","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsFontWeight`"],["HTML attribute","`labels-font-weight`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsFontWeight","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsColor","title":"labelsColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"appearance","member":{"name":"labelsColor","attribute":"labels-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsColor`"],["HTML attribute","`labels-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsColor","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsConnectorColor","title":"labelsConnectorColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"appearance","member":{"name":"labelsConnectorColor","attribute":"labels-connector-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorColor`"],["HTML attribute","`labels-connector-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsConnectorColor","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsConnectorWidth","title":"labelsConnectorWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"labelsConnectorWidth","attribute":"labels-connector-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorWidth`"],["HTML attribute","`labels-connector-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsConnectorWidth","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsConnectorPadding","title":"labelsConnectorPadding","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"appearance","member":{"name":"labelsConnectorPadding","attribute":"labels-connector-padding","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorPadding`"],["HTML attribute","`labels-connector-padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsConnectorPadding","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsConnectorShape","title":"labelsConnectorShape","summary":"Allowed values: straight, crooked. Default: undefined.","kind":"option","group":"appearance","member":{"name":"labelsConnectorShape","attribute":"labels-connector-shape","type":"'crooked' | 'straight'","kind":"string","values":["straight","crooked"],"default":"undefined","description":"Allowed values: straight, crooked. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorShape`"],["HTML attribute","`labels-connector-shape`"],["Type","`'crooked' | 'straight'`"],["Default","`undefined`"],["Allowed values","`straight`, `crooked`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsConnectorShape","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/labelsAllowOverlap","title":"labelsAllowOverlap","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"appearance","member":{"name":"labelsAllowOverlap","attribute":"labels-allow-overlap","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsAllowOverlap`"],["HTML attribute","`labels-allow-overlap`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-labelsAllowOverlap","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/tooltipEnabled","title":"tooltipEnabled","summary":"Pie tooltip toggle. Named `tooltipEnabled` to avoid the cartesian `tooltipShow` event.","kind":"option","group":"tooltip","member":{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Pie tooltip toggle. Named `tooltipEnabled` to avoid the cartesian `tooltipShow` event."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-tooltipEnabled","title":"sy-bubble-chart","description":""},{"path":"/docs/components/lollipop#property-tooltipEnabled","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-tooltipEnabled","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-tooltipEnabled","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-tooltipEnabled","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-tooltipEnabled","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-tooltipEnabled","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-tooltipEnabled","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-tooltipEnabled","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-tooltipEnabled","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-tooltipEnabled","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-tooltipEnabled","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#property-tooltipEnabled","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-tooltipEnabled","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-tooltipEnabled","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-tooltipEnabled","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#property-tooltipEnabled","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/treemap#property-tooltipEnabled","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-tooltipEnabled","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-tooltipEnabled","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-tooltipEnabled","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-tooltipEnabled","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-tooltipEnabled","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-tooltipEnabled","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-tooltipEnabled","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-tooltipEnabled","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-tooltipEnabled","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-tooltipEnabled","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-tooltipEnabled","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-tooltipEnabled","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-tooltipEnabled","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-tooltipEnabled","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-tooltipEnabled","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-tooltipEnabled","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/tooltipFormat","title":"tooltipFormat","summary":"Pie tooltip HTML formatter (property-only — functions can't be set via attribute).","kind":"option","group":"tooltip","member":{"name":"tooltipFormat","attribute":"tooltip-format","type":"((slice: PieChartResolvedSlice) => string) | ((detail: ChordHitDetail) => string) | ((detail: NetworkGraphHitDetail) => string) | ((detail: TreemapHitDetail) => string) | ((detail: SunburstHitDetail) => string) | ((detail: IcicleHitDetail) => string) | ((detail: GanttHitDetail) => string) | ((detail: ParallelCoordinatesHitDetail) => string) | ((detail: DendrogramHitDetail) => string) | ((detail: GeoMapHitDetail) => string)","kind":"property","values":[],"default":"undefined","description":"Pie tooltip HTML formatter (property-only — functions can't be set via attribute)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`((slice: PieChartResolvedSlice) => string) | ((detail: ChordHitDetail) => string) | ((detail: NetworkGraphHitDetail) => string) | ((detail: TreemapHitDetail) => string) | ((detail: SunburstHitDetail) => string) | ((detail: IcicleHitDetail) => string) | ((detail: GanttHitDetail) => string) | ((detail: ParallelCoordinatesHitDetail) => string) | ((detail: DendrogramHitDetail) => string) | ((detail: GeoMapHitDetail) => string)`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartResolvedSlice","title":"PieChartResolvedSlice","description":"Type definition"},{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","description":"Type definition"},{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","description":"Type definition"},{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"},{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"},{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"},{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-tooltipFormat","title":"sy-pie-chart","description":""},{"path":"/docs/components/bubble#property-tooltipFormat","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-tooltipFormat","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-tooltipFormat","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-tooltipFormat","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-tooltipFormat","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-tooltipFormat","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-tooltipFormat","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-tooltipFormat","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-tooltipFormat","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-tooltipFormat","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-tooltipFormat","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-tooltipFormat","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-tooltipFormat","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-tooltipFormat","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-tooltipFormat","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-tooltipFormat","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-tooltipFormat","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-tooltipFormat","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-tooltipFormat","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-tooltipFormat","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-tooltipFormat","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-tooltipFormat","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-tooltipFormat","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-tooltipFormat","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-tooltipFormat","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-tooltipFormat","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-tooltipFormat","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-tooltipFormat","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-tooltipFormat","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-tooltipFormat","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-tooltipFormat","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-tooltipFormat","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-tooltipFormat","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-tooltipFormat","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-tooltipFormat","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-tooltipFormat","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-tooltipFormat","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-tooltipFormat","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-tooltipFormat","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-tooltipFormat","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-tooltipFormat","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-tooltipFormat","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-tooltipFormat","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#property-tooltipFormat","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/enableMouseTracking","title":"enableMouseTracking","summary":"Pie mouse-tracking toggle. Mirrors Highcharts plotOptions.pie.enableMouseTracking.","kind":"option","group":"tooltip","member":{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Pie mouse-tracking toggle. Mirrors Highcharts plotOptions.pie.enableMouseTracking."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-enableMouseTracking","title":"sy-pie-chart","description":""},{"path":"/docs/components/bubble#property-enableMouseTracking","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-enableMouseTracking","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-enableMouseTracking","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-enableMouseTracking","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-enableMouseTracking","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-enableMouseTracking","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-enableMouseTracking","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-enableMouseTracking","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-enableMouseTracking","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#property-enableMouseTracking","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#property-enableMouseTracking","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-enableMouseTracking","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#property-enableMouseTracking","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-enableMouseTracking","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-enableMouseTracking","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#property-enableMouseTracking","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-enableMouseTracking","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-enableMouseTracking","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-enableMouseTracking","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#property-enableMouseTracking","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-enableMouseTracking","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-enableMouseTracking","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#property-enableMouseTracking","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#property-enableMouseTracking","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#property-enableMouseTracking","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#property-enableMouseTracking","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-enableMouseTracking","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-enableMouseTracking","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-enableMouseTracking","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-enableMouseTracking","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-enableMouseTracking","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-enableMouseTracking","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-enableMouseTracking","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-enableMouseTracking","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-enableMouseTracking","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-enableMouseTracking","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-enableMouseTracking","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-enableMouseTracking","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-enableMouseTracking","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#property-enableMouseTracking","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-enableMouseTracking","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-enableMouseTracking","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-enableMouseTracking","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/stickyTracking","title":"stickyTracking","summary":"Keep hover/tooltip until another slice is entered (Highcharts stickyTracking).","kind":"option","group":"tooltip","member":{"name":"stickyTracking","attribute":"sticky-tracking","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Keep hover/tooltip until another slice is entered (Highcharts stickyTracking)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stickyTracking`"],["HTML attribute","`sticky-tracking`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-stickyTracking","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/size","title":"size","summary":"Pie outer diameter. Number = px; '%' = fraction of the smaller plot side.","kind":"option","group":"specific","member":{"name":"size","attribute":"size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pie outer diameter. Number = px; '%' = fraction of the smaller plot side."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`size`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-size","title":"sy-pie-chart","description":""},{"path":"/docs/components/radar#property-size","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-size","title":"sy-gauge-chart","description":""},{"path":"/docs/components/item#property-size","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/centerX","title":"centerX","summary":"Pass as a JavaScript property. type: number | string.","kind":"option","group":"specific","member":{"name":"centerX","attribute":"center-x","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerX`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-centerX","title":"sy-pie-chart","description":""},{"path":"/docs/components/radar#property-centerX","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-centerX","title":"sy-gauge-chart","description":""},{"path":"/docs/components/item#property-centerX","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/centerY","title":"centerY","summary":"Pass as a JavaScript property. type: number | string.","kind":"option","group":"specific","member":{"name":"centerY","attribute":"center-y","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerY`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-centerY","title":"sy-pie-chart","description":""},{"path":"/docs/components/radar#property-centerY","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-centerY","title":"sy-gauge-chart","description":""},{"path":"/docs/components/item#property-centerY","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/minSize","title":"minSize","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"minSize","attribute":"min-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minSize`"],["HTML attribute","`min-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-minSize","title":"sy-pie-chart","description":""},{"path":"/docs/components/item#property-minSize","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/donutThickness","title":"donutThickness","summary":"Donut ring thickness in px. Named `donutThickness` to avoid the cartesian `thickness` prop.","kind":"option","group":"specific","member":{"name":"donutThickness","attribute":"donut-thickness","type":"number","kind":"number","values":[],"default":"undefined","description":"Donut ring thickness in px. Named `donutThickness` to avoid the cartesian `thickness` prop."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`donutThickness`"],["HTML attribute","`donut-thickness`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/symbol","title":"symbol","summary":"Item dot symbol — `circle` (default) / `square` / `diamond`; per-datum `symbol` overrides.","kind":"option","group":"specific","member":{"name":"symbol","attribute":"symbol","type":"ItemChartSymbol","kind":"string","values":["circle","square","diamond"],"default":"undefined","description":"Item dot symbol — `circle` (default) / `square` / `diamond`; per-datum `symbol` overrides."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`symbol`"],["HTML attribute","`symbol`"],["Type","`ItemChartSymbol`"],["Default","`undefined`"],["Allowed values","`circle`, `square`, `diamond`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ItemChartSymbol","title":"ItemChartSymbol","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/item#property-symbol","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/rows","title":"rows","summary":"Item concentric ring count; auto (smallest that fits) when unset.","kind":"option","group":"specific","member":{"name":"rows","attribute":"rows","type":"number","kind":"number","values":[],"default":"undefined","description":"Item concentric ring count; auto (smallest that fits) when unset."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rows`"],["HTML attribute","`rows`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-density-map and create the element before configuring it.\nchart.rows = 40;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/density-map","title":"Density Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-rows","title":"sy-density-map","description":""},{"path":"/docs/components/item#property-rows","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/itemPadding","title":"itemPadding","summary":"Item cell whitespace fraction around each dot, 0..0.9 (Highcharts itemPadding).","kind":"option","group":"specific","member":{"name":"itemPadding","attribute":"item-padding","type":"number","kind":"number","values":[],"default":"undefined","description":"Item cell whitespace fraction around each dot, 0..0.9 (Highcharts itemPadding)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`itemPadding`"],["HTML attribute","`item-padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/item#property-itemPadding","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/options/minFontSize","title":"minFontSize","summary":"Word cloud: smallest rendered font in px (Highcharts minFontSize).","kind":"option","group":"specific","member":{"name":"minFontSize","attribute":"min-font-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Word cloud: smallest rendered font in px (Highcharts minFontSize)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minFontSize`"],["HTML attribute","`min-font-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-minFontSize","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/maxFontSize","title":"maxFontSize","summary":"Word cloud: font px of the heaviest word (Highcharts maxFontSize).","kind":"option","group":"specific","member":{"name":"maxFontSize","attribute":"max-font-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Word cloud: font px of the heaviest word (Highcharts maxFontSize)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`maxFontSize`"],["HTML attribute","`max-font-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-maxFontSize","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/weightScale","title":"weightScale","summary":"Word cloud: weight→fontSize curve — `linear` (default) / `sqrt` / `log`.","kind":"option","group":"specific","member":{"name":"weightScale","attribute":"weight-scale","type":"WordCloudWeightScale","kind":"string","values":["linear","sqrt","log"],"default":"undefined","description":"Word cloud: weight→fontSize curve — `linear` (default) / `sqrt` / `log`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weightScale`"],["HTML attribute","`weight-scale`"],["Type","`WordCloudWeightScale`"],["Default","`undefined`"],["Allowed values","`linear`, `sqrt`, `log`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WordCloudWeightScale","title":"WordCloudWeightScale","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-word-cloud and create the element before configuring it.\nchart.weightScale = \"sqrt\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/word-cloud","title":"Word Cloud · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-weightScale","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/spiral","title":"spiral","summary":"Word cloud: spiral search pattern — `rectangular` (default) / `archimedean`.","kind":"option","group":"specific","member":{"name":"spiral","attribute":"spiral","type":"WordCloudSpiral","kind":"string","values":["rectangular","archimedean"],"default":"undefined","description":"Word cloud: spiral search pattern — `rectangular` (default) / `archimedean`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`spiral`"],["HTML attribute","`spiral`"],["Type","`WordCloudSpiral`"],["Default","`undefined`"],["Allowed values","`rectangular`, `archimedean`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WordCloudSpiral","title":"WordCloudSpiral","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-spiral","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/orientations","title":"orientations","summary":"Word cloud: number of distinct orientations in the rotation cycle (default 2).","kind":"option","group":"specific","member":{"name":"orientations","attribute":"orientations","type":"number","kind":"number","values":[],"default":"undefined","description":"Word cloud: number of distinct orientations in the rotation cycle (default 2)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientations`"],["HTML attribute","`orientations`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-orientations","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/rotationFrom","title":"rotationFrom","summary":"Word cloud: rotation cycle start in degrees (default 0).","kind":"option","group":"specific","member":{"name":"rotationFrom","attribute":"rotation-from","type":"number","kind":"number","values":[],"default":"undefined","description":"Word cloud: rotation cycle start in degrees (default 0)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rotationFrom`"],["HTML attribute","`rotation-from`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-rotationFrom","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/rotationTo","title":"rotationTo","summary":"Word cloud: rotation cycle end in degrees (default 90).","kind":"option","group":"specific","member":{"name":"rotationTo","attribute":"rotation-to","type":"number","kind":"number","values":[],"default":"undefined","description":"Word cloud: rotation cycle end in degrees (default 90)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rotationTo`"],["HTML attribute","`rotation-to`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-rotationTo","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/wordPadding","title":"wordPadding","summary":"Word cloud: empty px kept between word boxes (default 2).","kind":"option","group":"specific","member":{"name":"wordPadding","attribute":"word-padding","type":"number","kind":"number","values":[],"default":"undefined","description":"Word cloud: empty px kept between word boxes (default 2)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wordPadding`"],["HTML attribute","`word-padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/word-cloud#property-wordPadding","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/options/paths","title":"paths","summary":"Pictorial: SVG path definitions the icons cycle through per category. Property-only.","kind":"option","group":"specific","member":{"name":"paths","attribute":"paths","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pictorial: SVG path definitions the icons cycle through per category. Property-only."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`paths`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pictorial#property-paths","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/iconPadding","title":"iconPadding","summary":"Pictorial: fraction of each band kept as whitespace around its icon, 0..0.9.","kind":"option","group":"specific","member":{"name":"iconPadding","attribute":"icon-padding","type":"number","kind":"number","values":[],"default":"undefined","description":"Pictorial: fraction of each band kept as whitespace around its icon, 0..0.9."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`iconPadding`"],["HTML attribute","`icon-padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pictorial#property-iconPadding","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/trackOpacity","title":"trackOpacity","summary":"Pictorial: opacity of the unfilled remainder silhouette (0 hides the track).","kind":"option","group":"specific","member":{"name":"trackOpacity","attribute":"track-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Pictorial: opacity of the unfilled remainder silhouette (0 hides the track)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`trackOpacity`"],["HTML attribute","`track-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pictorial#property-trackOpacity","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/tileShape","title":"tileShape","summary":"Tilemap: tile glyph — `hexagon` (default) / `square`; circle/diamond land .","kind":"option","group":"specific","member":{"name":"tileShape","attribute":"tile-shape","type":"TilemapTileShape","kind":"string","values":["circle","square","diamond","hexagon"],"default":"undefined","description":"Tilemap: tile glyph — `hexagon` (default) / `square`; circle/diamond land ."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tileShape`"],["HTML attribute","`tile-shape`"],["Type","`TilemapTileShape`"],["Default","`undefined`"],["Allowed values","`circle`, `square`, `diamond`, `hexagon`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TilemapTileShape","title":"TilemapTileShape","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-tilemap and create the element before configuring it.\nchart.tileShape = \"hexagon\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/tilemap","title":"Tilemap · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/tilemap#property-tileShape","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/options/showLabels","title":"showLabels","summary":"Tilemap: render each tile's label inside the tile when it fits.","kind":"option","group":"specific","member":{"name":"showLabels","attribute":"show-labels","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Tilemap: render each tile's label inside the tile when it fits."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showLabels`"],["HTML attribute","`show-labels`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-data-zoom and create the element before configuring it.\nchart.showLabels = true;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/data-zoom","title":"Data Zoom · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-showLabels","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/tilemap#property-showLabels","title":"sy-tilemap","description":""},{"path":"/docs/components/data-zoom#property-showLabels","title":"sy-data-zoom","description":""},{"path":"/docs/components/navigator#property-showLabels","title":"sy-navigator","description":""},{"path":"/docs/components/visual-map#property-showLabels","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/labelColor","title":"labelColor","summary":"Tilemap: in-tile label colour.","kind":"option","group":"appearance","member":{"name":"labelColor","attribute":"label-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Tilemap: in-tile label colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelColor`"],["HTML attribute","`label-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-labelColor","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-labelColor","title":"sy-funnel-chart","description":""},{"path":"/docs/components/tilemap#property-labelColor","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/options/colorAxis","title":"colorAxis","summary":"Tilemap: value→colour axis (`true`/`'auto'`/object). Property-only; off by default.","kind":"option","group":"appearance","member":{"name":"colorAxis","attribute":"color-axis","type":"TilemapColorAxisInput","kind":"property","values":["auto"],"default":"undefined","description":"Tilemap: value→colour axis (`true`/`'auto'`/object). Property-only; off by default."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TilemapColorAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TilemapColorAxisInput","title":"TilemapColorAxisInput","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-tilemap and create the element before configuring it.\nchart.colorAxis = \"auto\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/tilemap","title":"Tilemap · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/tilemap#property-colorAxis","title":"sy-tilemap","description":""},{"path":"/docs/components/wafer-map#property-colorAxis","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-colorAxis","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-colorAxis","title":"sy-wafer-correlation","description":""}]}]}]},{"path":"/docs/options/colorLegend","title":"colorLegend","summary":"Tilemap: show the colour-axis gradient legend (on while the axis is on).","kind":"option","group":"appearance","member":{"name":"colorLegend","attribute":"color-legend","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Tilemap: show the colour-axis gradient legend (on while the axis is on)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorLegend`"],["HTML attribute","`color-legend`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/tilemap#property-colorLegend","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/options/matrix","title":"matrix","summary":"Heatmap: a dense matrix — `{ columns, rows, values }` (row-major) or rows of columns. Property-only.","kind":"option","group":"specific","member":{"name":"matrix","attribute":"matrix","type":"HeatmapMatrixInput","kind":"property","values":[],"default":"undefined","description":"Heatmap: a dense matrix — `{ columns, rows, values }` (row-major) or rows of columns. Property-only."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`matrix`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapMatrixInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapMatrixInput","title":"HeatmapMatrixInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/heatmap#property-matrix","title":"sy-heatmap","description":""}]}]}]},{"path":"/docs/options/xCategories","title":"xCategories","summary":"Heatmap: column labels (array, or a comma list). Given explicitly, they fix the column count.","kind":"option","group":"specific","member":{"name":"xCategories","attribute":"x-categories","type":"HeatmapCategoriesInput","kind":"property","values":[],"default":"undefined","description":"Heatmap: column labels (array, or a comma list). Given explicitly, they fix the column count."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapCategoriesInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapCategoriesInput","title":"HeatmapCategoriesInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/heatmap#property-xCategories","title":"sy-heatmap","description":""},{"path":"/docs/components/bar-3d#property-xCategories","title":"sy-bar-3d","description":""}]}]}]},{"path":"/docs/options/yCategories","title":"yCategories","summary":"Heatmap: row labels (row 0 is the top row).","kind":"option","group":"specific","member":{"name":"yCategories","attribute":"y-categories","type":"HeatmapCategoriesInput","kind":"property","values":[],"default":"undefined","description":"Heatmap: row labels (row 0 is the top row)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapCategoriesInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapCategoriesInput","title":"HeatmapCategoriesInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/heatmap#property-yCategories","title":"sy-heatmap","description":""},{"path":"/docs/components/bar-3d#property-yCategories","title":"sy-bar-3d","description":""}]}]}]},{"path":"/docs/options/emptyColor","title":"emptyColor","summary":"Heatmap: the colour of an empty cell (default transparent).","kind":"option","group":"layout","member":{"name":"emptyColor","attribute":"empty-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Heatmap: the colour of an empty cell (default transparent)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`emptyColor`"],["HTML attribute","`empty-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/heatmap#property-emptyColor","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-emptyColor","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-emptyColor","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-emptyColor","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/padding","title":"padding","summary":"(ledger E2 / E7) — the value-domain padding fraction of the Pro cartesian families (box plot, bubble, candlestick / OHLC, density map, error bar, waterfall: each wrapper defaults to 0.05). Left unset, the wrapper's own default applies; the Community cartesian families size their domains through their axis inputs instead.","kind":"option","group":"layout","member":{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"undefined","description":"(ledger E2 / E7) — the value-domain padding fraction of the Pro cartesian families (box plot, bubble, candlestick / OHLC, density map, error bar, waterfall: each wrapper defaults to 0.05). Left unset, the wrapper's own default applies; the Community cartesian families size their domains through their axis inputs instead."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-padding","title":"sy-bubble-chart","description":""},{"path":"/docs/components/waterfall#property-padding","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/box-plot#property-padding","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-padding","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/density-map#property-padding","title":"sy-density-map","description":""},{"path":"/docs/components/treemap#property-padding","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-padding","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-padding","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-padding","title":"sy-dendrogram","description":""},{"path":"/docs/components/geo-map#property-padding","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-padding","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-padding","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-padding","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/headerHeight","title":"headerHeight","summary":"Treemap branch header band in CSS pixels.","kind":"option","group":"specific","member":{"name":"headerHeight","attribute":"header-height","type":"number","kind":"number","values":[],"default":"undefined","description":"Treemap branch header band in CSS pixels."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`headerHeight`"],["HTML attribute","`header-height`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/treemap#property-headerHeight","title":"sy-treemap","description":""}]}]}]},{"path":"/docs/options/drilldown","title":"drilldown","summary":"Enable Treemap branch navigation and accessible hierarchy controls.","kind":"option","group":"specific","member":{"name":"drilldown","attribute":"drilldown","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Enable Treemap branch navigation and accessible hierarchy controls."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drilldown`"],["HTML attribute","`drilldown`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.drilldown = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/treemap#property-drilldown","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-drilldown","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-drilldown","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-drilldown","title":"sy-dendrogram","description":""}]}]}]},{"path":"/docs/options/dendrogramDirection","title":"dendrogramDirection","summary":"Dendrogram depth direction; sibling order remains in normalized input order.","kind":"option","group":"specific","member":{"name":"dendrogramDirection","attribute":"dendrogram-direction","type":"DendrogramDirection","kind":"string","values":["top-down","bottom-up","left-right","right-left"],"default":"'left-right'","description":"Dendrogram depth direction; sibling order remains in normalized input order."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dendrogramDirection`"],["HTML attribute","`dendrogram-direction`"],["Type","`DendrogramDirection`"],["Default","`'left-right'`"],["Allowed values","`top-down`, `bottom-up`, `left-right`, `right-left`"]]},{"kind":"links","items":[{"path":"/docs/types/DendrogramDirection","title":"DendrogramDirection","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.dendrogramDirection = 'left-right';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/icicleDirection","title":"icicleDirection","summary":"Icicle depth direction; sibling order remains in normalized input order.","kind":"option","group":"specific","member":{"name":"icicleDirection","attribute":"icicle-direction","type":"IcicleDirection","kind":"string","values":["top-down","bottom-up","left-right","right-left"],"default":"'top-down'","description":"Icicle depth direction; sibling order remains in normalized input order."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`icicleDirection`"],["HTML attribute","`icicle-direction`"],["Type","`IcicleDirection`"],["Default","`'top-down'`"],["Allowed values","`top-down`, `bottom-up`, `left-right`, `right-left`"]]},{"kind":"links","items":[{"path":"/docs/types/IcicleDirection","title":"IcicleDirection","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.icicleDirection = 'top-down';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/parallelCoordinatesAxes","title":"parallelCoordinatesAxes","summary":"Independent axis ticks, captions, local guides and label styles.","kind":"option","group":"specific","member":{"name":"parallelCoordinatesAxes","attribute":"parallel-coordinates-axes","type":"ParallelCoordinatesAxesInput","kind":"property","values":[],"default":"undefined","description":"Independent axis ticks, captions, local guides and label styles."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`parallelCoordinatesAxes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParallelCoordinatesAxesInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxesInput","title":"ParallelCoordinatesAxesInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/parallelCoordinatesBrush","title":"parallelCoordinatesBrush","summary":"Pass as a JavaScript property. type: ParallelCoordinatesBrushInput.","kind":"option","group":"specific","member":{"name":"parallelCoordinatesBrush","attribute":"parallel-coordinates-brush","type":"ParallelCoordinatesBrushInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ParallelCoordinatesBrushInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`parallelCoordinatesBrush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParallelCoordinatesBrushInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushInput","title":"ParallelCoordinatesBrushInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/parallelCoordinatesDimensions","title":"parallelCoordinatesDimensions","summary":"Numeric dimensions in display order. Omit to infer them from row values.","kind":"option","group":"specific","member":{"name":"parallelCoordinatesDimensions","attribute":"parallel-coordinates-dimensions","type":"ReadonlyArray<ParallelCoordinatesDimensionInput>","kind":"property","values":[],"default":"undefined","description":"Numeric dimensions in display order. Omit to infer them from row values."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`parallelCoordinatesDimensions`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<ParallelCoordinatesDimensionInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesDimensionInput","title":"ParallelCoordinatesDimensionInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/parallelCoordinatesLineWidth","title":"parallelCoordinatesLineWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"parallelCoordinatesLineWidth","attribute":"parallel-coordinates-line-width","type":"number","kind":"number","values":[],"default":"1.5","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`parallelCoordinatesLineWidth`"],["HTML attribute","`parallel-coordinates-line-width`"],["Type","`number`"],["Default","`1.5`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.parallelCoordinatesLineWidth = 1.5;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/parallelCoordinatesLineOpacity","title":"parallelCoordinatesLineOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"parallelCoordinatesLineOpacity","attribute":"parallel-coordinates-line-opacity","type":"number","kind":"number","values":[],"default":".65","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`parallelCoordinatesLineOpacity`"],["HTML attribute","`parallel-coordinates-line-opacity`"],["Type","`number`"],["Default","`.65`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/parallelCoordinatesInactiveRowOpacity","title":"parallelCoordinatesInactiveRowOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"parallelCoordinatesInactiveRowOpacity","attribute":"parallel-coordinates-inactive-row-opacity","type":"number","kind":"number","values":[],"default":".25","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`parallelCoordinatesInactiveRowOpacity`"],["HTML attribute","`parallel-coordinates-inactive-row-opacity`"],["Type","`number`"],["Default","`.25`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/parallelCoordinatesAxisLabels","title":"parallelCoordinatesAxisLabels","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"parallelCoordinatesAxisLabels","attribute":"parallel-coordinates-axis-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`parallelCoordinatesAxisLabels`"],["HTML attribute","`parallel-coordinates-axis-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.parallelCoordinatesAxisLabels = true;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/camera3d","title":"camera3d","summary":"Camera and orbit settings shared by the 3D families. Assign objects as properties or JSON attributes.","kind":"option","group":"axes","member":{"name":"camera3d","attribute":"camera3d","type":"Scene3DCameraOptions|string","kind":"property","values":[],"default":"undefined","description":"Camera and orbit settings shared by the 3D families. Assign objects as properties or JSON attributes."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`camera3d`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DCameraOptions|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/orbit3d","title":"orbit3d","summary":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string.","kind":"option","group":"axes","member":{"name":"orbit3d","attribute":"orbit3d","type":"Orbit3DOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orbit3d`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Orbit3DOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Orbit3DOptions","title":"Orbit3DOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/lighting3d","title":"lighting3d","summary":"Pass as a JavaScript property. type: Scene3DLightingOptions.","kind":"option","group":"specific","member":{"name":"lighting3d","attribute":"lighting3d","type":"Scene3DLightingOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DLightingOptions."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lighting3d`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DLightingOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DLightingOptions","title":"Scene3DLightingOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/material3d","title":"material3d","summary":"Pass as a JavaScript property. type: Scene3DMaterialOptions.","kind":"option","group":"specific","member":{"name":"material3d","attribute":"material3d","type":"Scene3DMaterialOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`material3d`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DMaterialOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DMaterialOptions","title":"Scene3DMaterialOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/flowLinesStyle","title":"flowLinesStyle","summary":"FlowLines route widths, colors, arrows and endpoint markers.","kind":"option","group":"specific","member":{"name":"flowLinesStyle","attribute":"flow-lines-style","type":"FlowLinesStyle","kind":"property","values":[],"default":"undefined","description":"FlowLines route widths, colors, arrows and endpoint markers."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flowLinesStyle`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FlowLinesStyle`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesStyle","title":"FlowLinesStyle","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/flowLinesPath","title":"flowLinesPath","summary":"Allowed values: great-circle, straight. Default: 'great-circle'.","kind":"option","group":"specific","member":{"name":"flowLinesPath","attribute":"flow-lines-path","type":"GeoMapConnectionPath","kind":"string","values":["great-circle","straight"],"default":"'great-circle'","description":"Allowed values: great-circle, straight. Default: 'great-circle'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flowLinesPath`"],["HTML attribute","`flow-lines-path`"],["Type","`GeoMapConnectionPath`"],["Default","`'great-circle'`"],["Allowed values","`great-circle`, `straight`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapConnectionPath","title":"GeoMapConnectionPath","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.flowLinesPath = 'great-circle';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/flowLinesLocationLabels","title":"flowLinesLocationLabels","summary":"Allowed values: auto, show, hide. Default: 'auto'.","kind":"option","group":"specific","member":{"name":"flowLinesLocationLabels","attribute":"flow-lines-location-labels","type":"GeoMapLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flowLinesLocationLabels`"],["HTML attribute","`flow-lines-location-labels`"],["Type","`GeoMapLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.flowLinesLocationLabels = 'auto';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/flowLinesLabels","title":"flowLinesLabels","summary":"Allowed values: auto, show, hide. Default: 'hide'.","kind":"option","group":"specific","member":{"name":"flowLinesLabels","attribute":"flow-lines-labels","type":"GeoMapLabelMode","kind":"string","values":["auto","show","hide"],"default":"'hide'","description":"Allowed values: auto, show, hide. Default: 'hide'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flowLinesLabels`"],["HTML attribute","`flow-lines-labels`"],["Type","`GeoMapLabelMode`"],["Default","`'hide'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.flowLinesLabels = 'hide';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/flowLinesLabelValue","title":"flowLinesLabelValue","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"flowLinesLabelValue","attribute":"flow-lines-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flowLinesLabelValue`"],["HTML attribute","`flow-lines-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.flowLinesLabelValue = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/themeRiverAxes","title":"themeRiverAxes","summary":"ThemeRiver time and stacked-magnitude axes.","kind":"option","group":"layout","member":{"name":"themeRiverAxes","attribute":"theme-river-axes","type":"ThemeRiverAxesOptions","kind":"property","values":[],"default":"undefined","description":"ThemeRiver time and stacked-magnitude axes."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`themeRiverAxes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ThemeRiverAxesOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverAxesOptions","title":"ThemeRiverAxesOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/themeRiverOffset","title":"themeRiverOffset","summary":"Allowed values: silhouette, zero, expand. Default: 'silhouette'.","kind":"option","group":"layout","member":{"name":"themeRiverOffset","attribute":"theme-river-offset","type":"ThemeRiverOffset","kind":"string","values":["silhouette","zero","expand"],"default":"'silhouette'","description":"Allowed values: silhouette, zero, expand. Default: 'silhouette'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`themeRiverOffset`"],["HTML attribute","`theme-river-offset`"],["Type","`ThemeRiverOffset`"],["Default","`'silhouette'`"],["Allowed values","`silhouette`, `zero`, `expand`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverOffset","title":"ThemeRiverOffset","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.themeRiverOffset = 'silhouette';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/themeRiverOrder","title":"themeRiverOrder","summary":"Allowed values: input, reverse. Default: 'input'.","kind":"option","group":"layout","member":{"name":"themeRiverOrder","attribute":"theme-river-order","type":"ThemeRiverOrder","kind":"string","values":["input","reverse"],"default":"'input'","description":"Allowed values: input, reverse. Default: 'input'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`themeRiverOrder`"],["HTML attribute","`theme-river-order`"],["Type","`ThemeRiverOrder`"],["Default","`'input'`"],["Allowed values","`input`, `reverse`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverOrder","title":"ThemeRiverOrder","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.themeRiverOrder = 'input';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/themeRiverColors","title":"themeRiverColors","summary":"Pass as a JavaScript property. type: ReadonlyArray<string>.","kind":"option","group":"layout","member":{"name":"themeRiverColors","attribute":"theme-river-colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`themeRiverColors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/themeRiverOpacity","title":"themeRiverOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"layout","member":{"name":"themeRiverOpacity","attribute":"theme-river-opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`themeRiverOpacity`"],["HTML attribute","`theme-river-opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.themeRiverOpacity = 1;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/themeRiverHiddenSeries","title":"themeRiverHiddenSeries","summary":"Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>.","kind":"option","group":"layout","member":{"name":"themeRiverHiddenSeries","attribute":"theme-river-hidden-series","type":"ReadonlyArray<ThemeRiverId>","kind":"property","values":[],"default":"[]","description":"Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`themeRiverHiddenSeries`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<ThemeRiverId>`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dAxes","title":"bar3dAxes","summary":"Pass as a JavaScript property. type: Bar3DAxesOptions|boolean|string.","kind":"option","group":"specific","member":{"name":"bar3dAxes","attribute":"bar3d-axes","type":"Bar3DAxesOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Bar3DAxesOptions|boolean|string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dAxes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Bar3DAxesOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DAxesOptions","title":"Bar3DAxesOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dAxes","title":"scatter3dAxes","summary":"Pass as a JavaScript property. type: Scatter3DAxesOptions|boolean|string.","kind":"option","group":"specific","member":{"name":"scatter3dAxes","attribute":"scatter3d-axes","type":"Scatter3DAxesOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scatter3DAxesOptions|boolean|string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dAxes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scatter3DAxesOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DAxesOptions","title":"Scatter3DAxesOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dSize","title":"bar3dSize","summary":"Pass as a JavaScript property. type: Scene3DVector.","kind":"option","group":"specific","member":{"name":"bar3dSize","attribute":"bar3d-size","type":"Scene3DVector","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DVector."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DVector`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dSize","title":"scatter3dSize","summary":"Pass as a JavaScript property. type: Scene3DVector.","kind":"option","group":"specific","member":{"name":"scatter3dSize","attribute":"scatter3d-size","type":"Scene3DVector","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DVector."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DVector`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dColors","title":"bar3dColors","summary":"Pass as a JavaScript property. type: HeatmapColorInput.","kind":"option","group":"specific","member":{"name":"bar3dColors","attribute":"bar3d-colors","type":"HeatmapColorInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: HeatmapColorInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dColors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapColorInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dColors","title":"scatter3dColors","summary":"Pass as a JavaScript property. type: HeatmapColorInput.","kind":"option","group":"specific","member":{"name":"scatter3dColors","attribute":"scatter3d-colors","type":"HeatmapColorInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: HeatmapColorInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dColors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapColorInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dColorDomain","title":"bar3dColorDomain","summary":"Pass as a JavaScript property. type: Bar3DDomain.","kind":"option","group":"specific","member":{"name":"bar3dColorDomain","attribute":"bar3d-color-domain","type":"Bar3DDomain","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Bar3DDomain."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dColorDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Bar3DDomain`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDomain","title":"Bar3DDomain","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dColorDomain","title":"scatter3dColorDomain","summary":"Pass as a JavaScript property. type: Scatter3DDomain.","kind":"option","group":"specific","member":{"name":"scatter3dColorDomain","attribute":"scatter3d-color-domain","type":"Scatter3DDomain","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scatter3DDomain."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dColorDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scatter3DDomain`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDomain","title":"Scatter3DDomain","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dMissingColor","title":"bar3dMissingColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"bar3dMissingColor","attribute":"bar3d-missing-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dMissingColor`"],["HTML attribute","`bar3d-missing-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dMissingColor","title":"scatter3dMissingColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"scatter3dMissingColor","attribute":"scatter3d-missing-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dMissingColor`"],["HTML attribute","`scatter3d-missing-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dOpacity","title":"bar3dOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"bar3dOpacity","attribute":"bar3d-opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dOpacity`"],["HTML attribute","`bar3d-opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.bar3dOpacity = 1;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dWidth","title":"bar3dWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"bar3dWidth","attribute":"bar3d-width","type":"number","kind":"number","values":[],"default":".72","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dWidth`"],["HTML attribute","`bar3d-width`"],["Type","`number`"],["Default","`.72`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dDepth","title":"bar3dDepth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"bar3dDepth","attribute":"bar3d-depth","type":"number","kind":"number","values":[],"default":".72","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dDepth`"],["HTML attribute","`bar3d-depth`"],["Type","`number`"],["Default","`.72`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dXCategories","title":"bar3dXCategories","summary":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>.","kind":"option","group":"specific","member":{"name":"bar3dXCategories","attribute":"bar3d-x-categories","type":"ReadonlyArray<Bar3DCategory>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dXCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<Bar3DCategory>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/bar3dYCategories","title":"bar3dYCategories","summary":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>.","kind":"option","group":"specific","member":{"name":"bar3dYCategories","attribute":"bar3d-y-categories","type":"ReadonlyArray<Bar3DCategory>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bar3dYCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<Bar3DCategory>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dOpacity","title":"scatter3dOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"scatter3dOpacity","attribute":"scatter3d-opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dOpacity`"],["HTML attribute","`scatter3d-opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.scatter3dOpacity = 1;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dMarker","title":"scatter3dMarker","summary":"Allowed values: sphere, cube. Default: 'sphere'.","kind":"option","group":"specific","member":{"name":"scatter3dMarker","attribute":"scatter3d-marker","type":"Scatter3DMarker","kind":"string","values":["sphere","cube"],"default":"'sphere'","description":"Allowed values: sphere, cube. Default: 'sphere'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dMarker`"],["HTML attribute","`scatter3d-marker`"],["Type","`Scatter3DMarker`"],["Default","`'sphere'`"],["Allowed values","`sphere`, `cube`"]]},{"kind":"links","items":[{"path":"/docs/types/Scatter3DMarker","title":"Scatter3DMarker","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.scatter3dMarker = 'sphere';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dMarkerRadius","title":"scatter3dMarkerRadius","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"scatter3dMarkerRadius","attribute":"scatter3d-marker-radius","type":"number","kind":"number","values":[],"default":".06","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dMarkerRadius`"],["HTML attribute","`scatter3d-marker-radius`"],["Type","`number`"],["Default","`.06`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/scatter3dMarkerDetail","title":"scatter3dMarkerDetail","summary":"Set as an HTML attribute or JavaScript property. type: 0|1|2.","kind":"option","group":"specific","member":{"name":"scatter3dMarkerDetail","attribute":"scatter3d-marker-detail","type":"0|1|2","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: 0|1|2."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatter3dMarkerDetail`"],["HTML attribute","`scatter3d-marker-detail`"],["Type","`0|1|2`"],["Default","`1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.scatter3dMarkerDetail = 1;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dAxes","title":"surface3dAxes","summary":"Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string.","kind":"option","group":"specific","member":{"name":"surface3dAxes","attribute":"surface3d-axes","type":"Surface3DAxesOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dAxes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Surface3DAxesOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Surface3DAxesOptions","title":"Surface3DAxesOptions","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dSize","title":"surface3dSize","summary":"Pass as a JavaScript property. type: Scene3DVector.","kind":"option","group":"specific","member":{"name":"surface3dSize","attribute":"surface3d-size","type":"Scene3DVector","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DVector."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DVector`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dColors","title":"surface3dColors","summary":"Pass as a JavaScript property. type: HeatmapColorInput.","kind":"option","group":"specific","member":{"name":"surface3dColors","attribute":"surface3d-colors","type":"HeatmapColorInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: HeatmapColorInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dColors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapColorInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dColorDomain","title":"surface3dColorDomain","summary":"Pass as a JavaScript property. type: Surface3DDomain.","kind":"option","group":"specific","member":{"name":"surface3dColorDomain","attribute":"surface3d-color-domain","type":"Surface3DDomain","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Surface3DDomain."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dColorDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Surface3DDomain`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Surface3DDomain","title":"Surface3DDomain","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dMissingColor","title":"surface3dMissingColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"surface3dMissingColor","attribute":"surface3d-missing-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dMissingColor`"],["HTML attribute","`surface3d-missing-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dOpacity","title":"surface3dOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"surface3dOpacity","attribute":"surface3d-opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dOpacity`"],["HTML attribute","`surface3d-opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.surface3dOpacity = 1;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dWireframe","title":"surface3dWireframe","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"surface3dWireframe","attribute":"surface3d-wireframe","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dWireframe`"],["HTML attribute","`surface3d-wireframe`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.surface3dWireframe = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dWireWidth","title":"surface3dWireWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"surface3dWireWidth","attribute":"surface3d-wire-width","type":"number","kind":"number","values":[],"default":".8","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dWireWidth`"],["HTML attribute","`surface3d-wire-width`"],["Type","`number`"],["Default","`.8`"]]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/surface3dWireColor","title":"surface3dWireColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"surface3dWireColor","attribute":"surface3d-wire-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surface3dWireColor`"],["HTML attribute","`surface3d-wire-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttBarHeight","title":"ganttBarHeight","summary":"Maximum Gantt task bar height in CSS pixels.","kind":"option","group":"specific","member":{"name":"ganttBarHeight","attribute":"gantt-bar-height","type":"number","kind":"number","values":[],"default":"24","description":"Maximum Gantt task bar height in CSS pixels."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttBarHeight`"],["HTML attribute","`gantt-bar-height`"],["Type","`number`"],["Default","`24`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.ganttBarHeight = 24;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttRowGap","title":"ganttRowGap","summary":"Gantt row gap in CSS pixels.","kind":"option","group":"specific","member":{"name":"ganttRowGap","attribute":"gantt-row-gap","type":"number","kind":"number","values":[],"default":"4","description":"Gantt row gap in CSS pixels."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttRowGap`"],["HTML attribute","`gantt-row-gap`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.ganttRowGap = 4;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttTimeDomain","title":"ganttTimeDomain","summary":"Explicit full Gantt time domain in epoch milliseconds.","kind":"option","group":"specific","member":{"name":"ganttTimeDomain","attribute":"gantt-time-domain","type":"readonly [number, number]","kind":"property","values":[],"default":"undefined","description":"Explicit full Gantt time domain in epoch milliseconds."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttTimeDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`readonly [number, number]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttCriticalPath","title":"ganttCriticalPath","summary":"Pass as a JavaScript property. type: GanttCriticalPathInput.","kind":"option","group":"specific","member":{"name":"ganttCriticalPath","attribute":"gantt-critical-path","type":"GanttCriticalPathInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GanttCriticalPathInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttCriticalPath`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttCriticalPathInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttCriticalPathInput","title":"GanttCriticalPathInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttTaskEditing","title":"ganttTaskEditing","summary":"Gantt task move/resize with elapsed-time snapping and optional bounds. Disabled by default.","kind":"option","group":"specific","member":{"name":"ganttTaskEditing","attribute":"gantt-task-editing","type":"GanttTaskEditingInput","kind":"property","values":[],"default":"undefined","description":"Gantt task move/resize with elapsed-time snapping and optional bounds. Disabled by default."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttTaskEditing`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttTaskEditingInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditingInput","title":"GanttTaskEditingInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttBaseline","title":"ganttBaseline","summary":"Gantt reference-date strips and automatic domain inclusion. Visible by default when supplied.","kind":"option","group":"specific","member":{"name":"ganttBaseline","attribute":"gantt-baseline","type":"GanttBaselineStyleInput","kind":"property","values":[],"default":"undefined","description":"Gantt reference-date strips and automatic domain inclusion. Visible by default when supplied."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttBaseline`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttBaselineStyleInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttBaselineStyleInput","title":"GanttBaselineStyleInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttDependencies","title":"ganttDependencies","summary":"Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>.","kind":"option","group":"specific","member":{"name":"ganttDependencies","attribute":"gantt-dependencies","type":"ReadonlyArray<GanttDependencyInput>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttDependencies`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<GanttDependencyInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyInput","title":"GanttDependencyInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttDependencyStyle","title":"ganttDependencyStyle","summary":"Pass as a JavaScript property. type: GanttDependencyStyleInput.","kind":"option","group":"specific","member":{"name":"ganttDependencyStyle","attribute":"gantt-dependency-style","type":"GanttDependencyStyleInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GanttDependencyStyleInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttDependencyStyle`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttDependencyStyleInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyStyleInput","title":"GanttDependencyStyleInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttTimeAxis","title":"ganttTimeAxis","summary":"Pass as a JavaScript property. type: GanttTimeAxisInput.","kind":"option","group":"specific","member":{"name":"ganttTimeAxis","attribute":"gantt-time-axis","type":"GanttTimeAxisInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GanttTimeAxisInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttTimeAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttTimeAxisInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttTimeAxisInput","title":"GanttTimeAxisInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttCrosshairTimeUnit","title":"ganttCrosshairTimeUnit","summary":"Gantt crosshair time badge precision; default hour. Uses ganttTimeAxis.utc.","kind":"option","group":"specific","member":{"name":"ganttCrosshairTimeUnit","attribute":"gantt-crosshair-time-unit","type":"GanttCrosshairTimeUnit","kind":"string","values":["year","month","week","day","hour","minute","second"],"default":"'hour'","description":"Gantt crosshair time badge precision; default hour. Uses ganttTimeAxis.utc."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttCrosshairTimeUnit`"],["HTML attribute","`gantt-crosshair-time-unit`"],["Type","`GanttCrosshairTimeUnit`"],["Default","`'hour'`"],["Allowed values","`year`, `month`, `week`, `day`, `hour`, `minute`, `second`"]]},{"kind":"links","items":[{"path":"/docs/types/GanttCrosshairTimeUnit","title":"GanttCrosshairTimeUnit","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.ganttCrosshairTimeUnit = 'hour';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttBarRadius","title":"ganttBarRadius","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"ganttBarRadius","attribute":"gantt-bar-radius","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttBarRadius`"],["HTML attribute","`gantt-bar-radius`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.ganttBarRadius = 3;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttProgressShow","title":"ganttProgressShow","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"ganttProgressShow","attribute":"gantt-progress-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttProgressShow`"],["HTML attribute","`gantt-progress-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.ganttProgressShow = true;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/ganttProgressColor","title":"ganttProgressColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"ganttProgressColor","attribute":"gantt-progress-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ganttProgressColor`"],["HTML attribute","`gantt-progress-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.ganttProgressColor = 'auto';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/taskLabelFormat","title":"taskLabelFormat","summary":"Pass as a JavaScript property. type: (task:GanttTask)=>string.","kind":"option","group":"specific","member":{"name":"taskLabelFormat","attribute":"task-label-format","type":"(task:GanttTask)=>string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (task:GanttTask)=>string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`taskLabelFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(task:GanttTask)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gantt#property-taskLabelFormat","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/taskLabels","title":"taskLabels","summary":"Allowed values: auto, show, hide. Default: undefined.","kind":"option","group":"specific","member":{"name":"taskLabels","attribute":"task-labels","type":"GanttLabelMode","kind":"string","values":["auto","show","hide"],"default":"undefined","description":"Allowed values: auto, show, hide. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`taskLabels`"],["HTML attribute","`task-labels`"],["Type","`GanttLabelMode`"],["Default","`undefined`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttLabelMode","title":"GanttLabelMode","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gantt#property-taskLabels","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/kernel","title":"kernel","summary":"Density map: the kernel profile (`gaussian`, `epanechnikov`, `quartic`, `triangular`, `uniform`).","kind":"option","group":"specific","member":{"name":"kernel","attribute":"kernel","type":"DensityMapKernel","kind":"string","values":["gaussian","epanechnikov","quartic","triangular","uniform"],"default":"undefined","description":"Density map: the kernel profile (`gaussian`, `epanechnikov`, `quartic`, `triangular`, `uniform`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`kernel`"],["HTML attribute","`kernel`"],["Type","`DensityMapKernel`"],["Default","`undefined`"],["Allowed values","`gaussian`, `epanechnikov`, `quartic`, `triangular`, `uniform`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapKernel","title":"DensityMapKernel","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-density-map and create the element before configuring it.\nchart.kernel = \"gaussian\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/density-map","title":"Density Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-kernel","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/bandwidth","title":"bandwidth","summary":"Density map: the bandwidth — a number (both axes), `\"x,y\"`, `{ x, y }`, or `auto` (Silverman's rule).","kind":"option","group":"specific","member":{"name":"bandwidth","attribute":"bandwidth","type":"DensityMapBandwidthInput","kind":"property","values":[],"default":"undefined","description":"Density map: the bandwidth — a number (both axes), `\"x,y\"`, `{ x, y }`, or `auto` (Silverman's rule)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandwidth`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DensityMapBandwidthInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapBandwidthInput","title":"DensityMapBandwidthInput","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-density-map and create the element before configuring it.\nchart.bandwidth = 9;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/density-map","title":"Density Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-bandwidth","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/bandwidthUnit","title":"bandwidthUnit","summary":"Density map: the unit of an explicit bandwidth — `data` (default) or `px`.","kind":"option","group":"specific","member":{"name":"bandwidthUnit","attribute":"bandwidth-unit","type":"DensityMapBandwidthUnit","kind":"string","values":["data","px"],"default":"undefined","description":"Density map: the unit of an explicit bandwidth — `data` (default) or `px`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandwidthUnit`"],["HTML attribute","`bandwidth-unit`"],["Type","`DensityMapBandwidthUnit`"],["Default","`undefined`"],["Allowed values","`data`, `px`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapBandwidthUnit","title":"DensityMapBandwidthUnit","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-bandwidthUnit","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/cellSize","title":"cellSize","summary":"Density map: CSS px per estimate cell (the grid follows the plot).","kind":"option","group":"specific","member":{"name":"cellSize","attribute":"cell-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Density map: CSS px per estimate cell (the grid follows the plot)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellSize`"],["HTML attribute","`cell-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-cellSize","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/threshold","title":"threshold","summary":"Density map: cells under this fraction of the peak density are empty.","kind":"option","group":"specific","member":{"name":"threshold","attribute":"threshold","type":"number","kind":"number","values":[],"default":"undefined","description":"Density map: cells under this fraction of the peak density are empty."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`threshold`"],["HTML attribute","`threshold`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-threshold","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/computePath","title":"computePath","summary":"Density map: where the estimate runs — `auto` (the GPU once the renderer is up), `cpu`, `gpu`.","kind":"option","group":"specific","member":{"name":"computePath","attribute":"compute-path","type":"DensityMapComputePathInput","kind":"string","values":["auto","cpu","gpu"],"default":"undefined","description":"Density map: where the estimate runs — `auto` (the GPU once the renderer is up), `cpu`, `gpu`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`computePath`"],["HTML attribute","`compute-path`"],["Type","`DensityMapComputePathInput`"],["Default","`undefined`"],["Allowed values","`auto`, `cpu`, `gpu`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapComputePathInput","title":"DensityMapComputePathInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-computePath","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/fade","title":"fade","summary":"Density map: the fade band above the threshold cut, as a fraction of the peak ().","kind":"option","group":"specific","member":{"name":"fade","attribute":"fade","type":"number","kind":"number","values":[],"default":"undefined","description":"Density map: the fade band above the threshold cut, as a fraction of the peak ()."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fade`"],["HTML attribute","`fade`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-fade","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/densityUnit","title":"densityUnit","summary":"Density map: how densities read — the cell's mass, or mass per unit area ().","kind":"option","group":"specific","member":{"name":"densityUnit","attribute":"density-unit","type":"DensityMapUnitInput","kind":"string","values":["mass","per-area"],"default":"undefined","description":"Density map: how densities read — the cell's mass, or mass per unit area ()."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`densityUnit`"],["HTML attribute","`density-unit`"],["Type","`DensityMapUnitInput`"],["Default","`undefined`"],["Allowed values","`mass`, `per-area`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapUnitInput","title":"DensityMapUnitInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/density-map#property-densityUnit","title":"sy-density-map","description":""}]}]}]},{"path":"/docs/options/sampleRate","title":"sampleRate","summary":"Spectrogram: the sampling rate in Hz — the frequency axis spans 0 … sample-rate / 2.","kind":"option","group":"specific","member":{"name":"sampleRate","attribute":"sample-rate","type":"number","kind":"number","values":[],"default":"undefined","description":"Spectrogram: the sampling rate in Hz — the frequency axis spans 0 … sample-rate / 2."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sampleRate`"],["HTML attribute","`sample-rate`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-sampleRate","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/freqMin","title":"freqMin","summary":"Spectrogram: the frequency axis ends in Hz (they win over `sample-rate`).","kind":"option","group":"specific","member":{"name":"freqMin","attribute":"freq-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Spectrogram: the frequency axis ends in Hz (they win over `sample-rate`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`freqMin`"],["HTML attribute","`freq-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-freqMin","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/freqMax","title":"freqMax","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"freqMax","attribute":"freq-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`freqMax`"],["HTML attribute","`freq-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-freqMax","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/hopSeconds","title":"hopSeconds","summary":"Spectrogram: seconds per frame (the hop) — the time axis.","kind":"option","group":"specific","member":{"name":"hopSeconds","attribute":"hop-seconds","type":"number","kind":"number","values":[],"default":"undefined","description":"Spectrogram: seconds per frame (the hop) — the time axis."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`hopSeconds`"],["HTML attribute","`hop-seconds`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-hopSeconds","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/timeOrigin","title":"timeOrigin","summary":"Spectrogram: seconds at the first frame.","kind":"option","group":"specific","member":{"name":"timeOrigin","attribute":"time-origin","type":"number","kind":"number","values":[],"default":"undefined","description":"Spectrogram: seconds at the first frame."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`timeOrigin`"],["HTML attribute","`time-origin`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-timeOrigin","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/valueScale","title":"valueScale","summary":"Spectrogram: `db` (the frames are decibels) or `linear` (magnitudes, converted with 20 · log10).","kind":"option","group":"specific","member":{"name":"valueScale","attribute":"value-scale","type":"SpectrogramValueScale","kind":"string","values":["linear","db"],"default":"undefined","description":"Spectrogram: `db` (the frames are decibels) or `linear` (magnitudes, converted with 20 · log10)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueScale`"],["HTML attribute","`value-scale`"],["Type","`SpectrogramValueScale`"],["Default","`undefined`"],["Allowed values","`linear`, `db`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramValueScale","title":"SpectrogramValueScale","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-spectrogram and create the element before configuring it.\nchart.valueScale = \"linear\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/spectrogram","title":"Spectrogram · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-valueScale","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/dbFloor","title":"dbFloor","summary":"Spectrogram: the dB a zero magnitude reads on the linear scale (default −120).","kind":"option","group":"specific","member":{"name":"dbFloor","attribute":"db-floor","type":"number","kind":"number","values":[],"default":"undefined","description":"Spectrogram: the dB a zero magnitude reads on the linear scale (default −120)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dbFloor`"],["HTML attribute","`db-floor`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-dbFloor","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/year","title":"year","summary":"Calendar heatmap: the year (Jan 1 … Dec 31) unless `start-date` / `end-date` say otherwise.","kind":"option","group":"specific","member":{"name":"year","attribute":"year","type":"number","kind":"number","values":[],"default":"undefined","description":"Calendar heatmap: the year (Jan 1 … Dec 31) unless `start-date` / `end-date` say otherwise."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`year`"],["HTML attribute","`year`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-year","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/startDate","title":"startDate","summary":"Calendar heatmap: the range ends (ISO dates); they win over `year`; neither → the entries' span.","kind":"option","group":"specific","member":{"name":"startDate","attribute":"start-date","type":"string","kind":"string","values":[],"default":"undefined","description":"Calendar heatmap: the range ends (ISO dates); they win over `year`; neither → the entries' span."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startDate`"],["HTML attribute","`start-date`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-startDate","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/endDate","title":"endDate","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"endDate","attribute":"end-date","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`endDate`"],["HTML attribute","`end-date`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-endDate","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/weekStart","title":"weekStart","summary":"Calendar heatmap: the first day of the week (the top row) — `monday` or `sunday`.","kind":"option","group":"specific","member":{"name":"weekStart","attribute":"week-start","type":"CalendarWeekStart","kind":"string","values":["monday","sunday"],"default":"undefined","description":"Calendar heatmap: the first day of the week (the top row) — `monday` or `sunday`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weekStart`"],["HTML attribute","`week-start`"],["Type","`CalendarWeekStart`"],["Default","`undefined`"],["Allowed values","`monday`, `sunday`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CalendarWeekStart","title":"CalendarWeekStart","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-calendar-heatmap and create the element before configuring it.\nchart.weekStart = \"monday\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/calendar-heatmap","title":"Calendar Heatmap · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-weekStart","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/aggregate","title":"aggregate","summary":"Calendar heatmap: how several entries on one day fold — `sum`, `max`, `min`, `mean`, `last`.","kind":"option","group":"specific","member":{"name":"aggregate","attribute":"aggregate","type":"CalendarAggregate","kind":"string","values":["sum","max","min","mean","last"],"default":"undefined","description":"Calendar heatmap: how several entries on one day fold — `sum`, `max`, `min`, `mean`, `last`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`aggregate`"],["HTML attribute","`aggregate`"],["Type","`CalendarAggregate`"],["Default","`undefined`"],["Allowed values","`sum`, `max`, `min`, `mean`, `last`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CalendarAggregate","title":"CalendarAggregate","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-aggregate","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/noDataValue","title":"noDataValue","summary":"Calendar heatmap: what a day without entries reads — a number (default 0 → the ramp's first colour) or `nan` (→ `empty-color`).","kind":"option","group":"specific","member":{"name":"noDataValue","attribute":"no-data-value","type":"number | 'nan'","kind":"property","values":["nan"],"default":"undefined","description":"Calendar heatmap: what a day without entries reads — a number (default 0 → the ramp's first colour) or `nan` (→ `empty-color`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`noDataValue`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'nan'`"],["Default","`undefined`"],["Literals in the type","`nan`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-noDataValue","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/monthLabels","title":"monthLabels","summary":"Calendar heatmap: month labels along the top.","kind":"option","group":"specific","member":{"name":"monthLabels","attribute":"month-labels","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Calendar heatmap: month labels along the top."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`monthLabels`"],["HTML attribute","`month-labels`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-monthLabels","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/weekdayLabels","title":"weekdayLabels","summary":"Calendar heatmap: weekday labels down the left — `short` (rows 0 / 2 / 4), `all`, `none`.","kind":"option","group":"specific","member":{"name":"weekdayLabels","attribute":"weekday-labels","type":"CalendarWeekdayLabels","kind":"string","values":["none","short","all"],"default":"undefined","description":"Calendar heatmap: weekday labels down the left — `short` (rows 0 / 2 / 4), `all`, `none`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weekdayLabels`"],["HTML attribute","`weekday-labels`"],["Type","`CalendarWeekdayLabels`"],["Default","`undefined`"],["Allowed values","`none`, `short`, `all`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CalendarWeekdayLabels","title":"CalendarWeekdayLabels","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-weekdayLabels","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/monthLines","title":"monthLines","summary":"Calendar heatmap: month boundaries as step lines between the cells.","kind":"option","group":"specific","member":{"name":"monthLines","attribute":"month-lines","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Calendar heatmap: month boundaries as step lines between the cells."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`monthLines`"],["HTML attribute","`month-lines`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/calendar-heatmap#property-monthLines","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/upColor","title":"upColor","summary":"Candlestick: the colour of a rising bar (close > open).","kind":"option","group":"specific","member":{"name":"upColor","attribute":"up-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Candlestick: the colour of a rising bar (close > open)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`upColor`"],["HTML attribute","`up-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-upColor","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/candlestick#property-upColor","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-upColor","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-upColor","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-upColor","title":"sy-stock-volume","description":""}]}]}]},{"path":"/docs/options/downColor","title":"downColor","summary":"Candlestick: the colour of a falling bar (close < open).","kind":"option","group":"specific","member":{"name":"downColor","attribute":"down-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Candlestick: the colour of a falling bar (close < open)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`downColor`"],["HTML attribute","`down-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-downColor","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/candlestick#property-downColor","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-downColor","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-downColor","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-downColor","title":"sy-stock-volume","description":""}]}]}]},{"path":"/docs/options/flatColor","title":"flatColor","summary":"Candlestick: the colour of a doji (close = open).","kind":"option","group":"specific","member":{"name":"flatColor","attribute":"flat-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Candlestick: the colour of a doji (close = open)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flatColor`"],["HTML attribute","`flat-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-flatColor","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-flatColor","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/candleWidth","title":"candleWidth","summary":"Candlestick: the body's share of the bar pitch (0 … 1, default 0.7).","kind":"option","group":"specific","member":{"name":"candleWidth","attribute":"candle-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Candlestick: the body's share of the bar pitch (0 … 1, default 0.7)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`candleWidth`"],["HTML attribute","`candle-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-candleWidth","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-candleWidth","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/wickWidth","title":"wickWidth","summary":"Candlestick: the wick width in CSS px.","kind":"option","group":"specific","member":{"name":"wickWidth","attribute":"wick-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Candlestick: the wick width in CSS px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wickWidth`"],["HTML attribute","`wick-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-wickWidth","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-wickWidth","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/bodyStyle","title":"bodyStyle","summary":"Candlestick (): `solid`, `hollow`, or `hollow-up` (rising bars hollow, falling filled).","kind":"option","group":"specific","member":{"name":"bodyStyle","attribute":"body-style","type":"CandlestickBodyStyle","kind":"string","values":["solid","hollow","hollow-up"],"default":"undefined","description":"Candlestick (): `solid`, `hollow`, or `hollow-up` (rising bars hollow, falling filled)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bodyStyle`"],["HTML attribute","`body-style`"],["Type","`CandlestickBodyStyle`"],["Default","`undefined`"],["Allowed values","`solid`, `hollow`, `hollow-up`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBodyStyle","title":"CandlestickBodyStyle","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-bodyStyle","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-bodyStyle","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/wickColor","title":"wickColor","summary":"Candlestick (): the wick colour; `auto` follows the body colour.","kind":"option","group":"specific","member":{"name":"wickColor","attribute":"wick-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Candlestick (): the wick colour; `auto` follows the body colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wickColor`"],["HTML attribute","`wick-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-wickColor","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-wickColor","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/timeScale","title":"timeScale","summary":"Candlestick (): `ordinal` (one slot per bar — no weekend / holiday gaps; the default) or `linear` (wall time).","kind":"option","group":"specific","member":{"name":"timeScale","attribute":"time-scale","type":"CandlestickTimeScale","kind":"string","values":["linear","ordinal"],"default":"undefined","description":"Candlestick (): `ordinal` (one slot per bar — no weekend / holiday gaps; the default) or `linear` (wall time)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`timeScale`"],["HTML attribute","`time-scale`"],["Type","`CandlestickTimeScale`"],["Default","`undefined`"],["Allowed values","`linear`, `ordinal`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickTimeScale","title":"CandlestickTimeScale","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-candlestick-chart and create the element before configuring it.\nchart.timeScale = \"ordinal\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/candlestick","title":"Candlestick · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-timeScale","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-timeScale","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/session","title":"session","summary":"Candlestick (): the exchange session the labels read — `24x7`, `us-equity`, or a JSON object `{ timezone, sessions, holidays, closedWeekdays }`.","kind":"option","group":"specific","member":{"name":"session","attribute":"session","type":"CandlestickSessionInput | string","kind":"property","values":[],"default":"undefined","description":"Candlestick (): the exchange session the labels read — `24x7`, `us-equity`, or a JSON object `{ timezone, sessions, holidays, closedWeekdays }`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`session`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickSessionInput | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickSessionInput","title":"CandlestickSessionInput","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-stock-chart and create the element before configuring it.\nchart.session = \"24x7\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/stock-chart","title":"Stock Chart · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-session","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-session","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-session","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-session","title":"sy-stock-volume","description":""},{"path":"/docs/components/stock-flags#property-session","title":"sy-stock-flags","description":""}]}]}]},{"path":"/docs/options/volume","title":"volume","summary":"Candlestick (): `pane` adds a volume pane below the price (a feed without volumes gets none); `off` by default.","kind":"option","group":"specific","member":{"name":"volume","attribute":"volume","type":"CandlestickVolumeMode","kind":"string","values":["off","pane"],"default":"undefined","description":"Candlestick (): `pane` adds a volume pane below the price (a feed without volumes gets none); `off` by default."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volume`"],["HTML attribute","`volume`"],["Type","`CandlestickVolumeMode`"],["Default","`undefined`"],["Allowed values","`off`, `pane`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickVolumeMode","title":"CandlestickVolumeMode","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-candlestick-chart and create the element before configuring it.\nchart.volume = \"off\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/candlestick","title":"Candlestick · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-volume","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-volume","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/volumeHeight","title":"volumeHeight","summary":"Candlestick (): the volume pane's share of the plot height (0.05 … 0.8; default 0.25).","kind":"option","group":"specific","member":{"name":"volumeHeight","attribute":"volume-height","type":"number","kind":"number","values":[],"default":"undefined","description":"Candlestick (): the volume pane's share of the plot height (0.05 … 0.8; default 0.25)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeHeight`"],["HTML attribute","`volume-height`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-volumeHeight","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-volumeHeight","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/volumeUpColor","title":"volumeUpColor","summary":"Candlestick (): the volume bar colours (`auto` = up-color / down-color) and their alpha (default 0.45).","kind":"option","group":"specific","member":{"name":"volumeUpColor","attribute":"volume-up-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Candlestick (): the volume bar colours (`auto` = up-color / down-color) and their alpha (default 0.45)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeUpColor`"],["HTML attribute","`volume-up-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-volumeUpColor","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-volumeUpColor","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/volumeDownColor","title":"volumeDownColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"volumeDownColor","attribute":"volume-down-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeDownColor`"],["HTML attribute","`volume-down-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-volumeDownColor","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-volumeDownColor","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/volumeAlpha","title":"volumeAlpha","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"volumeAlpha","attribute":"volume-alpha","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeAlpha`"],["HTML attribute","`volume-alpha`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-volumeAlpha","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-volumeAlpha","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/barStyle","title":"barStyle","summary":"Candlestick / OHLC (): the bar style — `candle` / `ohlc` / `hlc` on a candlestick, `ohlc` / `hlc` on `type=\"ohlc\"`.","kind":"option","group":"specific","member":{"name":"barStyle","attribute":"bar-style","type":"string","kind":"string","values":[],"default":"undefined","description":"Candlestick / OHLC (): the bar style — `candle` / `ohlc` / `hlc` on a candlestick, `ohlc` / `hlc` on `type=\"ohlc\"`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barStyle`"],["HTML attribute","`bar-style`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-ohlc-chart and create the element before configuring it.\nchart.barStyle = \"ohlc\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/ohlc","title":"Ohlc · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-barStyle","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-barStyle","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/overlays","title":"overlays","summary":"Candlestick (): moving-average overlays — spec objects `{ kind, period, color?, width?, label? }`, a JSON string, or the compact `\"sma:20 ema:50\"`.","kind":"option","group":"specific","member":{"name":"overlays","attribute":"overlays","type":"CandlestickOverlayInput | string","kind":"property","values":[],"default":"undefined","description":"Candlestick (): moving-average overlays — spec objects `{ kind, period, color?, width?, label? }`, a JSON string, or the compact `\"sma:20 ema:50\"`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`overlays`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickOverlayInput | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlayInput","title":"CandlestickOverlayInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/candlestick#property-overlays","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-overlays","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/boxColor","title":"boxColor","summary":"Box plot: the box colour — the border, and at `box-fill-alpha` the fill; `auto` whiskers / outliers follow it.","kind":"option","group":"specific","member":{"name":"boxColor","attribute":"box-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Box plot: the box colour — the border, and at `box-fill-alpha` the fill; `auto` whiskers / outliers follow it."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxColor`"],["HTML attribute","`box-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-boxColor","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/boxFillAlpha","title":"boxFillAlpha","summary":"Box plot: the fill's alpha (default 0.35).","kind":"option","group":"specific","member":{"name":"boxFillAlpha","attribute":"box-fill-alpha","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot: the fill's alpha (default 0.35)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxFillAlpha`"],["HTML attribute","`box-fill-alpha`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-boxFillAlpha","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/medianColor","title":"medianColor","summary":"Box plot: the median line colour.","kind":"option","group":"specific","member":{"name":"medianColor","attribute":"median-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Box plot: the median line colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`medianColor`"],["HTML attribute","`median-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-medianColor","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/whiskerColor","title":"whiskerColor","summary":"Box plot: the whisker / outlier colours (`auto` = the box colour).","kind":"option","group":"specific","member":{"name":"whiskerColor","attribute":"whisker-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Box plot: the whisker / outlier colours (`auto` = the box colour)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerColor`"],["HTML attribute","`whisker-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-whiskerColor","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/outlierColor","title":"outlierColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"outlierColor","attribute":"outlier-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`outlierColor`"],["HTML attribute","`outlier-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-outlierColor","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/boxWidth","title":"boxWidth","summary":"Box plot: the box's share of the slot pitch (0 … 1, default 0.6).","kind":"option","group":"specific","member":{"name":"boxWidth","attribute":"box-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot: the box's share of the slot pitch (0 … 1, default 0.6)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxWidth`"],["HTML attribute","`box-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-boxWidth","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/whiskerRule","title":"whiskerRule","summary":"Box plot: `tukey` (1.5 × IQR, the default), `min-max` (no outliers), or a number of IQRs.","kind":"option","group":"specific","member":{"name":"whiskerRule","attribute":"whisker-rule","type":"string","kind":"string","values":[],"default":"undefined","description":"Box plot: `tukey` (1.5 × IQR, the default), `min-max` (no outliers), or a number of IQRs."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerRule`"],["HTML attribute","`whisker-rule`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-whiskerRule","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/quantileMethod","title":"quantileMethod","summary":"Box plot (): the quantile method — `linear` (R-7, the default), `exclusive` (R-6), `nearest`, `lower`, `higher`, `midpoint`.","kind":"option","group":"specific","member":{"name":"quantileMethod","attribute":"quantile-method","type":"string","kind":"string","values":[],"default":"undefined","description":"Box plot (): the quantile method — `linear` (R-7, the default), `exclusive` (R-6), `nearest`, `lower`, `higher`, `midpoint`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`quantileMethod`"],["HTML attribute","`quantile-method`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-quantileMethod","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/whiskerPercentile","title":"whiskerPercentile","summary":"Box plot (): the `percentile` whisker rule's p (0 … 50, default 5).","kind":"option","group":"specific","member":{"name":"whiskerPercentile","attribute":"whisker-percentile","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): the `percentile` whisker rule's p (0 … 50, default 5)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerPercentile`"],["HTML attribute","`whisker-percentile`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-whiskerPercentile","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/notched","title":"notched","summary":"Box plot (): the stepped notch (median ± 1.57 × IQR / √n).","kind":"option","group":"specific","member":{"name":"notched","attribute":"notched","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Box plot (): the stepped notch (median ± 1.57 × IQR / √n)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`notched`"],["HTML attribute","`notched`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-notched","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/showMean","title":"showMean","summary":"Box plot (): the mean marker — a small square in `mean-color` (`auto` = the median colour).","kind":"option","group":"specific","member":{"name":"showMean","attribute":"show-mean","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Box plot (): the mean marker — a small square in `mean-color` (`auto` = the median colour)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showMean`"],["HTML attribute","`show-mean`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-showMean","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/meanColor","title":"meanColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"meanColor","attribute":"mean-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`meanColor`"],["HTML attribute","`mean-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-meanColor","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/capWidth","title":"capWidth","summary":"Box plot (): The whisker caps' share of the box (0 hides them).","kind":"option","group":"specific","member":{"name":"capWidth","attribute":"cap-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The whisker caps' share of the box (0 hides them)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`capWidth`"],["HTML attribute","`cap-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-capWidth","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-capWidth","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/whiskerWidth","title":"whiskerWidth","summary":"Box plot (): The whisker / border thickness in CSS px.","kind":"option","group":"specific","member":{"name":"whiskerWidth","attribute":"whisker-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The whisker / border thickness in CSS px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerWidth`"],["HTML attribute","`whisker-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-whiskerWidth","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-whiskerWidth","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/medianWidth","title":"medianWidth","summary":"Box plot (): The median line thickness in CSS px.","kind":"option","group":"specific","member":{"name":"medianWidth","attribute":"median-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The median line thickness in CSS px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`medianWidth`"],["HTML attribute","`median-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-medianWidth","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/outlierRadius","title":"outlierRadius","summary":"Box plot (): The outlier disc radius in CSS px.","kind":"option","group":"specific","member":{"name":"outlierRadius","attribute":"outlier-radius","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The outlier disc radius in CSS px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`outlierRadius`"],["HTML attribute","`outlier-radius`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-outlierRadius","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/boxMinPx","title":"boxMinPx","summary":"Box plot (): The narrowest box in CSS px.","kind":"option","group":"specific","member":{"name":"boxMinPx","attribute":"box-min-px","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The narrowest box in CSS px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxMinPx`"],["HTML attribute","`box-min-px`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-boxMinPx","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/boxMaxPx","title":"boxMaxPx","summary":"Box plot (): The widest box in CSS px.","kind":"option","group":"specific","member":{"name":"boxMaxPx","attribute":"box-max-px","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The widest box in CSS px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxMaxPx`"],["HTML attribute","`box-max-px`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-boxMaxPx","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/notchWidth","title":"notchWidth","summary":"Box plot (): The notch's share of the box width (notched).","kind":"option","group":"specific","member":{"name":"notchWidth","attribute":"notch-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The notch's share of the box width (notched)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`notchWidth`"],["HTML attribute","`notch-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-notchWidth","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/meanSize","title":"meanSize","summary":"Box plot (): The mean marker size in CSS px (show-mean).","kind":"option","group":"specific","member":{"name":"meanSize","attribute":"mean-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Box plot (): The mean marker size in CSS px (show-mean)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`meanSize`"],["HTML attribute","`mean-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/box-plot#property-meanSize","title":"sy-box-plot-chart","description":""}]}]}]},{"path":"/docs/options/fillAlpha","title":"fillAlpha","summary":"The fill opacity of a bubble (the border stays opaque).","kind":"option","group":"appearance","member":{"name":"fillAlpha","attribute":"fill-alpha","type":"number","kind":"number","values":[],"default":"undefined","description":"The fill opacity of a bubble (the border stays opaque)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillAlpha`"],["HTML attribute","`fill-alpha`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-fillAlpha","title":"sy-bubble-chart","description":""},{"path":"/docs/components/candlestick#property-fillAlpha","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-fillAlpha","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/minRadius","title":"minRadius","summary":"The radius range in CSS px the z range maps onto.","kind":"option","group":"specific","member":{"name":"minRadius","attribute":"min-radius","type":"number","kind":"number","values":[],"default":"undefined","description":"The radius range in CSS px the z range maps onto."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minRadius`"],["HTML attribute","`min-radius`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-minRadius","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/maxRadius","title":"maxRadius","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"maxRadius","attribute":"max-radius","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`maxRadius`"],["HTML attribute","`max-radius`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-maxRadius","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/sizeScale","title":"sizeScale","summary":"`area` (the disc area proportional to z; the default) or `radius`.","kind":"option","group":"specific","member":{"name":"sizeScale","attribute":"size-scale","type":"string","kind":"string","values":[],"default":"undefined","description":"`area` (the disc area proportional to z; the default) or `radius`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sizeScale`"],["HTML attribute","`size-scale`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-sizeScale","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/layout","title":"layout","summary":"Bubble: `xy` or `pack`. Network Graph: deterministic `circular`, `force`, or top-to-bottom `hierarchical` placement.","kind":"option","group":"specific","member":{"name":"layout","attribute":"layout","type":"string","kind":"string","values":[],"default":"undefined","description":"Bubble: `xy` or `pack`. Network Graph: deterministic `circular`, `force`, or top-to-bottom `hierarchical` placement."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`layout`"],["HTML attribute","`layout`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-network-graph and create the element before configuring it.\nchart.layout = \"circular\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/network-graph","title":"Network Graph · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-layout","title":"sy-bubble-chart","description":""},{"path":"/docs/components/network-graph#property-layout","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/clustering","title":"clustering","summary":"Network Graph: `none` or `louvain` community detection over the current graph; with the automatic palette, node colours follow the group. Independent of `layout`.","kind":"option","group":"specific","member":{"name":"clustering","attribute":"clustering","type":"string","kind":"string","values":[],"default":"undefined","description":"Network Graph: `none` or `louvain` community detection over the current graph; with the automatic palette, node colours follow the group. Independent of `layout`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`clustering`"],["HTML attribute","`clustering`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/network-graph#property-clustering","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/bundling","title":"bundling","summary":"Network Graph: `none` or `force` edge bundling of the connecting lines toward compatible neighbours; `bundle-strength` 0 … 1 scales the attraction (default 0.5).","kind":"option","group":"specific","member":{"name":"bundling","attribute":"bundling","type":"string","kind":"string","values":[],"default":"undefined","description":"Network Graph: `none` or `force` edge bundling of the connecting lines toward compatible neighbours; `bundle-strength` 0 … 1 scales the attraction (default 0.5)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bundling`"],["HTML attribute","`bundling`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/network-graph#property-bundling","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/bundleStrength","title":"bundleStrength","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"bundleStrength","attribute":"bundle-strength","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bundleStrength`"],["HTML attribute","`bundle-strength`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/network-graph#property-bundleStrength","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/nodeDrag","title":"nodeDrag","summary":"Network Graph — nodes can be dragged with a pointer and nudged with Ctrl / ⌘ + arrows; a dragged node stays pinned. `node-drag=\"false\"` turns it off.","kind":"option","group":"specific","member":{"name":"nodeDrag","attribute":"node-drag","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Network Graph — nodes can be dragged with a pointer and nudged with Ctrl / ⌘ + arrows; a dragged node stays pinned. `node-drag=\"false\"` turns it off."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeDrag`"],["HTML attribute","`node-drag`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/network-graph#property-nodeDrag","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/packPadding","title":"packPadding","summary":"Bubble pack gap in CSS px, and `contain` (shrink only) or `fill` fitting.","kind":"option","group":"specific","member":{"name":"packPadding","attribute":"pack-padding","type":"number","kind":"number","values":[],"default":"undefined","description":"Bubble pack gap in CSS px, and `contain` (shrink only) or `fill` fitting."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`packPadding`"],["HTML attribute","`pack-padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-packPadding","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/packFit","title":"packFit","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"packFit","attribute":"pack-fit","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`packFit`"],["HTML attribute","`pack-fit`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-packFit","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/shading","title":"shading","summary":"the bubble shading: `flat` or `sphere` (a highlight and a darker rim), and its strength 0 … 1.","kind":"option","group":"specific","member":{"name":"shading","attribute":"shading","type":"string","kind":"string","values":[],"default":"undefined","description":"the bubble shading: `flat` or `sphere` (a highlight and a darker rim), and its strength 0 … 1."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shading`"],["HTML attribute","`shading`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-shading","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/shadeStrength","title":"shadeStrength","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"shadeStrength","attribute":"shade-strength","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shadeStrength`"],["HTML attribute","`shade-strength`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-shadeStrength","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/totalColor","title":"totalColor","summary":"Waterfall: the subtotal / total bars' colour, the connectors' colour and thickness, their switch.","kind":"option","group":"specific","member":{"name":"totalColor","attribute":"total-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Waterfall: the subtotal / total bars' colour, the connectors' colour and thickness, their switch."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`totalColor`"],["HTML attribute","`total-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-totalColor","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/connectorColor","title":"connectorColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"connectorColor","attribute":"connector-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectorColor`"],["HTML attribute","`connector-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-connectorColor","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/connectorWidth","title":"connectorWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"connectorWidth","attribute":"connector-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectorWidth`"],["HTML attribute","`connector-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-connectorWidth","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/showConnectors","title":"showConnectors","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"showConnectors","attribute":"show-connectors","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showConnectors`"],["HTML attribute","`show-connectors`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-showConnectors","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/barWidth","title":"barWidth","summary":"Waterfall: the bar's share of the slot pitch (0.6), clamped between bar-min-px and bar-max-px.","kind":"option","group":"specific","member":{"name":"barWidth","attribute":"bar-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Waterfall: the bar's share of the slot pitch (0.6), clamped between bar-min-px and bar-max-px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barWidth`"],["HTML attribute","`bar-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-barWidth","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/error-bar#property-barWidth","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/bar-3d#property-barWidth","title":"sy-bar-3d","description":""}]}]}]},{"path":"/docs/options/barMinPx","title":"barMinPx","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"barMinPx","attribute":"bar-min-px","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barMinPx`"],["HTML attribute","`bar-min-px`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-barMinPx","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/error-bar#property-barMinPx","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/barMaxPx","title":"barMaxPx","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"barMaxPx","attribute":"bar-max-px","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barMaxPx`"],["HTML attribute","`bar-max-px`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-barMaxPx","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/error-bar#property-barMaxPx","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/showTotal","title":"showTotal","summary":"Waterfall (): append the auto grand total after the last step (unless it already is a total), named `total-label`.","kind":"option","group":"specific","member":{"name":"showTotal","attribute":"show-total","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Waterfall (): append the auto grand total after the last step (unless it already is a total), named `total-label`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showTotal`"],["HTML attribute","`show-total`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-showTotal","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/totalLabel","title":"totalLabel","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"totalLabel","attribute":"total-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`totalLabel`"],["HTML attribute","`total-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-totalLabel","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/detectResult","title":"detectResult","summary":"Waterfall: recognise a last step given as a plain value equal to the running total as the result bar (default on).","kind":"option","group":"specific","member":{"name":"detectResult","attribute":"detect-result","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Waterfall: recognise a last step given as a plain value equal to the running total as the result bar (default on)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`detectResult`"],["HTML attribute","`detect-result`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-detectResult","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/lastResult","title":"lastResult","summary":"Waterfall: true makes the last merged step a result using the preceding running total and total-color; false disables auto detection; omitted uses detect-result. Explicit datum kinds remain effective when false.","kind":"option","group":"specific","member":{"name":"lastResult","attribute":"last-result","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Waterfall: true makes the last merged step a result using the preceding running total and total-color; false disables auto detection; omitted uses detect-result. Explicit datum kinds remain effective when false."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lastResult`"],["HTML attribute","`last-result`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-lastResult","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/labelMode","title":"labelMode","summary":"Waterfall (): the value labels' mode — value / running / both (`show-labels` switches them on); `labelFormat(bar)` replaces the text.","kind":"option","group":"appearance","member":{"name":"labelMode","attribute":"label-mode","type":"string","kind":"string","values":[],"default":"undefined","description":"Waterfall (): the value labels' mode — value / running / both (`show-labels` switches them on); `labelFormat(bar)` replaces the text."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelMode`"],["HTML attribute","`label-mode`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-labelMode","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/labelFormat","title":"labelFormat","summary":"Pass as a JavaScript property. type: (bar: unknown) => string.","kind":"option","group":"appearance","member":{"name":"labelFormat","attribute":"label-format","type":"(bar: unknown) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (bar: unknown) => string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(bar: unknown) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/waterfall#property-labelFormat","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/options/errorColor","title":"errorColor","summary":"Error bar: the whisker + cap colour; bar mode (a column from zero); the caps' switch.","kind":"option","group":"layout","member":{"name":"errorColor","attribute":"error-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Error bar: the whisker + cap colour; bar mode (a column from zero); the caps' switch."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`errorColor`"],["HTML attribute","`error-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/error-bar#property-errorColor","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/nodeRadius","title":"nodeRadius","summary":"Network Graph: circle marker radius and connection width in CSS px.","kind":"option","group":"specific","member":{"name":"nodeRadius","attribute":"node-radius","type":"number","kind":"number","values":[],"default":"undefined","description":"Network Graph: circle marker radius and connection width in CSS px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeRadius`"],["HTML attribute","`node-radius`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dendrogram#property-nodeRadius","title":"sy-dendrogram","description":""},{"path":"/docs/components/network-graph#property-nodeRadius","title":"sy-network-graph","description":""},{"path":"/docs/components/geo-map#property-nodeRadius","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/projection","title":"projection","summary":"Geo Map: identity keeps the coordinate frame; mercator selects spherical Mercator.","kind":"option","group":"specific","member":{"name":"projection","attribute":"projection","type":"GeoMapProjection","kind":"property","values":["identity","mercator","equirectangular","albers","orthographic"],"default":"undefined","description":"Geo Map: identity keeps the coordinate frame; mercator selects spherical Mercator."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`projection`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapProjection`"],["Default","`undefined`"],["Literals in the type","`identity`, `mercator`, `equirectangular`, `albers`, `orthographic`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-geo-map and create the element before configuring it.\nchart.projection = \"mercator\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/geo-map","title":"Geo Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-projection","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-projection","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/options/features","title":"features","summary":"Geo Map: polygon FeatureCollection below the point layer.","kind":"option","group":"specific","member":{"name":"features","attribute":"features","type":"GeoMapFeatureCollection","kind":"property","values":[],"default":"undefined","description":"Geo Map: polygon FeatureCollection below the point layer."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`features`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapFeatureCollection`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-features","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/polygonColor","title":"polygonColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"polygonColor","attribute":"polygon-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`polygonColor`"],["HTML attribute","`polygon-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-polygonColor","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/polygonOpacity","title":"polygonOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"polygonOpacity","attribute":"polygon-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`polygonOpacity`"],["HTML attribute","`polygon-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-polygonOpacity","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/mapColorAxis","title":"mapColorAxis","summary":"Geo Map choropleth domain, feature property and palette.","kind":"option","group":"specific","member":{"name":"mapColorAxis","attribute":"map-color-axis","type":"GeoMapColorAxisInput","kind":"property","values":["auto"],"default":"undefined","description":"Geo Map choropleth domain, feature property and palette."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapColorAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapColorAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapColorAxisInput","title":"GeoMapColorAxisInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapColorAxis","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/mapBubble","title":"mapBubble","summary":"Value-scaled geographic point bubbles.","kind":"option","group":"specific","member":{"name":"mapBubble","attribute":"map-bubble","type":"GeoMapBubbleInput","kind":"property","values":[],"default":"undefined","description":"Value-scaled geographic point bubbles."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapBubble`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapBubbleInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapBubbleInput","title":"GeoMapBubbleInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapBubble","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/mapHeat","title":"mapHeat","summary":"Pass as a JavaScript property. type: GeoMapHeatInput.","kind":"option","group":"specific","member":{"name":"mapHeat","attribute":"map-heat","type":"GeoMapHeatInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GeoMapHeatInput."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapHeat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapHeatInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatInput","title":"GeoMapHeatInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapHeat","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/mapLayers","title":"mapLayers","summary":"Geo Map presentation masks; omitted layers remain visible.","kind":"option","group":"specific","member":{"name":"mapLayers","attribute":"map-layers","type":"GeoMapLayersInput","kind":"property","values":[],"default":"undefined","description":"Geo Map presentation masks; omitted layers remain visible."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapLayers`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapLayersInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayersInput","title":"GeoMapLayersInput","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapLayers","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-mapLayers","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/options/mapLegend","title":"mapLegend","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"mapLegend","attribute":"map-legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapLegend`"],["HTML attribute","`map-legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.mapLegend = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapLegend","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/featureLabels","title":"featureLabels","summary":"Geo Map: region/connection name visibility and optional numeric values.","kind":"option","group":"specific","member":{"name":"featureLabels","attribute":"feature-labels","type":"GeoMapLabelMode","kind":"string","values":["auto","show","hide"],"default":"undefined","description":"Geo Map: region/connection name visibility and optional numeric values."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`featureLabels`"],["HTML attribute","`feature-labels`"],["Type","`GeoMapLabelMode`"],["Default","`undefined`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-featureLabels","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/featureLabelValue","title":"featureLabelValue","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"featureLabelValue","attribute":"feature-label-value","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`featureLabelValue`"],["HTML attribute","`feature-label-value`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-featureLabelValue","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/featureTooltipFormat","title":"featureTooltipFormat","summary":"Geo Map: custom region/connection tooltip text from owned feature metadata.","kind":"option","group":"specific","member":{"name":"featureTooltipFormat","attribute":"feature-tooltip-format","type":"(detail:GeoMapFeatureHitDetail)=>string","kind":"property","values":[],"default":"undefined","description":"Geo Map: custom region/connection tooltip text from owned feature metadata."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`featureTooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail:GeoMapFeatureHitDetail)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-featureTooltipFormat","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/connectionWidth","title":"connectionWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"connectionWidth","attribute":"connection-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionWidth`"],["HTML attribute","`connection-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-connectionWidth","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/connectionColor","title":"connectionColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"connectionColor","attribute":"connection-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionColor`"],["HTML attribute","`connection-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-connectionColor","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/connectionOpacity","title":"connectionOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"connectionOpacity","attribute":"connection-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionOpacity`"],["HTML attribute","`connection-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-connectionOpacity","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/connectionPath","title":"connectionPath","summary":"Geo Map: great-circle arcs or flat-map straight routes; on globes, straight lifts the equirectangular route onto the surface.","kind":"option","group":"specific","member":{"name":"connectionPath","attribute":"connection-path","type":"GeoMapConnectionPath","kind":"string","values":["great-circle","straight"],"default":"'great-circle'","description":"Geo Map: great-circle arcs or flat-map straight routes; on globes, straight lifts the equirectangular route onto the surface."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionPath`"],["HTML attribute","`connection-path`"],["Type","`GeoMapConnectionPath`"],["Default","`'great-circle'`"],["Allowed values","`great-circle`, `straight`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapConnectionPath","title":"GeoMapConnectionPath","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.connectionPath = 'great-circle';","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-connectionPath","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/crosshairSnapDistance","title":"crosshairSnapDistance","summary":"Geo Map: point-center capture distance in CSS pixels when crosshair.snap is enabled.","kind":"option","group":"tooltip","member":{"name":"crosshairSnapDistance","attribute":"crosshair-snap-distance","type":"number","kind":"number","values":[],"default":"12","description":"Geo Map: point-center capture distance in CSS pixels when crosshair.snap is enabled."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairSnapDistance`"],["HTML attribute","`crosshair-snap-distance`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.crosshairSnapDistance = 12;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/theme-river#property-crosshairSnapDistance","title":"sy-theme-river","description":""},{"path":"/docs/components/geo-map#property-crosshairSnapDistance","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-crosshairSnapDistance","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#property-crosshairSnapDistance","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-crosshairSnapDistance","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-crosshairSnapDistance","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/options/mapRegion","title":"mapRegion","summary":"Geo Map: fit a continent in 2D, or face it on an orthographic globe.","kind":"option","group":"specific","member":{"name":"mapRegion","attribute":"map-region","type":"GeoMapRegion","kind":"string","values":["world","africa","asia","europe","north-america","south-america","oceania","antarctica"],"default":"undefined","description":"Geo Map: fit a continent in 2D, or face it on an orthographic globe."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapRegion`"],["HTML attribute","`map-region`"],["Type","`GeoMapRegion`"],["Default","`undefined`"],["Allowed values","`world`, `africa`, `asia`, `europe`, `north-america`, `south-america`, `oceania`, `antarctica`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapRegion","title":"GeoMapRegion","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-geo-map and create the element before configuring it.\nchart.mapRegion = \"asia\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/geo-map","title":"Geo Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapRegion","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-mapRegion","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/options/mapBackground","title":"mapBackground","summary":"Geo Map: bundled Natural Earth land/coastlines, or no background.","kind":"option","group":"specific","member":{"name":"mapBackground","attribute":"map-background","type":"GeoMapBackground","kind":"string","values":["none","natural-earth"],"default":"undefined","description":"Geo Map: bundled Natural Earth land/coastlines, or no background."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapBackground`"],["HTML attribute","`map-background`"],["Type","`GeoMapBackground`"],["Default","`undefined`"],["Allowed values","`none`, `natural-earth`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapBackground","title":"GeoMapBackground","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-geo-map and create the element before configuring it.\nchart.mapBackground = \"natural-earth\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/geo-map","title":"Geo Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapBackground","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-mapBackground","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/options/mapFixed","title":"mapFixed","summary":"Geo Map: lock geographic dragging inside the fixed map frame. Flat maps wrap longitude; Albers/Orthographic rotate. Zoom is separate. Default false.","kind":"option","group":"specific","member":{"name":"mapFixed","attribute":"map-fixed","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Geo Map: lock geographic dragging inside the fixed map frame. Flat maps wrap longitude; Albers/Orthographic rotate. Zoom is separate. Default false."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapFixed`"],["HTML attribute","`map-fixed`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/geo-map#property-mapFixed","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-mapFixed","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/options/linkWidth","title":"linkWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"linkWidth","attribute":"link-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkWidth`"],["HTML attribute","`link-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dendrogram#property-linkWidth","title":"sy-dendrogram","description":""},{"path":"/docs/components/network-graph#property-linkWidth","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/linkDistance","title":"linkDistance","summary":"Network Graph force layout: spring rest distance in CSS px (default 80).","kind":"option","group":"specific","member":{"name":"linkDistance","attribute":"link-distance","type":"number","kind":"number","values":[],"default":"undefined","description":"Network Graph force layout: spring rest distance in CSS px (default 80)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkDistance`"],["HTML attribute","`link-distance`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/network-graph#property-linkDistance","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/repulsion","title":"repulsion","summary":"Network Graph force layout: non-negative node repulsion strength (default 2400).","kind":"option","group":"specific","member":{"name":"repulsion","attribute":"repulsion","type":"number","kind":"number","values":[],"default":"undefined","description":"Network Graph force layout: non-negative node repulsion strength (default 2400)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`repulsion`"],["HTML attribute","`repulsion`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/network-graph#property-repulsion","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/padAngle","title":"padAngle","summary":"Chord: the gap between neighbouring node arcs in degrees (default 2).","kind":"option","group":"specific","member":{"name":"padAngle","attribute":"pad-angle","type":"number","kind":"number","values":[],"default":"undefined","description":"Chord: the gap between neighbouring node arcs in degrees (default 2)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padAngle`"],["HTML attribute","`pad-angle`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/chord#property-padAngle","title":"sy-chord","description":""}]}]}]},{"path":"/docs/options/nodeWidth","title":"nodeWidth","summary":"The nodes' width and the gap between stacked nodes (CSS px).","kind":"option","group":"specific","member":{"name":"nodeWidth","attribute":"node-width","type":"number","kind":"number","values":[],"default":"undefined","description":"The nodes' width and the gap between stacked nodes (CSS px)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeWidth`"],["HTML attribute","`node-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/sankey#property-nodeWidth","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-nodeWidth","title":"sy-chord","description":""}]}]}]},{"path":"/docs/options/nodePadding","title":"nodePadding","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"nodePadding","attribute":"node-padding","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodePadding`"],["HTML attribute","`node-padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/sankey#property-nodePadding","title":"sy-sankey","description":""}]}]}]},{"path":"/docs/options/nodeAlign","title":"nodeAlign","summary":"Where a node without a forward path stands: justify / left / right / center.","kind":"option","group":"specific","member":{"name":"nodeAlign","attribute":"node-align","type":"SankeyAlign","kind":"string","values":["left","right","center","justify"],"default":"undefined","description":"Where a node without a forward path stands: justify / left / right / center."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeAlign`"],["HTML attribute","`node-align`"],["Type","`SankeyAlign`"],["Default","`undefined`"],["Allowed values","`left`, `right`, `center`, `justify`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SankeyAlign","title":"SankeyAlign","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-sankey and create the element before configuring it.\nchart.nodeAlign = \"justify\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/sankey","title":"Sankey · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/sankey#property-nodeAlign","title":"sy-sankey","description":""}]}]}]},{"path":"/docs/options/linkColor","title":"linkColor","summary":"The ribbons' colour (source / target / a CSS colour) and opacity.","kind":"option","group":"specific","member":{"name":"linkColor","attribute":"link-color","type":"string","kind":"string","values":[],"default":"undefined","description":"The ribbons' colour (source / target / a CSS colour) and opacity."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkColor`"],["HTML attribute","`link-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/sankey#property-linkColor","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-linkColor","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-linkColor","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/linkOpacity","title":"linkOpacity","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"linkOpacity","attribute":"link-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkOpacity`"],["HTML attribute","`link-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dendrogram#property-linkOpacity","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-linkOpacity","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-linkOpacity","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-linkOpacity","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/layoutIterations","title":"layoutIterations","summary":"Sankey relaxation passes (default 6) or Network Graph force steps (default 200). Zero keeps the initial placement.","kind":"option","group":"specific","member":{"name":"layoutIterations","attribute":"layout-iterations","type":"number","kind":"number","values":[],"default":"undefined","description":"Sankey relaxation passes (default 6) or Network Graph force steps (default 200). Zero keeps the initial placement."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`layoutIterations`"],["HTML attribute","`layout-iterations`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/sankey#property-layoutIterations","title":"sy-sankey","description":""},{"path":"/docs/components/network-graph#property-layoutIterations","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/linkCurvature","title":"linkCurvature","summary":"the ribbons' centre line: 0 straight … 1 the full S-curve.","kind":"option","group":"specific","member":{"name":"linkCurvature","attribute":"link-curvature","type":"number","kind":"number","values":[],"default":"undefined","description":"the ribbons' centre line: 0 straight … 1 the full S-curve."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkCurvature`"],["HTML attribute","`link-curvature`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/sankey#property-linkCurvature","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-linkCurvature","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-linkCurvature","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/nodeLabels","title":"nodeLabels","summary":"the node labels (auto / show / hide) and the throughput suffix.","kind":"option","group":"specific","member":{"name":"nodeLabels","attribute":"node-labels","type":"SankeyLabelMode","kind":"string","values":["auto","show","hide"],"default":"undefined","description":"the node labels (auto / show / hide) and the throughput suffix."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`SankeyLabelMode`"],["Default","`undefined`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SankeyLabelMode","title":"SankeyLabelMode","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-chord and create the element before configuring it.\nchart.nodeLabels = \"show\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/chord","title":"Chord · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/treemap#property-nodeLabels","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-nodeLabels","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-nodeLabels","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-nodeLabels","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-nodeLabels","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-nodeLabels","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-nodeLabels","title":"sy-network-graph","description":""},{"path":"/docs/components/geo-map#property-nodeLabels","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/nodeLabelValue","title":"nodeLabelValue","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/treemap#property-nodeLabelValue","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-nodeLabelValue","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-nodeLabelValue","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-nodeLabelValue","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-nodeLabelValue","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-nodeLabelValue","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-nodeLabelValue","title":"sy-network-graph","description":""},{"path":"/docs/components/geo-map#property-nodeLabelValue","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/options/neighbourDim","title":"neighbourDim","summary":"with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (1 = no dim).","kind":"option","group":"specific","member":{"name":"neighbourDim","attribute":"neighbour-dim","type":"number","kind":"number","values":[],"default":"undefined","description":"with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (1 = no dim)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neighbourDim`"],["HTML attribute","`neighbour-dim`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/sankey#property-neighbourDim","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-neighbourDim","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-neighbourDim","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/options/showBars","title":"showBars","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"showBars","attribute":"show-bars","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showBars`"],["HTML attribute","`show-bars`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/error-bar#property-showBars","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/showCaps","title":"showCaps","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"showCaps","attribute":"show-caps","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showCaps`"],["HTML attribute","`show-caps`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/error-bar#property-showCaps","title":"sy-error-bar-chart","description":""}]}]}]},{"path":"/docs/options/samples","title":"samples","summary":"Spectrogram (): raw samples (a property) — the FFT pipeline frames them; ignored while `data` is set.","kind":"option","group":"specific","member":{"name":"samples","attribute":"samples","type":"ArrayLike<number>","kind":"property","values":[],"default":"undefined","description":"Spectrogram (): raw samples (a property) — the FFT pipeline frames them; ignored while `data` is set."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`samples`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ArrayLike<number>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-samples","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/fftSize","title":"fftSize","summary":"Spectrogram (): the FFT size, a power of two (default 1,024).","kind":"option","group":"specific","member":{"name":"fftSize","attribute":"fft-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Spectrogram (): the FFT size, a power of two (default 1,024)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fftSize`"],["HTML attribute","`fft-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-fftSize","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/fftHop","title":"fftHop","summary":"Spectrogram (): samples between frame starts (default fft-size / 2).","kind":"option","group":"specific","member":{"name":"fftHop","attribute":"fft-hop","type":"number","kind":"number","values":[],"default":"undefined","description":"Spectrogram (): samples between frame starts (default fft-size / 2)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fftHop`"],["HTML attribute","`fft-hop`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-fftHop","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/fftWindow","title":"fftWindow","summary":"Spectrogram (): the analysis window — `hann`, `hamming`, `blackman`, `rect`.","kind":"option","group":"specific","member":{"name":"fftWindow","attribute":"fft-window","type":"SpectrogramWindowKind","kind":"string","values":["rect","hann","hamming","blackman"],"default":"undefined","description":"Spectrogram (): the analysis window — `hann`, `hamming`, `blackman`, `rect`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fftWindow`"],["HTML attribute","`fft-window`"],["Type","`SpectrogramWindowKind`"],["Default","`undefined`"],["Allowed values","`rect`, `hann`, `hamming`, `blackman`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramWindowKind","title":"SpectrogramWindowKind","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/spectrogram#property-fftWindow","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/renderPath","title":"renderPath","summary":"Heatmap (): the draw path — `auto` / `plane` / `cells`. `border-radius` / `border-width` / `border-color` style the cells.","kind":"option","group":"animation","member":{"name":"renderPath","attribute":"render-path","type":"HeatmapRenderPath","kind":"string","values":["auto","plane","cells"],"default":"undefined","description":"Heatmap (): the draw path — `auto` / `plane` / `cells`. `border-radius` / `border-width` / `border-color` style the cells."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`renderPath`"],["HTML attribute","`render-path`"],["Type","`HeatmapRenderPath`"],["Default","`undefined`"],["Allowed values","`auto`, `plane`, `cells`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapRenderPath","title":"HeatmapRenderPath","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/heatmap#property-renderPath","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-renderPath","title":"sy-calendar-heatmap","description":""}]}]}]},{"path":"/docs/options/lod","title":"lod","summary":"Heatmap (): the plane path's level of detail — `auto` / `point` / `area`.","kind":"option","group":"animation","member":{"name":"lod","attribute":"lod","type":"HeatmapLodMode","kind":"string","values":["auto","point","area","smooth"],"default":"undefined","description":"Heatmap (): the plane path's level of detail — `auto` / `point` / `area`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lod`"],["HTML attribute","`lod`"],["Type","`HeatmapLodMode`"],["Default","`undefined`"],["Allowed values","`auto`, `point`, `area`, `smooth`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapLodMode","title":"HeatmapLodMode","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/heatmap#property-lod","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-lod","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-lod","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-lod","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/areaReduce","title":"areaReduce","summary":"Heatmap / spectrogram (): how the area LOD folds the cells a pixel covers — `mean` (the heatmap default) or `max` (the spectrogram default, peak-hold).","kind":"option","group":"animation","member":{"name":"areaReduce","attribute":"area-reduce","type":"'mean' | 'max'","kind":"string","values":["max","mean"],"default":"undefined","description":"Heatmap / spectrogram (): how the area LOD folds the cells a pixel covers — `mean` (the heatmap default) or `max` (the spectrogram default, peak-hold)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`areaReduce`"],["HTML attribute","`area-reduce`"],["Type","`'mean' | 'max'`"],["Default","`undefined`"],["Allowed values","`max`, `mean`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/heatmap#property-areaReduce","title":"sy-heatmap","description":""},{"path":"/docs/components/spectrogram#property-areaReduce","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/options/stemUnit","title":"stemUnit","summary":"Stem-leaf: stem unit — one stem spans this much (default 10).","kind":"option","group":"specific","member":{"name":"stemUnit","attribute":"stem-unit","type":"number","kind":"number","values":[],"default":"undefined","description":"Stem-leaf: stem unit — one stem spans this much (default 10)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stemUnit`"],["HTML attribute","`stem-unit`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/stemSplit","title":"stemSplit","summary":"Stem-leaf: 1 (default) or 2 — each stem splits into 0–4 / 5–9 half-rows.","kind":"option","group":"specific","member":{"name":"stemSplit","attribute":"stem-split","type":"1 | 2","kind":"number","values":[],"default":"undefined","description":"Stem-leaf: 1 (default) or 2 — each stem splits into 0–4 / 5–9 half-rows."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stemSplit`"],["HTML attribute","`stem-split`"],["Type","`1 | 2`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/activeColor","title":"activeColor","summary":"Stem-leaf: accent for the hovered/focused leaf.","kind":"option","group":"specific","member":{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Stem-leaf: accent for the hovered/focused leaf."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-activeColor","title":"sy-bubble-chart","description":""},{"path":"/docs/components/waterfall#property-activeColor","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#property-activeColor","title":"sy-histogram-chart","description":""},{"path":"/docs/components/error-bar#property-activeColor","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#property-activeColor","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/treemap#property-activeColor","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-activeColor","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-activeColor","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-activeColor","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-activeColor","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-activeColor","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-activeColor","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-activeColor","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-activeColor","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-activeColor","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-activeColor","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#property-activeColor","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-activeColor","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-activeColor","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-activeColor","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/showKey","title":"showKey","summary":"Stem-leaf: show the reading key (`2 | 3 = 23`) under the plot.","kind":"option","group":"specific","member":{"name":"showKey","attribute":"show-key","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Stem-leaf: show the reading key (`2 | 3 = 23`) under the plot."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showKey`"],["HTML attribute","`show-key`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/stem-leaf#property-showKey","title":"sy-stem-leaf-chart","description":""}]}]}]},{"path":"/docs/options/bins","title":"bins","summary":"Histogram: bin rule — `square-root` (default) / `sturges` / `rice` / literal count.","kind":"option","group":"specific","member":{"name":"bins","attribute":"bins","type":"HistogramBinsRule","kind":"property","values":["square-root","sturges","rice","scott","freedman-diaconis"],"default":"undefined","description":"Histogram: bin rule — `square-root` (default) / `sturges` / `rice` / literal count."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bins`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HistogramBinsRule`"],["Default","`undefined`"],["Literals in the type","`square-root`, `sturges`, `rice`, `scott`, `freedman-diaconis`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HistogramBinsRule","title":"HistogramBinsRule","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-histogram-chart and create the element before configuring it.\nchart.bins = 6;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/histogram","title":"Histogram · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-bins","title":"sy-histogram-chart","description":""}]}]}]},{"path":"/docs/options/measure","title":"measure","summary":"Histogram (): what a bar's height means — count / percent / density.","kind":"option","group":"specific","member":{"name":"measure","attribute":"measure","type":"'count' | 'percent' | 'density'","kind":"string","values":["percent","count","density"],"default":"undefined","description":"Histogram (): what a bar's height means — count / percent / density."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`measure`"],["HTML attribute","`measure`"],["Type","`'count' | 'percent' | 'density'`"],["Default","`undefined`"],["Allowed values","`percent`, `count`, `density`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-histogram-chart and create the element before configuring it.\nchart.measure = \"count\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/histogram","title":"Histogram · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-measure","title":"sy-histogram-chart","description":""}]}]}]},{"path":"/docs/options/cumulative","title":"cumulative","summary":"Histogram (): running sums (the empirical CDF for density).","kind":"option","group":"specific","member":{"name":"cumulative","attribute":"cumulative","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Histogram (): running sums (the empirical CDF for density)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cumulative`"],["HTML attribute","`cumulative`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-cumulative","title":"sy-histogram-chart","description":""}]}]}]},{"path":"/docs/options/barGap","title":"barGap","summary":"Histogram (): a CSS-px gap between the bars.","kind":"option","group":"specific","member":{"name":"barGap","attribute":"bar-gap","type":"number","kind":"number","values":[],"default":"undefined","description":"Histogram (): a CSS-px gap between the bars."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barGap`"],["HTML attribute","`bar-gap`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-barGap","title":"sy-histogram-chart","description":""}]}]}]},{"path":"/docs/options/binWidth","title":"binWidth","summary":"Histogram: explicit bin width — wins over `bins`.","kind":"option","group":"specific","member":{"name":"binWidth","attribute":"bin-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Histogram: explicit bin width — wins over `bins`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`binWidth`"],["HTML attribute","`bin-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-binWidth","title":"sy-histogram-chart","description":""}]}]}]},{"path":"/docs/options/domainMin","title":"domainMin","summary":"Histogram: domain overrides (outside observations clamp into the edge bins).","kind":"option","group":"specific","member":{"name":"domainMin","attribute":"domain-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Histogram: domain overrides (outside observations clamp into the edge bins)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`domainMin`"],["HTML attribute","`domain-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-domainMin","title":"sy-histogram-chart","description":""}]}]}]},{"path":"/docs/options/domainMax","title":"domainMax","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"domainMax","attribute":"domain-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`domainMax`"],["HTML attribute","`domain-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-domainMax","title":"sy-histogram-chart","description":""}]}]}]},{"path":"/docs/options/edgeColor","title":"edgeColor","summary":"Histogram: 1px separator between gapless bars.","kind":"option","group":"specific","member":{"name":"edgeColor","attribute":"edge-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Histogram: 1px separator between gapless bars."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeColor`"],["HTML attribute","`edge-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/histogram#property-edgeColor","title":"sy-histogram-chart","description":""},{"path":"/docs/components/wafer-map#property-edgeColor","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/diameter","title":"diameter","summary":"Wafer map: wafer diameter in mm.","kind":"option","group":"specific","member":{"name":"diameter","attribute":"diameter","type":"number","kind":"number","values":[],"default":"undefined","description":"Wafer map: wafer diameter in mm."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`diameter`"],["HTML attribute","`diameter`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-wafer-map and create the element before configuring it.\nchart.diameter = 150;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/wafer-map","title":"Wafer Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-diameter","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-diameter","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-diameter","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-diameter","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/edgeExclusion","title":"edgeExclusion","summary":"Wafer map: unusable edge band in mm.","kind":"option","group":"specific","member":{"name":"edgeExclusion","attribute":"edge-exclusion","type":"number","kind":"number","values":[],"default":"undefined","description":"Wafer map: unusable edge band in mm."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeExclusion`"],["HTML attribute","`edge-exclusion`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-edgeExclusion","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-edgeExclusion","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-edgeExclusion","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-edgeExclusion","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/indicator","title":"indicator","summary":"Wafer map: orientation-mark kind (`notch` / `flat` / `none`).","kind":"option","group":"specific","member":{"name":"indicator","attribute":"indicator","type":"WaferIndicator","kind":"string","values":["none","flat","notch"],"default":"undefined","description":"Wafer map: orientation-mark kind (`notch` / `flat` / `none`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`indicator`"],["HTML attribute","`indicator`"],["Type","`WaferIndicator`"],["Default","`undefined`"],["Allowed values","`none`, `flat`, `notch`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferIndicator","title":"WaferIndicator","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-indicator","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-indicator","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-indicator","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-indicator","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/waferOrientation","title":"waferOrientation","summary":"Wafer map: where the orientation mark points.","kind":"option","group":"specific","member":{"name":"waferOrientation","attribute":"wafer-orientation","type":"WaferOrientation","kind":"string","values":["left","right","down","up"],"default":"undefined","description":"Wafer map: where the orientation mark points."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`waferOrientation`"],["HTML attribute","`wafer-orientation`"],["Type","`WaferOrientation`"],["Default","`undefined`"],["Allowed values","`left`, `right`, `down`, `up`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferOrientation","title":"WaferOrientation","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/dieWidth","title":"dieWidth","summary":"Wafer map: die size in mm.","kind":"option","group":"specific","member":{"name":"dieWidth","attribute":"die-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Wafer map: die size in mm."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieWidth`"],["HTML attribute","`die-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-wafer-map and create the element before configuring it.\nchart.dieWidth = 10;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/wafer-map","title":"Wafer Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-dieWidth","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-dieWidth","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-dieWidth","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-dieWidth","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/dieHeight","title":"dieHeight","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"dieHeight","attribute":"die-height","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieHeight`"],["HTML attribute","`die-height`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-wafer-map and create the element before configuring it.\nchart.dieHeight = 10;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/wafer-map","title":"Wafer Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-dieHeight","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-dieHeight","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-dieHeight","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-dieHeight","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/scribeX","title":"scribeX","summary":"Wafer map: scribe-street widths in mm.","kind":"option","group":"specific","member":{"name":"scribeX","attribute":"scribe-x","type":"number","kind":"number","values":[],"default":"undefined","description":"Wafer map: scribe-street widths in mm."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeX`"],["HTML attribute","`scribe-x`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-scribeX","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-scribeX","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-scribeX","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-scribeX","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/scribeY","title":"scribeY","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"scribeY","attribute":"scribe-y","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeY`"],["HTML attribute","`scribe-y`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-scribeY","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-scribeY","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-scribeY","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-scribeY","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/showPartial","title":"showPartial","summary":"Wafer map: draw edge (partial) dies.","kind":"option","group":"specific","member":{"name":"showPartial","attribute":"show-partial","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Wafer map: draw edge (partial) dies."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showPartial`"],["HTML attribute","`show-partial`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-showPartial","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-showPartial","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-showPartial","title":"sy-wafer-correlation","description":""}]}]}]},{"path":"/docs/options/dieIndexOrigin","title":"dieIndexOrigin","summary":"Wafer map: die-index convention (`top-left` bounding-box corner / `center` signed).","kind":"option","group":"specific","member":{"name":"dieIndexOrigin","attribute":"die-index-origin","type":"DieIndexOrigin","kind":"string","values":["top-left","center"],"default":"undefined","description":"Wafer map: die-index convention (`top-left` bounding-box corner / `center` signed)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieIndexOrigin`"],["HTML attribute","`die-index-origin`"],["Type","`DieIndexOrigin`"],["Default","`undefined`"],["Allowed values","`top-left`, `center`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DieIndexOrigin","title":"DieIndexOrigin","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-dieIndexOrigin","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/dieIndexBase","title":"dieIndexBase","summary":"Wafer map: first index value (0 or 1).","kind":"option","group":"specific","member":{"name":"dieIndexBase","attribute":"die-index-base","type":"number","kind":"number","values":[],"default":"undefined","description":"Wafer map: first index value (0 or 1)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieIndexBase`"],["HTML attribute","`die-index-base`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-dieIndexBase","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/showDieIndex","title":"showDieIndex","summary":"Wafer map: print `ix,iy` inside each die (auto-hides on small dies).","kind":"option","group":"specific","member":{"name":"showDieIndex","attribute":"show-die-index","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Wafer map: print `ix,iy` inside each die (auto-hides on small dies)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showDieIndex`"],["HTML attribute","`show-die-index`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-showDieIndex","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/mode","title":"mode","summary":"Wafer map: colouring mode (`grid` accent / `bin` categorical bin map).","kind":"option","group":"specific","member":{"name":"mode","attribute":"mode","type":"WaferMapMode","kind":"string","values":["value","grid","bin","binary"],"default":"undefined","description":"Wafer map: colouring mode (`grid` accent / `bin` categorical bin map)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mode`"],["HTML attribute","`mode`"],["Type","`WaferMapMode`"],["Default","`undefined`"],["Allowed values","`value`, `grid`, `bin`, `binary`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferMapMode","title":"WaferMapMode","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-wafer-map and create the element before configuring it.\nchart.mode = \"bin\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/wafer-map","title":"Wafer Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-mode","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/binColors","title":"binColors","summary":"Wafer map: explicit per-bin colours (`{ [bin]: colour }`, property).","kind":"option","group":"specific","member":{"name":"binColors","attribute":"bin-colors","type":"Readonly<Record<string, string>>","kind":"property","values":[],"default":"undefined","description":"Wafer map: explicit per-bin colours (`{ [bin]: colour }`, property)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`binColors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Readonly<Record<string, string>>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-binColors","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/passBin","title":"passBin","summary":"Wafer map: the pass bin code (default 1).","kind":"option","group":"specific","member":{"name":"passBin","attribute":"pass-bin","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Wafer map: the pass bin code (default 1)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`passBin`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-wafer-map and create the element before configuring it.\nchart.passBin = 1;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/wafer-map","title":"Wafer Map · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-passBin","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-passBin","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-passBin","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-passBin","title":"sy-yield-zone-chart","description":""}]}]}]},{"path":"/docs/options/passColor","title":"passColor","summary":"Wafer map: pass-bin fill.","kind":"option","group":"specific","member":{"name":"passColor","attribute":"pass-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Wafer map: pass-bin fill."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`passColor`"],["HTML attribute","`pass-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-passColor","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/failColor","title":"failColor","summary":"Wafer map: fail fill for `mode=\"binary\"`.","kind":"option","group":"specific","member":{"name":"failColor","attribute":"fail-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Wafer map: fail fill for `mode=\"binary\"`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`failColor`"],["HTML attribute","`fail-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-failColor","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/showStats","title":"showStats","summary":"Wafer map: show the statistics line under the value legend.","kind":"option","group":"specific","member":{"name":"showStats","attribute":"show-stats","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Wafer map: show the statistics line under the value legend."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showStats`"],["HTML attribute","`show-stats`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-showStats","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-showStats","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-showStats","title":"sy-wafer-correlation","description":""}]}]}]},{"path":"/docs/options/overlay","title":"overlay","summary":"Wafer map: overlay layer (`none` / `defect`).","kind":"option","group":"specific","member":{"name":"overlay","attribute":"overlay","type":"'none' | 'defect'","kind":"string","values":["none","defect"],"default":"undefined","description":"Wafer map: overlay layer (`none` / `defect`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`overlay`"],["HTML attribute","`overlay`"],["Type","`'none' | 'defect'`"],["Default","`undefined`"],["Allowed values","`none`, `defect`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-overlay","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/defects","title":"defects","summary":"Wafer map: inspection defects (`{x, y, class?, size?}`, wafer mm, property).","kind":"option","group":"specific","member":{"name":"defects","attribute":"defects","type":"ReadonlyArray<{ x: number; y: number; class?: number | string; size?: number }>","kind":"property","values":[],"default":"undefined","description":"Wafer map: inspection defects (`{x, y, class?, size?}`, wafer mm, property)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`defects`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<{ x: number; y: number; class?: number | string; size?: number }>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-defects","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/defectColor","title":"defectColor","summary":"Wafer map: dot colour for unclassified defects.","kind":"option","group":"specific","member":{"name":"defectColor","attribute":"defect-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Wafer map: dot colour for unclassified defects."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`defectColor`"],["HTML attribute","`defect-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-defectColor","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/grid","title":"grid","summary":"Wafer map: grid chrome — `die` (scribe only) or `shot` (+ reticle boundaries).","kind":"option","group":"specific","member":{"name":"grid","attribute":"grid","type":"'die' | 'shot'","kind":"string","values":["die","shot"],"default":"undefined","description":"Wafer map: grid chrome — `die` (scribe only) or `shot` (+ reticle boundaries)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`grid`"],["HTML attribute","`grid`"],["Type","`'die' | 'shot'`"],["Default","`undefined`"],["Allowed values","`die`, `shot`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-grid","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/shotCols","title":"shotCols","summary":"Wafer map: dies per exposure shot.","kind":"option","group":"specific","member":{"name":"shotCols","attribute":"shot-cols","type":"number","kind":"number","values":[],"default":"undefined","description":"Wafer map: dies per exposure shot."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotCols`"],["HTML attribute","`shot-cols`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-shotCols","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/shotRows","title":"shotRows","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"shotRows","attribute":"shot-rows","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotRows`"],["HTML attribute","`shot-rows`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-shotRows","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/shotOffsetX","title":"shotOffsetX","summary":"Wafer map: shot-grid alignment shift in whole dies.","kind":"option","group":"specific","member":{"name":"shotOffsetX","attribute":"shot-offset-x","type":"number","kind":"number","values":[],"default":"undefined","description":"Wafer map: shot-grid alignment shift in whole dies."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotOffsetX`"],["HTML attribute","`shot-offset-x`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-shotOffsetX","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/shotOffsetY","title":"shotOffsetY","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"shotOffsetY","attribute":"shot-offset-y","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotOffsetY`"],["HTML attribute","`shot-offset-y`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-shotOffsetY","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/shotColor","title":"shotColor","summary":"Wafer map: shot boundary stroke.","kind":"option","group":"specific","member":{"name":"shotColor","attribute":"shot-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Wafer map: shot boundary stroke."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotColor`"],["HTML attribute","`shot-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-shotColor","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/binLegend","title":"binLegend","summary":"Wafer map: show the bin legend under the wafer.","kind":"option","group":"specific","member":{"name":"binLegend","attribute":"bin-legend","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Wafer map: show the bin legend under the wafer."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`binLegend`"],["HTML attribute","`bin-legend`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/wafer-map#property-binLegend","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/options/sectorPadding","title":"sectorPadding","summary":"Polar rose: fraction of each angular slot kept as whitespace, 0..0.8.","kind":"option","group":"specific","member":{"name":"sectorPadding","attribute":"sector-padding","type":"number","kind":"number","values":[],"default":"undefined","description":"Polar rose: fraction of each angular slot kept as whitespace, 0..0.8."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sectorPadding`"],["HTML attribute","`sector-padding`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-sectorPadding","title":"sy-polar-chart","description":""}]}]}]},{"path":"/docs/options/variableRadius","title":"variableRadius","summary":"Pie variable-radius mode — each datum's `z` drives the slice's outer radius (Highcharts variablepie).","kind":"option","group":"specific","member":{"name":"variableRadius","attribute":"variable-radius","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Pie variable-radius mode — each datum's `z` drives the slice's outer radius (Highcharts variablepie)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`variableRadius`"],["HTML attribute","`variable-radius`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-variableRadius","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/sizeBy","title":"sizeBy","summary":"Variable-radius z→radius mapping: `'area'` (default, radius ∝ √z̄) or `'radius'` (linear).","kind":"option","group":"specific","member":{"name":"sizeBy","attribute":"size-by","type":"PieChartSizeBy","kind":"string","values":["area","radius"],"default":"undefined","description":"Variable-radius z→radius mapping: `'area'` (default, radius ∝ √z̄) or `'radius'` (linear)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sizeBy`"],["HTML attribute","`size-by`"],["Type","`PieChartSizeBy`"],["Default","`undefined`"],["Allowed values","`area`, `radius`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartSizeBy","title":"PieChartSizeBy","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-sizeBy","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/zMin","title":"zMin","summary":"Variable-radius z-domain lower bound (defaults to the data minimum).","kind":"option","group":"specific","member":{"name":"zMin","attribute":"z-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Variable-radius z-domain lower bound (defaults to the data minimum)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zMin`"],["HTML attribute","`z-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-zMin","title":"sy-pie-chart","description":""},{"path":"/docs/components/bubble#property-zMin","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/zMax","title":"zMax","summary":"Variable-radius z-domain upper bound (defaults to the data maximum).","kind":"option","group":"specific","member":{"name":"zMax","attribute":"z-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Variable-radius z-domain upper bound (defaults to the data maximum)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zMax`"],["HTML attribute","`z-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-zMax","title":"sy-pie-chart","description":""},{"path":"/docs/components/bubble#property-zMax","title":"sy-bubble-chart","description":""}]}]}]},{"path":"/docs/options/minPointSize","title":"minPointSize","summary":"Smallest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts minPointSize).","kind":"option","group":"specific","member":{"name":"minPointSize","attribute":"min-point-size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Smallest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts minPointSize)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minPointSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-minPointSize","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/maxPointSize","title":"maxPointSize","summary":"Largest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts maxPointSize).","kind":"option","group":"specific","member":{"name":"maxPointSize","attribute":"max-point-size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Largest slice outer DIAMETER — px number or '%' of the full outer diameter (Highcharts maxPointSize)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`maxPointSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pie#property-maxPointSize","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/options/data","title":"data","summary":"Chart-specific data. Use the input structure for the chart, such as a tree, nodes and links, or OHLC records. Not every type in this union applies to every chart.","kind":"option","group":"data","member":{"name":"data","attribute":"data","type":"RadarChartData | FunnelChartData | ReadonlyArray<DumbbellDatum> | ReadonlyArray<DotPlotDatum> | ReadonlyArray<TornadoDatum> | ReadonlyArray<VariwideDatum> | ChordData | NetworkGraphData | TreemapData | SankeyData | ErrorBarData | WaterfallData | BubbleData | BoxPlotData | CandlestickData | CalendarHeatmapData | SpectrogramInput | DensityMapInput | HeatmapData | SunburstData | IcicleData | GanttData | ParallelCoordinatesData | DendrogramData | GeoMapData | Surface3DData | Scatter3DData | FlowLinesData | ThemeRiverData | Bar3DData","kind":"property","values":[],"default":"undefined","description":"Chart-specific data. Use the input structure for the chart, such as a tree, nodes and links, or OHLC records. Not every type in this union applies to every chart."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`RadarChartData | FunnelChartData | ReadonlyArray<DumbbellDatum> | ReadonlyArray<DotPlotDatum> | ReadonlyArray<TornadoDatum> | ReadonlyArray<VariwideDatum> | ChordData | NetworkGraphData | TreemapData | SankeyData | ErrorBarData | WaterfallData | BubbleData | BoxPlotData | CandlestickData | CalendarHeatmapData | SpectrogramInput | DensityMapInput | HeatmapData | SunburstData | IcicleData | GanttData | ParallelCoordinatesData | DendrogramData | GeoMapData | Surface3DData | Scatter3DData | FlowLinesData | ThemeRiverData | Bar3DData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/RadarChartData","title":"RadarChartData","description":"Type definition"},{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","description":"Type definition"},{"path":"/docs/types/DumbbellDatum","title":"DumbbellDatum","description":"Type definition"},{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","description":"Type definition"},{"path":"/docs/types/TornadoDatum","title":"TornadoDatum","description":"Type definition"},{"path":"/docs/types/VariwideDatum","title":"VariwideDatum","description":"Type definition"},{"path":"/docs/types/ChordData","title":"ChordData","description":"Type definition"},{"path":"/docs/types/NetworkGraphData","title":"NetworkGraphData","description":"Type definition"},{"path":"/docs/types/TreemapData","title":"TreemapData","description":"Type definition"},{"path":"/docs/types/SankeyData","title":"SankeyData","description":"Type definition"},{"path":"/docs/types/ErrorBarData","title":"ErrorBarData","description":"Type definition"},{"path":"/docs/types/WaterfallData","title":"WaterfallData","description":"Type definition"},{"path":"/docs/types/BubbleData","title":"BubbleData","description":"Type definition"},{"path":"/docs/types/BoxPlotData","title":"BoxPlotData","description":"Type definition"},{"path":"/docs/types/CandlestickData","title":"CandlestickData","description":"Type definition"},{"path":"/docs/types/CalendarHeatmapData","title":"CalendarHeatmapData","description":"Type definition"},{"path":"/docs/types/SpectrogramInput","title":"SpectrogramInput","description":"Type definition"},{"path":"/docs/types/DensityMapInput","title":"DensityMapInput","description":"Type definition"},{"path":"/docs/types/HeatmapData","title":"HeatmapData","description":"Type definition"},{"path":"/docs/types/SunburstData","title":"SunburstData","description":"Type definition"},{"path":"/docs/types/IcicleData","title":"IcicleData","description":"Type definition"},{"path":"/docs/types/GanttData","title":"GanttData","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesData","title":"ParallelCoordinatesData","description":"Type definition"},{"path":"/docs/types/DendrogramData","title":"DendrogramData","description":"Type definition"},{"path":"/docs/types/GeoMapData","title":"GeoMapData","description":"Type definition"},{"path":"/docs/types/Surface3DData","title":"Surface3DData","description":"Type definition"},{"path":"/docs/types/Scatter3DData","title":"Scatter3DData","description":"Type definition"},{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","description":"Type definition"},{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","description":"Type definition"},{"path":"/docs/types/Bar3DData","title":"Bar3DData","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-bubble-chart and create the element before configuring it.\nchart.data = [\n  {\n    \"x\": 20,\n    \"y\": 70,\n    \"z\": 30,\n    \"name\": \"A\"\n  },\n  {\n    \"x\": 45,\n    \"y\": 55,\n    \"z\": 60,\n    \"name\": \"B\"\n  },\n  {\n    \"x\": 75,\n    \"y\": 80,\n    \"z\": 45,\n    \"name\": \"C\"\n  },\n  {\n    \"x\": 60,\n    \"y\": 30,\n    \"z\": 20,\n    \"name\": \"D\"\n  }\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/bubble","title":"Bubble · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/bubble#property-data","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#property-data","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-data","title":"sy-radar-chart","description":""},{"path":"/docs/components/dumbbell#property-data","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-data","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-data","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-data","title":"sy-variwide-chart","description":""},{"path":"/docs/components/waterfall#property-data","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/box-plot#property-data","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#property-data","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#property-data","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#property-data","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#property-data","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#property-data","title":"sy-spectrogram","description":""},{"path":"/docs/components/funnel#property-data","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-data","title":"sy-funnel-chart","description":""},{"path":"/docs/components/tilemap#property-data","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#property-data","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#property-data","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#property-data","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#property-data","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#property-data","title":"sy-sankey","description":""},{"path":"/docs/components/chord#property-data","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#property-data","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#property-data","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#property-data","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#property-data","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#property-data","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#property-data","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-data","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#property-data","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#property-data","title":"sy-stock-volume","description":""},{"path":"/docs/components/stock-flags#property-data","title":"sy-stock-flags","description":""},{"path":"/docs/components/surface-3d#property-data","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-data","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-data","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#property-data","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/options/categories","title":"categories","summary":"Radar category spoke labels (property).","kind":"option","group":"data","member":{"name":"categories","attribute":"categories","type":"string[]","kind":"property","values":[],"default":"undefined","description":"Radar category spoke labels (property)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-polar-chart and create the element before configuring it.\nchart.categories = [\n  \"N\",\n  \"NE\",\n  \"E\",\n  \"SE\",\n  \"S\",\n  \"SW\",\n  \"W\",\n  \"NW\"\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/polar","title":"Polar · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-categories","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-categories","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-categories","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-categories","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-categories","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-categories","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-categories","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-categories","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-categories","title":"sy-pareto-chart","description":""},{"path":"/docs/components/pictorial#property-categories","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/visual-map#property-categories","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/gridShape","title":"gridShape","summary":"Radar grid web shape — `polygon` (spider) or `circle`.","kind":"option","group":"specific","member":{"name":"gridShape","attribute":"grid-shape","type":"RadarGridShape","kind":"string","values":["circle","polygon"],"default":"undefined","description":"Radar grid web shape — `polygon` (spider) or `circle`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridShape`"],["HTML attribute","`grid-shape`"],["Type","`RadarGridShape`"],["Default","`undefined`"],["Allowed values","`circle`, `polygon`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/RadarGridShape","title":"RadarGridShape","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/radar#property-gridShape","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/gridColor","title":"gridColor","summary":"Radar grid ring/spoke stroke colour.","kind":"option","group":"specific","member":{"name":"gridColor","attribute":"grid-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Radar grid ring/spoke stroke colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridColor`"],["HTML attribute","`grid-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-gridColor","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-gridColor","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/lineWidth","title":"lineWidth","summary":"Radar polygon outline width in px.","kind":"option","group":"specific","member":{"name":"lineWidth","attribute":"line-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Radar polygon outline width in px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineWidth`"],["HTML attribute","`line-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-lineWidth","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-lineWidth","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#property-lineWidth","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-lineWidth","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/pareto#property-lineWidth","title":"sy-pareto-chart","description":""},{"path":"/docs/components/parallel-coordinates#property-lineWidth","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/options/showMarkers","title":"showMarkers","summary":"Shows radar vertex markers.","kind":"option","group":"specific","member":{"name":"showMarkers","attribute":"show-markers","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Shows radar vertex markers."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showMarkers`"],["HTML attribute","`show-markers`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/radar#property-showMarkers","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/markerRadius","title":"markerRadius","summary":"Radar vertex marker radius in px.","kind":"option","group":"appearance","member":{"name":"markerRadius","attribute":"marker-radius","type":"number","kind":"number","values":[],"default":"undefined","description":"Radar vertex marker radius in px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerRadius`"],["HTML attribute","`marker-radius`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/radar#property-markerRadius","title":"sy-radar-chart","description":""},{"path":"/docs/components/scatter-3d#property-markerRadius","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/options/showRingLabels","title":"showRingLabels","summary":"Shows labels beside radar rings.","kind":"option","group":"specific","member":{"name":"showRingLabels","attribute":"show-ring-labels","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Shows labels beside radar rings."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showRingLabels`"],["HTML attribute","`show-ring-labels`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-showRingLabels","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-showRingLabels","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/ringLabelColor","title":"ringLabelColor","summary":"Radar ring label colour.","kind":"option","group":"specific","member":{"name":"ringLabelColor","attribute":"ring-label-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Radar ring label colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelColor`"],["HTML attribute","`ring-label-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-ringLabelColor","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-ringLabelColor","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/ringLabelFontSize","title":"ringLabelFontSize","summary":"Radar ring label font size in px.","kind":"option","group":"specific","member":{"name":"ringLabelFontSize","attribute":"ring-label-font-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Radar ring label font size in px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelFontSize`"],["HTML attribute","`ring-label-font-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-ringLabelFontSize","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-ringLabelFontSize","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/ringLabelFormat","title":"ringLabelFormat","summary":"Radar ring label format string.","kind":"option","group":"specific","member":{"name":"ringLabelFormat","attribute":"ring-label-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Radar ring label format string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelFormat`"],["HTML attribute","`ring-label-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/radar#property-ringLabelFormat","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/categoryLabelColor","title":"categoryLabelColor","summary":"Radar category spoke label colour.","kind":"option","group":"specific","member":{"name":"categoryLabelColor","attribute":"category-label-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Radar category spoke label colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categoryLabelColor`"],["HTML attribute","`category-label-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-categoryLabelColor","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-categoryLabelColor","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/categoryLabelFontSize","title":"categoryLabelFontSize","summary":"Radar category spoke label font size in px.","kind":"option","group":"specific","member":{"name":"categoryLabelFontSize","attribute":"category-label-font-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Radar category spoke label font size in px."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categoryLabelFontSize`"],["HTML attribute","`category-label-font-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-categoryLabelFontSize","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-categoryLabelFontSize","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/editable","title":"editable","summary":"Enables drag-to-edit radar points.","kind":"option","group":"specific","member":{"name":"editable","attribute":"editable","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Enables drag-to-edit radar points."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`editable`"],["HTML attribute","`editable`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/radar#property-editable","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/options/neckWidth","title":"neckWidth","summary":"Funnel neck width as a fraction of the full width (funnel only).","kind":"option","group":"specific","member":{"name":"neckWidth","attribute":"neck-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Funnel neck width as a fraction of the full width (funnel only)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neckWidth`"],["HTML attribute","`neck-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-funnel-chart and create the element before configuring it.\nchart.neckWidth = 0;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/pyramid","title":"Pyramid · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-neckWidth","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-neckWidth","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/neckHeight","title":"neckHeight","summary":"Funnel neck height as a fraction of the total height (the straight bottom band).","kind":"option","group":"specific","member":{"name":"neckHeight","attribute":"neck-height","type":"number","kind":"number","values":[],"default":"undefined","description":"Funnel neck height as a fraction of the total height (the straight bottom band)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neckHeight`"],["HTML attribute","`neck-height`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-funnel-chart and create the element before configuring it.\nchart.neckHeight = 0;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/pyramid","title":"Pyramid · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-neckHeight","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-neckHeight","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/gap","title":"gap","summary":"Vertical gap between funnel/pyramid sections (px).","kind":"option","group":"specific","member":{"name":"gap","attribute":"gap","type":"number","kind":"number","values":[],"default":"undefined","description":"Vertical gap between funnel/pyramid sections (px)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gap`"],["HTML attribute","`gap`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-gap","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-gap","title":"sy-funnel-chart","description":""},{"path":"/docs/components/tilemap#property-gap","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/options/labelPlacement","title":"labelPlacement","summary":"Funnel/pyramid data-label placement.","kind":"option","group":"appearance","member":{"name":"labelPlacement","attribute":"label-placement","type":"FunnelLabelPlacement","kind":"string","values":["none","left","right","inside"],"default":"undefined","description":"Funnel/pyramid data-label placement."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelPlacement`"],["HTML attribute","`label-placement`"],["Type","`FunnelLabelPlacement`"],["Default","`undefined`"],["Allowed values","`none`, `left`, `right`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelLabelPlacement","title":"FunnelLabelPlacement","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-labelPlacement","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-labelPlacement","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/showPercent","title":"showPercent","summary":"Show the percentage in funnel/pyramid labels.","kind":"option","group":"specific","member":{"name":"showPercent","attribute":"show-percent","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Show the percentage in funnel/pyramid labels."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showPercent`"],["HTML attribute","`show-percent`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-funnel-chart and create the element before configuring it.\nchart.showPercent = true;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/funnel","title":"Funnel · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-showPercent","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-showPercent","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/inactiveOtherSections","title":"inactiveOtherSections","summary":"Dim non-active funnel/pyramid sections when a section is active.","kind":"option","group":"appearance","member":{"name":"inactiveOtherSections","attribute":"inactive-other-sections","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Dim non-active funnel/pyramid sections when a section is active."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherSections`"],["HTML attribute","`inactive-other-sections`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-inactiveOtherSections","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-inactiveOtherSections","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/inactiveSectionOpacity","title":"inactiveSectionOpacity","summary":"Opacity applied to non-active funnel/pyramid sections.","kind":"option","group":"appearance","member":{"name":"inactiveSectionOpacity","attribute":"inactive-section-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Opacity applied to non-active funnel/pyramid sections."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveSectionOpacity`"],["HTML attribute","`inactive-section-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-inactiveSectionOpacity","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-inactiveSectionOpacity","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/activeSectionIndex","title":"activeSectionIndex","summary":"Controlled active funnel/pyramid section index. Negative/undefined falls back to hover/focus.","kind":"option","group":"specific","member":{"name":"activeSectionIndex","attribute":"active-section-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Controlled active funnel/pyramid section index. Negative/undefined falls back to hover/focus."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSectionIndex`"],["HTML attribute","`active-section-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/funnel#property-activeSectionIndex","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-activeSectionIndex","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/lineColor","title":"lineColor","summary":"Cumulative-line colour (pareto only).","kind":"option","group":"specific","member":{"name":"lineColor","attribute":"line-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Cumulative-line colour (pareto only)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineColor`"],["HTML attribute","`line-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dumbbell#property-lineColor","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/pareto#property-lineColor","title":"sy-pareto-chart","description":""},{"path":"/docs/components/stock-chart#property-lineColor","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/options/referenceValue","title":"referenceValue","summary":"80/20 reference percentage on the cumulative axis (pareto only).","kind":"option","group":"specific","member":{"name":"referenceValue","attribute":"reference-value","type":"number","kind":"number","values":[],"default":"undefined","description":"80/20 reference percentage on the cumulative axis (pareto only)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`referenceValue`"],["HTML attribute","`reference-value`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pareto#property-referenceValue","title":"sy-pareto-chart","description":""}]}]}]},{"path":"/docs/options/showReference","title":"showReference","summary":"Show the pareto reference line.","kind":"option","group":"specific","member":{"name":"showReference","attribute":"show-reference","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Show the pareto reference line."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showReference`"],["HTML attribute","`show-reference`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pareto#property-showReference","title":"sy-pareto-chart","description":""}]}]}]},{"path":"/docs/options/referenceColor","title":"referenceColor","summary":"Pareto reference-line colour.","kind":"option","group":"specific","member":{"name":"referenceColor","attribute":"reference-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Pareto reference-line colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`referenceColor`"],["HTML attribute","`reference-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pareto#property-referenceColor","title":"sy-pareto-chart","description":""}]}]}]},{"path":"/docs/options/sortDescending","title":"sortDescending","summary":"Sort pareto categories by value, largest first. Default true.","kind":"option","group":"specific","member":{"name":"sortDescending","attribute":"sort-descending","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Sort pareto categories by value, largest first. Default true."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sortDescending`"],["HTML attribute","`sort-descending`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/lollipop#property-sortDescending","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-sortDescending","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#property-sortDescending","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-sortDescending","title":"sy-variwide-chart","description":""},{"path":"/docs/components/pareto#property-sortDescending","title":"sy-pareto-chart","description":""}]}]}]},{"path":"/docs/options/valueAxisLabel","title":"valueAxisLabel","summary":"Left value-axis label (pareto).","kind":"option","group":"specific","member":{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Left value-axis label (pareto)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/lollipop#property-valueAxisLabel","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#property-valueAxisLabel","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-valueAxisLabel","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-valueAxisLabel","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#property-valueAxisLabel","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-valueAxisLabel","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#property-valueAxisLabel","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#property-valueAxisLabel","title":"sy-histogram-chart","description":""},{"path":"/docs/components/pictorial#property-valueAxisLabel","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/options/cumulativeAxisLabel","title":"cumulativeAxisLabel","summary":"Right cumulative-axis label (pareto).","kind":"option","group":"specific","member":{"name":"cumulativeAxisLabel","attribute":"cumulative-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Right cumulative-axis label (pareto)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cumulativeAxisLabel`"],["HTML attribute","`cumulative-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/pareto#property-cumulativeAxisLabel","title":"sy-pareto-chart","description":""}]}]}]},{"path":"/docs/options/markerColor","title":"markerColor","summary":"Lollipop marker fill override (defaults to `color`).","kind":"option","group":"appearance","member":{"name":"markerColor","attribute":"marker-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Lollipop marker fill override (defaults to `color`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerColor`"],["HTML attribute","`marker-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/lollipop#property-markerColor","title":"sy-lollipop-chart","description":""}]}]}]},{"path":"/docs/options/orientation","title":"orientation","summary":"Lollipop layout direction: `horizontal` (Cleveland, default) or `vertical`.","kind":"option","group":"specific","member":{"name":"orientation","attribute":"orientation","type":"'vertical' | 'horizontal'","kind":"string","values":["vertical","horizontal"],"default":"undefined","description":"Lollipop layout direction: `horizontal` (Cleveland, default) or `vertical`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`'vertical' | 'horizontal'`"],["Default","`undefined`"],["Allowed values","`vertical`, `horizontal`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-lollipop-chart and create the element before configuring it.\nchart.orientation = \"vertical\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/lollipop","title":"Lollipop · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/lollipop#property-orientation","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/box-plot#property-orientation","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/wafer-map#property-orientation","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#property-orientation","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#property-orientation","title":"sy-wafer-correlation","description":""},{"path":"/docs/components/yield-zone-chart#property-orientation","title":"sy-yield-zone-chart","description":""},{"path":"/docs/components/data-zoom#property-orientation","title":"sy-data-zoom","description":""},{"path":"/docs/components/navigator#property-orientation","title":"sy-navigator","description":""},{"path":"/docs/components/visual-map#property-orientation","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/lowName","title":"lowName","summary":"Dumbbell legend label for the low-end markers.","kind":"option","group":"specific","member":{"name":"lowName","attribute":"low-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Dumbbell legend label for the low-end markers."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lowName`"],["HTML attribute","`low-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dumbbell#property-lowName","title":"sy-dumbbell-chart","description":""}]}]}]},{"path":"/docs/options/highName","title":"highName","summary":"Dumbbell legend label for the high-end markers.","kind":"option","group":"specific","member":{"name":"highName","attribute":"high-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Dumbbell legend label for the high-end markers."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`highName`"],["HTML attribute","`high-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dumbbell#property-highName","title":"sy-dumbbell-chart","description":""}]}]}]},{"path":"/docs/options/lowColor","title":"lowColor","summary":"Dumbbell low-end marker colour.","kind":"option","group":"specific","member":{"name":"lowColor","attribute":"low-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Dumbbell low-end marker colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lowColor`"],["HTML attribute","`low-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/highColor","title":"highColor","summary":"Dumbbell high-end marker colour.","kind":"option","group":"specific","member":{"name":"highColor","attribute":"high-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Dumbbell high-end marker colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`highColor`"],["HTML attribute","`high-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/weights","title":"weights","summary":"Variwide column width metric (the 2nd dimension), one per category.","kind":"option","group":"specific","member":{"name":"weights","attribute":"weights","type":"Float32Array | Array<number | null | undefined>","kind":"property","values":[],"default":"undefined","description":"Variwide column width metric (the 2nd dimension), one per category."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weights`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Float32Array | Array<number | null | undefined>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/variwide#property-weights","title":"sy-variwide-chart","description":""}]}]}]},{"path":"/docs/options/colorful","title":"colorful","summary":"Variwide: colour each column from the categorical palette.","kind":"option","group":"appearance","member":{"name":"colorful","attribute":"colorful","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Variwide: colour each column from the categorical palette."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorful`"],["HTML attribute","`colorful`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/variwide#property-colorful","title":"sy-variwide-chart","description":""}]}]}]},{"path":"/docs/options/columnGap","title":"columnGap","summary":"Variwide gap between columns as a fraction of each slot (0..0.45).","kind":"option","group":"specific","member":{"name":"columnGap","attribute":"column-gap","type":"number","kind":"number","values":[],"default":"undefined","description":"Variwide gap between columns as a fraction of each slot (0..0.45)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`columnGap`"],["HTML attribute","`column-gap`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/variwide#property-columnGap","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#property-columnGap","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/options/leftValues","title":"leftValues","summary":"Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`.","kind":"option","group":"specific","member":{"name":"leftValues","attribute":"left-values","type":"Float32Array | Array<number | null | undefined>","kind":"property","values":[],"default":"undefined","description":"Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`leftValues`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Float32Array | Array<number | null | undefined>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/tornado#property-leftValues","title":"sy-tornado-chart","description":""}]}]}]},{"path":"/docs/options/rightValues","title":"rightValues","summary":"Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`.","kind":"option","group":"specific","member":{"name":"rightValues","attribute":"right-values","type":"Float32Array | Array<number | null | undefined>","kind":"property","values":[],"default":"undefined","description":"Deprecated fallback: prefer `data` rows with `values[0]` and `values[1]`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rightValues`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Float32Array | Array<number | null | undefined>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/tornado#property-rightValues","title":"sy-tornado-chart","description":""}]}]}]},{"path":"/docs/options/leftColor","title":"leftColor","summary":"Tornado left-series bar colour.","kind":"option","group":"specific","member":{"name":"leftColor","attribute":"left-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Tornado left-series bar colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`leftColor`"],["HTML attribute","`left-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/rightColor","title":"rightColor","summary":"Tornado right-series bar colour.","kind":"option","group":"specific","member":{"name":"rightColor","attribute":"right-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Tornado right-series bar colour."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rightColor`"],["HTML attribute","`right-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/leftLabel","title":"leftLabel","summary":"Tornado left-series label.","kind":"option","group":"specific","member":{"name":"leftLabel","attribute":"left-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Tornado left-series label."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`leftLabel`"],["HTML attribute","`left-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/tornado#property-leftLabel","title":"sy-tornado-chart","description":""}]}]}]},{"path":"/docs/options/rightLabel","title":"rightLabel","summary":"Tornado right-series label.","kind":"option","group":"specific","member":{"name":"rightLabel","attribute":"right-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Tornado right-series label."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rightLabel`"],["HTML attribute","`right-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/tornado#property-rightLabel","title":"sy-tornado-chart","description":""}]}]}]},{"path":"/docs/options/showColumnShare","title":"showColumnShare","summary":"Marimekko: show the per-column total percentage under each column.","kind":"option","group":"specific","member":{"name":"showColumnShare","attribute":"show-column-share","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Marimekko: show the per-column total percentage under each column."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showColumnShare`"],["HTML attribute","`show-column-share`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/marimekko#property-showColumnShare","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/options/groups","title":"groups","summary":"Comparison series = legend labels + colour order (one per value index).","kind":"option","group":"specific","member":{"name":"groups","attribute":"groups","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Comparison series = legend labels + colour order (one per value index)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`groups`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-dot-plot-chart and create the element before configuring it.\nchart.groups = [\n  \"Reference\",\n  \"Target\",\n  \"Actual\"\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/dot-plot","title":"Dot Plot · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dumbbell#property-groups","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#property-groups","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#property-groups","title":"sy-dot-plot-chart","description":""}]}]}]},{"path":"/docs/options/showRowLines","title":"showRowLines","summary":"Dot-plot: draw a faint guide line across each row between its min and max dot.","kind":"option","group":"specific","member":{"name":"showRowLines","attribute":"show-row-lines","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Dot-plot: draw a faint guide line across each row between its min and max dot."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showRowLines`"],["HTML attribute","`show-row-lines`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/dot-plot#property-showRowLines","title":"sy-dot-plot-chart","description":""}]}]}]},{"path":"/docs/options/value","title":"value","summary":"Gauge primary scalar value.","kind":"option","group":"specific","member":{"name":"value","attribute":"value","type":"number","kind":"number","values":[],"default":"undefined","description":"Gauge primary scalar value."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`value`"],["HTML attribute","`value`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-gauge-chart and create the element before configuring it.\nchart.value = 80;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/gauge","title":"Gauge · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-value","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/min","title":"min","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"min","attribute":"min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`min`"],["HTML attribute","`min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-radar-chart and create the element before configuring it.\nchart.min = 0;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/radar","title":"Radar · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/radar#property-min","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-min","title":"sy-gauge-chart","description":""},{"path":"/docs/components/visual-map#property-min","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/max","title":"max","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"max","attribute":"max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`max`"],["HTML attribute","`max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-radar-chart and create the element before configuring it.\nchart.max = 100;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/radar","title":"Radar · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-max","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-max","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-max","title":"sy-gauge-chart","description":""},{"path":"/docs/components/visual-map#property-max","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/options/needles","title":"needles","summary":"Multi-needle override (dial variant). Property-only.","kind":"option","group":"specific","member":{"name":"needles","attribute":"needles","type":"GaugeNeedleSpec[]","kind":"property","values":[],"default":"undefined","description":"Multi-needle override (dial variant). Property-only."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needles`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeNeedleSpec[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-needles","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/rings","title":"rings","summary":"Gauge activity-variant rings — each with its own value/max (property-only).","kind":"option","group":"specific","member":{"name":"rings","attribute":"rings","type":"GaugeActivityRingSpec[]","kind":"property","values":[],"default":"undefined","description":"Gauge activity-variant rings — each with its own value/max (property-only)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeActivityRingSpec[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeActivityRingSpec","title":"GaugeActivityRingSpec","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-rings","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/time","title":"time","summary":"Gauge clock-variant time — 'now' (live) or 'HH:MM(:SS)'.","kind":"option","group":"specific","member":{"name":"time","attribute":"time","type":"string","kind":"string","values":[],"default":"undefined","description":"Gauge clock-variant time — 'now' (live) or 'HH:MM(:SS)'."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`time`"],["HTML attribute","`time`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-time","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/showSeconds","title":"showSeconds","summary":"Gauge clock-variant second hand.","kind":"option","group":"specific","member":{"name":"showSeconds","attribute":"show-seconds","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Gauge clock-variant second hand."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showSeconds`"],["HTML attribute","`show-seconds`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-showSeconds","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/variant","title":"variant","summary":"Allowed values: solid, dial, activity, vuMeter, speedometer, clock. Default: undefined.","kind":"option","group":"specific","member":{"name":"variant","attribute":"variant","type":"GaugeChartVariant","kind":"string","values":["solid","dial","activity","vuMeter","speedometer","clock"],"default":"undefined","description":"Allowed values: solid, dial, activity, vuMeter, speedometer, clock. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`variant`"],["HTML attribute","`variant`"],["Type","`GaugeChartVariant`"],["Default","`undefined`"],["Allowed values","`solid`, `dial`, `activity`, `vuMeter`, `speedometer`, `clock`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartVariant","title":"GaugeChartVariant","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-polar-chart and create the element before configuring it.\nchart.variant = \"rose\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/polar","title":"Polar · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/polar#property-variant","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#property-variant","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-variant","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/innerRadius","title":"innerRadius","summary":"Solid-variant inner radius. Number = px; `'%'` = fraction of outerRadius.","kind":"option","group":"specific","member":{"name":"innerRadius","attribute":"inner-radius","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Solid-variant inner radius. Number = px; `'%'` = fraction of outerRadius."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`innerRadius`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-innerRadius","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/stops","title":"stops","summary":"Solid-variant colour stops. Property-only.","kind":"option","group":"specific","member":{"name":"stops","attribute":"stops","type":"GaugeColorStop[]","kind":"property","values":[],"default":"undefined","description":"Solid-variant colour stops. Property-only."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stops`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeColorStop[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeColorStop","title":"GaugeColorStop","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-stops","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/needleShape","title":"needleShape","summary":"Allowed values: needle, arrow, line, wedge. Default: undefined.","kind":"option","group":"specific","member":{"name":"needleShape","attribute":"needle-shape","type":"GaugeNeedleShape","kind":"string","values":["needle","arrow","line","wedge"],"default":"undefined","description":"Allowed values: needle, arrow, line, wedge. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleShape`"],["HTML attribute","`needle-shape`"],["Type","`GaugeNeedleShape`"],["Default","`undefined`"],["Allowed values","`needle`, `arrow`, `line`, `wedge`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleShape","title":"GaugeNeedleShape","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-needleShape","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/needleLength","title":"needleLength","summary":"Pass as a JavaScript property. type: number | string.","kind":"option","group":"specific","member":{"name":"needleLength","attribute":"needle-length","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleLength`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-needleLength","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/needleRearLength","title":"needleRearLength","summary":"Pass as a JavaScript property. type: number | string.","kind":"option","group":"specific","member":{"name":"needleRearLength","attribute":"needle-rear-length","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleRearLength`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-needleRearLength","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/needleWidth","title":"needleWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"needleWidth","attribute":"needle-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleWidth`"],["HTML attribute","`needle-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-needleWidth","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/pivotRadius","title":"pivotRadius","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"pivotRadius","attribute":"pivot-radius","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`pivotRadius`"],["HTML attribute","`pivot-radius`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-pivotRadius","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/pivotColor","title":"pivotColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"pivotColor","attribute":"pivot-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`pivotColor`"],["HTML attribute","`pivot-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-pivotColor","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/plotBands","title":"plotBands","summary":"Gauge plot bands — an array (property), or `'auto'` for %-of-max zones.","kind":"option","group":"specific","member":{"name":"plotBands","attribute":"plot-bands","type":"GaugePlotBand[] | 'auto'","kind":"property","values":["auto"],"default":"undefined","description":"Gauge plot bands — an array (property), or `'auto'` for %-of-max zones."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`plotBands`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugePlotBand[] | 'auto'`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugePlotBand","title":"GaugePlotBand","description":"Type definition"}]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-gauge-chart and create the element before configuring it.\nchart.plotBands = [\n  {\n    \"from\": 0,\n    \"to\": 120,\n    \"color\": \"#16a34a\"\n  },\n  {\n    \"from\": 120,\n    \"to\": 160,\n    \"color\": \"#f59e0b\"\n  },\n  {\n    \"from\": 160,\n    \"to\": 200,\n    \"color\": \"#dc2626\"\n  }\n];","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/gauge","title":"Gauge · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-plotBands","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/bandThickness","title":"bandThickness","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"bandThickness","attribute":"band-thickness","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandThickness`"],["HTML attribute","`band-thickness`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-gauge-chart and create the element before configuring it.\nchart.bandThickness = 14;","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/gauge","title":"Gauge · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-bandThickness","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/bandTrackColor","title":"bandTrackColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"bandTrackColor","attribute":"band-track-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandTrackColor`"],["HTML attribute","`band-track-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-bandTrackColor","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/valueDisplay","title":"valueDisplay","summary":"Allowed values: percent, value. Default: undefined.","kind":"option","group":"specific","member":{"name":"valueDisplay","attribute":"value-display","type":"GaugeValueDisplay","kind":"string","values":["percent","value"],"default":"undefined","description":"Allowed values: percent, value. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueDisplay`"],["HTML attribute","`value-display`"],["Type","`GaugeValueDisplay`"],["Default","`undefined`"],["Allowed values","`percent`, `value`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeValueDisplay","title":"GaugeValueDisplay","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-valueDisplay","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/rounded","title":"rounded","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"rounded","attribute":"rounded","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rounded`"],["HTML attribute","`rounded`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-rounded","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/trackColor","title":"trackColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"trackColor","attribute":"track-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`trackColor`"],["HTML attribute","`track-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-trackColor","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/showTicks","title":"showTicks","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"showTicks","attribute":"show-ticks","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showTicks`"],["HTML attribute","`show-ticks`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-showTicks","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickInterval","title":"tickInterval","summary":"Allowed values: auto. Default: undefined.","kind":"option","group":"specific","member":{"name":"tickInterval","attribute":"tick-interval","type":"number | 'auto'","kind":"property","values":["auto"],"default":"undefined","description":"Allowed values: auto. Default: undefined."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickInterval`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'auto'`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/radar#property-tickInterval","title":"sy-radar-chart","description":""},{"path":"/docs/components/gauge#property-tickInterval","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/minorTicks","title":"minorTicks","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"minorTicks","attribute":"minor-ticks","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minorTicks`"],["HTML attribute","`minor-ticks`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-minorTicks","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickLength","title":"tickLength","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"tickLength","attribute":"tick-length","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLength`"],["HTML attribute","`tick-length`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-tickLength","title":"sy-gauge-chart","description":""},{"path":"/docs/components/candlestick#property-tickLength","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#property-tickLength","title":"sy-ohlc-chart","description":""}]}]}]},{"path":"/docs/options/minorTickLength","title":"minorTickLength","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"minorTickLength","attribute":"minor-tick-length","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minorTickLength`"],["HTML attribute","`minor-tick-length`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-minorTickLength","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickWidth","title":"tickWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"tickWidth","attribute":"tick-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickWidth`"],["HTML attribute","`tick-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-tickWidth","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/minorTickWidth","title":"minorTickWidth","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"minorTickWidth","attribute":"minor-tick-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minorTickWidth`"],["HTML attribute","`minor-tick-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-minorTickWidth","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickColor","title":"tickColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"tickColor","attribute":"tick-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickColor`"],["HTML attribute","`tick-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-tickColor","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/showTickLabels","title":"showTickLabels","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"showTickLabels","attribute":"show-tick-labels","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showTickLabels`"],["HTML attribute","`show-tick-labels`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-showTickLabels","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickLabelDistance","title":"tickLabelDistance","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"tickLabelDistance","attribute":"tick-label-distance","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelDistance`"],["HTML attribute","`tick-label-distance`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-tickLabelDistance","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickLabelColor","title":"tickLabelColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"tickLabelColor","attribute":"tick-label-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelColor`"],["HTML attribute","`tick-label-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-tickLabelColor","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickLabelFontSize","title":"tickLabelFontSize","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"tickLabelFontSize","attribute":"tick-label-font-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelFontSize`"],["HTML attribute","`tick-label-font-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-tickLabelFontSize","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/tickLabelFormat","title":"tickLabelFormat","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"tickLabelFormat","attribute":"tick-label-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelFormat`"],["HTML attribute","`tick-label-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-tickLabelFormat","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/showValue","title":"showValue","summary":"Set as an HTML attribute or JavaScript property. type: boolean.","kind":"option","group":"specific","member":{"name":"showValue","attribute":"show-value","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: boolean."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showValue`"],["HTML attribute","`show-value`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-showValue","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-showValue","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-showValue","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/valueFormat","title":"valueFormat","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"valueFormat","attribute":"value-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueFormat`"],["HTML attribute","`value-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-valueFormat","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#property-valueFormat","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#property-valueFormat","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/options/valueColor","title":"valueColor","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"valueColor","attribute":"value-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueColor`"],["HTML attribute","`value-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-valueColor","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/valueFontSize","title":"valueFontSize","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"valueFontSize","attribute":"value-font-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueFontSize`"],["HTML attribute","`value-font-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-valueFontSize","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/unit","title":"unit","summary":"Set as an HTML attribute or JavaScript property. type: string.","kind":"option","group":"specific","member":{"name":"unit","attribute":"unit","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unit`"],["HTML attribute","`unit`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"// Register sy-gauge-chart and create the element before configuring it.\nchart.unit = \"km/h\";","language":"javascript"},{"kind":"links","items":[{"path":"/docs/components/gauge","title":"Gauge · Complete examples and API","description":""}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/stem-leaf#property-unit","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/gauge#property-unit","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/analogDamping","title":"analogDamping","summary":"Gauge `analog` needle settle shaping (forwarded to <sy-gauge-chart>).","kind":"option","group":"specific","member":{"name":"analogDamping","attribute":"analog-damping","type":"number","kind":"number","values":[],"default":"undefined","description":"Gauge `analog` needle settle shaping (forwarded to <sy-gauge-chart>)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`analogDamping`"],["HTML attribute","`analog-damping`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-analogDamping","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/analogFrequency","title":"analogFrequency","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"analogFrequency","attribute":"analog-frequency","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`analogFrequency`"],["HTML attribute","`analog-frequency`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-analogFrequency","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/analogOvershootAngle","title":"analogOvershootAngle","summary":"Set as an HTML attribute or JavaScript property. type: number.","kind":"option","group":"specific","member":{"name":"analogOvershootAngle","attribute":"analog-overshoot-angle","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`analogOvershootAngle`"],["HTML attribute","`analog-overshoot-angle`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/gauge#property-analogOvershootAngle","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/options/loading","title":"loading","summary":"Loading overlay ().","kind":"option","group":"layout","member":{"name":"loading","attribute":"loading","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Loading overlay ()."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`loading`"],["HTML attribute","`loading`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.loading = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/loadingText","title":"loadingText","summary":"Loading overlay text override; falls back to the locale string.","kind":"option","group":"layout","member":{"name":"loadingText","attribute":"loading-text","type":"string","kind":"string","values":[],"default":"undefined","description":"Loading overlay text override; falls back to the locale string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`loadingText`"],["HTML attribute","`loading-text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/emptyText","title":"emptyText","summary":"Empty-state text override; falls back to the locale string ().","kind":"option","group":"layout","member":{"name":"emptyText","attribute":"empty-text","type":"string","kind":"string","values":[],"default":"undefined","description":"Empty-state text override; falls back to the locale string ()."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`emptyText`"],["HTML attribute","`empty-text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/showEmpty","title":"showEmpty","summary":"Auto empty state when no finite data point exists. Default `true`.","kind":"option","group":"layout","member":{"name":"showEmpty","attribute":"show-empty","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Auto empty state when no finite data point exists. Default `true`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showEmpty`"],["HTML attribute","`show-empty`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.showEmpty = true;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/theme-river#property-showEmpty","title":"sy-theme-river","description":""},{"path":"/docs/components/flow-lines#property-showEmpty","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#property-showEmpty","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-showEmpty","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-showEmpty","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/options/error","title":"error","summary":"Error state (). `true` uses the locale default; a string is the message.","kind":"option","group":"layout","member":{"name":"error","attribute":"error","type":"boolean | string","kind":"property","values":[],"default":"undefined","description":"Error state (). `true` uses the locale default; a string is the message."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`error`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`boolean | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/errorText","title":"errorText","summary":"Error body text override (used when `error` is boolean `true`).","kind":"option","group":"layout","member":{"name":"errorText","attribute":"error-text","type":"string","kind":"string","values":[],"default":"undefined","description":"Error body text override (used when `error` is boolean `true`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`errorText`"],["HTML attribute","`error-text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/contextmenu","title":"contextmenu","summary":"Enables the shared right-click context menu on empty chart area. Default `false`.","kind":"option","group":"export","member":{"name":"contextmenu","attribute":"contextmenu","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Enables the shared right-click context menu on empty chart area. Default `false`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`contextmenu`"],["HTML attribute","`contextmenu`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.contextmenu = false;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/contextMenuItems","title":"contextMenuItems","summary":"Append custom menu items after the built-in image and data export items. This array does not replace the default menu. Pass objects with action callbacks as a JavaScript property.","kind":"option","group":"export","member":{"name":"contextMenuItems","attribute":"context-menu-items","type":"ChartMenuItem[]","kind":"property","values":[],"default":"undefined","description":"Append custom menu items after the built-in image and data export items. This array does not replace the default menu. Pass objects with action callbacks as a JavaScript property."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`contextMenuItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartMenuItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartMenuItem","title":"ChartMenuItem","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/exportFilename","title":"exportFilename","summary":"Base filename (no extension) for exports; falls back to the title or type.","kind":"option","group":"export","member":{"name":"exportFilename","attribute":"export-filename","type":"string","kind":"string","values":[],"default":"undefined","description":"Base filename (no extension) for exports; falls back to the title or type."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`exportFilename`"],["HTML attribute","`export-filename`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/exportScale","title":"exportScale","summary":"Output pixel scale for PNG export (1–8). Default 2 (retina).","kind":"option","group":"export","member":{"name":"exportScale","attribute":"export-scale","type":"number","kind":"number","values":[],"default":"2","description":"Output pixel scale for PNG export (1–8). Default 2 (retina)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`exportScale`"],["HTML attribute","`export-scale`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"example","title":"Configuration example","blocks":[{"kind":"code","source":"chart.exportScale = 2;","language":"javascript"}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/stock-chart#property-exportScale","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/options/exportBackground","title":"exportBackground","summary":"Backdrop painted behind PNG/SVG exports; falls back to the theme background.","kind":"option","group":"export","member":{"name":"exportBackground","attribute":"export-background","type":"string","kind":"string","values":[],"default":"undefined","description":"Backdrop painted behind PNG/SVG exports; falls back to the theme background."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`exportBackground`"],["HTML attribute","`export-background`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/theme","title":"theme","summary":"The theme used for chart colors and typography. Pass a theme name or a supported theme object. Page and chart themes are separate; update both in your app.","kind":"option","group":"layout","member":{"name":"theme","attribute":"theme","type":"ChartThemeName | ChartTheme","kind":"property","values":["light","dark","high-contrast"],"default":"undefined","description":"The theme used for chart colors and typography. Pass a theme name or a supported theme object. Page and chart themes are separate; update both in your app."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`theme`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartThemeName | ChartTheme`"],["Default","`undefined`"],["Literals in the type","`light`, `dark`, `high-contrast`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartThemeName","title":"ChartThemeName","description":"Type definition"},{"path":"/docs/types/ChartTheme","title":"ChartTheme","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""}]}]}]},{"path":"/docs/options/locale","title":"locale","summary":"Locale name (`en` | `ko` | `ja` | `zh`) or a partial override object ().","kind":"option","group":"layout","member":{"name":"locale","attribute":"locale","type":"ChartLocaleName | Partial<ChartLocale>","kind":"property","values":["en","ko","ja","zh"],"default":"undefined","description":"Locale name (`en` | `ko` | `ja` | `zh`) or a partial override object ()."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locale`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartLocaleName | Partial<ChartLocale>`"],["Default","`undefined`"],["Literals in the type","`en`, `ko`, `ja`, `zh`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartLocaleName","title":"ChartLocaleName","description":"Type definition"},{"path":"/docs/types/ChartLocale","title":"ChartLocale","description":"Type definition"}]}]},{"id":"related","title":"Related documentation","blocks":[{"kind":"paragraph","text":"A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below."},{"kind":"links","items":[{"path":"/docs/concepts","title":"Shared facade and direct tags","description":""},{"path":"/docs/components/theme-river#property-locale","title":"sy-theme-river","description":""},{"path":"/docs/components/flow-lines#property-locale","title":"sy-flow-lines","description":""},{"path":"/docs/components/stock-chart#property-locale","title":"sy-stock-chart","description":""},{"path":"/docs/components/surface-3d#property-locale","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#property-locale","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#property-locale","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/methods","title":"Methods","summary":"Asynchronous methods for the shared sy-chart component. Also check the direct tag's API for behavior supported by your selected chart.","kind":"methods","sections":[{"id":"members","title":"Complete list","blocks":[{"kind":"links","items":[{"path":"/docs/methods/getFlowLinesData","title":"getFlowLinesData","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getFlowLinesLayout","title":"getFlowLinesLayout","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getFlowLinesDiagnostics","title":"getFlowLinesDiagnostics","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/selectFlowLines","title":"selectFlowLines","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showFlowLinesTooltip","title":"showFlowLinesTooltip","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/clearFlowLinesStream","title":"clearFlowLinesStream","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/recycleFlowLinesGpu","title":"recycleFlowLinesGpu","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getThemeRiverData","title":"getThemeRiverData","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getThemeRiverLayout","title":"getThemeRiverLayout","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getThemeRiverDiagnostics","title":"getThemeRiverDiagnostics","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/selectThemeRiverPoint","title":"selectThemeRiverPoint","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showThemeRiverTooltip","title":"showThemeRiverTooltip","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showThemeRiverCrosshair","title":"showThemeRiverCrosshair","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/clearThemeRiverStream","title":"clearThemeRiverStream","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/recycleThemeRiverGpu","title":"recycleThemeRiverGpu","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getBar3DData","title":"getBar3DData","description":"Surface grid coordinates are row/column; generic tooltip methods use a row-major sample index."},{"path":"/docs/methods/getScatter3DData","title":"getScatter3DData","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getBar3DLayout","title":"getBar3DLayout","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getScatter3DLayout","title":"getScatter3DLayout","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getBar3DDiagnostics","title":"getBar3DDiagnostics","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getScatter3DDiagnostics","title":"getScatter3DDiagnostics","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/selectBar3DPoint","title":"selectBar3DPoint","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/selectScatter3DPoint","title":"selectScatter3DPoint","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showBar3DTooltip","title":"showBar3DTooltip","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showScatter3DTooltip","title":"showScatter3DTooltip","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showBar3DCrosshair","title":"showBar3DCrosshair","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showScatter3DCrosshair","title":"showScatter3DCrosshair","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getSurface3DData","title":"getSurface3DData","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getSurface3DLayout","title":"getSurface3DLayout","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getSurface3DDiagnostics","title":"getSurface3DDiagnostics","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/selectSurface3DPoint","title":"selectSurface3DPoint","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showSurface3DTooltip","title":"showSurface3DTooltip","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showSurface3DCrosshair","title":"showSurface3DCrosshair","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getCamera3D","title":"getCamera3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/setCamera3D","title":"setCamera3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/setProjection3D","title":"setProjection3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/fitCamera3D","title":"fitCamera3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/resetCamera3D","title":"resetCamera3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/saveCamera3D","title":"saveCamera3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/rotate3D","title":"rotate3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/pan3D","title":"pan3D","description":"Pan the 3D camera in CSS pixels; use zoomBy for camera distance/orthographic zoom."},{"path":"/docs/methods/recycleGpu3D","title":"recycleGpu3D","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/clearBar3DStream","title":"clearBar3DStream","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/clearScatter3DStream","title":"clearScatter3DStream","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/clearSurface3DStream","title":"clearSurface3DStream","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getDataTable","title":"getDataTable","description":"Resolves the data table for the current data ( / 134). Waits for the type's load answer and rejects with a ChartLoadError (its `code` = the status) when the type cannot be drawn here: no table is invented for it. A Pro chart type's table comes from its element only (the facade carries no Pro data resolvers)."},{"path":"/docs/methods/getCSV","title":"getCSV","description":"Returns the chart data as a CSV string (UTF-8 BOM, RFC 4180)."},{"path":"/docs/methods/getSVG","title":"getSVG","description":"Returns the chart as standalone SVG markup (canvas families wrap their raster); the drawing overlay rides along as a nested layer, and the brand is the last layer over everything. Keeps its `string | null` contract: null when the type cannot be drawn here (see getDataTable) or there is no surface yet."},{"path":"/docs/methods/exportCSV","title":"exportCSV","description":"Downloads the chart data as a CSV file (). Data only: no brand. Rejects like getDataTable when the type cannot be drawn."},{"path":"/docs/methods/exportSVG","title":"exportSVG","description":"Downloads the chart as an SVG file (). Rejects with a ChartLoadError when the type cannot be drawn here."},{"path":"/docs/methods/exportPNG","title":"exportPNG","description":"Downloads the chart as a PNG file at `exportScale` (). Rejects with a ChartLoadError when the type cannot be drawn here."},{"path":"/docs/methods/print","title":"print","description":"Prints an inlined snapshot of the chart (Highcharts `printChart`), brand included. The snapshot goes into a hidden frame of this document that prints itself: the former popup (`window.open(…, 'noopener,noreferrer')`) always got `null` back — `noopener` hides the new window from its opener — so nothing was ever printed, and a popup opened after the awaited export would also meet popup blockers. The frame is built with DOM calls only: the chart title becomes the document title and the image's alt text as plain text (never HTML), and no inline script or handler is needed. Rejects with a ChartLoadError when the type cannot be drawn here."},{"path":"/docs/methods/setContextMenuEnabled","title":"setContextMenuEnabled","description":"Enables or disables the shared right-click context menu at runtime."},{"path":"/docs/methods/openContextMenu","title":"openContextMenu","description":"Opens the shared context menu at chart-local coordinates, or the chart centre when omitted."},{"path":"/docs/methods/closeContextMenu","title":"closeContextMenu","description":"Closes the shared context menu."},{"path":"/docs/methods/showDataTable","title":"showDataTable","description":"Opens the accessible data table dialog ()."},{"path":"/docs/methods/hideDataTable","title":"hideDataTable","description":"Closes the accessible data table dialog."},{"path":"/docs/methods/redraw","title":"redraw","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"path":"/docs/methods/getYield","title":"getYield","description":"Wafer map: pass/fail/yield summary over the probed dies (`null` on other types)."},{"path":"/docs/methods/getValueStats","title":"getValueStats","description":"Wafer map: statistics over the measured die values (`null` on other types)."},{"path":"/docs/methods/getDefectSummary","title":"getDefectSummary","description":"Wafer map: per-class defect summary (`null` on other types)."},{"path":"/docs/methods/getShotOf","title":"getShotOf","description":"Wafer map: shot (reticle) coordinate of a lattice cell (`null` on other types)."},{"path":"/docs/methods/hitTestDie","title":"hitTestDie","description":"Wafer map: die under a component-local CSS point (`null` off-die or on other types)."},{"path":"/docs/methods/selectDie","title":"selectDie","description":"Wafer map: select a die programmatically (`null` off-lattice or on other types)."},{"path":"/docs/methods/clearDieSelection","title":"clearDieSelection","description":"Wafer map: clear the die selection."},{"path":"/docs/methods/getSelectedDie","title":"getSelectedDie","description":"Wafer map: the current die selection (`null` when none or on other types)."},{"path":"/docs/methods/appendDie","title":"appendDie","description":"Wafer map: stream one probe result in (cell upsert; re-tests emit `binChanged`)."},{"path":"/docs/methods/updateDie","title":"updateDie","description":"Wafer map: patch one die's data (creates the cell when absent)."},{"path":"/docs/methods/getDieIndex","title":"getDieIndex","description":"Wafer map: map index of a notch-frame lattice cell (`null` off-wafer or on other types)."},{"path":"/docs/methods/getDieByIndex","title":"getDieByIndex","description":"Wafer map: die entry addressed by its map index (`null` off-wafer or on other types)."},{"path":"/docs/methods/getRunningTotal","title":"getRunningTotal","description":"The waterfall's running total after its last step (the value a total bar stands to); `undefined` on any other type."},{"path":"/docs/methods/getTypeLoadState","title":"getTypeLoadState","description":"The chart type's current load answer : status, tag, entitlement state, reason and attempt."},{"path":"/docs/methods/whenTypeReady","title":"whenTypeReady","description":"Resolves once the chart type's answer is settled — ready, or the reason it cannot be drawn — after a pending license or an import in flight. Never rejects: check `status`."},{"path":"/docs/methods/retryTypeLoad","title":"retryTypeLoad","description":"Asks for the chart type again (a new attempt), e.g. after `load-failed`; resolves with the settled answer."},{"path":"/docs/methods/getEngineStatus","title":"getEngineStatus","description":"The engine behind the chart : the element's own getEngineStatus() once the type is drawn; while it cannot be, the facade's answer — `unavailable` with the license code, `module-missing` (not installed or not selected) or `load-failed` (the element's chunk). Null while the type is loading, for an unknown type, and before the element answers."},{"path":"/docs/methods/getActiveTier","title":"getActiveTier","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/setData","title":"setData","description":"Replace the bar set."},{"path":"/docs/methods/addSeries","title":"addSeries","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/removeSeries","title":"removeSeries","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/updateSeries","title":"updateSeries","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/updatePoint","title":"updatePoint","description":"Radar-only — patch one category value in a series."},{"path":"/docs/methods/setSeriesData","title":"setSeriesData","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/addPointToSeries","title":"addPointToSeries","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showSeries","title":"showSeries","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/hideSeries","title":"hideSeries","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/appendPoint","title":"appendPoint","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"path":"/docs/methods/appendBatch","title":"appendBatch","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"path":"/docs/methods/shift","title":"shift","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"path":"/docs/methods/replace","title":"replace","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"path":"/docs/methods/getStreamSource","title":"getStreamSource","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"path":"/docs/methods/setAnimation","title":"setAnimation","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/pauseAnimation","title":"pauseAnimation","description":"Pause the current animation."},{"path":"/docs/methods/resumeAnimation","title":"resumeAnimation","description":"Resume a paused animation."},{"path":"/docs/methods/replayAnimation","title":"replayAnimation","description":"Pie / gauge — replay the initial reveal (pie sweep-from-zero, gauge sweep-from-min)."},{"path":"/docs/methods/setValue","title":"setValue","description":"Gauge-only — set the primary value."},{"path":"/docs/methods/getValue","title":"getValue","description":"Gauge-only — read the current primary value."},{"path":"/docs/methods/addNeedle","title":"addNeedle","description":"Gauge-only — add a needle (dial variant)."},{"path":"/docs/methods/removeNeedle","title":"removeNeedle","description":"Gauge-only — remove a needle by id or index."},{"path":"/docs/methods/updateNeedle","title":"updateNeedle","description":"Gauge-only — patch a needle."},{"path":"/docs/methods/addSection","title":"addSection","description":"Funnel / pyramid-only — add a section (stage). Returns its index."},{"path":"/docs/methods/removeSection","title":"removeSection","description":"Funnel / pyramid-only — remove a section by id or index."},{"path":"/docs/methods/updateSection","title":"updateSection","description":"Funnel / pyramid-only — patch a section."},{"path":"/docs/methods/hitTest","title":"hitTest","description":"Radar / funnel / pyramid — hit-test the polar/radial SVG at chart-local coordinates."},{"path":"/docs/methods/showRadarTooltipAt","title":"showRadarTooltipAt","description":"Radar-only — open a vertex tooltip by series/category index."},{"path":"/docs/methods/showSectionTooltipAt","title":"showSectionTooltipAt","description":"Funnel / pyramid-only — open a section tooltip by id or index."},{"path":"/docs/methods/hitTestGauge","title":"hitTestGauge","description":"Gauge-only — hit-test the dial at canvas coordinates."},{"path":"/docs/methods/showGaugeTooltip","title":"showGaugeTooltip","description":"Gauge-only — open the value tooltip programmatically."},{"path":"/docs/methods/showTooltipAtValue","title":"showTooltipAtValue","description":"Gauge-only — open the value tooltip at a specific value's angle (analogue of showTooltipAtSlice)."},{"path":"/docs/methods/setRings","title":"setRings","description":"Gauge-only (activity) — replace the ring set."},{"path":"/docs/methods/setRingValue","title":"setRingValue","description":"Gauge-only (activity) — update one ring's value by id, name, or index."},{"path":"/docs/methods/selectNodeAt","title":"selectNodeAt","description":"Sankey / Chord / Network Graph — pin a node by index; its neighbourhood stays highlighted after pointer leave. A negative or unknown index releases selection. `null` on other types."},{"path":"/docs/methods/selectRowAt","title":"selectRowAt","description":"Treemap: enter a positive branch by ID, or null for the forest. Requires drilldown. Select a visible Gantt task by its normalized source index. Parallel Coordinates: source rows and independent axis geometry."},{"path":"/docs/methods/getRows","title":"getRows","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getRow","title":"getRow","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getRowById","title":"getRowById","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getRowCount","title":"getRowCount","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesLayout","title":"getParallelCoordinatesLayout","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/setParallelCoordinatesBrushes","title":"setParallelCoordinatesBrushes","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/setParallelCoordinatesAxisBrush","title":"setParallelCoordinatesAxisBrush","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/clearParallelCoordinatesBrushes","title":"clearParallelCoordinatesBrushes","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesBrushes","title":"getParallelCoordinatesBrushes","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesBrushedRows","title":"getParallelCoordinatesBrushedRows","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesBrushModels","title":"getParallelCoordinatesBrushModels","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesLineModels","title":"getParallelCoordinatesLineModels","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesAxisModels","title":"getParallelCoordinatesAxisModels","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesAxes","title":"getParallelCoordinatesAxes","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getParallelCoordinatesDiagnostics","title":"getParallelCoordinatesDiagnostics","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/selectTaskAt","title":"selectTaskAt","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getTasks","title":"getTasks","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getTask","title":"getTask","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getTaskById","title":"getTaskById","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getTaskCount","title":"getTaskCount","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttExtent","title":"getGanttExtent","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttLayout","title":"getGanttLayout","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttDiagnostics","title":"getGanttDiagnostics","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttLabels","title":"getGanttLabels","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttBaselines","title":"getGanttBaselines","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttTaskEdits","title":"getGanttTaskEdits","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/resetGanttTaskEdits","title":"resetGanttTaskEdits","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/cancelGanttTaskEdit","title":"cancelGanttTaskEdit","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttCriticalPath","title":"getGanttCriticalPath","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttDependencies","title":"getGanttDependencies","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttDependencyPaths","title":"getGanttDependencyPaths","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttDependencySelection","title":"getGanttDependencySelection","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/selectGanttDependencyAt","title":"selectGanttDependencyAt","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/hitTestGanttDependency","title":"hitTestGanttDependency","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showGanttDependencyTooltipAtIndex","title":"showGanttDependencyTooltipAtIndex","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getGanttTimeAxis","title":"getGanttTimeAxis","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/drillTo","title":"drillTo","description":"Enter a structural branch by stable ID; null returns to the complete forest. Requires drilldown."},{"path":"/docs/methods/drillDown","title":"drillDown","description":"Treemap: enter a branch by its normalized data index. Requires drilldown."},{"path":"/docs/methods/drillUp","title":"drillUp","description":"Treemap: return to the parent branch, then the forest."},{"path":"/docs/methods/getDrillRoot","title":"getDrillRoot","description":"Treemap: current branch with its original identity and index, or null for the forest."},{"path":"/docs/methods/selectLinkAt","title":"selectLinkAt","description":"Sankey / Chord / Network Graph — pin a link by index; it keeps the accent after pointer leave. A negative or unknown index releases selection. `null` on other types."},{"path":"/docs/methods/clearSelection","title":"clearSelection","description":"Sankey / Chord / Network Graph — release selection (a no-op on other types)."},{"path":"/docs/methods/pinNode","title":"pinNode","description":"Sankey / Chord / Network Graph — `{ node, link }` selection details, each nullable; `null` on other types. Network Graph — hold a node at a plot-local position (as a drag does); null on other types or unknown ids."},{"path":"/docs/methods/unpinNode","title":"unpinNode","description":"Network Graph — release a pinned node; false on other types or when it was not pinned."},{"path":"/docs/methods/clearPinnedNodes","title":"clearPinnedNodes","description":"Network Graph — release every pinned node; the count released."},{"path":"/docs/methods/getPinnedNodes","title":"getPinnedNodes","description":"Network Graph — the pinned nodes at their applied positions; empty on other types."},{"path":"/docs/methods/getSelection","title":"getSelection","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"path":"/docs/methods/selectSlice","title":"selectSlice","description":"Pie-only — select a slice by id or index."},{"path":"/docs/methods/deselectSlice","title":"deselectSlice","description":"Pie-only — clear selection on a slice."},{"path":"/docs/methods/getSelectedSlices","title":"getSelectedSlices","description":"Pie-only — read the current selection set."},{"path":"/docs/methods/hitTestSlice","title":"hitTestSlice","description":"Pie-only — hit-test slice at canvas-relative coordinates."},{"path":"/docs/methods/showTooltipAtSlice","title":"showTooltipAtSlice","description":"Pie-only — programmatic tooltip open."},{"path":"/docs/methods/addParty","title":"addParty","description":"Item-only — add a party (datum) to the parliament."},{"path":"/docs/methods/removeParty","title":"removeParty","description":"Item-only — remove a party by id, name, or index."},{"path":"/docs/methods/updateParty","title":"updateParty","description":"Item-only — patch a party's datum fields."},{"path":"/docs/methods/setPartySeats","title":"setPartySeats","description":"Item-only — set a party's seat count."},{"path":"/docs/methods/hitTestSeat","title":"hitTestSeat","description":"Item-only — hit-test the seat dot at canvas-relative coordinates."},{"path":"/docs/methods/showTooltipAtParty","title":"showTooltipAtParty","description":"Item-only — programmatic tooltip open on a party."},{"path":"/docs/methods/addWord","title":"addWord","description":"Word-cloud-only — add a word datum."},{"path":"/docs/methods/removeWord","title":"removeWord","description":"Word-cloud-only — remove a word by id, name, or index."},{"path":"/docs/methods/updateWord","title":"updateWord","description":"Word-cloud-only — patch a word's datum fields."},{"path":"/docs/methods/setWordWeight","title":"setWordWeight","description":"Word-cloud-only — set a word's weight."},{"path":"/docs/methods/hitTestWord","title":"hitTestWord","description":"Word-cloud-only — hit-test the word at canvas-relative coordinates."},{"path":"/docs/methods/getDroppedWords","title":"getDroppedWords","description":"Word-cloud-only — words the spiral could not fit inside the plot."},{"path":"/docs/methods/showTooltipAtWord","title":"showTooltipAtWord","description":"Word-cloud-only — programmatic tooltip open on a word."},{"path":"/docs/methods/addTile","title":"addTile","description":"Tilemap-only — append a tile datum (occupied cells update in place)."},{"path":"/docs/methods/removeTile","title":"removeTile","description":"Tilemap-only — remove a tile by id, name, index, or `{x, y}` cell."},{"path":"/docs/methods/updateTile","title":"updateTile","description":"Tilemap-only — patch a tile's datum fields."},{"path":"/docs/methods/setTileValue","title":"setTileValue","description":"Tilemap-only — set a tile's metric value."},{"path":"/docs/methods/hitTestTile","title":"hitTestTile","description":"Tilemap-only — hit-test the tile at canvas-relative coordinates."},{"path":"/docs/methods/showTooltipAtTile","title":"showTooltipAtTile","description":"Tilemap-only — programmatic tooltip open on a tile."},{"path":"/docs/methods/hitTestLeaf","title":"hitTestLeaf","description":"Stem-leaf-only — hit-test the leaf at canvas-relative coordinates."},{"path":"/docs/methods/showTooltipAtLeaf","title":"showTooltipAtLeaf","description":"Stem-leaf-only — programmatic tooltip open on a leaf by source index."},{"path":"/docs/methods/hitTestSegment","title":"hitTestSegment","description":"Polar-only — hit-test the rose segment at canvas-relative coordinates."},{"path":"/docs/methods/showTooltipAtSegment","title":"showTooltipAtSegment","description":"Polar-only — programmatic tooltip open on a (direction, series) cell."},{"path":"/docs/methods/hitTestMarker","title":"hitTestMarker","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/hitTestMarkers","title":"hitTestMarkers","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showTooltipAtPoint","title":"showTooltipAtPoint","description":"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."},{"path":"/docs/methods/zoomTo","title":"zoomTo","description":"zoom the active cartesian family to explicit windows (`x` / `y`, `xAxis` / `yAxis`). Non-cartesian types resolve `null`."},{"path":"/docs/methods/zoomBy","title":"zoomBy","description":"scale the active cartesian family's windows by `factor` (< 1 zooms in) around `anchorFraction`."},{"path":"/docs/methods/panBy","title":"panBy","description":"slide the active cartesian family's zoomed windows by data units (`{ x?, y? }`)."},{"path":"/docs/methods/resetZoom","title":"resetZoom","description":"Reset the zoomed or panned range to the original data range."},{"path":"/docs/methods/resetMapView","title":"resetMapView","description":"Geo Map: restore the configured projection/region and clear viewport zoom."},{"path":"/docs/methods/parseTopoJSON","title":"parseTopoJSON","description":"Geo Map: decode TopoJSON without changing data. Returns null for other chart types or an unavailable child."},{"path":"/docs/methods/parseGeoJSON","title":"parseGeoJSON","description":"Geo Map: decode RFC 7946 GeoJSON without changing data. Returns null for other types or an unavailable child."},{"path":"/docs/methods/setFeatures","title":"setFeatures","description":"Geo Map: atomically validate and replace the polygon layer."},{"path":"/docs/methods/getFeatures","title":"getFeatures","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getMapHeat","title":"getMapHeat","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getMapLayers","title":"getMapLayers","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/setMapLayerVisible","title":"setMapLayerVisible","description":"Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null."},{"path":"/docs/methods/fitMap","title":"fitMap","description":"Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged."},{"path":"/docs/methods/getMapLabels","title":"getMapLabels","description":"Full source text and current screen placement for both point and feature names."},{"path":"/docs/methods/getMapView","title":"getMapView","description":"Owned geographic camera, effective region and viewport state."},{"path":"/docs/methods/getMapHeatAt","title":"getMapHeatAt","description":"Read aggregate density at a host-relative point; original point/feature selection remains separate."},{"path":"/docs/methods/getMapHeatAtCoordinate","title":"getMapHeatAtCoordinate","description":"Current visible density at longitude/latitude; null when hidden, clipped or outside the viewport."},{"path":"/docs/methods/getMapBubbleScale","title":"getMapBubbleScale","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getMapColorAxis","title":"getMapColorAxis","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getMapDiagnostics","title":"getMapDiagnostics","description":"Current Geo Map normalization counters; null for another type or an absent child."},{"path":"/docs/methods/getMapAvailability","title":"getMapAvailability","description":"Geo Map requested/active engine, asynchronous readiness and unavailable reason; null for other families or a missing child."},{"path":"/docs/methods/selectFeatureAt","title":"selectFeatureAt","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getFeatureSelection","title":"getFeatureSelection","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/showTooltipAtFeature","title":"showTooltipAtFeature","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getZoom","title":"getZoom","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"path":"/docs/methods/getZoomExtent","title":"getZoomExtent","description":"the active cartesian family's full axis extents (for range controls such as `sy-data-zoom`)."},{"path":"/docs/methods/connect","title":"connect","description":"link this chart's zoom / pan with other charts (elements or ids in this chart's root): every member's `zoomChange` reaches the others as `zoomTo({ source: 'sync' })` on the `axes` (default `'x'`). A newcomer is aligned to this chart. Calling again replaces the link."},{"path":"/docs/methods/disconnect","title":"disconnect","description":"drop the link made by `connect` (the charts keep their windows)."},{"path":"/docs/methods/showCrosshairAt","title":"showCrosshairAt","description":"show the active cartesian family's crosshair at a data position (no `crosshairMove`); false outside the plot."},{"path":"/docs/methods/hideCrosshair","title":"hideCrosshair","description":"hide the crosshair."},{"path":"/docs/methods/setBrush","title":"setBrush","description":"replace the brush areas of the active cartesian family (`null` clears)."},{"path":"/docs/methods/clearBrush","title":"clearBrush","description":"clear the brush areas."},{"path":"/docs/methods/getBrush","title":"getBrush","description":"the persisted brush areas (primary data space)."},{"path":"/docs/methods/getBrushSelection","title":"getBrushSelection","description":"the points inside the brush areas, per series."},{"path":"/docs/methods/getDrawings","title":"getDrawings","description":"the drawing document of the active cartesian family."},{"path":"/docs/methods/setDrawings","title":"setDrawings","description":"replace the drawing document (`null` clears; undoable)."},{"path":"/docs/methods/addDrawing","title":"addDrawing","description":"add one drawing (an explicit id replaces)."},{"path":"/docs/methods/updateDrawing","title":"updateDrawing","description":"merge a patch into one drawing."},{"path":"/docs/methods/removeDrawing","title":"removeDrawing","description":"remove one drawing."},{"path":"/docs/methods/removeDrawings","title":"removeDrawings","description":"remove several drawings in one undoable step."},{"path":"/docs/methods/setDrawingSpace","title":"setDrawingSpace","description":"move a drawing to the other coordinate space (its anchors convert at the current frame)."},{"path":"/docs/methods/clearDrawings","title":"clearDrawings","description":"clear the drawing document (undoable)."},{"path":"/docs/methods/undoDrawing","title":"undoDrawing","description":"undo the last drawing change."},{"path":"/docs/methods/redoDrawing","title":"redoDrawing","description":"redo the last undone drawing change."},{"path":"/docs/methods/exportDrawings","title":"exportDrawings","description":"the drawing document as its JSON envelope."},{"path":"/docs/methods/importDrawings","title":"importDrawings","description":"replace the drawing document from an envelope / list / JSON string."},{"path":"/docs/methods/getDrawingLayer","title":"getDrawingLayer","description":"the drawing overlay as a positioned SVG layer (null without drawings): what `getSVG` / `exportSVG` / `exportPNG` compose into the image."},{"path":"/docs/methods/exportDrawingsFile","title":"exportDrawingsFile","description":"downloads the drawing document as `<export name>-drawings.json` (the envelope `importDrawings` / `importDrawingsFile` read back); reports through `exported`."},{"path":"/docs/methods/importDrawingsFile","title":"importDrawingsFile","description":"replaces the drawing document from a picked file (a File / Blob of the envelope, or its text); a file that is not JSON is declined (null) and the document stays."},{"path":"/docs/methods/selectDrawings","title":"selectDrawings","description":"select drawings (`null` clears)."},{"path":"/docs/methods/getDrawingSelection","title":"getDrawingSelection","description":"the selected drawing ids."},{"path":"/docs/methods/setVisualMap","title":"setVisualMap","description":"bind (or clear) a visual map on the cartesian family that owns the paint."},{"path":"/docs/methods/getVisualMap","title":"getVisualMap","description":"An asynchronous method. Check the argument and return types below."},{"path":"/docs/methods/getVisualExtent","title":"getVisualExtent","description":"the extent of a dimension over the visible points (the domain a bound `sy-visual-map` adopts)."},{"path":"/docs/methods/getDataset","title":"getDataset","description":"the dataset after its transforms (id, dimensions, rows), or null without a dataset."},{"path":"/docs/methods/getEncodedSeries","title":"getEncodedSeries","description":"the encoded series (names, values, xValues, the dimension names behind them) and the category labels, or null."},{"path":"/docs/methods/dispatchAction","title":"dispatchAction","description":"One entry point over the imperative surface (ECharts `dispatchAction`): `{ type, payload }` or `{ type, ...fields }`. Routes to the method behind the type and answers `{ type, handled, result }`; an unknown type is reported, not thrown."},{"path":"/docs/methods/appendSamples","title":"appendSamples","description":"feed raw samples: every completed window becomes a frame (appended through the stream); the rest waits."},{"path":"/docs/methods/hideTooltip","title":"hideTooltip","description":"Close the currently visible tooltip."},{"path":"/docs/methods/hitTestScatterPoint","title":"hitTestScatterPoint","description":"An asynchronous method. Check the argument and return types below."}]}]}]},{"path":"/docs/methods/getFlowLinesData","title":"getFlowLinesData","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getFlowLinesData","parameters":[],"returns":"Promise<FlowLinesData|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getFlowLinesData(): Promise<FlowLinesData|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesData|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getFlowLinesLayout","title":"getFlowLinesLayout","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getFlowLinesLayout","parameters":[],"returns":"Promise<FlowLinesLayout|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getFlowLinesLayout(): Promise<FlowLinesLayout|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesLayout|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesLayout","title":"FlowLinesLayout","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getFlowLinesDiagnostics","title":"getFlowLinesDiagnostics","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getFlowLinesDiagnostics","parameters":[],"returns":"Promise<FlowLinesDiagnostics|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getFlowLinesDiagnostics(): Promise<FlowLinesDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesDiagnostics","title":"FlowLinesDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectFlowLines","title":"selectFlowLines","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectFlowLines","parameters":[{"name":"id","type":"FlowLinesId","optional":false},{"name":"kind","type":"'flow'|'location'","optional":true}],"returns":"Promise<FlowLinesHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectFlowLines(id: FlowLinesId, kind?: 'flow'|'location'): Promise<FlowLinesHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`FlowLinesId`","Required"],["`kind`","`'flow'|'location'`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"},{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showFlowLinesTooltip","title":"showFlowLinesTooltip","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showFlowLinesTooltip","parameters":[{"name":"index","type":"number","optional":false},{"name":"kind","type":"'flow'|'location'","optional":true}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showFlowLinesTooltip(index: number, kind?: 'flow'|'location'): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"],["`kind`","`'flow'|'location'`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/clearFlowLinesStream","title":"clearFlowLinesStream","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"clearFlowLinesStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearFlowLinesStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/recycleFlowLinesGpu","title":"recycleFlowLinesGpu","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"recycleFlowLinesGpu","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"recycleFlowLinesGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getThemeRiverData","title":"getThemeRiverData","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getThemeRiverData","parameters":[],"returns":"Promise<ThemeRiverData|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getThemeRiverData(): Promise<ThemeRiverData|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverData|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getThemeRiverLayout","title":"getThemeRiverLayout","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getThemeRiverLayout","parameters":[],"returns":"Promise<ThemeRiverLayout|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getThemeRiverLayout(): Promise<ThemeRiverLayout|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverLayout|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverLayout","title":"ThemeRiverLayout","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getThemeRiverDiagnostics","title":"getThemeRiverDiagnostics","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getThemeRiverDiagnostics","parameters":[],"returns":"Promise<ThemeRiverDiagnostics|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getThemeRiverDiagnostics(): Promise<ThemeRiverDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverDiagnostics","title":"ThemeRiverDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectThemeRiverPoint","title":"selectThemeRiverPoint","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectThemeRiverPoint","parameters":[{"name":"series","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<ThemeRiverHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectThemeRiverPoint(series: number, column: number): Promise<ThemeRiverHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showThemeRiverTooltip","title":"showThemeRiverTooltip","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showThemeRiverTooltip","parameters":[{"name":"series","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showThemeRiverTooltip(series: number, column: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showThemeRiverCrosshair","title":"showThemeRiverCrosshair","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showThemeRiverCrosshair","parameters":[{"name":"series","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showThemeRiverCrosshair(series: number, column: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/clearThemeRiverStream","title":"clearThemeRiverStream","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"clearThemeRiverStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearThemeRiverStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/recycleThemeRiverGpu","title":"recycleThemeRiverGpu","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"recycleThemeRiverGpu","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"recycleThemeRiverGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getBar3DData","title":"getBar3DData","summary":"Surface grid coordinates are row/column; generic tooltip methods use a row-major sample index.","kind":"methods","member":{"name":"getBar3DData","parameters":[],"returns":"Promise<Bar3DDatum[]|null>","description":"Surface grid coordinates are row/column; generic tooltip methods use a row-major sample index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getBar3DData(): Promise<Bar3DDatum[]|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DDatum[]|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getScatter3DData","title":"getScatter3DData","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getScatter3DData","parameters":[],"returns":"Promise<Scatter3DDatum[]|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getScatter3DData(): Promise<Scatter3DDatum[]|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DDatum[]|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getBar3DLayout","title":"getBar3DLayout","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getBar3DLayout","parameters":[],"returns":"Promise<Bar3DGeometry|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getBar3DLayout(): Promise<Bar3DGeometry|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DGeometry|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DGeometry","title":"Bar3DGeometry","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getScatter3DLayout","title":"getScatter3DLayout","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getScatter3DLayout","parameters":[],"returns":"Promise<Scatter3DGeometry|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getScatter3DLayout(): Promise<Scatter3DGeometry|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DGeometry|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DGeometry","title":"Scatter3DGeometry","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getBar3DDiagnostics","title":"getBar3DDiagnostics","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getBar3DDiagnostics","parameters":[],"returns":"Promise<Bar3DDiagnostics|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getBar3DDiagnostics(): Promise<Bar3DDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDiagnostics","title":"Bar3DDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getScatter3DDiagnostics","title":"getScatter3DDiagnostics","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getScatter3DDiagnostics","parameters":[],"returns":"Promise<Scatter3DDiagnostics|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getScatter3DDiagnostics(): Promise<Scatter3DDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDiagnostics","title":"Scatter3DDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectBar3DPoint","title":"selectBar3DPoint","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectBar3DPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<Bar3DHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectBar3DPoint(index: number): Promise<Bar3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Bar3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectScatter3DPoint","title":"selectScatter3DPoint","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectScatter3DPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<Scatter3DHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectScatter3DPoint(index: number): Promise<Scatter3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showBar3DTooltip","title":"showBar3DTooltip","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showBar3DTooltip","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showBar3DTooltip(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showScatter3DTooltip","title":"showScatter3DTooltip","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showScatter3DTooltip","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showScatter3DTooltip(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showBar3DCrosshair","title":"showBar3DCrosshair","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showBar3DCrosshair","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showBar3DCrosshair(index: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showScatter3DCrosshair","title":"showScatter3DCrosshair","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showScatter3DCrosshair","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showScatter3DCrosshair(index: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getSurface3DData","title":"getSurface3DData","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getSurface3DData","parameters":[],"returns":"Promise<Surface3DGrid|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getSurface3DData(): Promise<Surface3DGrid|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DGrid|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DGrid","title":"Surface3DGrid","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getSurface3DLayout","title":"getSurface3DLayout","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getSurface3DLayout","parameters":[],"returns":"Promise<Surface3DGeometry|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getSurface3DLayout(): Promise<Surface3DGeometry|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DGeometry|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DGeometry","title":"Surface3DGeometry","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getSurface3DDiagnostics","title":"getSurface3DDiagnostics","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getSurface3DDiagnostics","parameters":[],"returns":"Promise<Surface3DDiagnostics|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getSurface3DDiagnostics(): Promise<Surface3DDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DDiagnostics","title":"Surface3DDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectSurface3DPoint","title":"selectSurface3DPoint","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectSurface3DPoint","parameters":[{"name":"row","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<Surface3DHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectSurface3DPoint(row: number, column: number): Promise<Surface3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Surface3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showSurface3DTooltip","title":"showSurface3DTooltip","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showSurface3DTooltip","parameters":[{"name":"row","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showSurface3DTooltip(row: number, column: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showSurface3DCrosshair","title":"showSurface3DCrosshair","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showSurface3DCrosshair","parameters":[{"name":"row","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showSurface3DCrosshair(row: number, column: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getCamera3D","title":"getCamera3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getCamera3D","parameters":[],"returns":"Promise<Scene3DCameraOptions|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getCamera3D(): Promise<Scene3DCameraOptions|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scene3DCameraOptions|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/setCamera3D","title":"setCamera3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"setCamera3D","parameters":[{"name":"options","type":"Scene3DCameraOptions","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setCamera3D(options: Scene3DCameraOptions): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`Scene3DCameraOptions`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/setProjection3D","title":"setProjection3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"setProjection3D","parameters":[{"name":"projection","type":"Scene3DProjection","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setProjection3D(projection: Scene3DProjection): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`projection`","`Scene3DProjection`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DProjection","title":"Scene3DProjection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/fitCamera3D","title":"fitCamera3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"fitCamera3D","parameters":[{"name":"padding","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"fitCamera3D(padding?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`padding`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/resetCamera3D","title":"resetCamera3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"resetCamera3D","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"resetCamera3D(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/saveCamera3D","title":"saveCamera3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"saveCamera3D","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"saveCamera3D(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/rotate3D","title":"rotate3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"rotate3D","parameters":[{"name":"azimuth","type":"number","optional":false},{"name":"polar","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"rotate3D(azimuth: number, polar?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`azimuth`","`number`","Required"],["`polar`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/pan3D","title":"pan3D","summary":"Pan the 3D camera in CSS pixels; use zoomBy for camera distance/orthographic zoom.","kind":"methods","member":{"name":"pan3D","parameters":[{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<void>","description":"Pan the 3D camera in CSS pixels; use zoomBy for camera distance/orthographic zoom."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"pan3D(x: number, y: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/recycleGpu3D","title":"recycleGpu3D","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"recycleGpu3D","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"recycleGpu3D(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/clearBar3DStream","title":"clearBar3DStream","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"clearBar3DStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearBar3DStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/clearScatter3DStream","title":"clearScatter3DStream","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"clearScatter3DStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearScatter3DStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/clearSurface3DStream","title":"clearSurface3DStream","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"clearSurface3DStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearSurface3DStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getDataTable","title":"getDataTable","summary":"Resolves the data table for the current data ( / 134). Waits for the type's load answer and rejects with a ChartLoadError (its `code` = the status) when the type cannot be drawn here: no table is invented for it. A Pro chart type's table comes from its element only (the facade carries no Pro data resolvers).","kind":"methods","member":{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Resolves the data table for the current data ( / 134). Waits for the type's load answer and rejects with a ChartLoadError (its `code` = the status) when the type cannot be drawn here: no table is invented for it. A Pro chart type's table comes from its element only (the facade carries no Pro data resolvers)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/bubble#method-getDataTable","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-getDataTable","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#method-getDataTable","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/box-plot#method-getDataTable","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-getDataTable","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#method-getDataTable","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getDataTable","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getDataTable","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getDataTable","title":"sy-spectrogram","description":""},{"path":"/docs/components/treemap#method-getDataTable","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getDataTable","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getDataTable","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getDataTable","title":"sy-dendrogram","description":""},{"path":"/docs/components/theme-river#method-getDataTable","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-getDataTable","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-getDataTable","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getDataTable","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-getDataTable","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-getDataTable","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-getDataTable","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-getDataTable","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-getDataTable","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-getDataTable","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/getCSV","title":"getCSV","summary":"Returns the chart data as a CSV string (UTF-8 BOM, RFC 4180).","kind":"methods","member":{"name":"getCSV","parameters":[],"returns":"Promise<string>","description":"Returns the chart data as a CSV string (UTF-8 BOM, RFC 4180)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getCSV(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/theme-river#method-getCSV","title":"sy-theme-river","description":""},{"path":"/docs/components/stock-chart#method-getCSV","title":"sy-stock-chart","description":""},{"path":"/docs/components/surface-3d#method-getCSV","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-getCSV","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-getCSV","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/methods/getSVG","title":"getSVG","summary":"Returns the chart as standalone SVG markup (canvas families wrap their raster); the drawing overlay rides along as a nested layer, and the brand is the last layer over everything. Keeps its `string | null` contract: null when the type cannot be drawn here (see getDataTable) or there is no surface yet.","kind":"methods","member":{"name":"getSVG","parameters":[],"returns":"Promise<string | null>","description":"Returns the chart as standalone SVG markup (canvas families wrap their raster); the drawing overlay rides along as a nested layer, and the brand is the last layer over everything. Keeps its `string | null` contract: null when the type cannot be drawn here (see getDataTable) or there is no surface yet."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getSVG(): Promise<string | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/exportCSV","title":"exportCSV","summary":"Downloads the chart data as a CSV file (). Data only: no brand. Rejects like getDataTable when the type cannot be drawn.","kind":"methods","member":{"name":"exportCSV","parameters":[],"returns":"Promise<void>","description":"Downloads the chart data as a CSV file (). Data only: no brand. Rejects like getDataTable when the type cannot be drawn."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"exportCSV(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/stock-chart#method-exportCSV","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/exportSVG","title":"exportSVG","summary":"Downloads the chart as an SVG file (). Rejects with a ChartLoadError when the type cannot be drawn here.","kind":"methods","member":{"name":"exportSVG","parameters":[],"returns":"Promise<void>","description":"Downloads the chart as an SVG file (). Rejects with a ChartLoadError when the type cannot be drawn here."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"exportSVG(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/stock-chart#method-exportSVG","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/exportPNG","title":"exportPNG","summary":"Downloads the chart as a PNG file at `exportScale` (). Rejects with a ChartLoadError when the type cannot be drawn here.","kind":"methods","member":{"name":"exportPNG","parameters":[],"returns":"Promise<void>","description":"Downloads the chart as a PNG file at `exportScale` (). Rejects with a ChartLoadError when the type cannot be drawn here."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"exportPNG(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/stock-chart#method-exportPNG","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/print","title":"print","summary":"Prints an inlined snapshot of the chart (Highcharts `printChart`), brand included. The snapshot goes into a hidden frame of this document that prints itself: the former popup (`window.open(…, 'noopener,noreferrer')`) always got `null` back — `noopener` hides the new window from its opener — so nothing was ever printed, and a popup opened after the awaited export would also meet popup blockers. The frame is built with DOM calls only: the chart title becomes the document title and the image's alt text as plain text (never HTML), and no inline script or handler is needed. Rejects with a ChartLoadError when the type cannot be drawn here.","kind":"methods","member":{"name":"print","parameters":[],"returns":"Promise<void>","description":"Prints an inlined snapshot of the chart (Highcharts `printChart`), brand included. The snapshot goes into a hidden frame of this document that prints itself: the former popup (`window.open(…, 'noopener,noreferrer')`) always got `null` back — `noopener` hides the new window from its opener — so nothing was ever printed, and a popup opened after the awaited export would also meet popup blockers. The frame is built with DOM calls only: the chart title becomes the document title and the image's alt text as plain text (never HTML), and no inline script or handler is needed. Rejects with a ChartLoadError when the type cannot be drawn here."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"print(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/stock-chart#method-print","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/setContextMenuEnabled","title":"setContextMenuEnabled","summary":"Enables or disables the shared right-click context menu at runtime.","kind":"methods","member":{"name":"setContextMenuEnabled","parameters":[{"name":"enabled","type":"boolean","optional":false}],"returns":"Promise<void>","description":"Enables or disables the shared right-click context menu at runtime."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setContextMenuEnabled(enabled: boolean): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`enabled`","`boolean`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/openContextMenu","title":"openContextMenu","summary":"Opens the shared context menu at chart-local coordinates, or the chart centre when omitted.","kind":"methods","member":{"name":"openContextMenu","parameters":[{"name":"options","type":"ChartContextMenuOpenOptions","optional":true}],"returns":"Promise<void>","description":"Opens the shared context menu at chart-local coordinates, or the chart centre when omitted."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"openContextMenu(options?: ChartContextMenuOpenOptions): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`ChartContextMenuOpenOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartContextMenuOpenOptions","title":"ChartContextMenuOpenOptions","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/closeContextMenu","title":"closeContextMenu","summary":"Closes the shared context menu.","kind":"methods","member":{"name":"closeContextMenu","parameters":[],"returns":"Promise<void>","description":"Closes the shared context menu."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"closeContextMenu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showDataTable","title":"showDataTable","summary":"Opens the accessible data table dialog ().","kind":"methods","member":{"name":"showDataTable","parameters":[],"returns":"Promise<void>","description":"Opens the accessible data table dialog ()."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showDataTable(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/hideDataTable","title":"hideDataTable","summary":"Closes the accessible data table dialog.","kind":"methods","member":{"name":"hideDataTable","parameters":[],"returns":"Promise<void>","description":"Closes the accessible data table dialog."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hideDataTable(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/redraw","title":"redraw","summary":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves.","kind":"methods","member":{"name":"redraw","parameters":[],"returns":"Promise<ChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"redraw(): Promise<ChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartRenderResult","title":"ChartRenderResult","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-redraw","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-redraw","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-redraw","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-redraw","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-redraw","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-redraw","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-redraw","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-redraw","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-redraw","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-redraw","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-redraw","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-redraw","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-redraw","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-redraw","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-redraw","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-redraw","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-redraw","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-redraw","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-redraw","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-redraw","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-redraw","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-redraw","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-redraw","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-redraw","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-redraw","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-redraw","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-redraw","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-redraw","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-redraw","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-redraw","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-redraw","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-redraw","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-redraw","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-redraw","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-redraw","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-redraw","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-redraw","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-redraw","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-redraw","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-redraw","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-redraw","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-redraw","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-redraw","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-redraw","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-redraw","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-redraw","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-redraw","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-redraw","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-redraw","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-redraw","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getYield","title":"getYield","summary":"Wafer map: pass/fail/yield summary over the probed dies (`null` on other types).","kind":"methods","member":{"name":"getYield","parameters":[],"returns":"Promise<{ pass: number; fail: number; probed: number; yield: number } | null>","description":"Wafer map: pass/fail/yield summary over the probed dies (`null` on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getYield(): Promise<{ pass: number; fail: number; probed: number; yield: number } | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ pass: number; fail: number; probed: number; yield: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-getYield","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getValueStats","title":"getValueStats","summary":"Wafer map: statistics over the measured die values (`null` on other types).","kind":"methods","member":{"name":"getValueStats","parameters":[],"returns":"Promise<{ count: number; min: number; max: number; mean: number; stdDev: number; median: number } | null>","description":"Wafer map: statistics over the measured die values (`null` on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getValueStats(): Promise<{ count: number; min: number; max: number; mean: number; stdDev: number; median: number } | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ count: number; min: number; max: number; mean: number; stdDev: number; median: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-getValueStats","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getDefectSummary","title":"getDefectSummary","summary":"Wafer map: per-class defect summary (`null` on other types).","kind":"methods","member":{"name":"getDefectSummary","parameters":[],"returns":"Promise<{ total: number; offWafer: number; byClass: Array<{ key: string; count: number }> } | null>","description":"Wafer map: per-class defect summary (`null` on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDefectSummary(): Promise<{ total: number; offWafer: number; byClass: Array<{ key: string; count: number }> } | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ total: number; offWafer: number; byClass: Array<{ key: string; count: number }> } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-getDefectSummary","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getShotOf","title":"getShotOf","summary":"Wafer map: shot (reticle) coordinate of a lattice cell (`null` on other types).","kind":"methods","member":{"name":"getShotOf","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<{ shotCol: number; shotRow: number } | null>","description":"Wafer map: shot (reticle) coordinate of a lattice cell (`null` on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getShotOf(col: number, row: number): Promise<{ shotCol: number; shotRow: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ shotCol: number; shotRow: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-getShotOf","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/hitTestDie","title":"hitTestDie","summary":"Wafer map: die under a component-local CSS point (`null` off-die or on other types).","kind":"methods","member":{"name":"hitTestDie","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<unknown | null>","description":"Wafer map: die under a component-local CSS point (`null` off-die or on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestDie(cssX: number, cssY: number): Promise<unknown | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<unknown | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-hitTestDie","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/selectDie","title":"selectDie","summary":"Wafer map: select a die programmatically (`null` off-lattice or on other types).","kind":"methods","member":{"name":"selectDie","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<unknown | null>","description":"Wafer map: select a die programmatically (`null` off-lattice or on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectDie(col: number, row: number): Promise<unknown | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<unknown | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-selectDie","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/clearDieSelection","title":"clearDieSelection","summary":"Wafer map: clear the die selection.","kind":"methods","member":{"name":"clearDieSelection","parameters":[],"returns":"Promise<void>","description":"Wafer map: clear the die selection."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearDieSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-clearDieSelection","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getSelectedDie","title":"getSelectedDie","summary":"Wafer map: the current die selection (`null` when none or on other types).","kind":"methods","member":{"name":"getSelectedDie","parameters":[],"returns":"Promise<unknown | null>","description":"Wafer map: the current die selection (`null` when none or on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getSelectedDie(): Promise<unknown | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<unknown | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-getSelectedDie","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/appendDie","title":"appendDie","summary":"Wafer map: stream one probe result in (cell upsert; re-tests emit `binChanged`).","kind":"methods","member":{"name":"appendDie","parameters":[{"name":"datum","type":"{ col: number; row: number; bin?: number | string; value?: number }","optional":false}],"returns":"Promise<void>","description":"Wafer map: stream one probe result in (cell upsert; re-tests emit `binChanged`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"appendDie(datum: { col: number; row: number; bin?: number | string; value?: number }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`{ col: number; row: number; bin?: number | string; value?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-appendDie","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/updateDie","title":"updateDie","summary":"Wafer map: patch one die's data (creates the cell when absent).","kind":"methods","member":{"name":"updateDie","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false},{"name":"patch","type":"{ bin?: number | string; value?: number }","optional":false}],"returns":"Promise<unknown | null>","description":"Wafer map: patch one die's data (creates the cell when absent)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateDie(col: number, row: number, patch: { bin?: number | string; value?: number }): Promise<unknown | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"],["`patch`","`{ bin?: number | string; value?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<unknown | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-updateDie","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getDieIndex","title":"getDieIndex","summary":"Wafer map: map index of a notch-frame lattice cell (`null` off-wafer or on other types).","kind":"methods","member":{"name":"getDieIndex","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<DieIndexEntry | null>","description":"Wafer map: map index of a notch-frame lattice cell (`null` off-wafer or on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDieIndex(col: number, row: number): Promise<DieIndexEntry | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DieIndexEntry | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DieIndexEntry","title":"DieIndexEntry","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-getDieIndex","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getDieByIndex","title":"getDieByIndex","summary":"Wafer map: die entry addressed by its map index (`null` off-wafer or on other types).","kind":"methods","member":{"name":"getDieByIndex","parameters":[{"name":"ix","type":"number","optional":false},{"name":"iy","type":"number","optional":false}],"returns":"Promise<DieIndexEntry | null>","description":"Wafer map: die entry addressed by its map index (`null` off-wafer or on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDieByIndex(ix: number, iy: number): Promise<DieIndexEntry | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ix`","`number`","Required"],["`iy`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DieIndexEntry | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DieIndexEntry","title":"DieIndexEntry","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/wafer-map#method-getDieByIndex","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getRunningTotal","title":"getRunningTotal","summary":"The waterfall's running total after its last step (the value a total bar stands to); `undefined` on any other type.","kind":"methods","member":{"name":"getRunningTotal","parameters":[],"returns":"Promise<number | undefined>","description":"The waterfall's running total after its last step (the value a total bar stands to); `undefined` on any other type."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getRunningTotal(): Promise<number | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/waterfall#method-getRunningTotal","title":"sy-waterfall-chart","description":""}]}]}]},{"path":"/docs/methods/getTypeLoadState","title":"getTypeLoadState","summary":"The chart type's current load answer : status, tag, entitlement state, reason and attempt.","kind":"methods","member":{"name":"getTypeLoadState","parameters":[],"returns":"Promise<ChartTypeLoadDetail>","description":"The chart type's current load answer : status, tag, entitlement state, reason and attempt."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getTypeLoadState(): Promise<ChartTypeLoadDetail>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartTypeLoadDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartTypeLoadDetail","title":"ChartTypeLoadDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/whenTypeReady","title":"whenTypeReady","summary":"Resolves once the chart type's answer is settled — ready, or the reason it cannot be drawn — after a pending license or an import in flight. Never rejects: check `status`.","kind":"methods","member":{"name":"whenTypeReady","parameters":[],"returns":"Promise<ChartTypeLoadDetail>","description":"Resolves once the chart type's answer is settled — ready, or the reason it cannot be drawn — after a pending license or an import in flight. Never rejects: check `status`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"whenTypeReady(): Promise<ChartTypeLoadDetail>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartTypeLoadDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartTypeLoadDetail","title":"ChartTypeLoadDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/retryTypeLoad","title":"retryTypeLoad","summary":"Asks for the chart type again (a new attempt), e.g. after `load-failed`; resolves with the settled answer.","kind":"methods","member":{"name":"retryTypeLoad","parameters":[],"returns":"Promise<ChartTypeLoadDetail>","description":"Asks for the chart type again (a new attempt), e.g. after `load-failed`; resolves with the settled answer."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"retryTypeLoad(): Promise<ChartTypeLoadDetail>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartTypeLoadDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartTypeLoadDetail","title":"ChartTypeLoadDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getEngineStatus","title":"getEngineStatus","summary":"The engine behind the chart : the element's own getEngineStatus() once the type is drawn; while it cannot be, the facade's answer — `unavailable` with the license code, `module-missing` (not installed or not selected) or `load-failed` (the element's chunk). Null while the type is loading, for an unknown type, and before the element answers.","kind":"methods","member":{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus | null>","description":"The engine behind the chart : the element's own getEngineStatus() once the type is drawn; while it cannot be, the facade's answer — `unavailable` with the license code, `module-missing` (not installed or not selected) or `load-failed` (the element's chunk). Null while the type is loading, for an unknown type, and before the element answers."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getEngineStatus","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getEngineStatus","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getEngineStatus","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getEngineStatus","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-getEngineStatus","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-getEngineStatus","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-getEngineStatus","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-getEngineStatus","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-getEngineStatus","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-getEngineStatus","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-getEngineStatus","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-getEngineStatus","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-getEngineStatus","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-getEngineStatus","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-getEngineStatus","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-getEngineStatus","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-getEngineStatus","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-getEngineStatus","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-getEngineStatus","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-getEngineStatus","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-getEngineStatus","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-getEngineStatus","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getEngineStatus","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getEngineStatus","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getEngineStatus","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-getEngineStatus","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-getEngineStatus","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-getEngineStatus","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-getEngineStatus","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-getEngineStatus","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-getEngineStatus","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-getEngineStatus","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-getEngineStatus","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getEngineStatus","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getEngineStatus","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getEngineStatus","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-getEngineStatus","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-getEngineStatus","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-getEngineStatus","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-getEngineStatus","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-getEngineStatus","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-getEngineStatus","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getEngineStatus","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-getEngineStatus","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-getEngineStatus","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-getEngineStatus","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-getEngineStatus","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-getEngineStatus","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-getEngineStatus","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-getEngineStatus","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getActiveTier","title":"getActiveTier","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getActiveTier","parameters":[],"returns":"Promise<ChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getActiveTier(): Promise<ChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineTier","title":"ChartEngineTier","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getActiveTier","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getActiveTier","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getActiveTier","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getActiveTier","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-getActiveTier","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-getActiveTier","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-getActiveTier","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-getActiveTier","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-getActiveTier","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-getActiveTier","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-getActiveTier","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-getActiveTier","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-getActiveTier","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-getActiveTier","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-getActiveTier","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-getActiveTier","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-getActiveTier","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-getActiveTier","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-getActiveTier","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-getActiveTier","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-getActiveTier","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-getActiveTier","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getActiveTier","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getActiveTier","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getActiveTier","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-getActiveTier","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-getActiveTier","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-getActiveTier","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-getActiveTier","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-getActiveTier","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-getActiveTier","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-getActiveTier","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-getActiveTier","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getActiveTier","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getActiveTier","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getActiveTier","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-getActiveTier","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-getActiveTier","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-getActiveTier","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-getActiveTier","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-getActiveTier","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-getActiveTier","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getActiveTier","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-getActiveTier","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-getActiveTier","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-getActiveTier","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-getActiveTier","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-getActiveTier","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-getActiveTier","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-getActiveTier","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/setData","title":"setData","summary":"Replace the bar set.","kind":"methods","member":{"name":"setData","parameters":[{"name":"data","type":"RadarChartData | FunnelChartData | ReadonlyArray<VariwideDatum> | HeatmapData | DensityMapInput | SpectrogramInput | CalendarHeatmapData | CandlestickData | BoxPlotData | BubbleData | WaterfallData | ErrorBarData | SankeyData | ChordData | NetworkGraphData | TreemapData | SunburstData | IcicleData | GanttData | ParallelCoordinatesData | DendrogramData | GeoMapData | Surface3DData | Scatter3DData | FlowLinesData | ThemeRiverData | Bar3DData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setData(data: RadarChartData | FunnelChartData | ReadonlyArray<VariwideDatum> | HeatmapData | DensityMapInput | SpectrogramInput | CalendarHeatmapData | CandlestickData | BoxPlotData | BubbleData | WaterfallData | ErrorBarData | SankeyData | ChordData | NetworkGraphData | TreemapData | SunburstData | IcicleData | GanttData | ParallelCoordinatesData | DendrogramData | GeoMapData | Surface3DData | Scatter3DData | FlowLinesData | ThemeRiverData | Bar3DData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`RadarChartData | FunnelChartData | ReadonlyArray<VariwideDatum> | HeatmapData | DensityMapInput | SpectrogramInput | CalendarHeatmapData | CandlestickData | BoxPlotData | BubbleData | WaterfallData | ErrorBarData | SankeyData | ChordData | NetworkGraphData | TreemapData | SunburstData | IcicleData | GanttData | ParallelCoordinatesData | DendrogramData | GeoMapData | Surface3DData | Scatter3DData | FlowLinesData | ThemeRiverData | Bar3DData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartData","title":"RadarChartData","description":"Type definition"},{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","description":"Type definition"},{"path":"/docs/types/VariwideDatum","title":"VariwideDatum","description":"Type definition"},{"path":"/docs/types/HeatmapData","title":"HeatmapData","description":"Type definition"},{"path":"/docs/types/DensityMapInput","title":"DensityMapInput","description":"Type definition"},{"path":"/docs/types/SpectrogramInput","title":"SpectrogramInput","description":"Type definition"},{"path":"/docs/types/CalendarHeatmapData","title":"CalendarHeatmapData","description":"Type definition"},{"path":"/docs/types/CandlestickData","title":"CandlestickData","description":"Type definition"},{"path":"/docs/types/BoxPlotData","title":"BoxPlotData","description":"Type definition"},{"path":"/docs/types/BubbleData","title":"BubbleData","description":"Type definition"},{"path":"/docs/types/WaterfallData","title":"WaterfallData","description":"Type definition"},{"path":"/docs/types/ErrorBarData","title":"ErrorBarData","description":"Type definition"},{"path":"/docs/types/SankeyData","title":"SankeyData","description":"Type definition"},{"path":"/docs/types/ChordData","title":"ChordData","description":"Type definition"},{"path":"/docs/types/NetworkGraphData","title":"NetworkGraphData","description":"Type definition"},{"path":"/docs/types/TreemapData","title":"TreemapData","description":"Type definition"},{"path":"/docs/types/SunburstData","title":"SunburstData","description":"Type definition"},{"path":"/docs/types/IcicleData","title":"IcicleData","description":"Type definition"},{"path":"/docs/types/GanttData","title":"GanttData","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesData","title":"ParallelCoordinatesData","description":"Type definition"},{"path":"/docs/types/DendrogramData","title":"DendrogramData","description":"Type definition"},{"path":"/docs/types/GeoMapData","title":"GeoMapData","description":"Type definition"},{"path":"/docs/types/Surface3DData","title":"Surface3DData","description":"Type definition"},{"path":"/docs/types/Scatter3DData","title":"Scatter3DData","description":"Type definition"},{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","description":"Type definition"},{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","description":"Type definition"},{"path":"/docs/types/Bar3DData","title":"Bar3DData","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/bubble#method-setData","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-setData","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-setData","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-setData","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-setData","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-setData","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-setData","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-setData","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-setData","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-setData","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-setData","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-setData","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-setData","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-setData","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-setData","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-setData","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-setData","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-setData","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-setData","title":"sy-spectrogram","description":""},{"path":"/docs/components/funnel#method-setData","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-setData","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-setData","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/treemap#method-setData","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-setData","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-setData","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-setData","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-setData","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-setData","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-setData","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-setData","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-setData","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-setData","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-setData","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-setData","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-setData","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#method-setData","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#method-setData","title":"sy-stock-volume","description":""},{"path":"/docs/components/surface-3d#method-setData","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-setData","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-setData","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-setData","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-setData","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/addSeries","title":"addSeries","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"addSeries","parameters":[{"name":"options","type":"LineChartSeries | ScatterChartSeries","optional":false},{"name":"opts","type":"{ redraw?: boolean; insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addSeries(options: LineChartSeries | ScatterChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`LineChartSeries | ScatterChartSeries`","Required"],["`opts`","`{ redraw?: boolean; insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","description":"Type definition"},{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-addSeries","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-addSeries","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-addSeries","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-addSeries","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-addSeries","title":"sy-scatter-chart","description":""},{"path":"/docs/components/radar#method-addSeries","title":"sy-radar-chart","description":""},{"path":"/docs/components/marimekko#method-addSeries","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/methods/removeSeries","title":"removeSeries","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-removeSeries","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-removeSeries","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-removeSeries","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-removeSeries","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-removeSeries","title":"sy-scatter-chart","description":""},{"path":"/docs/components/radar#method-removeSeries","title":"sy-radar-chart","description":""},{"path":"/docs/components/marimekko#method-removeSeries","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/methods/updateSeries","title":"updateSeries","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<LineChartSeries | ScatterChartSeries>","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<LineChartSeries | ScatterChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<LineChartSeries | ScatterChartSeries>`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","description":"Type definition"},{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-updateSeries","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-updateSeries","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-updateSeries","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-updateSeries","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-updateSeries","title":"sy-scatter-chart","description":""},{"path":"/docs/components/radar#method-updateSeries","title":"sy-radar-chart","description":""},{"path":"/docs/components/marimekko#method-updateSeries","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/methods/updatePoint","title":"updatePoint","summary":"Radar-only — patch one category value in a series.","kind":"methods","member":{"name":"updatePoint","parameters":[{"name":"seriesIdOrIndex","type":"string | number","optional":false},{"name":"categoryIdOrIndex","type":"string | number","optional":false},{"name":"value","type":"number | null","optional":false}],"returns":"Promise<boolean>","description":"Radar-only — patch one category value in a series."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updatePoint(seriesIdOrIndex: string | number, categoryIdOrIndex: string | number, value: number | null): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`seriesIdOrIndex`","`string | number`","Required"],["`categoryIdOrIndex`","`string | number`","Required"],["`value`","`number | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/radar#method-updatePoint","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/methods/setSeriesData","title":"setSeriesData","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"setSeriesData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"data","type":"LineChartValues | ScatterChartValues","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setSeriesData(idOrIndex: string | number, data: LineChartValues | ScatterChartValues, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`data`","`LineChartValues | ScatterChartValues`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartValues","title":"LineChartValues","description":"Type definition"},{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-setSeriesData","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-setSeriesData","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-setSeriesData","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-setSeriesData","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-setSeriesData","title":"sy-scatter-chart","description":""},{"path":"/docs/components/marimekko#method-setSeriesData","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/methods/addPointToSeries","title":"addPointToSeries","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"addPointToSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"point","type":"number | ScatterChartDatum","optional":false},{"name":"opts","type":"{ shift?: boolean; redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addPointToSeries(idOrIndex: string | number, point: number | ScatterChartDatum, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`point`","`number | ScatterChartDatum`","Required"],["`opts`","`{ shift?: boolean; redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartDatum","title":"ScatterChartDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showSeries","title":"showSeries","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-showSeries","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-showSeries","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-showSeries","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-showSeries","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-showSeries","title":"sy-scatter-chart","description":""},{"path":"/docs/components/dumbbell#method-showSeries","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#method-showSeries","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/marimekko#method-showSeries","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/methods/hideSeries","title":"hideSeries","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"hideSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hideSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-hideSeries","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-hideSeries","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-hideSeries","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-hideSeries","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-hideSeries","title":"sy-scatter-chart","description":""},{"path":"/docs/components/dumbbell#method-hideSeries","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#method-hideSeries","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/marimekko#method-hideSeries","title":"sy-marimekko-chart","description":""}]}]}]},{"path":"/docs/methods/appendPoint","title":"appendPoint","summary":"Append one value to the stream. Check the argument type and the licensing requirements for streaming.","kind":"methods","member":{"name":"appendPoint","parameters":[{"name":"value","type":"number | ScatterChartDatum | PieChartDatum | RadarStreamFrame | FunnelSectionSpec | ChordLinkInput | NetworkGraphLinkInput | TreemapNodeInput | SunburstNodeInput | IcicleNodeInput | GanttTaskInput | ParallelCoordinatesRowInput | DendrogramNodeInput | GeoMapPointInput | Surface3DRowInput | Scatter3DDatum | FlowLinesRouteInput | ThemeRiverRow | Bar3DDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"appendPoint(value: number | ScatterChartDatum | PieChartDatum | RadarStreamFrame | FunnelSectionSpec | ChordLinkInput | NetworkGraphLinkInput | TreemapNodeInput | SunburstNodeInput | IcicleNodeInput | GanttTaskInput | ParallelCoordinatesRowInput | DendrogramNodeInput | GeoMapPointInput | Surface3DRowInput | Scatter3DDatum | FlowLinesRouteInput | ThemeRiverRow | Bar3DDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number | ScatterChartDatum | PieChartDatum | RadarStreamFrame | FunnelSectionSpec | ChordLinkInput | NetworkGraphLinkInput | TreemapNodeInput | SunburstNodeInput | IcicleNodeInput | GanttTaskInput | ParallelCoordinatesRowInput | DendrogramNodeInput | GeoMapPointInput | Surface3DRowInput | Scatter3DDatum | FlowLinesRouteInput | ThemeRiverRow | Bar3DDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartDatum","title":"ScatterChartDatum","description":"Type definition"},{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"},{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":"Type definition"},{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"},{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":"Type definition"},{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":"Type definition"},{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":"Type definition"},{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":"Type definition"},{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":"Type definition"},{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":"Type definition"},{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":"Type definition"},{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":"Type definition"},{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":"Type definition"},{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"},{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":"Type definition"},{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":"Type definition"},{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-appendPoint","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-appendPoint","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-appendPoint","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-appendPoint","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-appendPoint","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-appendPoint","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-appendPoint","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-appendPoint","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-appendPoint","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-appendPoint","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-appendPoint","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-appendPoint","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-appendPoint","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-appendPoint","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-appendPoint","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-appendPoint","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-appendPoint","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-appendPoint","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-appendPoint","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-appendPoint","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-appendPoint","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-appendPoint","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-appendPoint","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-appendPoint","title":"sy-density-map","description":""},{"path":"/docs/components/gauge#method-appendPoint","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-appendPoint","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-appendPoint","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-appendPoint","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-appendPoint","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-appendPoint","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-appendPoint","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-appendPoint","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-appendPoint","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-appendPoint","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-appendPoint","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-appendPoint","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-appendPoint","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-appendPoint","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-appendPoint","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-appendPoint","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-appendPoint","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-appendPoint","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-appendPoint","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-appendPoint","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-appendPoint","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-appendPoint","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-appendPoint","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-appendPoint","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-appendPoint","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/appendBatch","title":"appendBatch","summary":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming.","kind":"methods","member":{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"appendBatch(values: ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":"Type definition"},{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"},{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":"Type definition"},{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"},{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":"Type definition"},{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":"Type definition"},{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":"Type definition"},{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":"Type definition"},{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":"Type definition"},{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":"Type definition"},{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":"Type definition"},{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":"Type definition"},{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":"Type definition"},{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"},{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":"Type definition"},{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":"Type definition"},{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-appendBatch","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-appendBatch","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-appendBatch","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-appendBatch","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-appendBatch","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-appendBatch","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-appendBatch","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-appendBatch","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-appendBatch","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-appendBatch","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-appendBatch","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-appendBatch","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-appendBatch","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-appendBatch","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-appendBatch","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-appendBatch","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-appendBatch","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-appendBatch","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-appendBatch","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-appendBatch","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-appendBatch","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-appendBatch","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-appendBatch","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-appendBatch","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-appendBatch","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-appendBatch","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-appendBatch","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-appendBatch","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-appendBatch","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-appendBatch","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-appendBatch","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-appendBatch","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-appendBatch","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-appendBatch","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-appendBatch","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-appendBatch","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-appendBatch","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-appendBatch","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-appendBatch","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-appendBatch","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-appendBatch","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-appendBatch","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-appendBatch","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-appendBatch","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-appendBatch","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-appendBatch","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-appendBatch","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-appendBatch","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-appendBatch","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-appendBatch","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/shift","title":"shift","summary":"Drop the oldest streamed categories (the `data` boxes are not the stream).","kind":"methods","member":{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-shift","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-shift","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-shift","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-shift","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-shift","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-shift","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-shift","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-shift","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-shift","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-shift","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-shift","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-shift","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-shift","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-shift","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-shift","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-shift","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-shift","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-shift","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-shift","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-shift","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-shift","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-shift","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-shift","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-shift","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-shift","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-shift","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-shift","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-shift","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-shift","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-shift","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-shift","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-shift","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-shift","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-shift","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-shift","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-shift","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-shift","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-shift","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-shift","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-shift","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-shift","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-shift","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-shift","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-shift","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-shift","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-shift","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-shift","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-shift","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-shift","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-shift","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/replace","title":"replace","summary":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace).","kind":"methods","member":{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"replace(values: ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array | ScatterChartValues | ReadonlyArray<PieChartDatum> | ReadonlyArray<RadarStreamFrame> | ReadonlyArray<FunnelSectionSpec | number> | ReadonlyArray<ChordLinkInput> | ReadonlyArray<NetworkGraphLinkInput> | ReadonlyArray<TreemapNodeInput> | ReadonlyArray<SunburstNodeInput> | ReadonlyArray<IcicleNodeInput> | ReadonlyArray<GanttTaskInput> | ReadonlyArray<ParallelCoordinatesRowInput> | ReadonlyArray<DendrogramNodeInput> | ReadonlyArray<GeoMapPointInput> | ReadonlyArray<Surface3DRowInput> | ReadonlyArray<Scatter3DDatum> | ReadonlyArray<FlowLinesRouteInput | ThemeRiverRow> | ReadonlyArray<Bar3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":"Type definition"},{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"},{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":"Type definition"},{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"},{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":"Type definition"},{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":"Type definition"},{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":"Type definition"},{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":"Type definition"},{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":"Type definition"},{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":"Type definition"},{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":"Type definition"},{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":"Type definition"},{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":"Type definition"},{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"},{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":"Type definition"},{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":"Type definition"},{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-replace","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-replace","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-replace","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-replace","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-replace","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-replace","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-replace","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-replace","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-replace","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-replace","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-replace","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-replace","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-replace","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-replace","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-replace","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-replace","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-replace","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-replace","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-replace","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-replace","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-replace","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-replace","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-replace","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-replace","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-replace","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-replace","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-replace","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-replace","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-replace","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-replace","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-replace","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-replace","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-replace","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-replace","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-replace","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-replace","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-replace","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-replace","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-replace","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-replace","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-replace","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-replace","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-replace","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-replace","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-replace","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-replace","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-replace","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-replace","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-replace","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-replace","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getStreamSource","title":"getStreamSource","summary":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.","kind":"methods","member":{"name":"getStreamSource","parameters":[],"returns":"Promise<ChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getStreamSource(): Promise<ChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartStreamSource","title":"ChartStreamSource","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getStreamSource","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getStreamSource","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getStreamSource","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getStreamSource","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-getStreamSource","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-getStreamSource","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-getStreamSource","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-getStreamSource","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-getStreamSource","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-getStreamSource","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-getStreamSource","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-getStreamSource","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-getStreamSource","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-getStreamSource","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-getStreamSource","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-getStreamSource","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-getStreamSource","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-getStreamSource","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-getStreamSource","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-getStreamSource","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-getStreamSource","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-getStreamSource","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getStreamSource","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getStreamSource","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getStreamSource","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-getStreamSource","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-getStreamSource","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-getStreamSource","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-getStreamSource","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-getStreamSource","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-getStreamSource","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-getStreamSource","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-getStreamSource","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getStreamSource","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getStreamSource","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getStreamSource","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-getStreamSource","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-getStreamSource","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-getStreamSource","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-getStreamSource","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-getStreamSource","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-getStreamSource","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getStreamSource","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-getStreamSource","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-getStreamSource","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-getStreamSource","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-getStreamSource","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-getStreamSource","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-getStreamSource","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-getStreamSource","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/setAnimation","title":"setAnimation","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: ChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: ChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: ChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartEasing","title":"LineChartEasing","description":"Type definition"},{"path":"/docs/types/ChartAnimationType","title":"ChartAnimationType","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-setAnimation","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-setAnimation","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-setAnimation","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-setAnimation","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-setAnimation","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-setAnimation","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-setAnimation","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-setAnimation","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-setAnimation","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-setAnimation","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-setAnimation","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-setAnimation","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-setAnimation","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-setAnimation","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-setAnimation","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-setAnimation","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-setAnimation","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-setAnimation","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-setAnimation","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-setAnimation","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-setAnimation","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-setAnimation","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-setAnimation","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-setAnimation","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-setAnimation","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-setAnimation","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-setAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-setAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-setAnimation","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-setAnimation","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-setAnimation","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-setAnimation","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-setAnimation","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-setAnimation","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-setAnimation","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-setAnimation","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-setAnimation","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-setAnimation","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-setAnimation","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-setAnimation","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-setAnimation","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-setAnimation","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-setAnimation","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-setAnimation","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-setAnimation","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-setAnimation","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-setAnimation","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-setAnimation","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-setAnimation","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-setAnimation","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/pauseAnimation","title":"pauseAnimation","summary":"Pause the current animation.","kind":"methods","member":{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-pauseAnimation","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-pauseAnimation","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-pauseAnimation","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-pauseAnimation","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-pauseAnimation","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-pauseAnimation","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-pauseAnimation","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-pauseAnimation","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-pauseAnimation","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-pauseAnimation","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-pauseAnimation","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-pauseAnimation","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-pauseAnimation","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-pauseAnimation","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-pauseAnimation","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-pauseAnimation","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-pauseAnimation","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-pauseAnimation","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-pauseAnimation","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-pauseAnimation","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-pauseAnimation","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-pauseAnimation","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-pauseAnimation","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-pauseAnimation","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-pauseAnimation","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-pauseAnimation","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-pauseAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-pauseAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-pauseAnimation","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-pauseAnimation","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-pauseAnimation","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-pauseAnimation","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-pauseAnimation","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-pauseAnimation","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-pauseAnimation","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-pauseAnimation","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-pauseAnimation","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-pauseAnimation","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-pauseAnimation","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-pauseAnimation","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-pauseAnimation","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-pauseAnimation","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-pauseAnimation","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-pauseAnimation","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-pauseAnimation","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-pauseAnimation","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-pauseAnimation","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-pauseAnimation","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-pauseAnimation","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-pauseAnimation","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/resumeAnimation","title":"resumeAnimation","summary":"Resume a paused animation.","kind":"methods","member":{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-resumeAnimation","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-resumeAnimation","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-resumeAnimation","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-resumeAnimation","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-resumeAnimation","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-resumeAnimation","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-resumeAnimation","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-resumeAnimation","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-resumeAnimation","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-resumeAnimation","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-resumeAnimation","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-resumeAnimation","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-resumeAnimation","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-resumeAnimation","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-resumeAnimation","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-resumeAnimation","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-resumeAnimation","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-resumeAnimation","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-resumeAnimation","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-resumeAnimation","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-resumeAnimation","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-resumeAnimation","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-resumeAnimation","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-resumeAnimation","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-resumeAnimation","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-resumeAnimation","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-resumeAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-resumeAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-resumeAnimation","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-resumeAnimation","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-resumeAnimation","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-resumeAnimation","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-resumeAnimation","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-resumeAnimation","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-resumeAnimation","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-resumeAnimation","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-resumeAnimation","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-resumeAnimation","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-resumeAnimation","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-resumeAnimation","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-resumeAnimation","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-resumeAnimation","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-resumeAnimation","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-resumeAnimation","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-resumeAnimation","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-resumeAnimation","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-resumeAnimation","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-resumeAnimation","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-resumeAnimation","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-resumeAnimation","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/replayAnimation","title":"replayAnimation","summary":"Pie / gauge — replay the initial reveal (pie sweep-from-zero, gauge sweep-from-min).","kind":"methods","member":{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Pie / gauge — replay the initial reveal (pie sweep-from-zero, gauge sweep-from-min)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#method-replayAnimation","title":"sy-pie-chart","description":""},{"path":"/docs/components/bubble#method-replayAnimation","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-replayAnimation","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-replayAnimation","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-replayAnimation","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-replayAnimation","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-replayAnimation","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-replayAnimation","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-replayAnimation","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-replayAnimation","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-replayAnimation","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-replayAnimation","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-replayAnimation","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-replayAnimation","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-replayAnimation","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-replayAnimation","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-replayAnimation","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-replayAnimation","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-replayAnimation","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-replayAnimation","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-replayAnimation","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-replayAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-replayAnimation","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-replayAnimation","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-replayAnimation","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-replayAnimation","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-replayAnimation","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-replayAnimation","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-replayAnimation","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-replayAnimation","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-replayAnimation","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-replayAnimation","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-replayAnimation","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-replayAnimation","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-replayAnimation","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-replayAnimation","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-replayAnimation","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-replayAnimation","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-replayAnimation","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-replayAnimation","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-replayAnimation","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-replayAnimation","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-replayAnimation","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-replayAnimation","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-replayAnimation","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/setValue","title":"setValue","summary":"Gauge-only — set the primary value.","kind":"methods","member":{"name":"setValue","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Gauge-only — set the primary value."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setValue(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#method-setValue","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/getValue","title":"getValue","summary":"Gauge-only — read the current primary value.","kind":"methods","member":{"name":"getValue","parameters":[],"returns":"Promise<number>","description":"Gauge-only — read the current primary value."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getValue(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/spectrogram#method-getValue","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-getValue","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/addNeedle","title":"addNeedle","summary":"Gauge-only — add a needle (dial variant).","kind":"methods","member":{"name":"addNeedle","parameters":[{"name":"needle","type":"GaugeNeedleSpec","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Gauge-only — add a needle (dial variant)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addNeedle(needle: GaugeNeedleSpec, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`needle`","`GaugeNeedleSpec`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#method-addNeedle","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/removeNeedle","title":"removeNeedle","summary":"Gauge-only — remove a needle by id or index.","kind":"methods","member":{"name":"removeNeedle","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Gauge-only — remove a needle by id or index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeNeedle(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#method-removeNeedle","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/updateNeedle","title":"updateNeedle","summary":"Gauge-only — patch a needle.","kind":"methods","member":{"name":"updateNeedle","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<GaugeNeedleSpec>","optional":false}],"returns":"Promise<boolean>","description":"Gauge-only — patch a needle."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateNeedle(idOrIndex: string | number, patch: Partial<GaugeNeedleSpec>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<GaugeNeedleSpec>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#method-updateNeedle","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/addSection","title":"addSection","summary":"Funnel / pyramid-only — add a section (stage). Returns its index.","kind":"methods","member":{"name":"addSection","parameters":[{"name":"section","type":"FunnelSectionSpec | number","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Funnel / pyramid-only — add a section (stage). Returns its index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addSection(section: FunnelSectionSpec | number, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`section`","`FunnelSectionSpec | number`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/funnel#method-addSection","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-addSection","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/methods/removeSection","title":"removeSection","summary":"Funnel / pyramid-only — remove a section by id or index.","kind":"methods","member":{"name":"removeSection","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Funnel / pyramid-only — remove a section by id or index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeSection(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/funnel#method-removeSection","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-removeSection","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/methods/updateSection","title":"updateSection","summary":"Funnel / pyramid-only — patch a section.","kind":"methods","member":{"name":"updateSection","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<FunnelSectionSpec>","optional":false}],"returns":"Promise<boolean>","description":"Funnel / pyramid-only — patch a section."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateSection(idOrIndex: string | number, patch: Partial<FunnelSectionSpec>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<FunnelSectionSpec>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/funnel#method-updateSection","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-updateSection","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/methods/hitTest","title":"hitTest","summary":"Radar / funnel / pyramid — hit-test the polar/radial SVG at chart-local coordinates.","kind":"methods","member":{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<RadarChartPointerEventDetail | FunnelChartPointerEventDetail | ChordHitDetail | NetworkGraphHitDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapPickDetail | Surface3DHitDetail | Scatter3DHitDetail | FlowLinesHitDetail | ThemeRiverHitDetail | Bar3DHitDetail>","description":"Radar / funnel / pyramid — hit-test the polar/radial SVG at chart-local coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<RadarChartPointerEventDetail | FunnelChartPointerEventDetail | ChordHitDetail | NetworkGraphHitDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapPickDetail | Surface3DHitDetail | Scatter3DHitDetail | FlowLinesHitDetail | ThemeRiverHitDetail | Bar3DHitDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<RadarChartPointerEventDetail | FunnelChartPointerEventDetail | ChordHitDetail | NetworkGraphHitDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapPickDetail | Surface3DHitDetail | Scatter3DHitDetail | FlowLinesHitDetail | ThemeRiverHitDetail | Bar3DHitDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"},{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"},{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","description":"Type definition"},{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","description":"Type definition"},{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"},{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"},{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"},{"path":"/docs/types/GeoMapPickDetail","title":"GeoMapPickDetail","description":"Type definition"},{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"},{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"},{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"},{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":"Type definition"},{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/bubble#method-hitTest","title":"sy-bubble-chart","description":""},{"path":"/docs/components/radar#method-hitTest","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-hitTest","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-hitTest","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-hitTest","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-hitTest","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-hitTest","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-hitTest","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-hitTest","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-hitTest","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-hitTest","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-hitTest","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-hitTest","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#method-hitTest","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-hitTest","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-hitTest","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-hitTest","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-hitTest","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-hitTest","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-hitTest","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-hitTest","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/treemap#method-hitTest","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-hitTest","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-hitTest","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-hitTest","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-hitTest","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-hitTest","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-hitTest","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-hitTest","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-hitTest","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-hitTest","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-hitTest","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-hitTest","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-hitTest","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-hitTest","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-hitTest","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-hitTest","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-hitTest","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/showRadarTooltipAt","title":"showRadarTooltipAt","summary":"Radar-only — open a vertex tooltip by series/category index.","kind":"methods","member":{"name":"showRadarTooltipAt","parameters":[{"name":"seriesIndex","type":"number","optional":false},{"name":"categoryIndex","type":"number","optional":false}],"returns":"Promise<RadarChartPointerEventDetail | null>","description":"Radar-only — open a vertex tooltip by series/category index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showRadarTooltipAt(seriesIndex: number, categoryIndex: number): Promise<RadarChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`seriesIndex`","`number`","Required"],["`categoryIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<RadarChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showSectionTooltipAt","title":"showSectionTooltipAt","summary":"Funnel / pyramid-only — open a section tooltip by id or index.","kind":"methods","member":{"name":"showSectionTooltipAt","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<FunnelChartPointerEventDetail | null>","description":"Funnel / pyramid-only — open a section tooltip by id or index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showSectionTooltipAt(idOrIndex: string | number): Promise<FunnelChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/hitTestGauge","title":"hitTestGauge","summary":"Gauge-only — hit-test the dial at canvas coordinates.","kind":"methods","member":{"name":"hitTestGauge","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<GaugeChartPointerEventDetail | null>","description":"Gauge-only — hit-test the dial at canvas coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestGauge(cssX: number, cssY: number): Promise<GaugeChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showGaugeTooltip","title":"showGaugeTooltip","summary":"Gauge-only — open the value tooltip programmatically.","kind":"methods","member":{"name":"showGaugeTooltip","parameters":[],"returns":"Promise<GaugeChartPointerEventDetail | null>","description":"Gauge-only — open the value tooltip programmatically."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showGaugeTooltip(): Promise<GaugeChartPointerEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showTooltipAtValue","title":"showTooltipAtValue","summary":"Gauge-only — open the value tooltip at a specific value's angle (analogue of showTooltipAtSlice).","kind":"methods","member":{"name":"showTooltipAtValue","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<GaugeChartPointerEventDetail | null>","description":"Gauge-only — open the value tooltip at a specific value's angle (analogue of showTooltipAtSlice)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtValue(value: number): Promise<GaugeChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#method-showTooltipAtValue","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/setRings","title":"setRings","summary":"Gauge-only (activity) — replace the ring set.","kind":"methods","member":{"name":"setRings","parameters":[{"name":"rings","type":"GaugeActivityRingSpec[]","optional":false}],"returns":"Promise<void>","description":"Gauge-only (activity) — replace the ring set."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setRings(rings: GaugeActivityRingSpec[]): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rings`","`GaugeActivityRingSpec[]`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeActivityRingSpec","title":"GaugeActivityRingSpec","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#method-setRings","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/setRingValue","title":"setRingValue","summary":"Gauge-only (activity) — update one ring's value by id, name, or index.","kind":"methods","member":{"name":"setRingValue","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"value","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Gauge-only (activity) — update one ring's value by id, name, or index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setRingValue(idOrIndex: string | number, value: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#method-setRingValue","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/methods/selectNodeAt","title":"selectNodeAt","summary":"Sankey / Chord / Network Graph — pin a node by index; its neighbourhood stays highlighted after pointer leave. A negative or unknown index releases selection. `null` on other types.","kind":"methods","member":{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SankeyNodeEventDetail | ChordNodeEventDetail | NetworkGraphNodeEventDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapHitDetail>","description":"Sankey / Chord / Network Graph — pin a node by index; its neighbourhood stays highlighted after pointer leave. A negative or unknown index releases selection. `null` on other types."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectNodeAt(index: number): Promise<SankeyNodeEventDetail | ChordNodeEventDetail | NetworkGraphNodeEventDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapHitDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyNodeEventDetail | ChordNodeEventDetail | NetworkGraphNodeEventDetail | TreemapHitDetail | null | SunburstHitDetail | IcicleHitDetail | GanttHitDetail | ParallelCoordinatesHitDetail | DendrogramHitDetail | GeoMapHitDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":"Type definition"},{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":"Type definition"},{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":"Type definition"},{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"},{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"},{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"},{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#method-selectNodeAt","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-selectNodeAt","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-selectNodeAt","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-selectNodeAt","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-selectNodeAt","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-selectNodeAt","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-selectNodeAt","title":"sy-network-graph","description":""},{"path":"/docs/components/geo-map#method-selectNodeAt","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/selectRowAt","title":"selectRowAt","summary":"Treemap: enter a positive branch by ID, or null for the forest. Requires drilldown. Select a visible Gantt task by its normalized source index. Parallel Coordinates: source rows and independent axis geometry.","kind":"methods","member":{"name":"selectRowAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ParallelCoordinatesHitDetail|null>","description":"Treemap: enter a positive branch by ID, or null for the forest. Requires drilldown. Select a visible Gantt task by its normalized source index. Parallel Coordinates: source rows and independent axis geometry."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectRowAt(index: number): Promise<ParallelCoordinatesHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#method-selectRowAt","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/methods/getRows","title":"getRows","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getRows","parameters":[],"returns":"Promise<ParallelCoordinatesRow[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getRows(): Promise<ParallelCoordinatesRow[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#method-getRows","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/methods/getRow","title":"getRow","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getRow","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ParallelCoordinatesRow|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getRow(index: number): Promise<ParallelCoordinatesRow|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#method-getRow","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/methods/getRowById","title":"getRowById","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getRowById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<ParallelCoordinatesRow|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getRowById(id: string): Promise<ParallelCoordinatesRow|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#method-getRowById","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/methods/getRowCount","title":"getRowCount","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getRowCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getRowCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#method-getRowCount","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/methods/getParallelCoordinatesLayout","title":"getParallelCoordinatesLayout","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesLayout","parameters":[],"returns":"Promise<ParallelCoordinatesLayoutResult|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesLayout(): Promise<ParallelCoordinatesLayoutResult|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesLayoutResult|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLayoutResult","title":"ParallelCoordinatesLayoutResult","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/setParallelCoordinatesBrushes","title":"setParallelCoordinatesBrushes","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"setParallelCoordinatesBrushes","parameters":[{"name":"brushes","type":"ReadonlyArray<ParallelCoordinatesAxisBrush>|null","optional":false}],"returns":"Promise<ParallelCoordinatesBrushChangeEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setParallelCoordinatesBrushes(brushes: ReadonlyArray<ParallelCoordinatesAxisBrush>|null): Promise<ParallelCoordinatesBrushChangeEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`brushes`","`ReadonlyArray<ParallelCoordinatesAxisBrush>|null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesAxisBrush","title":"ParallelCoordinatesAxisBrush","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/setParallelCoordinatesAxisBrush","title":"setParallelCoordinatesAxisBrush","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"setParallelCoordinatesAxisBrush","parameters":[{"name":"dimensionId","type":"string","optional":false},{"name":"range","type":"readonly[number,number]|null","optional":false}],"returns":"Promise<ParallelCoordinatesBrushChangeEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setParallelCoordinatesAxisBrush(dimensionId: string, range: readonly[number,number]|null): Promise<ParallelCoordinatesBrushChangeEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`dimensionId`","`string`","Required"],["`range`","`readonly[number,number]|null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/clearParallelCoordinatesBrushes","title":"clearParallelCoordinatesBrushes","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"clearParallelCoordinatesBrushes","parameters":[{"name":"dimensionId","type":"string","optional":true}],"returns":"Promise<ParallelCoordinatesBrushChangeEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearParallelCoordinatesBrushes(dimensionId?: string): Promise<ParallelCoordinatesBrushChangeEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`dimensionId`","`string`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getParallelCoordinatesBrushes","title":"getParallelCoordinatesBrushes","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesBrushes","parameters":[],"returns":"Promise<ParallelCoordinatesAxisBrush[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesBrushes(): Promise<ParallelCoordinatesAxisBrush[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesAxisBrush[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxisBrush","title":"ParallelCoordinatesAxisBrush","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getParallelCoordinatesBrushedRows","title":"getParallelCoordinatesBrushedRows","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesBrushedRows","parameters":[],"returns":"Promise<ParallelCoordinatesRow[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesBrushedRows(): Promise<ParallelCoordinatesRow[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getParallelCoordinatesBrushModels","title":"getParallelCoordinatesBrushModels","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesBrushModels","parameters":[],"returns":"Promise<ParallelCoordinatesBrushModel[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesBrushModels(): Promise<ParallelCoordinatesBrushModel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushModel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushModel","title":"ParallelCoordinatesBrushModel","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getParallelCoordinatesLineModels","title":"getParallelCoordinatesLineModels","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesLineModels","parameters":[],"returns":"Promise<ParallelCoordinatesLineModel[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesLineModels(): Promise<ParallelCoordinatesLineModel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesLineModel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLineModel","title":"ParallelCoordinatesLineModel","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getParallelCoordinatesAxisModels","title":"getParallelCoordinatesAxisModels","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesAxisModels","parameters":[],"returns":"Promise<ParallelCoordinatesAxisModel[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesAxisModels(): Promise<ParallelCoordinatesAxisModel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesAxisModel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxisModel","title":"ParallelCoordinatesAxisModel","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getParallelCoordinatesAxes","title":"getParallelCoordinatesAxes","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesAxes","parameters":[],"returns":"Promise<ParallelCoordinatesAxis[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesAxes(): Promise<ParallelCoordinatesAxis[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesAxis[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getParallelCoordinatesDiagnostics","title":"getParallelCoordinatesDiagnostics","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getParallelCoordinatesDiagnostics","parameters":[],"returns":"Promise<ParallelCoordinatesDiagnostics|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getParallelCoordinatesDiagnostics(): Promise<ParallelCoordinatesDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesDiagnostics","title":"ParallelCoordinatesDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectTaskAt","title":"selectTaskAt","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectTaskAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GanttHitDetail | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectTaskAt(index: number): Promise<GanttHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#method-selectTaskAt","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/getTasks","title":"getTasks","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getTasks","parameters":[],"returns":"Promise<GanttTask[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getTasks(): Promise<GanttTask[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttTask[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#method-getTasks","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/getTask","title":"getTask","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getTask","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GanttTask | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getTask(index: number): Promise<GanttTask | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttTask | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#method-getTask","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/getTaskById","title":"getTaskById","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getTaskById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<GanttTask | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getTaskById(id: string): Promise<GanttTask | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttTask | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#method-getTaskById","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/getTaskCount","title":"getTaskCount","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getTaskCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getTaskCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#method-getTaskCount","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/getGanttExtent","title":"getGanttExtent","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttExtent","parameters":[],"returns":"Promise<GanttExtent | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttExtent(): Promise<GanttExtent | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttExtent","title":"GanttExtent","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttLayout","title":"getGanttLayout","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttLayout","parameters":[],"returns":"Promise<GanttLayoutResult | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttLayout(): Promise<GanttLayoutResult | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttLayoutResult | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttLayoutResult","title":"GanttLayoutResult","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttDiagnostics","title":"getGanttDiagnostics","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttDiagnostics","parameters":[],"returns":"Promise<GanttDiagnostics|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttDiagnostics(): Promise<GanttDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDiagnostics","title":"GanttDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttLabels","title":"getGanttLabels","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttLabels","parameters":[],"returns":"Promise<GanttLabel[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttLabels(): Promise<GanttLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttLabel","title":"GanttLabel","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttBaselines","title":"getGanttBaselines","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttBaselines","parameters":[],"returns":"Promise<GanttBaselineComparison[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttBaselines(): Promise<GanttBaselineComparison[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttBaselineComparison[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttBaselineComparison","title":"GanttBaselineComparison","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttTaskEdits","title":"getGanttTaskEdits","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttTaskEdits","parameters":[],"returns":"Promise<GanttTaskEdit[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttTaskEdits(): Promise<GanttTaskEdit[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttTaskEdit[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEdit","title":"GanttTaskEdit","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/resetGanttTaskEdits","title":"resetGanttTaskEdits","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"resetGanttTaskEdits","parameters":[{"name":"id","type":"string","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"resetGanttTaskEdits(id?: string): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/cancelGanttTaskEdit","title":"cancelGanttTaskEdit","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"cancelGanttTaskEdit","parameters":[],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"cancelGanttTaskEdit(): Promise<boolean>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttCriticalPath","title":"getGanttCriticalPath","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttCriticalPath","parameters":[],"returns":"Promise<GanttCriticalPathResult|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttCriticalPath(): Promise<GanttCriticalPathResult|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttCriticalPathResult|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttCriticalPathResult","title":"GanttCriticalPathResult","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttDependencies","title":"getGanttDependencies","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttDependencies","parameters":[],"returns":"Promise<GanttDependencyDataset|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttDependencies(): Promise<GanttDependencyDataset|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyDataset|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyDataset","title":"GanttDependencyDataset","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttDependencyPaths","title":"getGanttDependencyPaths","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttDependencyPaths","parameters":[],"returns":"Promise<GanttDependencyPath[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttDependencyPaths(): Promise<GanttDependencyPath[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyPath[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyPath","title":"GanttDependencyPath","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttDependencySelection","title":"getGanttDependencySelection","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttDependencySelection","parameters":[],"returns":"Promise<GanttDependencySelection|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttDependencySelection(): Promise<GanttDependencySelection|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencySelection|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencySelection","title":"GanttDependencySelection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectGanttDependencyAt","title":"selectGanttDependencyAt","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectGanttDependencyAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GanttDependencyHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectGanttDependencyAt(index: number): Promise<GanttDependencyHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/hitTestGanttDependency","title":"hitTestGanttDependency","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"hitTestGanttDependency","parameters":[{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<GanttDependencyHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestGanttDependency(x: number, y: number): Promise<GanttDependencyHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showGanttDependencyTooltipAtIndex","title":"showGanttDependencyTooltipAtIndex","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showGanttDependencyTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showGanttDependencyTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getGanttTimeAxis","title":"getGanttTimeAxis","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getGanttTimeAxis","parameters":[],"returns":"Promise<GanttTimeAxisModel | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getGanttTimeAxis(): Promise<GanttTimeAxisModel | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttTimeAxisModel | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTimeAxisModel","title":"GanttTimeAxisModel","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/drillTo","title":"drillTo","summary":"Enter a structural branch by stable ID; null returns to the complete forest. Requires drilldown.","kind":"methods","member":{"name":"drillTo","parameters":[{"name":"rootId","type":"string | null","optional":false}],"returns":"Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>","description":"Enter a structural branch by stable ID; null returns to the complete forest. Requires drilldown."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"drillTo(rootId: string | null): Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rootId`","`string | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#method-drillTo","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-drillTo","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-drillTo","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-drillTo","title":"sy-dendrogram","description":""}]}]}]},{"path":"/docs/methods/drillDown","title":"drillDown","summary":"Treemap: enter a branch by its normalized data index. Requires drilldown.","kind":"methods","member":{"name":"drillDown","parameters":[{"name":"nodeIndex","type":"number","optional":false}],"returns":"Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>","description":"Treemap: enter a branch by its normalized data index. Requires drilldown."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"drillDown(nodeIndex: number): Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodeIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#method-drillDown","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-drillDown","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-drillDown","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-drillDown","title":"sy-dendrogram","description":""}]}]}]},{"path":"/docs/methods/drillUp","title":"drillUp","summary":"Treemap: return to the parent branch, then the forest.","kind":"methods","member":{"name":"drillUp","parameters":[],"returns":"Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>","description":"Treemap: return to the parent branch, then the forest."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"drillUp(): Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapDrillChangeEventDetail | null | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#method-drillUp","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-drillUp","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-drillUp","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-drillUp","title":"sy-dendrogram","description":""}]}]}]},{"path":"/docs/methods/getDrillRoot","title":"getDrillRoot","summary":"Treemap: current branch with its original identity and index, or null for the forest.","kind":"methods","member":{"name":"getDrillRoot","parameters":[],"returns":"Promise<TreemapNode | null | SunburstNode | IcicleNode | DendrogramNode>","description":"Treemap: current branch with its original identity and index, or null for the forest."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDrillRoot(): Promise<TreemapNode | null | SunburstNode | IcicleNode | DendrogramNode>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapNode | null | SunburstNode | IcicleNode | DendrogramNode>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":"Type definition"},{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":"Type definition"},{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":"Type definition"},{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#method-getDrillRoot","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getDrillRoot","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getDrillRoot","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getDrillRoot","title":"sy-dendrogram","description":""}]}]}]},{"path":"/docs/methods/selectLinkAt","title":"selectLinkAt","summary":"Sankey / Chord / Network Graph — pin a link by index; it keeps the accent after pointer leave. A negative or unknown index releases selection. `null` on other types.","kind":"methods","member":{"name":"selectLinkAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SankeyLinkEventDetail | ChordLinkEventDetail | NetworkGraphLinkEventDetail | DendrogramHitDetail | null>","description":"Sankey / Chord / Network Graph — pin a link by index; it keeps the accent after pointer leave. A negative or unknown index releases selection. `null` on other types."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectLinkAt(index: number): Promise<SankeyLinkEventDetail | ChordLinkEventDetail | NetworkGraphLinkEventDetail | DendrogramHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyLinkEventDetail | ChordLinkEventDetail | NetworkGraphLinkEventDetail | DendrogramHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","description":"Type definition"},{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","description":"Type definition"},{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","description":"Type definition"},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/dendrogram#method-selectLinkAt","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-selectLinkAt","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-selectLinkAt","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-selectLinkAt","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/methods/clearSelection","title":"clearSelection","summary":"Sankey / Chord / Network Graph — release selection (a no-op on other types).","kind":"methods","member":{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Sankey / Chord / Network Graph — release selection (a no-op on other types)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#method-clearSelection","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-clearSelection","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-clearSelection","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-clearSelection","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-clearSelection","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-clearSelection","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-clearSelection","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-clearSelection","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-clearSelection","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-clearSelection","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-clearSelection","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#method-clearSelection","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-clearSelection","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-clearSelection","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-clearSelection","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/pinNode","title":"pinNode","summary":"Sankey / Chord / Network Graph — `{ node, link }` selection details, each nullable; `null` on other types. Network Graph — hold a node at a plot-local position (as a drag does); null on other types or unknown ids.","kind":"methods","member":{"name":"pinNode","parameters":[{"name":"id","type":"string","optional":false},{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<NetworkGraphPinnedNode | null>","description":"Sankey / Chord / Network Graph — `{ node, link }` selection details, each nullable; `null` on other types. Network Graph — hold a node at a plot-local position (as a drag does); null on other types or unknown ids."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"pinNode(id: string, x: number, y: number): Promise<NetworkGraphPinnedNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphPinnedNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphPinnedNode","title":"NetworkGraphPinnedNode","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/network-graph#method-pinNode","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/methods/unpinNode","title":"unpinNode","summary":"Network Graph — release a pinned node; false on other types or when it was not pinned.","kind":"methods","member":{"name":"unpinNode","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"Network Graph — release a pinned node; false on other types or when it was not pinned."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"unpinNode(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/network-graph#method-unpinNode","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/methods/clearPinnedNodes","title":"clearPinnedNodes","summary":"Network Graph — release every pinned node; the count released.","kind":"methods","member":{"name":"clearPinnedNodes","parameters":[],"returns":"Promise<number>","description":"Network Graph — release every pinned node; the count released."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearPinnedNodes(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/network-graph#method-clearPinnedNodes","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/methods/getPinnedNodes","title":"getPinnedNodes","summary":"Network Graph — the pinned nodes at their applied positions; empty on other types.","kind":"methods","member":{"name":"getPinnedNodes","parameters":[],"returns":"Promise<NetworkGraphPinnedNode[]>","description":"Network Graph — the pinned nodes at their applied positions; empty on other types."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getPinnedNodes(): Promise<NetworkGraphPinnedNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphPinnedNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphPinnedNode","title":"NetworkGraphPinnedNode","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/network-graph#method-getPinnedNodes","title":"sy-network-graph","description":""}]}]}]},{"path":"/docs/methods/getSelection","title":"getSelection","summary":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license.","kind":"methods","member":{"name":"getSelection","parameters":[],"returns":"Promise<SankeySelection | ChordSelection | NetworkGraphSelection | TreemapSelection | null | SunburstSelection | IcicleSelection | GanttSelection | ParallelCoordinatesSelection | DendrogramSelection | GeoMapSelection | Surface3DSelection | Scatter3DSelection | FlowLinesSelection | ThemeRiverSelection | Bar3DSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getSelection(): Promise<SankeySelection | ChordSelection | NetworkGraphSelection | TreemapSelection | null | SunburstSelection | IcicleSelection | GanttSelection | ParallelCoordinatesSelection | DendrogramSelection | GeoMapSelection | Surface3DSelection | Scatter3DSelection | FlowLinesSelection | ThemeRiverSelection | Bar3DSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeySelection | ChordSelection | NetworkGraphSelection | TreemapSelection | null | SunburstSelection | IcicleSelection | GanttSelection | ParallelCoordinatesSelection | DendrogramSelection | GeoMapSelection | Surface3DSelection | Scatter3DSelection | FlowLinesSelection | ThemeRiverSelection | Bar3DSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeySelection","title":"SankeySelection","description":"Type definition"},{"path":"/docs/types/ChordSelection","title":"ChordSelection","description":"Type definition"},{"path":"/docs/types/NetworkGraphSelection","title":"NetworkGraphSelection","description":"Type definition"},{"path":"/docs/types/TreemapSelection","title":"TreemapSelection","description":"Type definition"},{"path":"/docs/types/SunburstSelection","title":"SunburstSelection","description":"Type definition"},{"path":"/docs/types/IcicleSelection","title":"IcicleSelection","description":"Type definition"},{"path":"/docs/types/GanttSelection","title":"GanttSelection","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesSelection","title":"ParallelCoordinatesSelection","description":"Type definition"},{"path":"/docs/types/DendrogramSelection","title":"DendrogramSelection","description":"Type definition"},{"path":"/docs/types/GeoMapSelection","title":"GeoMapSelection","description":"Type definition"},{"path":"/docs/types/Surface3DSelection","title":"Surface3DSelection","description":"Type definition"},{"path":"/docs/types/Scatter3DSelection","title":"Scatter3DSelection","description":"Type definition"},{"path":"/docs/types/FlowLinesSelection","title":"FlowLinesSelection","description":"Type definition"},{"path":"/docs/types/ThemeRiverSelection","title":"ThemeRiverSelection","description":"Type definition"},{"path":"/docs/types/Bar3DSelection","title":"Bar3DSelection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#method-getSelection","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getSelection","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getSelection","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getSelection","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-getSelection","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-getSelection","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-getSelection","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-getSelection","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-getSelection","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-getSelection","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getSelection","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#method-getSelection","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-getSelection","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-getSelection","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-getSelection","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/selectSlice","title":"selectSlice","summary":"Pie-only — select a slice by id or index.","kind":"methods","member":{"name":"selectSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"selected","type":"boolean","optional":true}],"returns":"Promise<boolean>","description":"Pie-only — select a slice by id or index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectSlice(idOrIndex: string | number, selected?: boolean): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`selected`","`boolean`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#method-selectSlice","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/methods/deselectSlice","title":"deselectSlice","summary":"Pie-only — clear selection on a slice.","kind":"methods","member":{"name":"deselectSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Pie-only — clear selection on a slice."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"deselectSlice(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#method-deselectSlice","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/methods/getSelectedSlices","title":"getSelectedSlices","summary":"Pie-only — read the current selection set.","kind":"methods","member":{"name":"getSelectedSlices","parameters":[],"returns":"Promise<string[]>","description":"Pie-only — read the current selection set."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getSelectedSlices(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#method-getSelectedSlices","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/methods/hitTestSlice","title":"hitTestSlice","summary":"Pie-only — hit-test slice at canvas-relative coordinates.","kind":"methods","member":{"name":"hitTestSlice","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ sliceIndex: number; sliceId: string } | null>","description":"Pie-only — hit-test slice at canvas-relative coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestSlice(cssX: number, cssY: number): Promise<{ sliceIndex: number; sliceId: string } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ sliceIndex: number; sliceId: string } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#method-hitTestSlice","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtSlice","title":"showTooltipAtSlice","summary":"Pie-only — programmatic tooltip open.","kind":"methods","member":{"name":"showTooltipAtSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<PieChartSliceEventDetail | null>","description":"Pie-only — programmatic tooltip open."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtSlice(idOrIndex: string | number): Promise<PieChartSliceEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<PieChartSliceEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#method-showTooltipAtSlice","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/methods/addParty","title":"addParty","summary":"Item-only — add a party (datum) to the parliament.","kind":"methods","member":{"name":"addParty","parameters":[{"name":"datum","type":"ItemChartDatum","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Item-only — add a party (datum) to the parliament."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addParty(datum: ItemChartDatum, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`ItemChartDatum`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/item#method-addParty","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/methods/removeParty","title":"removeParty","summary":"Item-only — remove a party by id, name, or index.","kind":"methods","member":{"name":"removeParty","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Item-only — remove a party by id, name, or index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeParty(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/item#method-removeParty","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/methods/updateParty","title":"updateParty","summary":"Item-only — patch a party's datum fields.","kind":"methods","member":{"name":"updateParty","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<Exclude<ItemChartDatum, number>>","optional":false}],"returns":"Promise<boolean>","description":"Item-only — patch a party's datum fields."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateParty(idOrIndex: string | number, patch: Partial<Exclude<ItemChartDatum, number>>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<Exclude<ItemChartDatum, number>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/item#method-updateParty","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/methods/setPartySeats","title":"setPartySeats","summary":"Item-only — set a party's seat count.","kind":"methods","member":{"name":"setPartySeats","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"value","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Item-only — set a party's seat count."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setPartySeats(idOrIndex: string | number, value: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/item#method-setPartySeats","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/methods/hitTestSeat","title":"hitTestSeat","summary":"Item-only — hit-test the seat dot at canvas-relative coordinates.","kind":"methods","member":{"name":"hitTestSeat","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>","description":"Item-only — hit-test the seat dot at canvas-relative coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestSeat(cssX: number, cssY: number): Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/item#method-hitTestSeat","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtParty","title":"showTooltipAtParty","summary":"Item-only — programmatic tooltip open on a party.","kind":"methods","member":{"name":"showTooltipAtParty","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<ItemChartPointEventDetail | null>","description":"Item-only — programmatic tooltip open on a party."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtParty(idOrIndex: string | number): Promise<ItemChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ItemChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/item#method-showTooltipAtParty","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/methods/addWord","title":"addWord","summary":"Word-cloud-only — add a word datum.","kind":"methods","member":{"name":"addWord","parameters":[{"name":"datum","type":"WordCloudDatum","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Word-cloud-only — add a word datum."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addWord(datum: WordCloudDatum, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`WordCloudDatum`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/word-cloud#method-addWord","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/methods/removeWord","title":"removeWord","summary":"Word-cloud-only — remove a word by id, name, or index.","kind":"methods","member":{"name":"removeWord","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Word-cloud-only — remove a word by id, name, or index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeWord(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/word-cloud#method-removeWord","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/methods/updateWord","title":"updateWord","summary":"Word-cloud-only — patch a word's datum fields.","kind":"methods","member":{"name":"updateWord","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<Exclude<WordCloudDatum, readonly [string, number]>>","optional":false}],"returns":"Promise<boolean>","description":"Word-cloud-only — patch a word's datum fields."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateWord(idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<Exclude<WordCloudDatum, readonly [string, number]>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/word-cloud#method-updateWord","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/methods/setWordWeight","title":"setWordWeight","summary":"Word-cloud-only — set a word's weight.","kind":"methods","member":{"name":"setWordWeight","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"weight","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Word-cloud-only — set a word's weight."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setWordWeight(idOrIndex: string | number, weight: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`weight`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/word-cloud#method-setWordWeight","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/methods/hitTestWord","title":"hitTestWord","summary":"Word-cloud-only — hit-test the word at canvas-relative coordinates.","kind":"methods","member":{"name":"hitTestWord","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ index: number; id: string; name: string } | null>","description":"Word-cloud-only — hit-test the word at canvas-relative coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestWord(cssX: number, cssY: number): Promise<{ index: number; id: string; name: string } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ index: number; id: string; name: string } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/word-cloud#method-hitTestWord","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/methods/getDroppedWords","title":"getDroppedWords","summary":"Word-cloud-only — words the spiral could not fit inside the plot.","kind":"methods","member":{"name":"getDroppedWords","parameters":[],"returns":"Promise<Array<{ index: number; id: string; name: string; weight: number }>>","description":"Word-cloud-only — words the spiral could not fit inside the plot."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDroppedWords(): Promise<Array<{ index: number; id: string; name: string; weight: number }>>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Array<{ index: number; id: string; name: string; weight: number }>>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/word-cloud#method-getDroppedWords","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtWord","title":"showTooltipAtWord","summary":"Word-cloud-only — programmatic tooltip open on a word.","kind":"methods","member":{"name":"showTooltipAtWord","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<WordCloudPointEventDetail | null>","description":"Word-cloud-only — programmatic tooltip open on a word."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtWord(idOrIndex: string | number): Promise<WordCloudPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WordCloudPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/word-cloud#method-showTooltipAtWord","title":"sy-word-cloud","description":""}]}]}]},{"path":"/docs/methods/addTile","title":"addTile","summary":"Tilemap-only — append a tile datum (occupied cells update in place).","kind":"methods","member":{"name":"addTile","parameters":[{"name":"datum","type":"TilemapDatum","optional":false}],"returns":"Promise<number>","description":"Tilemap-only — append a tile datum (occupied cells update in place)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addTile(datum: TilemapDatum): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`TilemapDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/tilemap#method-addTile","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/methods/removeTile","title":"removeTile","summary":"Tilemap-only — remove a tile by id, name, index, or `{x, y}` cell.","kind":"methods","member":{"name":"removeTile","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false}],"returns":"Promise<boolean>","description":"Tilemap-only — remove a tile by id, name, index, or `{x, y}` cell."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeTile(idOrCell: string | number | { x: number; y: number }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/tilemap#method-removeTile","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/methods/updateTile","title":"updateTile","summary":"Tilemap-only — patch a tile's datum fields.","kind":"methods","member":{"name":"updateTile","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false},{"name":"patch","type":"Partial<TilemapDatum>","optional":false}],"returns":"Promise<boolean>","description":"Tilemap-only — patch a tile's datum fields."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateTile(idOrCell: string | number | { x: number; y: number }, patch: Partial<TilemapDatum>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"],["`patch`","`Partial<TilemapDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/tilemap#method-updateTile","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/methods/setTileValue","title":"setTileValue","summary":"Tilemap-only — set a tile's metric value.","kind":"methods","member":{"name":"setTileValue","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false},{"name":"value","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Tilemap-only — set a tile's metric value."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setTileValue(idOrCell: string | number | { x: number; y: number }, value: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"],["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/tilemap#method-setTileValue","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/methods/hitTestTile","title":"hitTestTile","summary":"Tilemap-only — hit-test the tile at canvas-relative coordinates.","kind":"methods","member":{"name":"hitTestTile","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ index: number; id: string; col: number; row: number; name: string } | null>","description":"Tilemap-only — hit-test the tile at canvas-relative coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestTile(cssX: number, cssY: number): Promise<{ index: number; id: string; col: number; row: number; name: string } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ index: number; id: string; col: number; row: number; name: string } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/tilemap#method-hitTestTile","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtTile","title":"showTooltipAtTile","summary":"Tilemap-only — programmatic tooltip open on a tile.","kind":"methods","member":{"name":"showTooltipAtTile","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false}],"returns":"Promise<TilemapPointEventDetail | null>","description":"Tilemap-only — programmatic tooltip open on a tile."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtTile(idOrCell: string | number | { x: number; y: number }): Promise<TilemapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TilemapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/tilemap#method-showTooltipAtTile","title":"sy-tilemap","description":""}]}]}]},{"path":"/docs/methods/hitTestLeaf","title":"hitTestLeaf","summary":"Stem-leaf-only — hit-test the leaf at canvas-relative coordinates.","kind":"methods","member":{"name":"hitTestLeaf","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ sourceIndex: number; value: number; stemLabel: string; digit: number } | null>","description":"Stem-leaf-only — hit-test the leaf at canvas-relative coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestLeaf(cssX: number, cssY: number): Promise<{ sourceIndex: number; value: number; stemLabel: string; digit: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ sourceIndex: number; value: number; stemLabel: string; digit: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/stem-leaf#method-hitTestLeaf","title":"sy-stem-leaf-chart","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtLeaf","title":"showTooltipAtLeaf","summary":"Stem-leaf-only — programmatic tooltip open on a leaf by source index.","kind":"methods","member":{"name":"showTooltipAtLeaf","parameters":[{"name":"sourceIndex","type":"number","optional":false}],"returns":"Promise<StemLeafPointEventDetail | null>","description":"Stem-leaf-only — programmatic tooltip open on a leaf by source index."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtLeaf(sourceIndex: number): Promise<StemLeafPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`sourceIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<StemLeafPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/stem-leaf#method-showTooltipAtLeaf","title":"sy-stem-leaf-chart","description":""}]}]}]},{"path":"/docs/methods/hitTestSegment","title":"hitTestSegment","summary":"Polar-only — hit-test the rose segment at canvas-relative coordinates.","kind":"methods","member":{"name":"hitTestSegment","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<PolarChartPointEventDetail | null>","description":"Polar-only — hit-test the rose segment at canvas-relative coordinates."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestSegment(cssX: number, cssY: number): Promise<PolarChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<PolarChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/polar#method-hitTestSegment","title":"sy-polar-chart","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtSegment","title":"showTooltipAtSegment","summary":"Polar-only — programmatic tooltip open on a (direction, series) cell.","kind":"methods","member":{"name":"showTooltipAtSegment","parameters":[{"name":"categoryIndex","type":"number","optional":false},{"name":"seriesIdOrIndex","type":"string | number","optional":false}],"returns":"Promise<PolarChartPointEventDetail | null>","description":"Polar-only — programmatic tooltip open on a (direction, series) cell."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtSegment(categoryIndex: number, seriesIdOrIndex: string | number): Promise<PolarChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`categoryIndex`","`number`","Required"],["`seriesIdOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<PolarChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/polar#method-showTooltipAtSegment","title":"sy-polar-chart","description":""}]}]}]},{"path":"/docs/methods/hitTestMarker","title":"hitTestMarker","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"hitTestMarker","parameters":[{"name":"clientX","type":"number","optional":false},{"name":"clientY","type":"number","optional":false}],"returns":"Promise<LineChartPointEventDetail | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestMarker(clientX: number, clientY: number): Promise<LineChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`clientX`","`number`","Required"],["`clientY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<LineChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-hitTestMarker","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/methods/hitTestMarkers","title":"hitTestMarkers","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"hitTestMarkers","parameters":[{"name":"clientX","type":"number","optional":false},{"name":"clientY","type":"number","optional":false}],"returns":"Promise<LineChartPointEventDetail[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestMarkers(clientX: number, clientY: number): Promise<LineChartPointEventDetail[]>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`clientX`","`number`","Required"],["`clientY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<LineChartPointEventDetail[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-hitTestMarkers","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtPoint","title":"showTooltipAtPoint","summary":"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.","kind":"methods","member":{"name":"showTooltipAtPoint","parameters":[{"name":"pointIndex","type":"number","optional":false},{"name":"seriesIndex","type":"number | 'left' | 'right'","optional":true}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtPoint(pointIndex: number, seriesIndex?: number | 'left' | 'right'): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pointIndex`","`number`","Required"],["`seriesIndex`","`number | 'left' | 'right'`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-showTooltipAtPoint","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-showTooltipAtPoint","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-showTooltipAtPoint","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-showTooltipAtPoint","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-showTooltipAtPoint","title":"sy-scatter-chart","description":""},{"path":"/docs/components/lollipop#method-showTooltipAtPoint","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-showTooltipAtPoint","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-showTooltipAtPoint","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-showTooltipAtPoint","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-showTooltipAtPoint","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-showTooltipAtPoint","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#method-showTooltipAtPoint","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-showTooltipAtPoint","title":"sy-histogram-chart","description":""},{"path":"/docs/components/pictorial#method-showTooltipAtPoint","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/treemap#method-showTooltipAtPoint","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-showTooltipAtPoint","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-showTooltipAtPoint","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-showTooltipAtPoint","title":"sy-dendrogram","description":""},{"path":"/docs/components/theme-river#method-showTooltipAtPoint","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-showTooltipAtPoint","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-showTooltipAtPoint","title":"sy-geo-map","description":""},{"path":"/docs/components/surface-3d#method-showTooltipAtPoint","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-showTooltipAtPoint","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-showTooltipAtPoint","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-showTooltipAtPoint","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/zoomTo","title":"zoomTo","summary":"zoom the active cartesian family to explicit windows (`x` / `y`, `xAxis` / `yAxis`). Non-cartesian types resolve `null`.","kind":"methods","member":{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"zoom the active cartesian family to explicit windows (`x` / `y`, `xAxis` / `yAxis`). Non-cartesian types resolve `null`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-zoomTo","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-zoomTo","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-zoomTo","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-zoomTo","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-zoomTo","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-zoomTo","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-zoomTo","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#method-zoomTo","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#method-zoomTo","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-zoomTo","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-zoomTo","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-zoomTo","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-zoomTo","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-zoomTo","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-zoomTo","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-zoomTo","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#method-zoomTo","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-zoomTo","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-zoomTo","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-zoomTo","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-zoomTo","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-zoomTo","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-zoomTo","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-zoomTo","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-zoomTo","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-zoomTo","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-zoomTo","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-zoomTo","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-zoomTo","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-zoomTo","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-zoomTo","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-zoomTo","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-zoomTo","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/gantt#method-zoomTo","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-zoomTo","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/zoomBy","title":"zoomBy","summary":"scale the active cartesian family's windows by `factor` (< 1 zooms in) around `anchorFraction`.","kind":"methods","member":{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"scale the active cartesian family's windows by `factor` (< 1 zooms in) around `anchorFraction`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-zoomBy","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-zoomBy","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-zoomBy","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-zoomBy","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-zoomBy","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-zoomBy","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-zoomBy","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#method-zoomBy","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#method-zoomBy","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-zoomBy","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-zoomBy","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-zoomBy","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-zoomBy","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-zoomBy","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-zoomBy","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-zoomBy","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#method-zoomBy","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-zoomBy","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-zoomBy","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-zoomBy","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-zoomBy","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-zoomBy","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-zoomBy","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-zoomBy","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-zoomBy","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-zoomBy","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-zoomBy","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-zoomBy","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-zoomBy","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-zoomBy","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-zoomBy","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-zoomBy","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-zoomBy","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/stock-chart#method-zoomBy","title":"sy-stock-chart","description":""},{"path":"/docs/components/surface-3d#method-zoomBy","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-zoomBy","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-zoomBy","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-zoomBy","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-zoomBy","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/panBy","title":"panBy","summary":"slide the active cartesian family's zoomed windows by data units (`{ x?, y? }`).","kind":"methods","member":{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"slide the active cartesian family's zoomed windows by data units (`{ x?, y? }`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-panBy","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-panBy","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-panBy","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-panBy","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-panBy","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-panBy","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-panBy","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#method-panBy","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#method-panBy","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-panBy","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-panBy","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-panBy","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-panBy","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-panBy","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-panBy","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-panBy","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#method-panBy","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-panBy","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-panBy","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-panBy","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-panBy","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-panBy","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-panBy","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-panBy","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-panBy","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-panBy","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-panBy","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-panBy","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-panBy","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-panBy","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-panBy","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-panBy","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-panBy","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-panBy","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-panBy","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-panBy","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-panBy","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-panBy","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/resetZoom","title":"resetZoom","summary":"Reset the zoomed or panned range to the original data range.","kind":"methods","member":{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-resetZoom","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-resetZoom","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-resetZoom","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-resetZoom","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-resetZoom","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-resetZoom","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-resetZoom","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#method-resetZoom","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#method-resetZoom","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-resetZoom","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-resetZoom","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-resetZoom","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-resetZoom","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-resetZoom","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-resetZoom","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-resetZoom","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#method-resetZoom","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-resetZoom","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-resetZoom","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-resetZoom","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-resetZoom","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-resetZoom","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-resetZoom","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-resetZoom","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-resetZoom","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-resetZoom","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-resetZoom","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-resetZoom","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-resetZoom","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-resetZoom","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-resetZoom","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-resetZoom","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-resetZoom","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-resetZoom","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-resetZoom","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-resetZoom","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-resetZoom","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-resetZoom","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/resetMapView","title":"resetMapView","summary":"Geo Map: restore the configured projection/region and clear viewport zoom.","kind":"methods","member":{"name":"resetMapView","parameters":[],"returns":"Promise<void>","description":"Geo Map: restore the configured projection/region and clear viewport zoom."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"resetMapView(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-resetMapView","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-resetMapView","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/methods/parseTopoJSON","title":"parseTopoJSON","summary":"Geo Map: decode TopoJSON without changing data. Returns null for other chart types or an unavailable child.","kind":"methods","member":{"name":"parseTopoJSON","parameters":[{"name":"input","type":"unknown","optional":false},{"name":"objectName","type":"string","optional":true}],"returns":"Promise<GeoMapFeatureCollection | null>","description":"Geo Map: decode TopoJSON without changing data. Returns null for other chart types or an unavailable child."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"parseTopoJSON(input: unknown, objectName?: string): Promise<GeoMapFeatureCollection | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`unknown`","Required"],["`objectName`","`string`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureCollection | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-parseTopoJSON","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/parseGeoJSON","title":"parseGeoJSON","summary":"Geo Map: decode RFC 7946 GeoJSON without changing data. Returns null for other types or an unavailable child.","kind":"methods","member":{"name":"parseGeoJSON","parameters":[{"name":"input","type":"unknown","optional":false}],"returns":"Promise<GeoMapFeatureCollection | null>","description":"Geo Map: decode RFC 7946 GeoJSON without changing data. Returns null for other types or an unavailable child."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"parseGeoJSON(input: unknown): Promise<GeoMapFeatureCollection | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`unknown`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureCollection | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-parseGeoJSON","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/setFeatures","title":"setFeatures","summary":"Geo Map: atomically validate and replace the polygon layer.","kind":"methods","member":{"name":"setFeatures","parameters":[{"name":"features","type":"GeoMapFeatureCollection","optional":true}],"returns":"Promise<void>","description":"Geo Map: atomically validate and replace the polygon layer."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setFeatures(features?: GeoMapFeatureCollection): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`features`","`GeoMapFeatureCollection`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-setFeatures","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getFeatures","title":"getFeatures","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getFeatures","parameters":[],"returns":"Promise<GeoMapFeatureCollection | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getFeatures(): Promise<GeoMapFeatureCollection | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureCollection | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getFeatures","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapHeat","title":"getMapHeat","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getMapHeat","parameters":[],"returns":"Promise<GeoMapHeatDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapHeat(): Promise<GeoMapHeatDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapHeatDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatDetail","title":"GeoMapHeatDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapHeat","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapLayers","title":"getMapLayers","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getMapLayers","parameters":[],"returns":"Promise<GeoMapLayerDetail[]>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapLayers(): Promise<GeoMapLayerDetail[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLayerDetail[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapLayers","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getMapLayers","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/methods/setMapLayerVisible","title":"setMapLayerVisible","summary":"Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null.","kind":"methods","member":{"name":"setMapLayerVisible","parameters":[{"name":"layer","type":"GeoMapLayer","optional":false},{"name":"visible","type":"boolean","optional":false}],"returns":"Promise<GeoMapLayerDetail|null>","description":"Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setMapLayerVisible(layer: GeoMapLayer, visible: boolean): Promise<GeoMapLayerDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`layer`","`GeoMapLayer`","Required"],["`visible`","`boolean`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLayerDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","description":"Type definition"},{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-setMapLayerVisible","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-setMapLayerVisible","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/methods/fitMap","title":"fitMap","summary":"Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged.","kind":"methods","member":{"name":"fitMap","parameters":[{"name":"options","type":"GeoMapFitOptions","optional":true}],"returns":"Promise<GeoMapFitDetail|null>","description":"Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"fitMap(options?: GeoMapFitOptions): Promise<GeoMapFitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`GeoMapFitOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFitDetail","title":"GeoMapFitDetail","description":"Type definition"},{"path":"/docs/types/GeoMapFitOptions","title":"GeoMapFitOptions","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-fitMap","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-fitMap","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/methods/getMapLabels","title":"getMapLabels","summary":"Full source text and current screen placement for both point and feature names.","kind":"methods","member":{"name":"getMapLabels","parameters":[],"returns":"Promise<GeoMapLabelView|null>","description":"Full source text and current screen placement for both point and feature names."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapLabels(): Promise<GeoMapLabelView|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLabelView|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelView","title":"GeoMapLabelView","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapLabels","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapView","title":"getMapView","summary":"Owned geographic camera, effective region and viewport state.","kind":"methods","member":{"name":"getMapView","parameters":[],"returns":"Promise<GeoMapViewDetail|null>","description":"Owned geographic camera, effective region and viewport state."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapView(): Promise<GeoMapViewDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapViewDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapViewDetail","title":"GeoMapViewDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapView","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getMapView","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/methods/getMapHeatAt","title":"getMapHeatAt","summary":"Read aggregate density at a host-relative point; original point/feature selection remains separate.","kind":"methods","member":{"name":"getMapHeatAt","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<GeoMapHeatPointDetail|null>","description":"Read aggregate density at a host-relative point; original point/feature selection remains separate."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapHeatAt(cssX: number, cssY: number): Promise<GeoMapHeatPointDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapHeatPointDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatPointDetail","title":"GeoMapHeatPointDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapHeatAt","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapHeatAtCoordinate","title":"getMapHeatAtCoordinate","summary":"Current visible density at longitude/latitude; null when hidden, clipped or outside the viewport.","kind":"methods","member":{"name":"getMapHeatAtCoordinate","parameters":[{"name":"longitude","type":"number","optional":false},{"name":"latitude","type":"number","optional":false}],"returns":"Promise<GeoMapHeatPointDetail|null>","description":"Current visible density at longitude/latitude; null when hidden, clipped or outside the viewport."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapHeatAtCoordinate(longitude: number, latitude: number): Promise<GeoMapHeatPointDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`longitude`","`number`","Required"],["`latitude`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapHeatPointDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatPointDetail","title":"GeoMapHeatPointDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapHeatAtCoordinate","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapBubbleScale","title":"getMapBubbleScale","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getMapBubbleScale","parameters":[],"returns":"Promise<GeoMapBubbleScaleDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapBubbleScale(): Promise<GeoMapBubbleScaleDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapBubbleScaleDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapBubbleScaleDetail","title":"GeoMapBubbleScaleDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapBubbleScale","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapColorAxis","title":"getMapColorAxis","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getMapColorAxis","parameters":[],"returns":"Promise<GeoMapColorAxisDetail|null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapColorAxis(): Promise<GeoMapColorAxisDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapColorAxisDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapColorAxisDetail","title":"GeoMapColorAxisDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapColorAxis","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapDiagnostics","title":"getMapDiagnostics","summary":"Current Geo Map normalization counters; null for another type or an absent child.","kind":"methods","member":{"name":"getMapDiagnostics","parameters":[],"returns":"Promise<GeoMapDiagnostics|null>","description":"Current Geo Map normalization counters; null for another type or an absent child."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapDiagnostics(): Promise<GeoMapDiagnostics|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapDiagnostics|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapDiagnostics","title":"GeoMapDiagnostics","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapDiagnostics","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getMapAvailability","title":"getMapAvailability","summary":"Geo Map requested/active engine, asynchronous readiness and unavailable reason; null for other families or a missing child.","kind":"methods","member":{"name":"getMapAvailability","parameters":[],"returns":"Promise<GeoMapAvailabilityDetail|null>","description":"Geo Map requested/active engine, asynchronous readiness and unavailable reason; null for other families or a missing child."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getMapAvailability(): Promise<GeoMapAvailabilityDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapAvailabilityDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapAvailabilityDetail","title":"GeoMapAvailabilityDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getMapAvailability","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/selectFeatureAt","title":"selectFeatureAt","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"selectFeatureAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GeoMapFeatureHitDetail | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectFeatureAt(index: number): Promise<GeoMapFeatureHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-selectFeatureAt","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getFeatureSelection","title":"getFeatureSelection","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getFeatureSelection","parameters":[],"returns":"Promise<GeoMapFeatureSelection | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getFeatureSelection(): Promise<GeoMapFeatureSelection | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureSelection | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureSelection","title":"GeoMapFeatureSelection","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-getFeatureSelection","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/showTooltipAtFeature","title":"showTooltipAtFeature","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"showTooltipAtFeature","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showTooltipAtFeature(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#method-showTooltipAtFeature","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/methods/getZoom","title":"getZoom","summary":"Read the current zoom range. Check the return type's nullability and the range for each axis.","kind":"methods","member":{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getZoom","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getZoom","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getZoom","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getZoom","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getZoom","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-getZoom","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-getZoom","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#method-getZoom","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#method-getZoom","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-getZoom","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-getZoom","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-getZoom","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-getZoom","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getZoom","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getZoom","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getZoom","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#method-getZoom","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-getZoom","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-getZoom","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-getZoom","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-getZoom","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getZoom","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getZoom","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getZoom","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-getZoom","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-getZoom","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-getZoom","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-getZoom","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-getZoom","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-getZoom","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getZoom","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-getZoom","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-getZoom","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/gantt#method-getZoom","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-getZoom","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/getZoomExtent","title":"getZoomExtent","summary":"the active cartesian family's full axis extents (for range controls such as `sy-data-zoom`).","kind":"methods","member":{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"the active cartesian family's full axis extents (for range controls such as `sy-data-zoom`)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getZoomExtent","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getZoomExtent","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getZoomExtent","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getZoomExtent","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getZoomExtent","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-getZoomExtent","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-getZoomExtent","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#method-getZoomExtent","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#method-getZoomExtent","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-getZoomExtent","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-getZoomExtent","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-getZoomExtent","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-getZoomExtent","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getZoomExtent","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getZoomExtent","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getZoomExtent","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#method-getZoomExtent","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-getZoomExtent","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-getZoomExtent","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-getZoomExtent","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-getZoomExtent","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-getZoomExtent","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-getZoomExtent","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-getZoomExtent","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-getZoomExtent","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-getZoomExtent","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-getZoomExtent","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-getZoomExtent","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-getZoomExtent","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-getZoomExtent","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-getZoomExtent","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-getZoomExtent","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-getZoomExtent","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/gantt#method-getZoomExtent","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#method-getZoomExtent","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/methods/connect","title":"connect","summary":"link this chart's zoom / pan with other charts (elements or ids in this chart's root): every member's `zoomChange` reaches the others as `zoomTo({ source: 'sync' })` on the `axes` (default `'x'`). A newcomer is aligned to this chart. Calling again replaces the link.","kind":"methods","member":{"name":"connect","parameters":[{"name":"charts","type":"ReadonlyArray<HTMLElement | string>","optional":false},{"name":"options","type":"ZoomConnectOptions","optional":true}],"returns":"Promise<number>","description":"link this chart's zoom / pan with other charts (elements or ids in this chart's root): every member's `zoomChange` reaches the others as `zoomTo({ source: 'sync' })` on the `axes` (default `'x'`). A newcomer is aligned to this chart. Calling again replaces the link."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"connect(charts: ReadonlyArray<HTMLElement | string>, options?: ZoomConnectOptions): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`charts`","`ReadonlyArray<HTMLElement | string>`","Required"],["`options`","`ZoomConnectOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ZoomConnectOptions","title":"ZoomConnectOptions","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/disconnect","title":"disconnect","summary":"drop the link made by `connect` (the charts keep their windows).","kind":"methods","member":{"name":"disconnect","parameters":[],"returns":"Promise<void>","description":"drop the link made by `connect` (the charts keep their windows)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"disconnect(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/showCrosshairAt","title":"showCrosshairAt","summary":"show the active cartesian family's crosshair at a data position (no `crosshairMove`); false outside the plot.","kind":"methods","member":{"name":"showCrosshairAt","parameters":[{"name":"request","type":"Bar3DCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"show the active cartesian family's crosshair at a data position (no `crosshairMove`); false outside the plot."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"showCrosshairAt(request: Bar3DCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`Bar3DCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DCrosshairShowRequest","title":"Bar3DCrosshairShowRequest","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-showCrosshairAt","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-showCrosshairAt","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-showCrosshairAt","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-showCrosshairAt","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-showCrosshairAt","title":"sy-scatter-chart","description":""},{"path":"/docs/components/theme-river#method-showCrosshairAt","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-showCrosshairAt","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/surface-3d#method-showCrosshairAt","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-showCrosshairAt","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-showCrosshairAt","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-showCrosshairAt","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/hideCrosshair","title":"hideCrosshair","summary":"hide the crosshair.","kind":"methods","member":{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-hideCrosshair","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-hideCrosshair","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-hideCrosshair","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-hideCrosshair","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-hideCrosshair","title":"sy-scatter-chart","description":""},{"path":"/docs/components/theme-river#method-hideCrosshair","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-hideCrosshair","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-hideCrosshair","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-hideCrosshair","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#method-hideCrosshair","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-hideCrosshair","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-hideCrosshair","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-hideCrosshair","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/setBrush","title":"setBrush","summary":"replace the brush areas of the active cartesian family (`null` clears).","kind":"methods","member":{"name":"setBrush","parameters":[{"name":"areas","type":"ReadonlyArray<CartesianBrushAreaInput> | null","optional":false}],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"replace the brush areas of the active cartesian family (`null` clears)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`areas`","`ReadonlyArray<CartesianBrushAreaInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-setBrush","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-setBrush","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-setBrush","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-setBrush","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-setBrush","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/clearBrush","title":"clearBrush","summary":"clear the brush areas.","kind":"methods","member":{"name":"clearBrush","parameters":[],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"clear the brush areas."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearBrush(): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-clearBrush","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-clearBrush","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-clearBrush","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-clearBrush","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-clearBrush","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/getBrush","title":"getBrush","summary":"the persisted brush areas (primary data space).","kind":"methods","member":{"name":"getBrush","parameters":[],"returns":"Promise<CartesianBrushArea[]>","description":"the persisted brush areas (primary data space)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getBrush(): Promise<CartesianBrushArea[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushArea[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getBrush","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getBrush","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getBrush","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getBrush","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getBrush","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/getBrushSelection","title":"getBrushSelection","summary":"the points inside the brush areas, per series.","kind":"methods","member":{"name":"getBrushSelection","parameters":[],"returns":"Promise<CartesianBrushSelectedSeries[]>","description":"the points inside the brush areas, per series."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushSelectedSeries[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getBrushSelection","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getBrushSelection","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getBrushSelection","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getBrushSelection","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getBrushSelection","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/getDrawings","title":"getDrawings","summary":"the drawing document of the active cartesian family.","kind":"methods","member":{"name":"getDrawings","parameters":[],"returns":"Promise<ChartDrawing[]>","description":"the drawing document of the active cartesian family."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDrawings(): Promise<ChartDrawing[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getDrawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getDrawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getDrawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getDrawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getDrawings","title":"sy-scatter-chart","description":""},{"path":"/docs/components/stock-chart#method-getDrawings","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/setDrawings","title":"setDrawings","summary":"replace the drawing document (`null` clears; undoable).","kind":"methods","member":{"name":"setDrawings","parameters":[{"name":"drawings","type":"ReadonlyArray<ChartDrawingInput> | null","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the drawing document (`null` clears; undoable)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawings`","`ReadonlyArray<ChartDrawingInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-setDrawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-setDrawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-setDrawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-setDrawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-setDrawings","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/addDrawing","title":"addDrawing","summary":"add one drawing (an explicit id replaces).","kind":"methods","member":{"name":"addDrawing","parameters":[{"name":"drawing","type":"ChartDrawingInput","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"add one drawing (an explicit id replaces)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawing`","`ChartDrawingInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-addDrawing","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-addDrawing","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-addDrawing","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-addDrawing","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-addDrawing","title":"sy-scatter-chart","description":""},{"path":"/docs/components/stock-chart#method-addDrawing","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/updateDrawing","title":"updateDrawing","summary":"merge a patch into one drawing.","kind":"methods","member":{"name":"updateDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"patch","type":"Partial<Omit<ChartDrawing, 'id'>>","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"merge a patch into one drawing."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`patch`","`Partial<Omit<ChartDrawing, 'id'>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-updateDrawing","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-updateDrawing","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-updateDrawing","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-updateDrawing","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-updateDrawing","title":"sy-scatter-chart","description":""},{"path":"/docs/components/stock-chart#method-updateDrawing","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/removeDrawing","title":"removeDrawing","summary":"remove one drawing.","kind":"methods","member":{"name":"removeDrawing","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"remove one drawing."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeDrawing(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-removeDrawing","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-removeDrawing","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-removeDrawing","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-removeDrawing","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-removeDrawing","title":"sy-scatter-chart","description":""},{"path":"/docs/components/stock-chart#method-removeDrawing","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/removeDrawings","title":"removeDrawings","summary":"remove several drawings in one undoable step.","kind":"methods","member":{"name":"removeDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string>","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"remove several drawings in one undoable step."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-removeDrawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-removeDrawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-removeDrawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-removeDrawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-removeDrawings","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/setDrawingSpace","title":"setDrawingSpace","summary":"move a drawing to the other coordinate space (its anchors convert at the current frame).","kind":"methods","member":{"name":"setDrawingSpace","parameters":[{"name":"id","type":"string","optional":false},{"name":"space","type":"DrawingSpace","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"move a drawing to the other coordinate space (its anchors convert at the current frame)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`space`","`DrawingSpace`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-setDrawingSpace","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-setDrawingSpace","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-setDrawingSpace","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-setDrawingSpace","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-setDrawingSpace","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/clearDrawings","title":"clearDrawings","summary":"clear the drawing document (undoable).","kind":"methods","member":{"name":"clearDrawings","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"clear the drawing document (undoable)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"clearDrawings(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-clearDrawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-clearDrawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-clearDrawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-clearDrawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-clearDrawings","title":"sy-scatter-chart","description":""},{"path":"/docs/components/stock-chart#method-clearDrawings","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/undoDrawing","title":"undoDrawing","summary":"undo the last drawing change.","kind":"methods","member":{"name":"undoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"undo the last drawing change."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"undoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-undoDrawing","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-undoDrawing","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-undoDrawing","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-undoDrawing","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-undoDrawing","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/redoDrawing","title":"redoDrawing","summary":"redo the last undone drawing change.","kind":"methods","member":{"name":"redoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"redo the last undone drawing change."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"redoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-redoDrawing","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-redoDrawing","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-redoDrawing","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-redoDrawing","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-redoDrawing","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/exportDrawings","title":"exportDrawings","summary":"the drawing document as its JSON envelope.","kind":"methods","member":{"name":"exportDrawings","parameters":[],"returns":"Promise<string>","description":"the drawing document as its JSON envelope."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"exportDrawings(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-exportDrawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-exportDrawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-exportDrawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-exportDrawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-exportDrawings","title":"sy-scatter-chart","description":""},{"path":"/docs/components/stock-chart#method-exportDrawings","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/methods/importDrawings","title":"importDrawings","summary":"replace the drawing document from an envelope / list / JSON string.","kind":"methods","member":{"name":"importDrawings","parameters":[{"name":"input","type":"ChartDrawingsInput","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the drawing document from an envelope / list / JSON string."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`ChartDrawingsInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-importDrawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-importDrawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-importDrawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-importDrawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-importDrawings","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/getDrawingLayer","title":"getDrawingLayer","summary":"the drawing overlay as a positioned SVG layer (null without drawings): what `getSVG` / `exportSVG` / `exportPNG` compose into the image.","kind":"methods","member":{"name":"getDrawingLayer","parameters":[],"returns":"Promise<DrawingLayerSnapshot | null>","description":"the drawing overlay as a positioned SVG layer (null without drawings): what `getSVG` / `exportSVG` / `exportPNG` compose into the image."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDrawingLayer(): Promise<DrawingLayerSnapshot | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingLayerSnapshot | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getDrawingLayer","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getDrawingLayer","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getDrawingLayer","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getDrawingLayer","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getDrawingLayer","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/exportDrawingsFile","title":"exportDrawingsFile","summary":"downloads the drawing document as `<export name>-drawings.json` (the envelope `importDrawings` / `importDrawingsFile` read back); reports through `exported`.","kind":"methods","member":{"name":"exportDrawingsFile","parameters":[],"returns":"Promise<void>","description":"downloads the drawing document as `<export name>-drawings.json` (the envelope `importDrawings` / `importDrawingsFile` read back); reports through `exported`."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"exportDrawingsFile(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/importDrawingsFile","title":"importDrawingsFile","summary":"replaces the drawing document from a picked file (a File / Blob of the envelope, or its text); a file that is not JSON is declined (null) and the document stays.","kind":"methods","member":{"name":"importDrawingsFile","parameters":[{"name":"file","type":"Blob | string","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replaces the drawing document from a picked file (a File / Blob of the envelope, or its text); a file that is not JSON is declined (null) and the document stays."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"importDrawingsFile(file: Blob | string): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`file`","`Blob | string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/selectDrawings","title":"selectDrawings","summary":"select drawings (`null` clears).","kind":"methods","member":{"name":"selectDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string> | null","optional":false}],"returns":"Promise<DrawingSelectionChangeEventDetail | null>","description":"select drawings (`null` clears)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingSelectionChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-selectDrawings","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-selectDrawings","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-selectDrawings","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-selectDrawings","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-selectDrawings","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/getDrawingSelection","title":"getDrawingSelection","summary":"the selected drawing ids.","kind":"methods","member":{"name":"getDrawingSelection","parameters":[],"returns":"Promise<string[]>","description":"the selected drawing ids."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDrawingSelection(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getDrawingSelection","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getDrawingSelection","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getDrawingSelection","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getDrawingSelection","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getDrawingSelection","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/methods/setVisualMap","title":"setVisualMap","summary":"bind (or clear) a visual map on the cartesian family that owns the paint.","kind":"methods","member":{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"bind (or clear) a visual map on the cartesian family that owns the paint."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-setVisualMap","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-setVisualMap","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-setVisualMap","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-setVisualMap","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-setVisualMap","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-setVisualMap","title":"sy-bubble-chart","description":""},{"path":"/docs/components/heatmap#method-setVisualMap","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-setVisualMap","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-setVisualMap","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-setVisualMap","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/methods/getVisualMap","title":"getVisualMap","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getVisualMap","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getVisualMap","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getVisualMap","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getVisualMap","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getVisualMap","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-getVisualMap","title":"sy-bubble-chart","description":""},{"path":"/docs/components/heatmap#method-getVisualMap","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getVisualMap","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getVisualMap","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getVisualMap","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/methods/getVisualExtent","title":"getVisualExtent","summary":"the extent of a dimension over the visible points (the domain a bound `sy-visual-map` adopts).","kind":"methods","member":{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"the extent of a dimension over the visible points (the domain a bound `sy-visual-map` adopts)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-getVisualExtent","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-getVisualExtent","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-getVisualExtent","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-getVisualExtent","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#method-getVisualExtent","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-getVisualExtent","title":"sy-bubble-chart","description":""},{"path":"/docs/components/heatmap#method-getVisualExtent","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-getVisualExtent","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-getVisualExtent","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-getVisualExtent","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/methods/getDataset","title":"getDataset","summary":"the dataset after its transforms (id, dimensions, rows), or null without a dataset.","kind":"methods","member":{"name":"getDataset","parameters":[],"returns":"Promise<{ id: string | undefined; dimensions: ReadonlyArray<{ index: number; name: string; type: string }>; rows: ReadonlyArray<ReadonlyArray<unknown>> } | null>","description":"the dataset after its transforms (id, dimensions, rows), or null without a dataset."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getDataset(): Promise<{ id: string | undefined; dimensions: ReadonlyArray<{ index: number; name: string; type: string }>; rows: ReadonlyArray<ReadonlyArray<unknown>> } | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ id: string | undefined; dimensions: ReadonlyArray<{ index: number; name: string; type: string }>; rows: ReadonlyArray<ReadonlyArray<unknown>> } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/getEncodedSeries","title":"getEncodedSeries","summary":"the encoded series (names, values, xValues, the dimension names behind them) and the category labels, or null.","kind":"methods","member":{"name":"getEncodedSeries","parameters":[],"returns":"Promise<EncodedDataset | null>","description":"the encoded series (names, values, xValues, the dimension names behind them) and the category labels, or null."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"getEncodedSeries(): Promise<EncodedDataset | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<EncodedDataset | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/EncodedDataset","title":"EncodedDataset","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/dispatchAction","title":"dispatchAction","summary":"One entry point over the imperative surface (ECharts `dispatchAction`): `{ type, payload }` or `{ type, ...fields }`. Routes to the method behind the type and answers `{ type, handled, result }`; an unknown type is reported, not thrown.","kind":"methods","member":{"name":"dispatchAction","parameters":[{"name":"action","type":"ChartAction | string","optional":false}],"returns":"Promise<ChartActionResult>","description":"One entry point over the imperative surface (ECharts `dispatchAction`): `{ type, payload }` or `{ type, ...fields }`. Routes to the method behind the type and answers `{ type, handled, result }`; an unknown type is reported, not thrown."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"dispatchAction(action: ChartAction | string): Promise<ChartActionResult>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`action`","`ChartAction | string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartActionResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartActionResult","title":"ChartActionResult","description":"Type definition"},{"path":"/docs/types/ChartAction","title":"ChartAction","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/methods/appendSamples","title":"appendSamples","summary":"feed raw samples: every completed window becomes a frame (appended through the stream); the rest waits.","kind":"methods","member":{"name":"appendSamples","parameters":[{"name":"samples","type":"ArrayLike<number>","optional":false}],"returns":"Promise<SpectrogramAppendSamplesResult>","description":"feed raw samples: every completed window becomes a frame (appended through the stream); the rest waits."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"appendSamples(samples: ArrayLike<number>): Promise<SpectrogramAppendSamplesResult>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`samples`","`ArrayLike<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramAppendSamplesResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramAppendSamplesResult","title":"SpectrogramAppendSamplesResult","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/spectrogram#method-appendSamples","title":"sy-spectrogram","description":""}]}]}]},{"path":"/docs/methods/hideTooltip","title":"hideTooltip","summary":"Close the currently visible tooltip.","kind":"methods","member":{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#method-hideTooltip","title":"sy-line-chart","description":""},{"path":"/docs/components/area#method-hideTooltip","title":"sy-area-chart","description":""},{"path":"/docs/components/column#method-hideTooltip","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#method-hideTooltip","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#method-hideTooltip","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#method-hideTooltip","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#method-hideTooltip","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#method-hideTooltip","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#method-hideTooltip","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#method-hideTooltip","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#method-hideTooltip","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#method-hideTooltip","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#method-hideTooltip","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#method-hideTooltip","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#method-hideTooltip","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#method-hideTooltip","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#method-hideTooltip","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#method-hideTooltip","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#method-hideTooltip","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#method-hideTooltip","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#method-hideTooltip","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#method-hideTooltip","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#method-hideTooltip","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#method-hideTooltip","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#method-hideTooltip","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#method-hideTooltip","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#method-hideTooltip","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#method-hideTooltip","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#method-hideTooltip","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#method-hideTooltip","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#method-hideTooltip","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#method-hideTooltip","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#method-hideTooltip","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#method-hideTooltip","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#method-hideTooltip","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#method-hideTooltip","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#method-hideTooltip","title":"sy-sankey","description":""},{"path":"/docs/components/chord#method-hideTooltip","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#method-hideTooltip","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#method-hideTooltip","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#method-hideTooltip","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#method-hideTooltip","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#method-hideTooltip","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#method-hideTooltip","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/ohlc#method-hideTooltip","title":"sy-ohlc-chart","description":""},{"path":"/docs/components/surface-3d#method-hideTooltip","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#method-hideTooltip","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#method-hideTooltip","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#method-hideTooltip","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/methods/hitTestScatterPoint","title":"hitTestScatterPoint","summary":"An asynchronous method. Check the argument and return types below.","kind":"methods","member":{"name":"hitTestScatterPoint","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ pointIndex: number; seriesIndex: number } | null>","description":"An asynchronous method. Check the argument and return types below."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"code","source":"hitTestScatterPoint(cssX: number, cssY: number): Promise<{ pointIndex: number; seriesIndex: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ pointIndex: number; seriesIndex: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events","title":"Events","summary":"Events for the shared sy-chart component. Also check the direct tag's API for behavior supported by your selected chart.","kind":"events","sections":[{"id":"members","title":"Complete list","blocks":[{"kind":"links","items":[{"path":"/docs/events/typeLoadChange","title":"typeLoadChange","description":"Every change of the chart type's load state: loading, ready, or why the type cannot be drawn ."},{"path":"/docs/events/rendered","title":"rendered","description":"Emits rendering results in detail when chart drawing completes."},{"path":"/docs/events/appended","title":"appended","description":"CustomEvent.detail type: ChartAppendedEventDetail. Event names are case-sensitive."},{"path":"/docs/events/windowSlid","title":"windowSlid","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"path":"/docs/events/chartAnimationStart","title":"chartAnimationStart","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"path":"/docs/events/chartAnimationEnd","title":"chartAnimationEnd","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"path":"/docs/events/chartAnimationInterrupted","title":"chartAnimationInterrupted","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"path":"/docs/events/pointHover","title":"pointHover","description":"CustomEvent.detail type: ChartPointEventDetail | null. Event names are case-sensitive."},{"path":"/docs/events/dependencyClick","title":"dependencyClick","description":"CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive."},{"path":"/docs/events/taskEditStart","title":"taskEditStart","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"path":"/docs/events/taskEditMove","title":"taskEditMove","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"path":"/docs/events/taskEditEnd","title":"taskEditEnd","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"path":"/docs/events/taskEditCancel","title":"taskEditCancel","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"path":"/docs/events/dependencyHover","title":"dependencyHover","description":"CustomEvent.detail type: GanttDependencyHitDetail|null. Event names are case-sensitive."},{"path":"/docs/events/dependencySelectionChange","title":"dependencySelectionChange","description":"CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive."},{"path":"/docs/events/pointClick","title":"pointClick","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"path":"/docs/events/pointContextMenu","title":"pointContextMenu","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail. Event names are case-sensitive."},{"path":"/docs/events/pointChange","title":"pointChange","description":"CustomEvent.detail type: RadarChartPointerEventDetail. Event names are case-sensitive."},{"path":"/docs/events/pointDragStart","title":"pointDragStart","description":"Network Graph — a node drag begins (after the 3 px threshold), moves and ends; `by` tells a pointer drag from a keyboard nudge."},{"path":"/docs/events/pointDragMove","title":"pointDragMove","description":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"path":"/docs/events/pointDragEnd","title":"pointDragEnd","description":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"path":"/docs/events/seriesClick","title":"seriesClick","description":"CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive."},{"path":"/docs/events/seriesOutsideClick","title":"seriesOutsideClick","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"path":"/docs/events/legendItemClick","title":"legendItemClick","description":"CustomEvent.detail type: ChartLegendItemEventDetail. Event names are case-sensitive."},{"path":"/docs/events/seriesToggled","title":"seriesToggled","description":"CustomEvent.detail type: ChartSeriesToggledEventDetail. Event names are case-sensitive."},{"path":"/docs/events/crosshairMove","title":"crosshairMove","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail. Event names are case-sensitive."},{"path":"/docs/events/tooltipShow","title":"tooltipShow","description":"Whether to display the built-in tooltip."},{"path":"/docs/events/tooltipHide","title":"tooltipHide","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"path":"/docs/events/zoomChange","title":"zoomChange","description":"re-emitted from the active cartesian family after every zoom change."},{"path":"/docs/events/mapViewChange","title":"mapViewChange","description":"Geographic camera after a completed globe drag or map-view reset."},{"path":"/docs/events/mapLayerChange","title":"mapLayerChange","description":"CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive."},{"path":"/docs/events/featureClick","title":"featureClick","description":"CustomEvent.detail type: GeoMapFeatureHitDetail. Event names are case-sensitive."},{"path":"/docs/events/featureHover","title":"featureHover","description":"CustomEvent.detail type: GeoMapFeatureHitDetail | null. Event names are case-sensitive."},{"path":"/docs/events/featureSelectionChange","title":"featureSelectionChange","description":"CustomEvent.detail type: GeoMapFeatureSelectionChangeEventDetail. Event names are case-sensitive."},{"path":"/docs/events/axisBrushChange","title":"axisBrushChange","description":"CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive."},{"path":"/docs/events/axisBrushStart","title":"axisBrushStart","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"path":"/docs/events/axisBrushMove","title":"axisBrushMove","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"path":"/docs/events/axisBrushEnd","title":"axisBrushEnd","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"path":"/docs/events/brushChange","title":"brushChange","description":"CustomEvent.detail type: CartesianBrushChangeEventDetail. Event names are case-sensitive."},{"path":"/docs/events/actionDispatched","title":"actionDispatched","description":"every `dispatchAction` call, after it ran (`handled` false for an unknown type)."},{"path":"/docs/events/renderProgress","title":"renderProgress","description":"re-emitted from the scatter family: a progressively painted chunk landed (`done` on the last)."},{"path":"/docs/events/brushStart","title":"brushStart","description":"CustomEvent.detail type: CartesianBrushStartEventDetail. Event names are case-sensitive."},{"path":"/docs/events/brushMove","title":"brushMove","description":"CustomEvent.detail type: CartesianBrushMoveEventDetail. Event names are case-sensitive."},{"path":"/docs/events/brushEnd","title":"brushEnd","description":"CustomEvent.detail type: CartesianBrushEndEventDetail. Event names are case-sensitive."},{"path":"/docs/events/drawingsChange","title":"drawingsChange","description":"the drawing document of the active cartesian family changed."},{"path":"/docs/events/drawingSelectionChange","title":"drawingSelectionChange","description":"the drawing selection of the active cartesian family changed."},{"path":"/docs/events/tooltipAction","title":"tooltipAction","description":"CustomEvent.detail type: ChartTooltipActionEventDetail. Event names are case-sensitive."},{"path":"/docs/events/sliceClick","title":"sliceClick","description":"CustomEvent.detail type: PieChartSliceEventDetail. Event names are case-sensitive."},{"path":"/docs/events/sliceHover","title":"sliceHover","description":"CustomEvent.detail type: PieChartSliceEventDetail | null. Event names are case-sensitive."},{"path":"/docs/events/sliceSelected","title":"sliceSelected","description":"CustomEvent.detail type: PieChartSelectedEventDetail. Event names are case-sensitive."},{"path":"/docs/events/sliceToggled","title":"sliceToggled","description":"CustomEvent.detail type: { index: number; sliceId: string; disabled: boolean }. Event names are case-sensitive."},{"path":"/docs/events/selectionChanged","title":"selectionChanged","description":"CustomEvent.detail type: SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail. Event names are case-sensitive."},{"path":"/docs/events/drillChange","title":"drillChange","description":"Treemap branch navigation through pointer, keyboard, methods or data reconciliation."},{"path":"/docs/events/gaugeClick","title":"gaugeClick","description":"CustomEvent.detail type: GaugeChartPointerEventDetail. Event names are case-sensitive."},{"path":"/docs/events/gaugeHover","title":"gaugeHover","description":"CustomEvent.detail type: GaugeChartPointerEventDetail | null. Event names are case-sensitive."},{"path":"/docs/events/valueChange","title":"valueChange","description":"CustomEvent.detail type: { value: number; fraction: number }. Event names are case-sensitive."},{"path":"/docs/events/needleToggled","title":"needleToggled","description":"CustomEvent.detail type: { index: number; needleId: string; disabled: boolean }. Event names are case-sensitive."},{"path":"/docs/events/sectionClick","title":"sectionClick","description":"CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive."},{"path":"/docs/events/sectionHover","title":"sectionHover","description":"CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive."},{"path":"/docs/events/sectionToggled","title":"sectionToggled","description":"CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive."},{"path":"/docs/events/cameraChange","title":"cameraChange","description":"CustomEvent.detail type: Surface3DCameraChangeEventDetail. Event names are case-sensitive."},{"path":"/docs/events/dataValidationError","title":"dataValidationError","description":"CustomEvent.detail type: ChartDataValidationErrorDetail. Event names are case-sensitive."},{"path":"/docs/events/contextMenuOpened","title":"contextMenuOpened","description":"CustomEvent.detail type: ChartContextMenuEventDetail. Event names are case-sensitive."},{"path":"/docs/events/contextMenuClosed","title":"contextMenuClosed","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"path":"/docs/events/contextMenuItemSelect","title":"contextMenuItemSelect","description":"CustomEvent.detail type: ChartContextMenuItemEventDetail. Event names are case-sensitive."},{"path":"/docs/events/exported","title":"exported","description":"CustomEvent.detail type: { format: 'png' | 'svg' | 'csv' | 'json'; filename: string }. Event names are case-sensitive."},{"path":"/docs/events/dataTableToggled","title":"dataTableToggled","description":"CustomEvent.detail type: { open: boolean }. Event names are case-sensitive."}]}]}]},{"path":"/docs/events/typeLoadChange","title":"typeLoadChange","summary":"Every change of the chart type's load state: loading, ready, or why the type cannot be drawn .","kind":"events","member":{"name":"typeLoadChange","type":"ChartTypeLoadDetail","description":"Every change of the chart type's load state: loading, ready, or why the type cannot be drawn ."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `typeLoadChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartTypeLoadDetail>`."},{"kind":"code","source":"chart.addEventListener('typeLoadChange', event => {\n  console.log(event.detail); // ChartTypeLoadDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartTypeLoadDetail","title":"ChartTypeLoadDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/rendered","title":"rendered","summary":"Emits rendering results in detail when chart drawing completes.","kind":"events","member":{"name":"rendered","type":"ChartRenderResult & { type: ChartType; tier: ChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartRenderResult & { type: ChartType; tier: ChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ChartRenderResult & { type: ChartType; tier: ChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartRenderResult","title":"ChartRenderResult","description":"Type definition"},{"path":"/docs/types/ChartType","title":"ChartType","description":"Type definition"},{"path":"/docs/types/ChartEngineTier","title":"ChartEngineTier","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-rendered","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-rendered","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-rendered","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-rendered","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-rendered","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-rendered","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-rendered","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-rendered","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-rendered","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-rendered","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-rendered","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-rendered","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-rendered","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-rendered","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-rendered","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-rendered","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-rendered","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-rendered","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-rendered","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-rendered","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-rendered","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-rendered","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-rendered","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-rendered","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-rendered","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-rendered","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-rendered","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-rendered","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-rendered","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-rendered","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-rendered","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-rendered","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-rendered","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-rendered","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-rendered","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-rendered","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-rendered","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-rendered","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-rendered","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-rendered","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-rendered","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-rendered","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-rendered","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-rendered","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/stock-chart#event-rendered","title":"sy-stock-chart","description":""},{"path":"/docs/components/stock-volume#event-rendered","title":"sy-stock-volume","description":""},{"path":"/docs/components/surface-3d#event-rendered","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-rendered","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-rendered","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-rendered","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-rendered","title":"sy-wafer-map","description":""},{"path":"/docs/components/wafer-stack#event-rendered","title":"sy-wafer-stack","description":""},{"path":"/docs/components/wafer-correlation#event-rendered","title":"sy-wafer-correlation","description":""}]}]}]},{"path":"/docs/events/appended","title":"appended","summary":"CustomEvent.detail type: ChartAppendedEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"appended","type":"ChartAppendedEventDetail","description":"CustomEvent.detail type: ChartAppendedEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartAppendedEventDetail>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // ChartAppendedEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartAppendedEventDetail","title":"ChartAppendedEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-appended","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-appended","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-appended","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-appended","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-appended","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-appended","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-appended","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-appended","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-appended","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-appended","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-appended","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-appended","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-appended","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-appended","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-appended","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-appended","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-appended","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-appended","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-appended","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-appended","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-appended","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-appended","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-appended","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-appended","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-appended","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-appended","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-appended","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-appended","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-appended","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-appended","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-appended","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-appended","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-appended","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-appended","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-appended","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-appended","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-appended","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-appended","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-appended","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-appended","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-appended","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-appended","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-appended","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-appended","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-appended","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-appended","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-appended","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-appended","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-appended","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/events/windowSlid","title":"windowSlid","summary":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive.","kind":"events","member":{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-windowSlid","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-windowSlid","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-windowSlid","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-windowSlid","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-windowSlid","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-windowSlid","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-windowSlid","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-windowSlid","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-windowSlid","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-windowSlid","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-windowSlid","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-windowSlid","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-windowSlid","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-windowSlid","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-windowSlid","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-windowSlid","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-windowSlid","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-windowSlid","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-windowSlid","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-windowSlid","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-windowSlid","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-windowSlid","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-windowSlid","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-windowSlid","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-windowSlid","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-windowSlid","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-windowSlid","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-windowSlid","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-windowSlid","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-windowSlid","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-windowSlid","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-windowSlid","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-windowSlid","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-windowSlid","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-windowSlid","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-windowSlid","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-windowSlid","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-windowSlid","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-windowSlid","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-windowSlid","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-windowSlid","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-windowSlid","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-windowSlid","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-windowSlid","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-windowSlid","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-windowSlid","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-windowSlid","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-windowSlid","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-windowSlid","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/events/chartAnimationStart","title":"chartAnimationStart","summary":"CustomEvent.detail type: void. Event names are case-sensitive.","kind":"events","member":{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-chartAnimationStart","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-chartAnimationStart","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-chartAnimationStart","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-chartAnimationStart","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-chartAnimationStart","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-chartAnimationStart","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-chartAnimationStart","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-chartAnimationStart","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-chartAnimationStart","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-chartAnimationStart","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-chartAnimationStart","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-chartAnimationStart","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-chartAnimationStart","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-chartAnimationStart","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-chartAnimationStart","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-chartAnimationStart","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-chartAnimationStart","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-chartAnimationStart","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-chartAnimationStart","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-chartAnimationStart","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-chartAnimationStart","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-chartAnimationStart","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-chartAnimationStart","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-chartAnimationStart","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-chartAnimationStart","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-chartAnimationStart","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-chartAnimationStart","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-chartAnimationStart","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-chartAnimationStart","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-chartAnimationStart","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-chartAnimationStart","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-chartAnimationStart","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-chartAnimationStart","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-chartAnimationStart","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-chartAnimationStart","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-chartAnimationStart","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-chartAnimationStart","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-chartAnimationStart","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-chartAnimationStart","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-chartAnimationStart","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-chartAnimationStart","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-chartAnimationStart","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-chartAnimationStart","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-chartAnimationStart","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-chartAnimationStart","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-chartAnimationStart","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-chartAnimationStart","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-chartAnimationStart","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-chartAnimationStart","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/events/chartAnimationEnd","title":"chartAnimationEnd","summary":"CustomEvent.detail type: void. Event names are case-sensitive.","kind":"events","member":{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-chartAnimationEnd","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-chartAnimationEnd","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-chartAnimationEnd","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-chartAnimationEnd","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-chartAnimationEnd","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-chartAnimationEnd","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-chartAnimationEnd","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-chartAnimationEnd","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-chartAnimationEnd","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-chartAnimationEnd","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-chartAnimationEnd","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-chartAnimationEnd","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-chartAnimationEnd","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-chartAnimationEnd","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-chartAnimationEnd","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-chartAnimationEnd","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-chartAnimationEnd","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-chartAnimationEnd","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-chartAnimationEnd","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-chartAnimationEnd","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-chartAnimationEnd","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-chartAnimationEnd","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-chartAnimationEnd","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-chartAnimationEnd","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-chartAnimationEnd","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-chartAnimationEnd","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-chartAnimationEnd","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-chartAnimationEnd","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-chartAnimationEnd","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-chartAnimationEnd","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-chartAnimationEnd","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-chartAnimationEnd","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-chartAnimationEnd","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-chartAnimationEnd","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-chartAnimationEnd","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-chartAnimationEnd","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-chartAnimationEnd","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-chartAnimationEnd","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-chartAnimationEnd","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-chartAnimationEnd","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-chartAnimationEnd","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-chartAnimationEnd","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-chartAnimationEnd","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-chartAnimationEnd","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-chartAnimationEnd","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-chartAnimationEnd","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-chartAnimationEnd","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-chartAnimationEnd","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-chartAnimationEnd","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/events/chartAnimationInterrupted","title":"chartAnimationInterrupted","summary":"CustomEvent.detail type: void. Event names are case-sensitive.","kind":"events","member":{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-chartAnimationInterrupted","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-chartAnimationInterrupted","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-chartAnimationInterrupted","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-chartAnimationInterrupted","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-chartAnimationInterrupted","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-chartAnimationInterrupted","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-chartAnimationInterrupted","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-chartAnimationInterrupted","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-chartAnimationInterrupted","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-chartAnimationInterrupted","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-chartAnimationInterrupted","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-chartAnimationInterrupted","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-chartAnimationInterrupted","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-chartAnimationInterrupted","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-chartAnimationInterrupted","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-chartAnimationInterrupted","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-chartAnimationInterrupted","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-chartAnimationInterrupted","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-chartAnimationInterrupted","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-chartAnimationInterrupted","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-chartAnimationInterrupted","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-chartAnimationInterrupted","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-chartAnimationInterrupted","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-chartAnimationInterrupted","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-chartAnimationInterrupted","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-chartAnimationInterrupted","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-chartAnimationInterrupted","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-chartAnimationInterrupted","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-chartAnimationInterrupted","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-chartAnimationInterrupted","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-chartAnimationInterrupted","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-chartAnimationInterrupted","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-chartAnimationInterrupted","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-chartAnimationInterrupted","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-chartAnimationInterrupted","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-chartAnimationInterrupted","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-chartAnimationInterrupted","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-chartAnimationInterrupted","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-chartAnimationInterrupted","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-chartAnimationInterrupted","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-chartAnimationInterrupted","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-chartAnimationInterrupted","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-chartAnimationInterrupted","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-chartAnimationInterrupted","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-chartAnimationInterrupted","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-chartAnimationInterrupted","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-chartAnimationInterrupted","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-chartAnimationInterrupted","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-chartAnimationInterrupted","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/events/pointHover","title":"pointHover","summary":"CustomEvent.detail type: ChartPointEventDetail | null. Event names are case-sensitive.","kind":"events","member":{"name":"pointHover","type":"ChartPointEventDetail | null","description":"CustomEvent.detail type: ChartPointEventDetail | null. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // ChartPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointEventDetail","title":"ChartPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-pointHover","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-pointHover","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-pointHover","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-pointHover","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-pointHover","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-pointHover","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-pointHover","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-pointHover","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-pointHover","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-pointHover","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-pointHover","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-pointHover","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-pointHover","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-pointHover","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-pointHover","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-pointHover","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-pointHover","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-pointHover","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-pointHover","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-pointHover","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-pointHover","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-pointHover","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-pointHover","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-pointHover","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#event-pointHover","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-pointHover","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-pointHover","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-pointHover","title":"sy-tilemap","description":""},{"path":"/docs/components/theme-river#event-pointHover","title":"sy-theme-river","description":""},{"path":"/docs/components/flow-lines#event-pointHover","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-pointHover","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-pointHover","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-pointHover","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-pointHover","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/events/dependencyClick","title":"dependencyClick","summary":"CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive.","kind":"events","member":{"name":"dependencyClick","type":"GanttDependencyHitDetail","description":"CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `dependencyClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencyHitDetail>`."},{"kind":"code","source":"chart.addEventListener('dependencyClick', event => {\n  console.log(event.detail); // GanttDependencyHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#event-dependencyClick","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/taskEditStart","title":"taskEditStart","summary":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"taskEditStart","type":"GanttTaskEditEventDetail","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `taskEditStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditStart', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#event-taskEditStart","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/taskEditMove","title":"taskEditMove","summary":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"taskEditMove","type":"GanttTaskEditEventDetail","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `taskEditMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditMove', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#event-taskEditMove","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/taskEditEnd","title":"taskEditEnd","summary":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"taskEditEnd","type":"GanttTaskEditEventDetail","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `taskEditEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditEnd', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#event-taskEditEnd","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/taskEditCancel","title":"taskEditCancel","summary":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"taskEditCancel","type":"GanttTaskEditEventDetail","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `taskEditCancel`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditCancel', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#event-taskEditCancel","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/dependencyHover","title":"dependencyHover","summary":"CustomEvent.detail type: GanttDependencyHitDetail|null. Event names are case-sensitive.","kind":"events","member":{"name":"dependencyHover","type":"GanttDependencyHitDetail|null","description":"CustomEvent.detail type: GanttDependencyHitDetail|null. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `dependencyHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencyHitDetail|null>`."},{"kind":"code","source":"chart.addEventListener('dependencyHover', event => {\n  console.log(event.detail); // GanttDependencyHitDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#event-dependencyHover","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/dependencySelectionChange","title":"dependencySelectionChange","summary":"CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive.","kind":"events","member":{"name":"dependencySelectionChange","type":"GanttDependencySelectionChange","description":"CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `dependencySelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencySelectionChange>`."},{"kind":"code","source":"chart.addEventListener('dependencySelectionChange', event => {\n  console.log(event.detail); // GanttDependencySelectionChange\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttDependencySelectionChange","title":"GanttDependencySelectionChange","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gantt#event-dependencySelectionChange","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/pointClick","title":"pointClick","summary":"A point selection event. Read the selected data and index from CustomEvent.detail.","kind":"events","member":{"name":"pointClick","type":"ChartPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // ChartPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointEventDetail","title":"ChartPointEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-pointClick","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-pointClick","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-pointClick","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-pointClick","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-pointClick","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-pointClick","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-pointClick","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-pointClick","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-pointClick","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-pointClick","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-pointClick","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-pointClick","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-pointClick","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-pointClick","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-pointClick","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-pointClick","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-pointClick","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-pointClick","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-pointClick","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-pointClick","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-pointClick","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-pointClick","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-pointClick","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-pointClick","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#event-pointClick","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-pointClick","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-pointClick","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-pointClick","title":"sy-tilemap","description":""},{"path":"/docs/components/theme-river#event-pointClick","title":"sy-theme-river","description":""},{"path":"/docs/components/flow-lines#event-pointClick","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-pointClick","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-pointClick","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-pointClick","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-pointClick","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/events/pointContextMenu","title":"pointContextMenu","summary":"CustomEvent.detail type: ChartPointContextMenuEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-pointContextMenu","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-pointContextMenu","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-pointContextMenu","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-pointContextMenu","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-pointContextMenu","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-pointContextMenu","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-pointContextMenu","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-pointContextMenu","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-pointContextMenu","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-pointContextMenu","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-pointContextMenu","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-pointContextMenu","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-pointContextMenu","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-pointContextMenu","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-pointContextMenu","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-pointContextMenu","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-pointContextMenu","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-pointContextMenu","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-pointContextMenu","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-pointContextMenu","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-pointContextMenu","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-pointContextMenu","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-pointContextMenu","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-pointContextMenu","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-pointContextMenu","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-pointContextMenu","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-pointContextMenu","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-pointContextMenu","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-pointContextMenu","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-pointContextMenu","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-pointContextMenu","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-pointContextMenu","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-pointContextMenu","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-pointContextMenu","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-pointContextMenu","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-pointContextMenu","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-pointContextMenu","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-pointContextMenu","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-pointContextMenu","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-pointContextMenu","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-pointContextMenu","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-pointContextMenu","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-pointContextMenu","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-pointContextMenu","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-pointContextMenu","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-pointContextMenu","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-pointContextMenu","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-pointContextMenu","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-pointContextMenu","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/events/pointChange","title":"pointChange","summary":"CustomEvent.detail type: RadarChartPointerEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"pointChange","type":"RadarChartPointerEventDetail","description":"CustomEvent.detail type: RadarChartPointerEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `pointChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<RadarChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointChange', event => {\n  console.log(event.detail); // RadarChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/radar#event-pointChange","title":"sy-radar-chart","description":""}]}]}]},{"path":"/docs/events/pointDragStart","title":"pointDragStart","summary":"Network Graph — a node drag begins (after the 3 px threshold), moves and ends; `by` tells a pointer drag from a keyboard nudge.","kind":"events","member":{"name":"pointDragStart","type":"NetworkGraphNodeDragEventDetail","description":"Network Graph — a node drag begins (after the 3 px threshold), moves and ends; `by` tells a pointer drag from a keyboard nudge."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `pointDragStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeDragEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointDragStart', event => {\n  console.log(event.detail); // NetworkGraphNodeDragEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/pointDragMove","title":"pointDragMove","summary":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"pointDragMove","type":"NetworkGraphNodeDragEventDetail","description":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `pointDragMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeDragEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointDragMove', event => {\n  console.log(event.detail); // NetworkGraphNodeDragEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/pointDragEnd","title":"pointDragEnd","summary":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"pointDragEnd","type":"NetworkGraphNodeDragEventDetail","description":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `pointDragEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeDragEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointDragEnd', event => {\n  console.log(event.detail); // NetworkGraphNodeDragEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/seriesClick","title":"seriesClick","summary":"CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive.","kind":"events","member":{"name":"seriesClick","type":"{ cssX: number; cssY: number }","description":"CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `seriesClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ cssX: number; cssY: number }>`."},{"kind":"code","source":"chart.addEventListener('seriesClick', event => {\n  console.log(event.detail); // { cssX: number; cssY: number }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-seriesClick","title":"sy-line-chart","description":""}]}]}]},{"path":"/docs/events/seriesOutsideClick","title":"seriesOutsideClick","summary":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-seriesOutsideClick","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-seriesOutsideClick","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-seriesOutsideClick","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-seriesOutsideClick","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-seriesOutsideClick","title":"sy-scatter-chart","description":""},{"path":"/docs/components/lollipop#event-seriesOutsideClick","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-seriesOutsideClick","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-seriesOutsideClick","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-seriesOutsideClick","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-seriesOutsideClick","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-seriesOutsideClick","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#event-seriesOutsideClick","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-seriesOutsideClick","title":"sy-histogram-chart","description":""},{"path":"/docs/components/pictorial#event-seriesOutsideClick","title":"sy-pictorial-chart","description":""}]}]}]},{"path":"/docs/events/legendItemClick","title":"legendItemClick","summary":"CustomEvent.detail type: ChartLegendItemEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"legendItemClick","type":"ChartLegendItemEventDetail","description":"CustomEvent.detail type: ChartLegendItemEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // ChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartLegendItemEventDetail","title":"ChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-legendItemClick","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-legendItemClick","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-legendItemClick","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-legendItemClick","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-legendItemClick","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-legendItemClick","title":"sy-scatter-chart","description":""},{"path":"/docs/components/polar#event-legendItemClick","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-legendItemClick","title":"sy-radar-chart","description":""},{"path":"/docs/components/dumbbell#event-legendItemClick","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#event-legendItemClick","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/marimekko#event-legendItemClick","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#event-legendItemClick","title":"sy-pareto-chart","description":""},{"path":"/docs/components/gauge#event-legendItemClick","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-legendItemClick","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-legendItemClick","title":"sy-funnel-chart","description":""},{"path":"/docs/components/item#event-legendItemClick","title":"sy-item-chart","description":""}]}]}]},{"path":"/docs/events/seriesToggled","title":"seriesToggled","summary":"CustomEvent.detail type: ChartSeriesToggledEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"seriesToggled","type":"ChartSeriesToggledEventDetail","description":"CustomEvent.detail type: ChartSeriesToggledEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // ChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartSeriesToggledEventDetail","title":"ChartSeriesToggledEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-seriesToggled","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-seriesToggled","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-seriesToggled","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-seriesToggled","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-seriesToggled","title":"sy-scatter-chart","description":""},{"path":"/docs/components/polar#event-seriesToggled","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-seriesToggled","title":"sy-radar-chart","description":""},{"path":"/docs/components/dumbbell#event-seriesToggled","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/dot-plot#event-seriesToggled","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/marimekko#event-seriesToggled","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/pareto#event-seriesToggled","title":"sy-pareto-chart","description":""}]}]}]},{"path":"/docs/events/crosshairMove","title":"crosshairMove","summary":"CustomEvent.detail type: CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail. Event names are case-sensitive.","kind":"events","member":{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | ParallelCoordinatesCrosshairDetail | null | Surface3DCrosshairDetail | Scatter3DCrosshairDetail | ThemeRiverCrosshairDetail | Bar3DCrosshairDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesCrosshairDetail","title":"ParallelCoordinatesCrosshairDetail","description":"Type definition"},{"path":"/docs/types/Surface3DCrosshairDetail","title":"Surface3DCrosshairDetail","description":"Type definition"},{"path":"/docs/types/Scatter3DCrosshairDetail","title":"Scatter3DCrosshairDetail","description":"Type definition"},{"path":"/docs/types/ThemeRiverCrosshairDetail","title":"ThemeRiverCrosshairDetail","description":"Type definition"},{"path":"/docs/types/Bar3DCrosshairDetail","title":"Bar3DCrosshairDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-crosshairMove","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-crosshairMove","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-crosshairMove","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-crosshairMove","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-crosshairMove","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-crosshairMove","title":"sy-bubble-chart","description":""},{"path":"/docs/components/radar#event-crosshairMove","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-crosshairMove","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-crosshairMove","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-crosshairMove","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-crosshairMove","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-crosshairMove","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-crosshairMove","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-crosshairMove","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-crosshairMove","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-crosshairMove","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-crosshairMove","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-crosshairMove","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/heatmap#event-crosshairMove","title":"sy-heatmap","description":""},{"path":"/docs/components/density-map#event-crosshairMove","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-crosshairMove","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#event-crosshairMove","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/theme-river#event-crosshairMove","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-crosshairMove","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-crosshairMove","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-crosshairMove","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-crosshairMove","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-crosshairMove","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-crosshairMove","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-crosshairMove","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-crosshairMove","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/tooltipShow","title":"tooltipShow","summary":"Whether to display the built-in tooltip.","kind":"events","member":{"name":"tooltipShow","type":"CartesianTooltipEventDetail |\n    PieChartTooltipShowEventDetail |\n    GaugeChartTooltipShowEventDetail |\n    RadarChartTooltipShowEventDetail |\n    FunnelChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail |\n    PieChartTooltipShowEventDetail |\n    GaugeChartTooltipShowEventDetail |\n    RadarChartTooltipShowEventDetail |\n    FunnelChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail |\n    PieChartTooltipShowEventDetail |\n    GaugeChartTooltipShowEventDetail |\n    RadarChartTooltipShowEventDetail |\n    FunnelChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"},{"path":"/docs/types/PieChartTooltipShowEventDetail","title":"PieChartTooltipShowEventDetail","description":"Type definition"},{"path":"/docs/types/GaugeChartTooltipShowEventDetail","title":"GaugeChartTooltipShowEventDetail","description":"Type definition"},{"path":"/docs/types/RadarChartTooltipShowEventDetail","title":"RadarChartTooltipShowEventDetail","description":"Type definition"},{"path":"/docs/types/FunnelChartTooltipShowEventDetail","title":"FunnelChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-tooltipShow","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-tooltipShow","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-tooltipShow","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-tooltipShow","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-tooltipShow","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-tooltipShow","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-tooltipShow","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-tooltipShow","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-tooltipShow","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-tooltipShow","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-tooltipShow","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-tooltipShow","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-tooltipShow","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-tooltipShow","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-tooltipShow","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-tooltipShow","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-tooltipShow","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-tooltipShow","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-tooltipShow","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-tooltipShow","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-tooltipShow","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-tooltipShow","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-tooltipShow","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-tooltipShow","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-tooltipShow","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-tooltipShow","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-tooltipShow","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-tooltipShow","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-tooltipShow","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-tooltipShow","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-tooltipShow","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-tooltipShow","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-tooltipShow","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-tooltipShow","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-tooltipShow","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-tooltipShow","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-tooltipShow","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-tooltipShow","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-tooltipShow","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-tooltipShow","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-tooltipShow","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-tooltipShow","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-tooltipShow","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-tooltipShow","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-tooltipShow","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-tooltipShow","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-tooltipShow","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-tooltipShow","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/tooltipHide","title":"tooltipHide","summary":"CustomEvent.detail type: void. Event names are case-sensitive.","kind":"events","member":{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-tooltipHide","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-tooltipHide","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-tooltipHide","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-tooltipHide","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-tooltipHide","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-tooltipHide","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-tooltipHide","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-tooltipHide","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-tooltipHide","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-tooltipHide","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-tooltipHide","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-tooltipHide","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-tooltipHide","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-tooltipHide","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-tooltipHide","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-tooltipHide","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-tooltipHide","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-tooltipHide","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-tooltipHide","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-tooltipHide","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-tooltipHide","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-tooltipHide","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-tooltipHide","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-tooltipHide","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-tooltipHide","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-tooltipHide","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-tooltipHide","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-tooltipHide","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-tooltipHide","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-tooltipHide","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-tooltipHide","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-tooltipHide","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-tooltipHide","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-tooltipHide","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-tooltipHide","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-tooltipHide","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-tooltipHide","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-tooltipHide","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-tooltipHide","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-tooltipHide","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-tooltipHide","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-tooltipHide","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-tooltipHide","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-tooltipHide","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-tooltipHide","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-tooltipHide","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-tooltipHide","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-tooltipHide","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/zoomChange","title":"zoomChange","summary":"re-emitted from the active cartesian family after every zoom change.","kind":"events","member":{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"re-emitted from the active cartesian family after every zoom change."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-zoomChange","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-zoomChange","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-zoomChange","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-zoomChange","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-zoomChange","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-zoomChange","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-zoomChange","title":"sy-polar-chart","description":""},{"path":"/docs/components/waterfall#event-zoomChange","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/histogram#event-zoomChange","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-zoomChange","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-zoomChange","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-zoomChange","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-zoomChange","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-zoomChange","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-zoomChange","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-zoomChange","title":"sy-spectrogram","description":""},{"path":"/docs/components/pictorial#event-zoomChange","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-zoomChange","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-zoomChange","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-zoomChange","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-zoomChange","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-zoomChange","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-zoomChange","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-zoomChange","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-zoomChange","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-zoomChange","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-zoomChange","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-zoomChange","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-zoomChange","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-zoomChange","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-zoomChange","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-zoomChange","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/gantt#event-zoomChange","title":"sy-gantt-chart","description":""},{"path":"/docs/components/wafer-map#event-zoomChange","title":"sy-wafer-map","description":""}]}]}]},{"path":"/docs/events/mapViewChange","title":"mapViewChange","summary":"Geographic camera after a completed globe drag or map-view reset.","kind":"events","member":{"name":"mapViewChange","type":"GeoMapViewChangeEventDetail","description":"Geographic camera after a completed globe drag or map-view reset."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `mapViewChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapViewChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('mapViewChange', event => {\n  console.log(event.detail); // GeoMapViewChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapViewChangeEventDetail","title":"GeoMapViewChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#event-mapViewChange","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-mapViewChange","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/events/mapLayerChange","title":"mapLayerChange","summary":"CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"mapLayerChange","type":"GeoMapLayerChangeEventDetail","description":"CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `mapLayerChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapLayerChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('mapLayerChange', event => {\n  console.log(event.detail); // GeoMapLayerChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerChangeEventDetail","title":"GeoMapLayerChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#event-mapLayerChange","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-mapLayerChange","title":"sy-flow-lines","description":""}]}]}]},{"path":"/docs/events/featureClick","title":"featureClick","summary":"CustomEvent.detail type: GeoMapFeatureHitDetail. Event names are case-sensitive.","kind":"events","member":{"name":"featureClick","type":"GeoMapFeatureHitDetail","description":"CustomEvent.detail type: GeoMapFeatureHitDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `featureClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureHitDetail>`."},{"kind":"code","source":"chart.addEventListener('featureClick', event => {\n  console.log(event.detail); // GeoMapFeatureHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#event-featureClick","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/events/featureHover","title":"featureHover","summary":"CustomEvent.detail type: GeoMapFeatureHitDetail | null. Event names are case-sensitive.","kind":"events","member":{"name":"featureHover","type":"GeoMapFeatureHitDetail | null","description":"CustomEvent.detail type: GeoMapFeatureHitDetail | null. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `featureHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('featureHover', event => {\n  console.log(event.detail); // GeoMapFeatureHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#event-featureHover","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/events/featureSelectionChange","title":"featureSelectionChange","summary":"CustomEvent.detail type: GeoMapFeatureSelectionChangeEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"featureSelectionChange","type":"GeoMapFeatureSelectionChangeEventDetail","description":"CustomEvent.detail type: GeoMapFeatureSelectionChangeEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `featureSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('featureSelectionChange', event => {\n  console.log(event.detail); // GeoMapFeatureSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureSelectionChangeEventDetail","title":"GeoMapFeatureSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/geo-map#event-featureSelectionChange","title":"sy-geo-map","description":""}]}]}]},{"path":"/docs/events/axisBrushChange","title":"axisBrushChange","summary":"CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"axisBrushChange","type":"ParallelCoordinatesBrushChangeEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `axisBrushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushChange', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#event-axisBrushChange","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/events/axisBrushStart","title":"axisBrushStart","summary":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"axisBrushStart","type":"ParallelCoordinatesBrushGestureEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `axisBrushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushGestureEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushStart', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#event-axisBrushStart","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/events/axisBrushMove","title":"axisBrushMove","summary":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"axisBrushMove","type":"ParallelCoordinatesBrushGestureEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `axisBrushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushGestureEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushMove', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#event-axisBrushMove","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/events/axisBrushEnd","title":"axisBrushEnd","summary":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"axisBrushEnd","type":"ParallelCoordinatesBrushGestureEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `axisBrushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushGestureEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushEnd', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/parallel-coordinates#event-axisBrushEnd","title":"sy-parallel-coordinates","description":""}]}]}]},{"path":"/docs/events/brushChange","title":"brushChange","summary":"CustomEvent.detail type: CartesianBrushChangeEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"brushChange","type":"CartesianBrushChangeEventDetail","description":"CustomEvent.detail type: CartesianBrushChangeEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `brushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushChange', event => {\n  console.log(event.detail); // CartesianBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-brushChange","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-brushChange","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-brushChange","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-brushChange","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-brushChange","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/events/actionDispatched","title":"actionDispatched","summary":"every `dispatchAction` call, after it ran (`handled` false for an unknown type).","kind":"events","member":{"name":"actionDispatched","type":"ChartActionEventDetail","description":"every `dispatchAction` call, after it ran (`handled` false for an unknown type)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `actionDispatched`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('actionDispatched', event => {\n  console.log(event.detail); // ChartActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartActionEventDetail","title":"ChartActionEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/renderProgress","title":"renderProgress","summary":"re-emitted from the scatter family: a progressively painted chunk landed (`done` on the last).","kind":"events","member":{"name":"renderProgress","type":"{ drawn: number; total: number; done: boolean }","description":"re-emitted from the scatter family: a progressively painted chunk landed (`done` on the last)."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `renderProgress`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ drawn: number; total: number; done: boolean }>`."},{"kind":"code","source":"chart.addEventListener('renderProgress', event => {\n  console.log(event.detail); // { drawn: number; total: number; done: boolean }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/scatter#event-renderProgress","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/events/brushStart","title":"brushStart","summary":"CustomEvent.detail type: CartesianBrushStartEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"brushStart","type":"CartesianBrushStartEventDetail","description":"CustomEvent.detail type: CartesianBrushStartEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `brushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushStartEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushStart', event => {\n  console.log(event.detail); // CartesianBrushStartEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-brushStart","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-brushStart","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-brushStart","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-brushStart","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-brushStart","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/events/brushMove","title":"brushMove","summary":"CustomEvent.detail type: CartesianBrushMoveEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"brushMove","type":"CartesianBrushMoveEventDetail","description":"CustomEvent.detail type: CartesianBrushMoveEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `brushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushMoveEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushMove', event => {\n  console.log(event.detail); // CartesianBrushMoveEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-brushMove","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-brushMove","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-brushMove","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-brushMove","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-brushMove","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/events/brushEnd","title":"brushEnd","summary":"CustomEvent.detail type: CartesianBrushEndEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"brushEnd","type":"CartesianBrushEndEventDetail","description":"CustomEvent.detail type: CartesianBrushEndEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `brushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushEndEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushEnd', event => {\n  console.log(event.detail); // CartesianBrushEndEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-brushEnd","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-brushEnd","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-brushEnd","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-brushEnd","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-brushEnd","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/events/drawingsChange","title":"drawingsChange","summary":"the drawing document of the active cartesian family changed.","kind":"events","member":{"name":"drawingsChange","type":"DrawingsChangeEventDetail","description":"the drawing document of the active cartesian family changed."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `drawingsChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingsChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingsChange', event => {\n  console.log(event.detail); // DrawingsChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-drawingsChange","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-drawingsChange","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-drawingsChange","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-drawingsChange","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-drawingsChange","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/events/drawingSelectionChange","title":"drawingSelectionChange","summary":"the drawing selection of the active cartesian family changed.","kind":"events","member":{"name":"drawingSelectionChange","type":"DrawingSelectionChangeEventDetail","description":"the drawing selection of the active cartesian family changed."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `drawingSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingSelectionChange', event => {\n  console.log(event.detail); // DrawingSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-drawingSelectionChange","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-drawingSelectionChange","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-drawingSelectionChange","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-drawingSelectionChange","title":"sy-bar-chart","description":""},{"path":"/docs/components/scatter#event-drawingSelectionChange","title":"sy-scatter-chart","description":""}]}]}]},{"path":"/docs/events/tooltipAction","title":"tooltipAction","summary":"CustomEvent.detail type: ChartTooltipActionEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"tooltipAction","type":"ChartTooltipActionEventDetail","description":"CustomEvent.detail type: ChartTooltipActionEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // ChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartTooltipActionEventDetail","title":"ChartTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/line#event-tooltipAction","title":"sy-line-chart","description":""},{"path":"/docs/components/area#event-tooltipAction","title":"sy-area-chart","description":""},{"path":"/docs/components/column#event-tooltipAction","title":"sy-column-chart","description":""},{"path":"/docs/components/bar#event-tooltipAction","title":"sy-bar-chart","description":""},{"path":"/docs/components/pie#event-tooltipAction","title":"sy-pie-chart","description":""},{"path":"/docs/components/scatter#event-tooltipAction","title":"sy-scatter-chart","description":""},{"path":"/docs/components/bubble#event-tooltipAction","title":"sy-bubble-chart","description":""},{"path":"/docs/components/polar#event-tooltipAction","title":"sy-polar-chart","description":""},{"path":"/docs/components/radar#event-tooltipAction","title":"sy-radar-chart","description":""},{"path":"/docs/components/lollipop#event-tooltipAction","title":"sy-lollipop-chart","description":""},{"path":"/docs/components/dumbbell#event-tooltipAction","title":"sy-dumbbell-chart","description":""},{"path":"/docs/components/tornado#event-tooltipAction","title":"sy-tornado-chart","description":""},{"path":"/docs/components/dot-plot#event-tooltipAction","title":"sy-dot-plot-chart","description":""},{"path":"/docs/components/variwide#event-tooltipAction","title":"sy-variwide-chart","description":""},{"path":"/docs/components/marimekko#event-tooltipAction","title":"sy-marimekko-chart","description":""},{"path":"/docs/components/waterfall#event-tooltipAction","title":"sy-waterfall-chart","description":""},{"path":"/docs/components/pareto#event-tooltipAction","title":"sy-pareto-chart","description":""},{"path":"/docs/components/histogram#event-tooltipAction","title":"sy-histogram-chart","description":""},{"path":"/docs/components/box-plot#event-tooltipAction","title":"sy-box-plot-chart","description":""},{"path":"/docs/components/error-bar#event-tooltipAction","title":"sy-error-bar-chart","description":""},{"path":"/docs/components/stem-leaf#event-tooltipAction","title":"sy-stem-leaf-chart","description":""},{"path":"/docs/components/heatmap#event-tooltipAction","title":"sy-heatmap","description":""},{"path":"/docs/components/calendar-heatmap#event-tooltipAction","title":"sy-calendar-heatmap","description":""},{"path":"/docs/components/density-map#event-tooltipAction","title":"sy-density-map","description":""},{"path":"/docs/components/spectrogram#event-tooltipAction","title":"sy-spectrogram","description":""},{"path":"/docs/components/gauge#event-tooltipAction","title":"sy-gauge-chart","description":""},{"path":"/docs/components/funnel#event-tooltipAction","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-tooltipAction","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pictorial#event-tooltipAction","title":"sy-pictorial-chart","description":""},{"path":"/docs/components/item#event-tooltipAction","title":"sy-item-chart","description":""},{"path":"/docs/components/word-cloud#event-tooltipAction","title":"sy-word-cloud","description":""},{"path":"/docs/components/tilemap#event-tooltipAction","title":"sy-tilemap","description":""},{"path":"/docs/components/treemap#event-tooltipAction","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-tooltipAction","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-tooltipAction","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-tooltipAction","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-tooltipAction","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-tooltipAction","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-tooltipAction","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-tooltipAction","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-tooltipAction","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-tooltipAction","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-tooltipAction","title":"sy-flow-lines","description":""},{"path":"/docs/components/candlestick#event-tooltipAction","title":"sy-candlestick-chart","description":""},{"path":"/docs/components/surface-3d#event-tooltipAction","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-tooltipAction","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-tooltipAction","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-tooltipAction","title":"sy-gantt-chart","description":""}]}]}]},{"path":"/docs/events/sliceClick","title":"sliceClick","summary":"CustomEvent.detail type: PieChartSliceEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"sliceClick","type":"PieChartSliceEventDetail","description":"CustomEvent.detail type: PieChartSliceEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `sliceClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartSliceEventDetail>`."},{"kind":"code","source":"chart.addEventListener('sliceClick', event => {\n  console.log(event.detail); // PieChartSliceEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#event-sliceClick","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/events/sliceHover","title":"sliceHover","summary":"CustomEvent.detail type: PieChartSliceEventDetail | null. Event names are case-sensitive.","kind":"events","member":{"name":"sliceHover","type":"PieChartSliceEventDetail | null","description":"CustomEvent.detail type: PieChartSliceEventDetail | null. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `sliceHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartSliceEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('sliceHover', event => {\n  console.log(event.detail); // PieChartSliceEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#event-sliceHover","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/events/sliceSelected","title":"sliceSelected","summary":"CustomEvent.detail type: PieChartSelectedEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"sliceSelected","type":"PieChartSelectedEventDetail","description":"CustomEvent.detail type: PieChartSelectedEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `sliceSelected`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartSelectedEventDetail>`."},{"kind":"code","source":"chart.addEventListener('sliceSelected', event => {\n  console.log(event.detail); // PieChartSelectedEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartSelectedEventDetail","title":"PieChartSelectedEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#event-sliceSelected","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/events/sliceToggled","title":"sliceToggled","summary":"CustomEvent.detail type: { index: number; sliceId: string; disabled: boolean }. Event names are case-sensitive.","kind":"events","member":{"name":"sliceToggled","type":"{ index: number; sliceId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sliceId: string; disabled: boolean }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `sliceToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sliceId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('sliceToggled', event => {\n  console.log(event.detail); // { index: number; sliceId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/pie#event-sliceToggled","title":"sy-pie-chart","description":""}]}]}]},{"path":"/docs/events/selectionChanged","title":"selectionChanged","summary":"CustomEvent.detail type: SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"selectionChanged","type":"SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail","description":"CustomEvent.detail type: SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // SankeySelectionChangeEventDetail | ChordSelectionChangeEventDetail | NetworkGraphSelectionChangeEventDetail | TreemapSelectionChangeEventDetail | SunburstSelectionChangeEventDetail | IcicleSelectionChangeEventDetail | GanttSelectionChangeEventDetail | ParallelCoordinatesSelectionChangeEventDetail | DendrogramSelectionChangeEventDetail | GeoMapSelectionChangeEventDetail | Surface3DSelectionChangeEventDetail | Scatter3DSelectionChangeEventDetail | FlowLinesSelectionChangeEventDetail | ThemeRiverSelectionChangeEventDetail | Bar3DSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SankeySelectionChangeEventDetail","title":"SankeySelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChordSelectionChangeEventDetail","title":"ChordSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/NetworkGraphSelectionChangeEventDetail","title":"NetworkGraphSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/TreemapSelectionChangeEventDetail","title":"TreemapSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/SunburstSelectionChangeEventDetail","title":"SunburstSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/IcicleSelectionChangeEventDetail","title":"IcicleSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/GanttSelectionChangeEventDetail","title":"GanttSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesSelectionChangeEventDetail","title":"ParallelCoordinatesSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/DendrogramSelectionChangeEventDetail","title":"DendrogramSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/GeoMapSelectionChangeEventDetail","title":"GeoMapSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/Surface3DSelectionChangeEventDetail","title":"Surface3DSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/Scatter3DSelectionChangeEventDetail","title":"Scatter3DSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/FlowLinesSelectionChangeEventDetail","title":"FlowLinesSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ThemeRiverSelectionChangeEventDetail","title":"ThemeRiverSelectionChangeEventDetail","description":"Type definition"},{"path":"/docs/types/Bar3DSelectionChangeEventDetail","title":"Bar3DSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#event-selectionChanged","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-selectionChanged","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-selectionChanged","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-selectionChanged","title":"sy-dendrogram","description":""},{"path":"/docs/components/sankey#event-selectionChanged","title":"sy-sankey","description":""},{"path":"/docs/components/chord#event-selectionChanged","title":"sy-chord","description":""},{"path":"/docs/components/network-graph#event-selectionChanged","title":"sy-network-graph","description":""},{"path":"/docs/components/theme-river#event-selectionChanged","title":"sy-theme-river","description":""},{"path":"/docs/components/parallel-coordinates#event-selectionChanged","title":"sy-parallel-coordinates","description":""},{"path":"/docs/components/geo-map#event-selectionChanged","title":"sy-geo-map","description":""},{"path":"/docs/components/flow-lines#event-selectionChanged","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#event-selectionChanged","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-selectionChanged","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-selectionChanged","title":"sy-scatter-3d","description":""},{"path":"/docs/components/gantt#event-selectionChanged","title":"sy-gantt-chart","description":""},{"path":"/docs/components/visual-map#event-selectionChanged","title":"sy-visual-map","description":""}]}]}]},{"path":"/docs/events/drillChange","title":"drillChange","summary":"Treemap branch navigation through pointer, keyboard, methods or data reconciliation.","kind":"events","member":{"name":"drillChange","type":"TreemapDrillChangeEventDetail | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail","description":"Treemap branch navigation through pointer, keyboard, methods or data reconciliation."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `drillChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapDrillChangeEventDetail | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drillChange', event => {\n  console.log(event.detail); // TreemapDrillChangeEventDetail | SunburstDrillChangeEventDetail | IcicleDrillChangeEventDetail | DendrogramDrillChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"},{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/treemap#event-drillChange","title":"sy-treemap","description":""},{"path":"/docs/components/sunburst#event-drillChange","title":"sy-sunburst","description":""},{"path":"/docs/components/icicle#event-drillChange","title":"sy-icicle","description":""},{"path":"/docs/components/dendrogram#event-drillChange","title":"sy-dendrogram","description":""}]}]}]},{"path":"/docs/events/gaugeClick","title":"gaugeClick","summary":"CustomEvent.detail type: GaugeChartPointerEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"gaugeClick","type":"GaugeChartPointerEventDetail","description":"CustomEvent.detail type: GaugeChartPointerEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `gaugeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GaugeChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('gaugeClick', event => {\n  console.log(event.detail); // GaugeChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#event-gaugeClick","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/events/gaugeHover","title":"gaugeHover","summary":"CustomEvent.detail type: GaugeChartPointerEventDetail | null. Event names are case-sensitive.","kind":"events","member":{"name":"gaugeHover","type":"GaugeChartPointerEventDetail | null","description":"CustomEvent.detail type: GaugeChartPointerEventDetail | null. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `gaugeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GaugeChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('gaugeHover', event => {\n  console.log(event.detail); // GaugeChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#event-gaugeHover","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/events/valueChange","title":"valueChange","summary":"CustomEvent.detail type: { value: number; fraction: number }. Event names are case-sensitive.","kind":"events","member":{"name":"valueChange","type":"{ value: number; fraction: number }","description":"CustomEvent.detail type: { value: number; fraction: number }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `valueChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ value: number; fraction: number }>`."},{"kind":"code","source":"chart.addEventListener('valueChange', event => {\n  console.log(event.detail); // { value: number; fraction: number }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#event-valueChange","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/events/needleToggled","title":"needleToggled","summary":"CustomEvent.detail type: { index: number; needleId: string; disabled: boolean }. Event names are case-sensitive.","kind":"events","member":{"name":"needleToggled","type":"{ index: number; needleId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; needleId: string; disabled: boolean }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `needleToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; needleId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('needleToggled', event => {\n  console.log(event.detail); // { index: number; needleId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/gauge#event-needleToggled","title":"sy-gauge-chart","description":""}]}]}]},{"path":"/docs/events/sectionClick","title":"sectionClick","summary":"CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"sectionClick","type":"FunnelChartPointerEventDetail","description":"CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `sectionClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('sectionClick', event => {\n  console.log(event.detail); // FunnelChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/funnel#event-sectionClick","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-sectionClick","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/events/sectionHover","title":"sectionHover","summary":"CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive.","kind":"events","member":{"name":"sectionHover","type":"FunnelChartPointerEventDetail | null","description":"CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `sectionHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('sectionHover', event => {\n  console.log(event.detail); // FunnelChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/funnel#event-sectionHover","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-sectionHover","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/events/sectionToggled","title":"sectionToggled","summary":"CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive.","kind":"events","member":{"name":"sectionToggled","type":"{ index: number; sectionId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `sectionToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sectionId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('sectionToggled', event => {\n  console.log(event.detail); // { index: number; sectionId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/funnel#event-sectionToggled","title":"sy-funnel-chart","description":""},{"path":"/docs/components/pyramid#event-sectionToggled","title":"sy-funnel-chart","description":""}]}]}]},{"path":"/docs/events/cameraChange","title":"cameraChange","summary":"CustomEvent.detail type: Surface3DCameraChangeEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"cameraChange","type":"Surface3DCameraChangeEventDetail","description":"CustomEvent.detail type: Surface3DCameraChangeEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `cameraChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Surface3DCameraChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('cameraChange', event => {\n  console.log(event.detail); // Surface3DCameraChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Surface3DCameraChangeEventDetail","title":"Surface3DCameraChangeEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/surface-3d#event-cameraChange","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-cameraChange","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-cameraChange","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/events/dataValidationError","title":"dataValidationError","summary":"CustomEvent.detail type: ChartDataValidationErrorDetail. Event names are case-sensitive.","kind":"events","member":{"name":"dataValidationError","type":"ChartDataValidationErrorDetail","description":"CustomEvent.detail type: ChartDataValidationErrorDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartDataValidationErrorDetail>`."},{"kind":"code","source":"chart.addEventListener('dataValidationError', event => {\n  console.log(event.detail); // ChartDataValidationErrorDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartDataValidationErrorDetail","title":"ChartDataValidationErrorDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/theme-river#event-dataValidationError","title":"sy-theme-river","description":""},{"path":"/docs/components/flow-lines#event-dataValidationError","title":"sy-flow-lines","description":""},{"path":"/docs/components/surface-3d#event-dataValidationError","title":"sy-surface-3d","description":""},{"path":"/docs/components/bar-3d#event-dataValidationError","title":"sy-bar-3d","description":""},{"path":"/docs/components/scatter-3d#event-dataValidationError","title":"sy-scatter-3d","description":""}]}]}]},{"path":"/docs/events/contextMenuOpened","title":"contextMenuOpened","summary":"CustomEvent.detail type: ChartContextMenuEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"contextMenuOpened","type":"ChartContextMenuEventDetail","description":"CustomEvent.detail type: ChartContextMenuEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `contextMenuOpened`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartContextMenuEventDetail>`."},{"kind":"code","source":"chart.addEventListener('contextMenuOpened', event => {\n  console.log(event.detail); // ChartContextMenuEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartContextMenuEventDetail","title":"ChartContextMenuEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/contextMenuClosed","title":"contextMenuClosed","summary":"CustomEvent.detail type: void. Event names are case-sensitive.","kind":"events","member":{"name":"contextMenuClosed","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `contextMenuClosed`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('contextMenuClosed', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/contextMenuItemSelect","title":"contextMenuItemSelect","summary":"CustomEvent.detail type: ChartContextMenuItemEventDetail. Event names are case-sensitive.","kind":"events","member":{"name":"contextMenuItemSelect","type":"ChartContextMenuItemEventDetail","description":"CustomEvent.detail type: ChartContextMenuItemEventDetail. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `contextMenuItemSelect`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartContextMenuItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('contextMenuItemSelect', event => {\n  console.log(event.detail); // ChartContextMenuItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartContextMenuItemEventDetail","title":"ChartContextMenuItemEventDetail","description":"Type definition"}]}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/events/exported","title":"exported","summary":"CustomEvent.detail type: { format: 'png' | 'svg' | 'csv' | 'json'; filename: string }. Event names are case-sensitive.","kind":"events","member":{"name":"exported","type":"{ format: 'png' | 'svg' | 'csv' | 'json'; filename: string }","description":"CustomEvent.detail type: { format: 'png' | 'svg' | 'csv' | 'json'; filename: string }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `exported`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ format: 'png' | 'svg' | 'csv' | 'json'; filename: string }>`."},{"kind":"code","source":"chart.addEventListener('exported', event => {\n  console.log(event.detail); // { format: 'png' | 'svg' | 'csv' | 'json'; filename: string }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[{"path":"/docs/components/stock-chart#event-exported","title":"sy-stock-chart","description":""}]}]}]},{"path":"/docs/events/dataTableToggled","title":"dataTableToggled","summary":"CustomEvent.detail type: { open: boolean }. Event names are case-sensitive.","kind":"events","member":{"name":"dataTableToggled","type":"{ open: boolean }","description":"CustomEvent.detail type: { open: boolean }. Event names are case-sensitive."},"sections":[{"id":"definition","title":"Definition","blocks":[{"kind":"paragraph","text":"Event name: `dataTableToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ open: boolean }>`."},{"kind":"code","source":"chart.addEventListener('dataTableToggled', event => {\n  console.log(event.detail); // { open: boolean }\n});","language":"javascript"}]},{"id":"related","title":"Related charts","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/components","title":"API by chart type","summary":"Choose a chart to inspect the direct tag's input data and API.","kind":"components","sections":[{"id":"charts","title":"Charts and companion components","blocks":[{"kind":"links","items":[{"path":"/docs/components/line","title":"Line","description":"sy-line-chart · Read changes over time as lines."},{"path":"/docs/components/area","title":"Area","description":"sy-area-chart · Show trends and magnitude with filled areas."},{"path":"/docs/components/column","title":"Column","description":"sy-column-chart · Compare category values with vertical bars."},{"path":"/docs/components/bar","title":"Bar","description":"sy-bar-chart · Compare category values with horizontal bars."},{"path":"/docs/components/pie","title":"Pie","description":"sy-pie-chart · Show the proportions that make up a whole."},{"path":"/docs/components/scatter","title":"Scatter","description":"sy-scatter-chart · Show relationships between two continuous variables as individual points."},{"path":"/docs/components/bubble","title":"Bubble","description":"sy-bubble-chart · Read three measures through point position and size."},{"path":"/docs/components/polar","title":"Polar","description":"sy-polar-chart · Arrange directions or cycles in polar coordinates."},{"path":"/docs/components/radar","title":"Radar","description":"sy-radar-chart · Compare multiple metrics in a single outline."},{"path":"/docs/components/lollipop","title":"Lollipop","description":"sy-lollipop-chart · Compare category values with simple dots and stems."},{"path":"/docs/components/dumbbell","title":"Dumbbell","description":"sy-dumbbell-chart · Connect two measurements to show their difference."},{"path":"/docs/components/tornado","title":"Tornado","description":"sy-tornado-chart · Compare two groups on opposite sides of a center line."},{"path":"/docs/components/dot-plot","title":"Dot Plot","description":"sy-dot-plot-chart · Compare multiple measurements per category using dots."},{"path":"/docs/components/variwide","title":"Variwide","description":"sy-variwide-chart · Show two measures through bar height and width."},{"path":"/docs/components/marimekko","title":"Marimekko","description":"sy-marimekko-chart · Show group size and internal proportions together."},{"path":"/docs/components/waterfall","title":"Waterfall","description":"sy-waterfall-chart · Show how increases and decreases accumulate into a final value."},{"path":"/docs/components/pareto","title":"Pareto","description":"sy-pareto-chart · Identify major causes using counts and cumulative percentages."},{"path":"/docs/components/histogram","title":"Histogram","description":"sy-histogram-chart · Summarize continuous measurements as interval frequencies."},{"path":"/docs/components/box-plot","title":"Box Plot","description":"sy-box-plot-chart · Summarize the median and spread with boxes and whiskers."},{"path":"/docs/components/error-bar","title":"Error Bar","description":"sy-error-bar-chart · Show uncertainty or a range around a central value."},{"path":"/docs/components/stem-leaf","title":"Stem Leaf","description":"sy-stem-leaf-chart · Read a distribution while retaining raw values."},{"path":"/docs/components/heatmap","title":"Heatmap","description":"sy-heatmap · Encode values at two coordinates using color."},{"path":"/docs/components/calendar-heatmap","title":"Calendar Heatmap","description":"sy-calendar-heatmap · Show daily activity as colors on a calendar."},{"path":"/docs/components/density-map","title":"Density Map","description":"sy-density-map · Show concentrations of observations as a smooth density surface."},{"path":"/docs/components/spectrogram","title":"Spectrogram","description":"sy-spectrogram · Show frequency intensity over time using color."},{"path":"/docs/components/gauge","title":"Gauge","description":"sy-gauge-chart · Read a metric's current state within a defined range."},{"path":"/docs/components/funnel","title":"Funnel","description":"sy-funnel-chart · Show the quantity remaining through successive stages."},{"path":"/docs/components/pyramid","title":"Pyramid","description":"sy-funnel-chart · Represent stage sizes as a pyramid."},{"path":"/docs/components/pictorial","title":"Pictorial","description":"sy-pictorial-chart · Express state through the filled portion of a familiar shape."},{"path":"/docs/components/item","title":"Item","description":"sy-item-chart · Show counts with repeated symbols."},{"path":"/docs/components/word-cloud","title":"Word Cloud","description":"sy-word-cloud · Represent word weights through text size."},{"path":"/docs/components/tilemap","title":"Tilemap","description":"sy-tilemap · Compare locations and values using equally sized tiles."},{"path":"/docs/components/treemap","title":"Treemap","description":"sy-treemap · Represent hierarchical sizes as rectangle areas."},{"path":"/docs/components/sunburst","title":"Sunburst","description":"sy-sunburst · Represent hierarchy depth and proportions with concentric rings."},{"path":"/docs/components/icicle","title":"Icicle","description":"sy-icicle · Show hierarchy depth as aligned bands."},{"path":"/docs/components/dendrogram","title":"Dendrogram","description":"sy-dendrogram · Show parent-child connections as a tree."},{"path":"/docs/components/sankey","title":"Sankey","description":"sy-sankey · Represent quantities moving between nodes through link widths."},{"path":"/docs/components/chord","title":"Chord","description":"sy-chord · Show connection volumes between groups as ribbons inside a circle."},{"path":"/docs/components/network-graph","title":"Network Graph","description":"sy-network-graph · Explore entities and their connections as a network."},{"path":"/docs/components/theme-river","title":"Theme River","description":"sy-theme-river · Stack multiple flows as they change over time."},{"path":"/docs/components/parallel-coordinates","title":"Parallel Coordinates","description":"sy-parallel-coordinates · Connect an observation's multiple metrics with one line."},{"path":"/docs/components/geo-map","title":"Geo Map","description":"sy-geo-map · Show geographic locations and magnitudes on a map."},{"path":"/docs/components/flow-lines","title":"Flow Lines","description":"sy-flow-lines · Connect movement between locations on a map."},{"path":"/docs/components/candlestick","title":"Candlestick","description":"sy-candlestick-chart · Show four prices per period in a candlestick."},{"path":"/docs/components/ohlc","title":"Ohlc","description":"sy-ohlc-chart · Read four prices from a high-low line and open-close ticks."},{"path":"/docs/components/stock-chart","title":"Stock Chart","description":"sy-stock-chart · Combine price history with financial exploration controls."},{"path":"/docs/components/stock-volume","title":"Stock Volume","description":"sy-stock-volume · Show volume on the same time axis as prices."},{"path":"/docs/components/stock-flags","title":"Stock Flags","description":"sy-stock-flags · Attach events at time positions in price data."},{"path":"/docs/components/surface-3d","title":"Surface 3d","description":"sy-surface-3d · Show gridded measurements as a continuous 3D surface."},{"path":"/docs/components/bar-3d","title":"Bar 3d","description":"sy-bar-3d · Represent combinations of two categories with bars of varying height."},{"path":"/docs/components/scatter-3d","title":"Scatter 3d","description":"sy-scatter-3d · Show three continuous measurements as points in space."},{"path":"/docs/components/gantt","title":"Gantt","description":"sy-gantt-chart · Arrange task durations and progress on a timeline."},{"path":"/docs/components/wafer-map","title":"Wafer Map","description":"sy-wafer-map · Show status and measurements at die coordinates on a wafer."},{"path":"/docs/components/wafer-stack","title":"Wafer Stack","description":"sy-wafer-stack · Aggregate multiple wafers at matching coordinates."},{"path":"/docs/components/wafer-correlation","title":"Wafer Correlation","description":"sy-wafer-correlation · Compare spatial patterns between two wafer sets."},{"path":"/docs/components/yield-zone-chart","title":"Yield Zone Chart","description":"sy-yield-zone-chart · Summarize yield by zones from the center to the edge."},{"path":"/docs/components/data-zoom","title":"Data Zoom","description":"sy-data-zoom · Change a target chart's visible range with a slider."},{"path":"/docs/components/navigator","title":"Navigator","description":"sy-navigator · Select a range over a condensed view of the full dataset."},{"path":"/docs/components/visual-map","title":"Visual Map","description":"sy-visual-map · Control value-based colors, sizes, and the selected range."}]}]}]},{"path":"/docs/components/line","title":"Line","summary":"Read changes over time as lines.","kind":"component","tag":"sy-line-chart","componentId":"line","api":{"props":[{"name":"series","attribute":"series","type":"LineChartSeries[]","kind":"property","values":[],"default":"undefined","description":"An array of series with names, colors, and values. Matching indices represent the same point in time."},{"name":"activeSeriesIndex","attribute":"active-series-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesState","attribute":"series-state","type":"LineChartSeriesStateOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LineChartSeriesStateOptions."},{"name":"values","attribute":"values","type":"LineChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"600","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"300","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"thickness","attribute":"thickness","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"marker","attribute":"marker","type":"LineChartMarker","kind":"string","values":["none","circle","square","triangle","cross","diamond","star"],"default":"'none'","description":"Allowed values: none, circle, square, triangle, cross, diamond, star. Default: 'none'."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"4","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"markerFilter","attribute":"marker-filter","type":"LineChartMarkerFilter","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LineChartMarkerFilter."},{"name":"markerClickable","attribute":"marker-clickable","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"markerActiveTrigger","attribute":"marker-active-trigger","type":"LineChartMarkerActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"'hover'","description":"Allowed values: hover, click, custom. Default: 'hover'."},{"name":"seriesActiveTrigger","attribute":"series-active-trigger","type":"LineChartMarkerActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"undefined","description":"Allowed values: hover, click, custom. Default: undefined."},{"name":"lineDash","attribute":"line-dash","type":"number[]","kind":"property","values":[],"default":"[]","description":"Pass as a JavaScript property. type: number[]."},{"name":"connectNulls","attribute":"connect-nulls","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"smooth","attribute":"smooth","type":"LineChartSmooth","kind":"string","values":["none","monotone","cardinal"],"default":"'none'","description":"Allowed values: none, monotone, cardinal. Default: 'none'."},{"name":"smoothTension","attribute":"smooth-tension","type":"number","kind":"number","values":[],"default":"0.5","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"step","attribute":"step","type":"LineChartStep","kind":"string","values":["none","left","right","center"],"default":"'none'","description":"Allowed values: none, left, right, center. Default: 'none'."},{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Reference value on the y-axis. Lines do not grow from the baseline, but the baseline remains visible as a value-axis tick and marker so threshold comparisons stay explicit across all cartesian chart families."},{"name":"engine","attribute":"engine","type":"LineChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"100_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"LineChartUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"LineChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"frameBudget","attribute":"frame-budget","type":"number","kind":"number","values":[],"default":"undefined","description":"milliseconds a drawn frame may take before the next scheduled frame is skipped (its appends land in the frame after). Default 16; 0 disables skipping (frames are still measured)."},{"name":"streamWindowMs","attribute":"stream-window-ms","type":"number","kind":"number","values":[],"default":"undefined","description":"an absolute time window: only points stamped within the last N ms are visible; it slides as points expire (a timed re-arm, not a frame loop) and overrides `stream-window` while set."},{"name":"streamTimestamps","attribute":"stream-timestamps","type":"'on' | 'off'","kind":"string","values":["off","on"],"default":"undefined","description":"(carry-over A1) — whether the internal ring stamps every point (a Float64 per slot: 8 MB at a 1M capacity). `on` (default) keeps the stamps an absolute `stream-window-ms` resolves through; `off` is the opt-out for charts that only ever use a count window (an absolute window then has nothing to resolve and falls back to `stream-window`)."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"200","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"LineChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"LineChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"LineChartLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"seriesName","attribute":"series-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"Allowed values: start, center, end. Default: 'end'."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"Allowed values: top, bottom, middle. Default: 'top'."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Match category axis categories to the values order."},{"name":"yAxis","attribute":"y-axis","type":"CartesianYAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Use consistent units and ranges for values being compared."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"name":"brush","attribute":"brush","type":"CartesianBrushInput","kind":"property","values":["auto","off","true","false","rect","lasso"],"default":"undefined","description":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"name":"drawings","attribute":"drawings","type":"ChartDrawingsInput","kind":"property","values":[],"default":"undefined","description":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"name":"drawingMode","attribute":"drawing-mode","type":"DrawingModeInput","kind":"property","values":["none","off","true","false","draw","select"],"default":"undefined","description":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"name":"drawingTool","attribute":"drawing-tool","type":"string","kind":"string","values":[],"default":"undefined","description":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"name":"drawingSpace","attribute":"drawing-space","type":"DrawingSpace","kind":"string","values":["data","pixel"],"default":"undefined","description":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."}],"methods":[{"name":"appendPoint","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<LineChartStreamSource | undefined>","description":"The stream session's source (a Chart Pro feature): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: LineChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"showTooltipAtPoint","parameters":[{"name":"pointIndex","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"showCrosshairAt","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDrawings","parameters":[],"returns":"Promise<ChartDrawing[]>","description":"the drawings of the document (data-space anchors)."},{"name":"setDrawings","parameters":[{"name":"drawings","type":"ReadonlyArray<ChartDrawingInput> | null","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"name":"addDrawing","parameters":[{"name":"drawing","type":"ChartDrawingInput","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"name":"updateDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"patch","type":"Partial<Omit<ChartDrawing, 'id'>>","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"name":"removeDrawing","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"remove one drawing."},{"name":"removeDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string>","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"name":"setDrawingSpace","parameters":[{"name":"id","type":"string","optional":false},{"name":"space","type":"DrawingSpace","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"name":"clearDrawings","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"clear the document (undoable)."},{"name":"undoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"undo the last document change; null when there is nothing to undo."},{"name":"redoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"redo the last undone change; null when there is nothing to redo."},{"name":"getDrawingLayer","parameters":[],"returns":"Promise<DrawingLayerSnapshot | null>","description":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"name":"exportDrawings","parameters":[],"returns":"Promise<string>","description":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"name":"importDrawings","parameters":[{"name":"input","type":"ChartDrawingsInput","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"name":"selectDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string> | null","optional":false}],"returns":"Promise<DrawingSelectionChangeEventDetail | null>","description":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"name":"getDrawingSelection","parameters":[],"returns":"Promise<string[]>","description":"the selected drawing ids."},{"name":"setBrush","parameters":[{"name":"areas","type":"ReadonlyArray<CartesianBrushAreaInput> | null","optional":false}],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"name":"clearBrush","parameters":[],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"clear the brush areas (`brushChange` with source 'clear')."},{"name":"getBrush","parameters":[],"returns":"Promise<CartesianBrushArea[]>","description":"the persisted brush areas (primary data space)."},{"name":"getBrushSelection","parameters":[],"returns":"Promise<CartesianBrushSelectedSeries[]>","description":"the points inside the brush areas, against the current layout."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"name":"hitTestMarker","parameters":[{"name":"clientX","type":"number","optional":false},{"name":"clientY","type":"number","optional":false}],"returns":"Promise<LineChartPointEventDetail | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTestMarkers","parameters":[{"name":"clientX","type":"number","optional":false},{"name":"clientY","type":"number","optional":false}],"returns":"Promise<LineChartPointEventDetail[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"redraw","parameters":[],"returns":"Promise<LineChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<LineChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addSeries","parameters":[{"name":"options","type":"LineChartSeries","optional":false},{"name":"opts","type":"{ redraw?: boolean; insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<LineChartSeries>","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setSeriesData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"data","type":"LineChartValues","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addPoint","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"point","type":"number","optional":false},{"name":"opts","type":"{ shift?: boolean; redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rendered","type":"LineChartRenderResult & { tier: LineChartEngineTier; budget?: LineChartFrameBudgetInfo; stream?: LineChartStreamFrameInfo }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"frameBudgetReport","type":"LineChartFrameBudgetEventDetail","description":"a scheduled frame was skipped (the previous one overran the budget, or the GPU is behind), or a drawn frame overran."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"pointHover","type":"LineChartPointEventDetail | null","description":"CustomEvent.detail type: LineChartPointEventDetail | null. Event names are case-sensitive."},{"name":"pointClick","type":"LineChartPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<LineChartPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<LineChartPointEventDetail>. Event names are case-sensitive."},{"name":"seriesClick","type":"{ cssX: number; cssY: number }","description":"CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"LineChartLegendItemEventDetail","description":"CustomEvent.detail type: LineChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"LineChartSeriesToggledEventDetail","description":"CustomEvent.detail type: LineChartSeriesToggledEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"name":"brushChange","type":"CartesianBrushChangeEventDetail","description":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"name":"brushStart","type":"CartesianBrushStartEventDetail","description":"a brush drag opened up (once per gesture)."},{"name":"brushMove","type":"CartesianBrushMoveEventDetail","description":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"name":"brushEnd","type":"CartesianBrushEndEventDetail","description":"the drag released (after `brushChange`), or was cancelled."},{"name":"drawingsChange","type":"DrawingsChangeEventDetail","description":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"name":"drawingSelectionChange","type":"DrawingSelectionChangeEventDetail","description":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."}]},"sections":[{"id":"overview","title":"sy-line-chart","blocks":[{"kind":"paragraph","text":"Compare trends and differences between series with dates or an ordered sequence."},{"kind":"paragraph","text":"Use Column or Bar to compare unrelated categories. Distinguish interpolated curves from actual measurements."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`series`","An array of series with names, colors, and values. Matching indices represent the same point in time."],["`xAxis`","Match category axis categories to the values order."],["`yAxis`","Use consistent units and ranges for values being compared."]]},{"kind":"links","items":[{"path":"/charts/line","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-line-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-line-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"series\": [\n          {\n            \"name\": \"Organic\",\n            \"color\": \"#8263d9\",\n            \"values\": [24, 29, 27, 38, 43, 40, 52, 58, 53, 68, 76, 84]\n          },\n          {\n            \"name\": \"Direct\",\n            \"color\": \"#239c91\",\n            \"values\": [15, 19, 17, 24, 22, 29, 32, 30, 39, 42, 40, 51]\n          },\n          {\n            \"name\": \"Referral\",\n            \"color\": \"#e99954\",\n            \"values\": [8, 11, 9, 15, 13, 19, 17, 23, 22, 28, 25, 33]\n          }\n        ],\n        \"xAxis\": {\n          \"kind\": \"category\",\n          \"categories\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"]\n        },\n        \"yAxis\": {\n          \"kind\": \"linear\",\n          \"min\": 0\n        },\n        \"smooth\": \"none\",\n        \"thickness\": 2.5,\n        \"marker\": \"circle\",\n        \"markerSize\": 4,\n        \"legend\": true,\n        \"tooltip\": {\n          \"show\": true,\n          \"mode\": \"shared\"\n        },\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'line example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-series","title":"series","blocks":[{"kind":"paragraph","text":"An array of series with names, colors, and values. Matching indices represent the same point in time."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartSeries[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","description":"Type definition"}]}]},{"id":"property-activeSeriesIndex","title":"activeSeriesIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSeriesIndex`"],["HTML attribute","`active-series-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-seriesState","title":"seriesState","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LineChartSeriesStateOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesState`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartSeriesStateOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeriesStateOptions","title":"LineChartSeriesStateOptions","description":"Type definition"}]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartValues","title":"LineChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-thickness","title":"thickness","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`thickness`"],["HTML attribute","`thickness`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"Allowed values: none, circle, square, triangle, cross, diamond, star. Default: 'none'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","`marker`"],["Type","`LineChartMarker`"],["Default","`'none'`"],["Allowed values","`none`, `circle`, `square`, `triangle`, `cross`, `diamond`, `star`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartMarker","title":"LineChartMarker","description":"Type definition"}]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"property-markerFilter","title":"markerFilter","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LineChartMarkerFilter."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerFilter`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartMarkerFilter`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartMarkerFilter","title":"LineChartMarkerFilter","description":"Type definition"}]}]},{"id":"property-markerClickable","title":"markerClickable","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerClickable`"],["HTML attribute","`marker-clickable`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-markerActiveTrigger","title":"markerActiveTrigger","blocks":[{"kind":"paragraph","text":"Allowed values: hover, click, custom. Default: 'hover'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerActiveTrigger`"],["HTML attribute","`marker-active-trigger`"],["Type","`LineChartMarkerActiveTrigger`"],["Default","`'hover'`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartMarkerActiveTrigger","title":"LineChartMarkerActiveTrigger","description":"Type definition"}]}]},{"id":"property-seriesActiveTrigger","title":"seriesActiveTrigger","blocks":[{"kind":"paragraph","text":"Allowed values: hover, click, custom. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesActiveTrigger`"],["HTML attribute","`series-active-trigger`"],["Type","`LineChartMarkerActiveTrigger`"],["Default","`undefined`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartMarkerActiveTrigger","title":"LineChartMarkerActiveTrigger","description":"Type definition"}]}]},{"id":"property-lineDash","title":"lineDash","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineDash`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number[]`"],["Default","`[]`"]]}]},{"id":"property-connectNulls","title":"connectNulls","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectNulls`"],["HTML attribute","`connect-nulls`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-smooth","title":"smooth","blocks":[{"kind":"paragraph","text":"Allowed values: none, monotone, cardinal. Default: 'none'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`smooth`"],["HTML attribute","`smooth`"],["Type","`LineChartSmooth`"],["Default","`'none'`"],["Allowed values","`none`, `monotone`, `cardinal`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartSmooth","title":"LineChartSmooth","description":"Type definition"}]}]},{"id":"property-smoothTension","title":"smoothTension","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`smoothTension`"],["HTML attribute","`smooth-tension`"],["Type","`number`"],["Default","`0.5`"]]}]},{"id":"property-step","title":"step","blocks":[{"kind":"paragraph","text":"Allowed values: none, left, right, center. Default: 'none'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`step`"],["HTML attribute","`step`"],["Type","`LineChartStep`"],["Default","`'none'`"],["Allowed values","`none`, `left`, `right`, `center`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartStep","title":"LineChartStep","description":"Type definition"}]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Reference value on the y-axis. Lines do not grow from the baseline, but the baseline remains visible as a value-axis tick and marker so threshold comparisons stay explicit across all cartesian chart families."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`LineChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartEngineMode","title":"LineChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`100_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`LineChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartUnavailableBehaviour","title":"LineChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartStreamSource","title":"LineChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-frameBudget","title":"frameBudget","blocks":[{"kind":"paragraph","text":"milliseconds a drawn frame may take before the next scheduled frame is skipped (its appends land in the frame after). Default 16; 0 disables skipping (frames are still measured)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`frameBudget`"],["HTML attribute","`frame-budget`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindowMs","title":"streamWindowMs","blocks":[{"kind":"paragraph","text":"an absolute time window: only points stamped within the last N ms are visible; it slides as points expire (a timed re-arm, not a frame loop) and overrides `stream-window` while set."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindowMs`"],["HTML attribute","`stream-window-ms`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamTimestamps","title":"streamTimestamps","blocks":[{"kind":"paragraph","text":"(carry-over A1) — whether the internal ring stamps every point (a Float64 per slot: 8 MB at a 1M capacity). `on` (default) keeps the stamps an absolute `stream-window-ms` resolves through; `off` is the opt-out for charts that only ever use a count window (an absolute window then has nothing to resolve and falls back to `stream-window`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamTimestamps`"],["HTML attribute","`stream-timestamps`"],["Type","`'on' | 'off'`"],["Default","`undefined`"],["Allowed values","`off`, `on`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`200`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`LineChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartEasing","title":"LineChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`LineChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartAnimationType","title":"LineChartAnimationType","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`LineChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartLegendPosition","title":"LineChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-seriesName","title":"seriesName","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesName`"],["HTML attribute","`series-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"Allowed values: start, center, end. Default: 'end'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"Allowed values: top, bottom, middle. Default: 'top'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Match category axis categories to the values order."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Use consistent units and ranges for values being compared."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianYAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-brush","title":"brush","blocks":[{"kind":"paragraph","text":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianBrushInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `rect`, `lasso`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","description":"Type definition"}]}]},{"id":"property-drawings","title":"drawings","blocks":[{"kind":"paragraph","text":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartDrawingsInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"property-drawingMode","title":"drawingMode","blocks":[{"kind":"paragraph","text":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingMode`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DrawingModeInput`"],["Default","`undefined`"],["Literals in the type","`none`, `off`, `true`, `false`, `draw`, `select`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","description":"Type definition"}]}]},{"id":"property-drawingTool","title":"drawingTool","blocks":[{"kind":"paragraph","text":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingTool`"],["HTML attribute","`drawing-tool`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-drawingSpace","title":"drawingSpace","blocks":[{"kind":"paragraph","text":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingSpace`"],["HTML attribute","`drawing-space`"],["Type","`DrawingSpace`"],["Default","`undefined`"],["Allowed values","`data`, `pixel`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LineChartRenderResult & { tier: LineChartEngineTier; budget?: LineChartFrameBudgetInfo; stream?: LineChartStreamFrameInfo }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // LineChartRenderResult & { tier: LineChartEngineTier; budget?: LineChartFrameBudgetInfo; stream?: LineChartStreamFrameInfo }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LineChartRenderResult","title":"LineChartRenderResult","description":"Type definition"},{"path":"/docs/types/LineChartEngineTier","title":"LineChartEngineTier","description":"Type definition"},{"path":"/docs/types/LineChartFrameBudgetInfo","title":"LineChartFrameBudgetInfo","description":"Type definition"},{"path":"/docs/types/LineChartStreamFrameInfo","title":"LineChartStreamFrameInfo","description":"Type definition"}]}]},{"id":"event-frameBudgetReport","title":"frameBudgetReport","blocks":[{"kind":"paragraph","text":"a scheduled frame was skipped (the previous one overran the budget, or the GPU is behind), or a drawn frame overran."},{"kind":"paragraph","text":"Event name: `frameBudgetReport`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LineChartFrameBudgetEventDetail>`."},{"kind":"code","source":"chart.addEventListener('frameBudgetReport', event => {\n  console.log(event.detail); // LineChartFrameBudgetEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LineChartFrameBudgetEventDetail","title":"LineChartFrameBudgetEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: LineChartPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LineChartPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // LineChartPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LineChartPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // LineChartPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<LineChartPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<LineChartPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<LineChartPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-seriesClick","title":"seriesClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { cssX: number; cssY: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ cssX: number; cssY: number }>`."},{"kind":"code","source":"chart.addEventListener('seriesClick', event => {\n  console.log(event.detail); // { cssX: number; cssY: number }\n});","language":"javascript"}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: LineChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LineChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // LineChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LineChartLegendItemEventDetail","title":"LineChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: LineChartSeriesToggledEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LineChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // LineChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LineChartSeriesToggledEventDetail","title":"LineChartSeriesToggledEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushChange","title":"brushChange","blocks":[{"kind":"paragraph","text":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"kind":"paragraph","text":"Event name: `brushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushChange', event => {\n  console.log(event.detail); // CartesianBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushStart","title":"brushStart","blocks":[{"kind":"paragraph","text":"a brush drag opened up (once per gesture)."},{"kind":"paragraph","text":"Event name: `brushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushStartEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushStart', event => {\n  console.log(event.detail); // CartesianBrushStartEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","description":"Type definition"}]}]},{"id":"event-brushMove","title":"brushMove","blocks":[{"kind":"paragraph","text":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"kind":"paragraph","text":"Event name: `brushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushMoveEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushMove', event => {\n  console.log(event.detail); // CartesianBrushMoveEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","description":"Type definition"}]}]},{"id":"event-brushEnd","title":"brushEnd","blocks":[{"kind":"paragraph","text":"the drag released (after `brushChange`), or was cancelled."},{"kind":"paragraph","text":"Event name: `brushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushEndEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushEnd', event => {\n  console.log(event.detail); // CartesianBrushEndEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","description":"Type definition"}]}]},{"id":"event-drawingsChange","title":"drawingsChange","blocks":[{"kind":"paragraph","text":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"kind":"paragraph","text":"Event name: `drawingsChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingsChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingsChange', event => {\n  console.log(event.detail); // DrawingsChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drawingSelectionChange","title":"drawingSelectionChange","blocks":[{"kind":"paragraph","text":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"kind":"paragraph","text":"Event name: `drawingSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingSelectionChange', event => {\n  console.log(event.detail); // DrawingSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (a Chart Pro feature): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<LineChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<LineChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartStreamSource","title":"LineChartStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: LineChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: LineChartEasing; enabled?: boolean; type?: LineChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartEasing","title":"LineChartEasing","description":"Type definition"},{"path":"/docs/types/LineChartAnimationType","title":"LineChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(pointIndex: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pointIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDrawings","title":"getDrawings","blocks":[{"kind":"paragraph","text":"the drawings of the document (data-space anchors)."},{"kind":"code","source":"getDrawings(): Promise<ChartDrawing[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-setDrawings","title":"setDrawings","blocks":[{"kind":"paragraph","text":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"kind":"code","source":"setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawings`","`ReadonlyArray<ChartDrawingInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-addDrawing","title":"addDrawing","blocks":[{"kind":"paragraph","text":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"kind":"code","source":"addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawing`","`ChartDrawingInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-updateDrawing","title":"updateDrawing","blocks":[{"kind":"paragraph","text":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"kind":"code","source":"updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`patch`","`Partial<Omit<ChartDrawing, 'id'>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-removeDrawing","title":"removeDrawing","blocks":[{"kind":"paragraph","text":"remove one drawing."},{"kind":"code","source":"removeDrawing(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-removeDrawings","title":"removeDrawings","blocks":[{"kind":"paragraph","text":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"kind":"code","source":"removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-setDrawingSpace","title":"setDrawingSpace","blocks":[{"kind":"paragraph","text":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"kind":"code","source":"setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`space`","`DrawingSpace`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"method-clearDrawings","title":"clearDrawings","blocks":[{"kind":"paragraph","text":"clear the document (undoable)."},{"kind":"code","source":"clearDrawings(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-undoDrawing","title":"undoDrawing","blocks":[{"kind":"paragraph","text":"undo the last document change; null when there is nothing to undo."},{"kind":"code","source":"undoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-redoDrawing","title":"redoDrawing","blocks":[{"kind":"paragraph","text":"redo the last undone change; null when there is nothing to redo."},{"kind":"code","source":"redoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingLayer","title":"getDrawingLayer","blocks":[{"kind":"paragraph","text":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"kind":"code","source":"getDrawingLayer(): Promise<DrawingLayerSnapshot | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingLayerSnapshot | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","description":"Type definition"}]}]},{"id":"method-exportDrawings","title":"exportDrawings","blocks":[{"kind":"paragraph","text":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"kind":"code","source":"exportDrawings(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-importDrawings","title":"importDrawings","blocks":[{"kind":"paragraph","text":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"kind":"code","source":"importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`ChartDrawingsInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"method-selectDrawings","title":"selectDrawings","blocks":[{"kind":"paragraph","text":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"kind":"code","source":"selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingSelectionChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingSelection","title":"getDrawingSelection","blocks":[{"kind":"paragraph","text":"the selected drawing ids."},{"kind":"code","source":"getDrawingSelection(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setBrush","title":"setBrush","blocks":[{"kind":"paragraph","text":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"kind":"code","source":"setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`areas`","`ReadonlyArray<CartesianBrushAreaInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","description":"Type definition"}]}]},{"id":"method-clearBrush","title":"clearBrush","blocks":[{"kind":"paragraph","text":"clear the brush areas (`brushChange` with source 'clear')."},{"kind":"code","source":"clearBrush(): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getBrush","title":"getBrush","blocks":[{"kind":"paragraph","text":"the persisted brush areas (primary data space)."},{"kind":"code","source":"getBrush(): Promise<CartesianBrushArea[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushArea[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":"Type definition"}]}]},{"id":"method-getBrushSelection","title":"getBrushSelection","blocks":[{"kind":"paragraph","text":"the points inside the brush areas, against the current layout."},{"kind":"code","source":"getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushSelectedSeries[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-hitTestMarker","title":"hitTestMarker","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hitTestMarker(clientX: number, clientY: number): Promise<LineChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`clientX`","`number`","Required"],["`clientY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<LineChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":"Type definition"}]}]},{"id":"method-hitTestMarkers","title":"hitTestMarkers","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hitTestMarkers(clientX: number, clientY: number): Promise<LineChartPointEventDetail[]>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`clientX`","`number`","Required"],["`clientY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<LineChartPointEventDetail[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<LineChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<LineChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartRenderResult","title":"LineChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<LineChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<LineChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartEngineTier","title":"LineChartEngineTier","description":"Type definition"}]}]},{"id":"method-addSeries","title":"addSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSeries(options: LineChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`LineChartSeries`","Required"],["`opts`","`{ redraw?: boolean; insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","description":"Type definition"}]}]},{"id":"method-removeSeries","title":"removeSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSeries","title":"updateSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<LineChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<LineChartSeries>`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","description":"Type definition"}]}]},{"id":"method-setSeriesData","title":"setSeriesData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setSeriesData(idOrIndex: string | number, data: LineChartValues, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`data`","`LineChartValues`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LineChartValues","title":"LineChartValues","description":"Type definition"}]}]},{"id":"method-addPoint","title":"addPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addPoint(idOrIndex: string | number, point: number, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`point`","`number`","Required"],["`opts`","`{ shift?: boolean; redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/area","title":"Area","summary":"Show trends and magnitude with filled areas.","kind":"component","tag":"sy-area-chart","componentId":"area","api":{"props":[{"name":"series","attribute":"series","type":"AreaChartSeries[]","kind":"property","values":[],"default":"undefined","description":"Each series contains values in chronological order."},{"name":"activeSeriesIndex","attribute":"active-series-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesState","attribute":"series-state","type":"AreaChartSeriesStateOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: AreaChartSeriesStateOptions."},{"name":"seriesActiveTrigger","attribute":"series-active-trigger","type":"AreaChartSeriesActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"'hover'","description":"Allowed values: hover, click, custom. Default: 'hover'."},{"name":"values","attribute":"values","type":"AreaChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"600","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"300","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"fillColor","attribute":"fill-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"fillOpacity","attribute":"fill-opacity","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"fillGradient","attribute":"fill-gradient","type":"AreaChartFillGradient","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: AreaChartFillGradient."},{"name":"fillPattern","attribute":"fill-pattern","type":"AreaChartFillPattern","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: AreaChartFillPattern."},{"name":"patternKind","attribute":"pattern-kind","type":"AreaChartPatternKind","kind":"string","values":["dots","diagonal","cross-hatch","diagonal-forward","diagonal-backward","fill"],"default":"undefined","description":"Allowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined."},{"name":"patternColor","attribute":"pattern-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"patternBackground","attribute":"pattern-background","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"patternSize","attribute":"pattern-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"patternThickness","attribute":"pattern-thickness","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"thickness","attribute":"thickness","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"marker","attribute":"marker","type":"LineChartMarker","kind":"string","values":["none","circle","square","triangle","cross","diamond","star"],"default":"'none'","description":"Allowed values: none, circle, square, triangle, cross, diamond, star. Default: 'none'."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"4","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"markerFilter","attribute":"marker-filter","type":"LineChartMarkerFilter","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LineChartMarkerFilter."},{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Value the area is anchored to (line at `yScale(baseline)`). Always explicit (default `0`) so the rendered start point is never ambiguous."},{"name":"connectNulls","attribute":"connect-nulls","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"engine","attribute":"engine","type":"AreaChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"100_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"AreaChartUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"AreaChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"200","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"AreaChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"AreaChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"AreaChartLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"seriesName","attribute":"series-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"Allowed values: start, center, end. Default: 'end'."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"Allowed values: top, bottom, middle. Default: 'top'."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Provide categories with the same length as the series."},{"name":"yAxis","attribute":"y-axis","type":"CartesianYAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"The value axis that defines the area's baseline."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"name":"brush","attribute":"brush","type":"CartesianBrushInput","kind":"property","values":["auto","off","true","false","rect","lasso"],"default":"undefined","description":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"name":"drawings","attribute":"drawings","type":"ChartDrawingsInput","kind":"property","values":[],"default":"undefined","description":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"name":"drawingMode","attribute":"drawing-mode","type":"DrawingModeInput","kind":"property","values":["none","off","true","false","draw","select"],"default":"undefined","description":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"name":"drawingTool","attribute":"drawing-tool","type":"string","kind":"string","values":[],"default":"undefined","description":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"name":"drawingSpace","attribute":"drawing-space","type":"DrawingSpace","kind":"string","values":["data","pixel"],"default":"undefined","description":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."}],"methods":[{"name":"appendPoint","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<AreaChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: AreaChartEasing; enabled?: boolean; type?: AreaChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"showTooltipAtPoint","parameters":[{"name":"pointIndex","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"showCrosshairAt","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDrawings","parameters":[],"returns":"Promise<ChartDrawing[]>","description":"the drawings of the document (data-space anchors)."},{"name":"setDrawings","parameters":[{"name":"drawings","type":"ReadonlyArray<ChartDrawingInput> | null","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"name":"addDrawing","parameters":[{"name":"drawing","type":"ChartDrawingInput","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"name":"updateDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"patch","type":"Partial<Omit<ChartDrawing, 'id'>>","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"name":"removeDrawing","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"remove one drawing."},{"name":"removeDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string>","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"name":"setDrawingSpace","parameters":[{"name":"id","type":"string","optional":false},{"name":"space","type":"DrawingSpace","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"name":"clearDrawings","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"clear the document (undoable)."},{"name":"undoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"undo the last document change; null when there is nothing to undo."},{"name":"redoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"redo the last undone change; null when there is nothing to redo."},{"name":"getDrawingLayer","parameters":[],"returns":"Promise<DrawingLayerSnapshot | null>","description":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"name":"exportDrawings","parameters":[],"returns":"Promise<string>","description":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"name":"importDrawings","parameters":[{"name":"input","type":"ChartDrawingsInput","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"name":"selectDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string> | null","optional":false}],"returns":"Promise<DrawingSelectionChangeEventDetail | null>","description":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"name":"getDrawingSelection","parameters":[],"returns":"Promise<string[]>","description":"the selected drawing ids."},{"name":"setBrush","parameters":[{"name":"areas","type":"ReadonlyArray<CartesianBrushAreaInput> | null","optional":false}],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"name":"clearBrush","parameters":[],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"clear the brush areas (`brushChange` with source 'clear')."},{"name":"getBrush","parameters":[],"returns":"Promise<CartesianBrushArea[]>","description":"the persisted brush areas (primary data space)."},{"name":"getBrushSelection","parameters":[],"returns":"Promise<CartesianBrushSelectedSeries[]>","description":"the points inside the brush areas, against the current layout."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"name":"redraw","parameters":[],"returns":"Promise<AreaChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<AreaChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addSeries","parameters":[{"name":"options","type":"AreaChartSeries","optional":false},{"name":"opts","type":"{ redraw?: boolean; insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<AreaChartSeries>","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setSeriesData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"data","type":"AreaChartValues","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addPoint","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"point","type":"number","optional":false},{"name":"opts","type":"{ shift?: boolean; redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rendered","type":"AreaChartRenderResult & { tier: AreaChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"name":"brushChange","type":"CartesianBrushChangeEventDetail","description":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"name":"brushStart","type":"CartesianBrushStartEventDetail","description":"a brush drag opened up (once per gesture)."},{"name":"brushMove","type":"CartesianBrushMoveEventDetail","description":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"name":"brushEnd","type":"CartesianBrushEndEventDetail","description":"the drag released (after `brushChange`), or was cancelled."},{"name":"drawingsChange","type":"DrawingsChangeEventDetail","description":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"name":"drawingSelectionChange","type":"DrawingSelectionChangeEventDetail","description":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"name":"pointHover","type":"CartesianPointEventDetail | null","description":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"name":"pointClick","type":"CartesianPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<CartesianPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"AreaChartLegendItemEventDetail","description":"CustomEvent.detail type: AreaChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"AreaChartSeriesToggledEventDetail","description":"CustomEvent.detail type: AreaChartSeriesToggledEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-area-chart","blocks":[{"kind":"paragraph","text":"Use for traffic, revenue, and other measures whose magnitude changes over time."},{"kind":"paragraph","text":"Overlapping areas may hide series behind them. Provide tooltips and a data table for precise comparisons."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`series`","Each series contains values in chronological order."],["`xAxis`","Provide categories with the same length as the series."],["`yAxis`","The value axis that defines the area's baseline."]]},{"kind":"links","items":[{"path":"/charts/area","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-area-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-area-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"series\": [\n          {\n            \"name\": \"Online\",\n            \"values\": [24, 29, 27, 38, 43, 40],\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"name\": \"Store\",\n            \"values\": [15, 19, 17, 24, 22, 29],\n            \"color\": \"#239c91\"\n          }\n        ],\n        \"xAxis\": {\n          \"kind\": \"category\",\n          \"categories\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\"]\n        },\n        \"yAxis\": {\n          \"kind\": \"linear\",\n          \"min\": 0\n        },\n        \"legend\": true,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'area example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-series","title":"series","blocks":[{"kind":"paragraph","text":"Each series contains values in chronological order."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`AreaChartSeries[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartSeries","title":"AreaChartSeries","description":"Type definition"}]}]},{"id":"property-activeSeriesIndex","title":"activeSeriesIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSeriesIndex`"],["HTML attribute","`active-series-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-seriesState","title":"seriesState","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: AreaChartSeriesStateOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesState`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`AreaChartSeriesStateOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartSeriesStateOptions","title":"AreaChartSeriesStateOptions","description":"Type definition"}]}]},{"id":"property-seriesActiveTrigger","title":"seriesActiveTrigger","blocks":[{"kind":"paragraph","text":"Allowed values: hover, click, custom. Default: 'hover'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesActiveTrigger`"],["HTML attribute","`series-active-trigger`"],["Type","`AreaChartSeriesActiveTrigger`"],["Default","`'hover'`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"links","items":[{"path":"/docs/types/AreaChartSeriesActiveTrigger","title":"AreaChartSeriesActiveTrigger","description":"Type definition"}]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`AreaChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/AreaChartValues","title":"AreaChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-fillColor","title":"fillColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillColor`"],["HTML attribute","`fill-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-fillOpacity","title":"fillOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillOpacity`"],["HTML attribute","`fill-opacity`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-fillGradient","title":"fillGradient","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: AreaChartFillGradient."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillGradient`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`AreaChartFillGradient`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartFillGradient","title":"AreaChartFillGradient","description":"Type definition"}]}]},{"id":"property-fillPattern","title":"fillPattern","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: AreaChartFillPattern."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillPattern`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`AreaChartFillPattern`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartFillPattern","title":"AreaChartFillPattern","description":"Type definition"}]}]},{"id":"property-patternKind","title":"patternKind","blocks":[{"kind":"paragraph","text":"Allowed values: dots, diagonal, cross-hatch, diagonal-forward, diagonal-backward, fill. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternKind`"],["HTML attribute","`pattern-kind`"],["Type","`AreaChartPatternKind`"],["Default","`undefined`"],["Allowed values","`dots`, `diagonal`, `cross-hatch`, `diagonal-forward`, `diagonal-backward`, `fill`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartPatternKind","title":"AreaChartPatternKind","description":"Type definition"}]}]},{"id":"property-patternColor","title":"patternColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternColor`"],["HTML attribute","`pattern-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-patternBackground","title":"patternBackground","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternBackground`"],["HTML attribute","`pattern-background`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-patternSize","title":"patternSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternSize`"],["HTML attribute","`pattern-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-patternThickness","title":"patternThickness","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`patternThickness`"],["HTML attribute","`pattern-thickness`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-thickness","title":"thickness","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`thickness`"],["HTML attribute","`thickness`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"Allowed values: none, circle, square, triangle, cross, diamond, star. Default: 'none'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","`marker`"],["Type","`LineChartMarker`"],["Default","`'none'`"],["Allowed values","`none`, `circle`, `square`, `triangle`, `cross`, `diamond`, `star`"]]},{"kind":"links","items":[{"path":"/docs/types/LineChartMarker","title":"LineChartMarker","description":"Type definition"}]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"property-markerFilter","title":"markerFilter","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LineChartMarkerFilter."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerFilter`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LineChartMarkerFilter`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LineChartMarkerFilter","title":"LineChartMarkerFilter","description":"Type definition"}]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Value the area is anchored to (line at `yScale(baseline)`). Always explicit (default `0`) so the rendered start point is never ambiguous."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-connectNulls","title":"connectNulls","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectNulls`"],["HTML attribute","`connect-nulls`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`AreaChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/AreaChartEngineMode","title":"AreaChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`100_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`AreaChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/AreaChartUnavailableBehaviour","title":"AreaChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`AreaChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartStreamSource","title":"AreaChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`200`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`AreaChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/AreaChartEasing","title":"AreaChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`AreaChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/AreaChartAnimationType","title":"AreaChartAnimationType","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`AreaChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/AreaChartLegendPosition","title":"AreaChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-seriesName","title":"seriesName","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesName`"],["HTML attribute","`series-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"Allowed values: start, center, end. Default: 'end'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"Allowed values: top, bottom, middle. Default: 'top'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Provide categories with the same length as the series."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"The value axis that defines the area's baseline."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianYAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-brush","title":"brush","blocks":[{"kind":"paragraph","text":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianBrushInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `rect`, `lasso`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","description":"Type definition"}]}]},{"id":"property-drawings","title":"drawings","blocks":[{"kind":"paragraph","text":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartDrawingsInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"property-drawingMode","title":"drawingMode","blocks":[{"kind":"paragraph","text":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingMode`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DrawingModeInput`"],["Default","`undefined`"],["Literals in the type","`none`, `off`, `true`, `false`, `draw`, `select`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","description":"Type definition"}]}]},{"id":"property-drawingTool","title":"drawingTool","blocks":[{"kind":"paragraph","text":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingTool`"],["HTML attribute","`drawing-tool`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-drawingSpace","title":"drawingSpace","blocks":[{"kind":"paragraph","text":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingSpace`"],["HTML attribute","`drawing-space`"],["Type","`DrawingSpace`"],["Default","`undefined`"],["Allowed values","`data`, `pixel`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<AreaChartRenderResult & { tier: AreaChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // AreaChartRenderResult & { tier: AreaChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/AreaChartRenderResult","title":"AreaChartRenderResult","description":"Type definition"},{"path":"/docs/types/AreaChartEngineTier","title":"AreaChartEngineTier","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushChange","title":"brushChange","blocks":[{"kind":"paragraph","text":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"kind":"paragraph","text":"Event name: `brushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushChange', event => {\n  console.log(event.detail); // CartesianBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushStart","title":"brushStart","blocks":[{"kind":"paragraph","text":"a brush drag opened up (once per gesture)."},{"kind":"paragraph","text":"Event name: `brushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushStartEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushStart', event => {\n  console.log(event.detail); // CartesianBrushStartEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","description":"Type definition"}]}]},{"id":"event-brushMove","title":"brushMove","blocks":[{"kind":"paragraph","text":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"kind":"paragraph","text":"Event name: `brushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushMoveEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushMove', event => {\n  console.log(event.detail); // CartesianBrushMoveEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","description":"Type definition"}]}]},{"id":"event-brushEnd","title":"brushEnd","blocks":[{"kind":"paragraph","text":"the drag released (after `brushChange`), or was cancelled."},{"kind":"paragraph","text":"Event name: `brushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushEndEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushEnd', event => {\n  console.log(event.detail); // CartesianBrushEndEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","description":"Type definition"}]}]},{"id":"event-drawingsChange","title":"drawingsChange","blocks":[{"kind":"paragraph","text":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"kind":"paragraph","text":"Event name: `drawingsChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingsChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingsChange', event => {\n  console.log(event.detail); // DrawingsChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drawingSelectionChange","title":"drawingSelectionChange","blocks":[{"kind":"paragraph","text":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"kind":"paragraph","text":"Event name: `drawingSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingSelectionChange', event => {\n  console.log(event.detail); // DrawingSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // CartesianPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // CartesianPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<CartesianPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<CartesianPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: AreaChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<AreaChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // AreaChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/AreaChartLegendItemEventDetail","title":"AreaChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: AreaChartSeriesToggledEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<AreaChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // AreaChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/AreaChartSeriesToggledEventDetail","title":"AreaChartSeriesToggledEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<AreaChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<AreaChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/AreaChartStreamSource","title":"AreaChartStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: AreaChartEasing; enabled?: boolean; type?: AreaChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: AreaChartEasing; enabled?: boolean; type?: AreaChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/AreaChartEasing","title":"AreaChartEasing","description":"Type definition"},{"path":"/docs/types/AreaChartAnimationType","title":"AreaChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(pointIndex: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pointIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDrawings","title":"getDrawings","blocks":[{"kind":"paragraph","text":"the drawings of the document (data-space anchors)."},{"kind":"code","source":"getDrawings(): Promise<ChartDrawing[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-setDrawings","title":"setDrawings","blocks":[{"kind":"paragraph","text":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"kind":"code","source":"setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawings`","`ReadonlyArray<ChartDrawingInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-addDrawing","title":"addDrawing","blocks":[{"kind":"paragraph","text":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"kind":"code","source":"addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawing`","`ChartDrawingInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-updateDrawing","title":"updateDrawing","blocks":[{"kind":"paragraph","text":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"kind":"code","source":"updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`patch`","`Partial<Omit<ChartDrawing, 'id'>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-removeDrawing","title":"removeDrawing","blocks":[{"kind":"paragraph","text":"remove one drawing."},{"kind":"code","source":"removeDrawing(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-removeDrawings","title":"removeDrawings","blocks":[{"kind":"paragraph","text":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"kind":"code","source":"removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-setDrawingSpace","title":"setDrawingSpace","blocks":[{"kind":"paragraph","text":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"kind":"code","source":"setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`space`","`DrawingSpace`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"method-clearDrawings","title":"clearDrawings","blocks":[{"kind":"paragraph","text":"clear the document (undoable)."},{"kind":"code","source":"clearDrawings(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-undoDrawing","title":"undoDrawing","blocks":[{"kind":"paragraph","text":"undo the last document change; null when there is nothing to undo."},{"kind":"code","source":"undoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-redoDrawing","title":"redoDrawing","blocks":[{"kind":"paragraph","text":"redo the last undone change; null when there is nothing to redo."},{"kind":"code","source":"redoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingLayer","title":"getDrawingLayer","blocks":[{"kind":"paragraph","text":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"kind":"code","source":"getDrawingLayer(): Promise<DrawingLayerSnapshot | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingLayerSnapshot | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","description":"Type definition"}]}]},{"id":"method-exportDrawings","title":"exportDrawings","blocks":[{"kind":"paragraph","text":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"kind":"code","source":"exportDrawings(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-importDrawings","title":"importDrawings","blocks":[{"kind":"paragraph","text":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"kind":"code","source":"importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`ChartDrawingsInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"method-selectDrawings","title":"selectDrawings","blocks":[{"kind":"paragraph","text":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"kind":"code","source":"selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingSelectionChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingSelection","title":"getDrawingSelection","blocks":[{"kind":"paragraph","text":"the selected drawing ids."},{"kind":"code","source":"getDrawingSelection(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setBrush","title":"setBrush","blocks":[{"kind":"paragraph","text":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"kind":"code","source":"setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`areas`","`ReadonlyArray<CartesianBrushAreaInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","description":"Type definition"}]}]},{"id":"method-clearBrush","title":"clearBrush","blocks":[{"kind":"paragraph","text":"clear the brush areas (`brushChange` with source 'clear')."},{"kind":"code","source":"clearBrush(): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getBrush","title":"getBrush","blocks":[{"kind":"paragraph","text":"the persisted brush areas (primary data space)."},{"kind":"code","source":"getBrush(): Promise<CartesianBrushArea[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushArea[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":"Type definition"}]}]},{"id":"method-getBrushSelection","title":"getBrushSelection","blocks":[{"kind":"paragraph","text":"the points inside the brush areas, against the current layout."},{"kind":"code","source":"getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushSelectedSeries[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<AreaChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<AreaChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/AreaChartRenderResult","title":"AreaChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<AreaChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<AreaChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/AreaChartEngineTier","title":"AreaChartEngineTier","description":"Type definition"}]}]},{"id":"method-addSeries","title":"addSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSeries(options: AreaChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`AreaChartSeries`","Required"],["`opts`","`{ redraw?: boolean; insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/AreaChartSeries","title":"AreaChartSeries","description":"Type definition"}]}]},{"id":"method-removeSeries","title":"removeSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSeries","title":"updateSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<AreaChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<AreaChartSeries>`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/AreaChartSeries","title":"AreaChartSeries","description":"Type definition"}]}]},{"id":"method-setSeriesData","title":"setSeriesData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setSeriesData(idOrIndex: string | number, data: AreaChartValues, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`data`","`AreaChartValues`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/AreaChartValues","title":"AreaChartValues","description":"Type definition"}]}]},{"id":"method-addPoint","title":"addPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addPoint(idOrIndex: string | number, point: number, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`point`","`number`","Required"],["`opts`","`{ shift?: boolean; redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/column","title":"Column","summary":"Compare category values with vertical bars.","kind":"component","tag":"sy-column-chart","componentId":"column","api":{"props":[{"name":"series","attribute":"series","type":"ColumnChartSeries[]","kind":"property","values":[],"default":"undefined","description":"Names, values, and colors for each group."},{"name":"activeSeriesIndex","attribute":"active-series-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesState","attribute":"series-state","type":"ColumnChartSeriesStateOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ColumnChartSeriesStateOptions."},{"name":"seriesActiveTrigger","attribute":"series-active-trigger","type":"ColumnChartSeriesActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"'hover'","description":"Allowed values: hover, click, custom. Default: 'hover'."},{"name":"values","attribute":"values","type":"ColumnChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Use a number array for a single series."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"600","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"300","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"thickness","attribute":"thickness","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"barPadding","attribute":"bar-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesPadding","attribute":"series-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Value the columns grow from. Always explicit (default `0`) so the start point of every column is never ambiguous — set to a non-zero anchor when the chart measures variance against something other than zero."},{"name":"stacking","attribute":"stacking","type":"CartesianSeriesStackingMode","kind":"string","values":["normal","percent"],"default":"undefined","description":"Allowed values: normal, percent. Default: undefined."},{"name":"borderRadius","attribute":"border-radius","type":"CartesianSeriesCornerRadiusValue","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue."},{"name":"borderScope","attribute":"border-scope","type":"ColumnBorderScope","kind":"string","values":["point","stack","outline"],"default":"'stack'","description":"Allowed values: point, stack, outline. Default: 'stack'."},{"name":"borderColor","attribute":"border-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"borderWidth","attribute":"border-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"borderDashStyle","attribute":"border-dash-style","type":"CartesianSeriesBorderDashStyle","kind":"string","values":["Solid","Dash","Dot","DashDot","LongDash","LongDashDot"],"default":"undefined","description":"Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined."},{"name":"inactiveOtherPoints","attribute":"inactive-other-points","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactivePointOpacity","attribute":"inactive-point-opacity","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"engine","attribute":"engine","type":"ColumnChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"ColumnChartUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"ColumnChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"200","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ColumnChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ColumnChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"ColumnChartLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"seriesName","attribute":"series-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"Allowed values: start, center, end. Default: 'end'."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"Allowed values: top, bottom, middle. Default: 'top'."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"categories determines the bar order."},{"name":"yAxis","attribute":"y-axis","type":"CartesianYAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"name":"brush","attribute":"brush","type":"CartesianBrushInput","kind":"property","values":["auto","off","true","false","rect","lasso"],"default":"undefined","description":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"name":"drawings","attribute":"drawings","type":"ChartDrawingsInput","kind":"property","values":[],"default":"undefined","description":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"name":"drawingMode","attribute":"drawing-mode","type":"DrawingModeInput","kind":"property","values":["none","off","true","false","draw","select"],"default":"undefined","description":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"name":"drawingTool","attribute":"drawing-tool","type":"string","kind":"string","values":[],"default":"undefined","description":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"name":"drawingSpace","attribute":"drawing-space","type":"DrawingSpace","kind":"string","values":["data","pixel"],"default":"undefined","description":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<ColumnChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<ColumnChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendPoint","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ColumnChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: ColumnChartEasing; enabled?: boolean; type?: ColumnChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"addSeries","parameters":[{"name":"options","type":"ColumnChartSeries","optional":false},{"name":"opts","type":"{ redraw?: boolean; insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<ColumnChartSeries>","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setSeriesData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"data","type":"ColumnChartValues","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addPoint","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"point","type":"number","optional":false},{"name":"opts","type":"{ shift?: boolean; redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showTooltipAtPoint","parameters":[{"name":"pointIndex","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"showCrosshairAt","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDrawings","parameters":[],"returns":"Promise<ChartDrawing[]>","description":"the drawings of the document (data-space anchors)."},{"name":"setDrawings","parameters":[{"name":"drawings","type":"ReadonlyArray<ChartDrawingInput> | null","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"name":"addDrawing","parameters":[{"name":"drawing","type":"ChartDrawingInput","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"name":"updateDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"patch","type":"Partial<Omit<ChartDrawing, 'id'>>","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"name":"removeDrawing","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"remove one drawing."},{"name":"removeDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string>","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"name":"setDrawingSpace","parameters":[{"name":"id","type":"string","optional":false},{"name":"space","type":"DrawingSpace","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"name":"clearDrawings","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"clear the document (undoable)."},{"name":"undoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"undo the last document change; null when there is nothing to undo."},{"name":"redoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"redo the last undone change; null when there is nothing to redo."},{"name":"getDrawingLayer","parameters":[],"returns":"Promise<DrawingLayerSnapshot | null>","description":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"name":"exportDrawings","parameters":[],"returns":"Promise<string>","description":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"name":"importDrawings","parameters":[{"name":"input","type":"ChartDrawingsInput","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"name":"selectDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string> | null","optional":false}],"returns":"Promise<DrawingSelectionChangeEventDetail | null>","description":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"name":"getDrawingSelection","parameters":[],"returns":"Promise<string[]>","description":"the selected drawing ids."},{"name":"setBrush","parameters":[{"name":"areas","type":"ReadonlyArray<CartesianBrushAreaInput> | null","optional":false}],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"name":"clearBrush","parameters":[],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"clear the brush areas (`brushChange` with source 'clear')."},{"name":"getBrush","parameters":[],"returns":"Promise<CartesianBrushArea[]>","description":"the persisted brush areas (primary data space)."},{"name":"getBrushSelection","parameters":[],"returns":"Promise<CartesianBrushSelectedSeries[]>","description":"the points inside the brush areas, against the current layout."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"name":"hitTestPoint","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ pointIndex: number; seriesIndex: number } | null>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rendered","type":"ColumnChartRenderResult & { tier: ColumnChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"name":"brushChange","type":"CartesianBrushChangeEventDetail","description":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"name":"brushStart","type":"CartesianBrushStartEventDetail","description":"a brush drag opened up (once per gesture)."},{"name":"brushMove","type":"CartesianBrushMoveEventDetail","description":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"name":"brushEnd","type":"CartesianBrushEndEventDetail","description":"the drag released (after `brushChange`), or was cancelled."},{"name":"drawingsChange","type":"DrawingsChangeEventDetail","description":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"name":"drawingSelectionChange","type":"DrawingSelectionChangeEventDetail","description":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"name":"pointHover","type":"CartesianPointEventDetail | null","description":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"name":"pointClick","type":"CartesianPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<CartesianPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"ColumnChartLegendItemEventDetail","description":"CustomEvent.detail type: ColumnChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"ColumnChartSeriesToggledEventDetail","description":"CustomEvent.detail type: ColumnChartSeriesToggledEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-column-chart","blocks":[{"kind":"paragraph","text":"Suitable for a small number of categories, such as monthly results or product quantities."},{"kind":"paragraph","text":"Bar lengths are most naturally compared from zero. Consider Bar when there are many categories."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`series`","Names, values, and colors for each group."],["`values`","Use a number array for a single series."],["`xAxis`","categories determines the bar order."]]},{"kind":"links","items":[{"path":"/charts/column","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-column-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-column-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"series\": [\n          {\n            \"name\": \"Online\",\n            \"values\": [24, 29, 27, 38, 43, 40],\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"name\": \"Store\",\n            \"values\": [15, 19, 17, 24, 22, 29],\n            \"color\": \"#239c91\"\n          }\n        ],\n        \"xAxis\": {\n          \"kind\": \"category\",\n          \"categories\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\"]\n        },\n        \"yAxis\": {\n          \"kind\": \"linear\",\n          \"min\": 0\n        },\n        \"legend\": true,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'column example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-series","title":"series","blocks":[{"kind":"paragraph","text":"Names, values, and colors for each group."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ColumnChartSeries[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartSeries","title":"ColumnChartSeries","description":"Type definition"}]}]},{"id":"property-activeSeriesIndex","title":"activeSeriesIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSeriesIndex`"],["HTML attribute","`active-series-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-seriesState","title":"seriesState","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ColumnChartSeriesStateOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesState`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ColumnChartSeriesStateOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartSeriesStateOptions","title":"ColumnChartSeriesStateOptions","description":"Type definition"}]}]},{"id":"property-seriesActiveTrigger","title":"seriesActiveTrigger","blocks":[{"kind":"paragraph","text":"Allowed values: hover, click, custom. Default: 'hover'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesActiveTrigger`"],["HTML attribute","`series-active-trigger`"],["Type","`ColumnChartSeriesActiveTrigger`"],["Default","`'hover'`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"links","items":[{"path":"/docs/types/ColumnChartSeriesActiveTrigger","title":"ColumnChartSeriesActiveTrigger","description":"Type definition"}]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Use a number array for a single series."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ColumnChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/ColumnChartValues","title":"ColumnChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-thickness","title":"thickness","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`thickness`"],["HTML attribute","`thickness`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-barPadding","title":"barPadding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barPadding`"],["HTML attribute","`bar-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-seriesPadding","title":"seriesPadding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesPadding`"],["HTML attribute","`series-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Value the columns grow from. Always explicit (default `0`) so the start point of every column is never ambiguous — set to a non-zero anchor when the chart measures variance against something other than zero."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-stacking","title":"stacking","blocks":[{"kind":"paragraph","text":"Allowed values: normal, percent. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stacking`"],["HTML attribute","`stacking`"],["Type","`CartesianSeriesStackingMode`"],["Default","`undefined`"],["Allowed values","`normal`, `percent`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesStackingMode","title":"CartesianSeriesStackingMode","description":"Type definition"}]}]},{"id":"property-borderRadius","title":"borderRadius","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderRadius`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianSeriesCornerRadiusValue`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesCornerRadiusValue","title":"CartesianSeriesCornerRadiusValue","description":"Type definition"}]}]},{"id":"property-borderScope","title":"borderScope","blocks":[{"kind":"paragraph","text":"Allowed values: point, stack, outline. Default: 'stack'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderScope`"],["HTML attribute","`border-scope`"],["Type","`ColumnBorderScope`"],["Default","`'stack'`"],["Allowed values","`point`, `stack`, `outline`"]]},{"kind":"links","items":[{"path":"/docs/types/ColumnBorderScope","title":"ColumnBorderScope","description":"Type definition"}]}]},{"id":"property-borderColor","title":"borderColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderColor`"],["HTML attribute","`border-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-borderWidth","title":"borderWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderWidth`"],["HTML attribute","`border-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-borderDashStyle","title":"borderDashStyle","blocks":[{"kind":"paragraph","text":"Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderDashStyle`"],["HTML attribute","`border-dash-style`"],["Type","`CartesianSeriesBorderDashStyle`"],["Default","`undefined`"],["Allowed values","`Solid`, `Dash`, `Dot`, `DashDot`, `LongDash`, `LongDashDot`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBorderDashStyle","title":"CartesianSeriesBorderDashStyle","description":"Type definition"}]}]},{"id":"property-inactiveOtherPoints","title":"inactiveOtherPoints","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherPoints`"],["HTML attribute","`inactive-other-points`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactivePointOpacity","title":"inactivePointOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactivePointOpacity`"],["HTML attribute","`inactive-point-opacity`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ColumnChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ColumnChartEngineMode","title":"ColumnChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ColumnChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/ColumnChartUnavailableBehaviour","title":"ColumnChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ColumnChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartStreamSource","title":"ColumnChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`200`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ColumnChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ColumnChartEasing","title":"ColumnChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ColumnChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartAnimationType","title":"ColumnChartAnimationType","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`ColumnChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/ColumnChartLegendPosition","title":"ColumnChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-seriesName","title":"seriesName","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesName`"],["HTML attribute","`series-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"Allowed values: start, center, end. Default: 'end'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"Allowed values: top, bottom, middle. Default: 'top'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"categories determines the bar order."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianYAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-brush","title":"brush","blocks":[{"kind":"paragraph","text":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianBrushInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `rect`, `lasso`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","description":"Type definition"}]}]},{"id":"property-drawings","title":"drawings","blocks":[{"kind":"paragraph","text":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartDrawingsInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"property-drawingMode","title":"drawingMode","blocks":[{"kind":"paragraph","text":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingMode`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DrawingModeInput`"],["Default","`undefined`"],["Literals in the type","`none`, `off`, `true`, `false`, `draw`, `select`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","description":"Type definition"}]}]},{"id":"property-drawingTool","title":"drawingTool","blocks":[{"kind":"paragraph","text":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingTool`"],["HTML attribute","`drawing-tool`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-drawingSpace","title":"drawingSpace","blocks":[{"kind":"paragraph","text":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingSpace`"],["HTML attribute","`drawing-space`"],["Type","`DrawingSpace`"],["Default","`undefined`"],["Allowed values","`data`, `pixel`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ColumnChartRenderResult & { tier: ColumnChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ColumnChartRenderResult & { tier: ColumnChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ColumnChartRenderResult","title":"ColumnChartRenderResult","description":"Type definition"},{"path":"/docs/types/ColumnChartEngineTier","title":"ColumnChartEngineTier","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushChange","title":"brushChange","blocks":[{"kind":"paragraph","text":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"kind":"paragraph","text":"Event name: `brushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushChange', event => {\n  console.log(event.detail); // CartesianBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushStart","title":"brushStart","blocks":[{"kind":"paragraph","text":"a brush drag opened up (once per gesture)."},{"kind":"paragraph","text":"Event name: `brushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushStartEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushStart', event => {\n  console.log(event.detail); // CartesianBrushStartEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","description":"Type definition"}]}]},{"id":"event-brushMove","title":"brushMove","blocks":[{"kind":"paragraph","text":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"kind":"paragraph","text":"Event name: `brushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushMoveEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushMove', event => {\n  console.log(event.detail); // CartesianBrushMoveEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","description":"Type definition"}]}]},{"id":"event-brushEnd","title":"brushEnd","blocks":[{"kind":"paragraph","text":"the drag released (after `brushChange`), or was cancelled."},{"kind":"paragraph","text":"Event name: `brushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushEndEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushEnd', event => {\n  console.log(event.detail); // CartesianBrushEndEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","description":"Type definition"}]}]},{"id":"event-drawingsChange","title":"drawingsChange","blocks":[{"kind":"paragraph","text":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"kind":"paragraph","text":"Event name: `drawingsChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingsChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingsChange', event => {\n  console.log(event.detail); // DrawingsChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drawingSelectionChange","title":"drawingSelectionChange","blocks":[{"kind":"paragraph","text":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"kind":"paragraph","text":"Event name: `drawingSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingSelectionChange', event => {\n  console.log(event.detail); // DrawingSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // CartesianPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // CartesianPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<CartesianPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<CartesianPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ColumnChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ColumnChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // ColumnChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ColumnChartLegendItemEventDetail","title":"ColumnChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ColumnChartSeriesToggledEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ColumnChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // ColumnChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ColumnChartSeriesToggledEventDetail","title":"ColumnChartSeriesToggledEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ColumnChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ColumnChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartRenderResult","title":"ColumnChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<ColumnChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ColumnChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartEngineTier","title":"ColumnChartEngineTier","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ColumnChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ColumnChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartStreamSource","title":"ColumnChartStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: ColumnChartEasing; enabled?: boolean; type?: ColumnChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: ColumnChartEasing; enabled?: boolean; type?: ColumnChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartEasing","title":"ColumnChartEasing","description":"Type definition"},{"path":"/docs/types/ColumnChartAnimationType","title":"ColumnChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-addSeries","title":"addSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSeries(options: ColumnChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`ColumnChartSeries`","Required"],["`opts`","`{ redraw?: boolean; insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartSeries","title":"ColumnChartSeries","description":"Type definition"}]}]},{"id":"method-removeSeries","title":"removeSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSeries","title":"updateSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<ColumnChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<ColumnChartSeries>`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartSeries","title":"ColumnChartSeries","description":"Type definition"}]}]},{"id":"method-setSeriesData","title":"setSeriesData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setSeriesData(idOrIndex: string | number, data: ColumnChartValues, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`data`","`ColumnChartValues`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ColumnChartValues","title":"ColumnChartValues","description":"Type definition"}]}]},{"id":"method-addPoint","title":"addPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addPoint(idOrIndex: string | number, point: number, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`point`","`number`","Required"],["`opts`","`{ shift?: boolean; redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(pointIndex: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pointIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDrawings","title":"getDrawings","blocks":[{"kind":"paragraph","text":"the drawings of the document (data-space anchors)."},{"kind":"code","source":"getDrawings(): Promise<ChartDrawing[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-setDrawings","title":"setDrawings","blocks":[{"kind":"paragraph","text":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"kind":"code","source":"setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawings`","`ReadonlyArray<ChartDrawingInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-addDrawing","title":"addDrawing","blocks":[{"kind":"paragraph","text":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"kind":"code","source":"addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawing`","`ChartDrawingInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-updateDrawing","title":"updateDrawing","blocks":[{"kind":"paragraph","text":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"kind":"code","source":"updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`patch`","`Partial<Omit<ChartDrawing, 'id'>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-removeDrawing","title":"removeDrawing","blocks":[{"kind":"paragraph","text":"remove one drawing."},{"kind":"code","source":"removeDrawing(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-removeDrawings","title":"removeDrawings","blocks":[{"kind":"paragraph","text":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"kind":"code","source":"removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-setDrawingSpace","title":"setDrawingSpace","blocks":[{"kind":"paragraph","text":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"kind":"code","source":"setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`space`","`DrawingSpace`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"method-clearDrawings","title":"clearDrawings","blocks":[{"kind":"paragraph","text":"clear the document (undoable)."},{"kind":"code","source":"clearDrawings(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-undoDrawing","title":"undoDrawing","blocks":[{"kind":"paragraph","text":"undo the last document change; null when there is nothing to undo."},{"kind":"code","source":"undoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-redoDrawing","title":"redoDrawing","blocks":[{"kind":"paragraph","text":"redo the last undone change; null when there is nothing to redo."},{"kind":"code","source":"redoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingLayer","title":"getDrawingLayer","blocks":[{"kind":"paragraph","text":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"kind":"code","source":"getDrawingLayer(): Promise<DrawingLayerSnapshot | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingLayerSnapshot | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","description":"Type definition"}]}]},{"id":"method-exportDrawings","title":"exportDrawings","blocks":[{"kind":"paragraph","text":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"kind":"code","source":"exportDrawings(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-importDrawings","title":"importDrawings","blocks":[{"kind":"paragraph","text":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"kind":"code","source":"importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`ChartDrawingsInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"method-selectDrawings","title":"selectDrawings","blocks":[{"kind":"paragraph","text":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"kind":"code","source":"selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingSelectionChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingSelection","title":"getDrawingSelection","blocks":[{"kind":"paragraph","text":"the selected drawing ids."},{"kind":"code","source":"getDrawingSelection(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setBrush","title":"setBrush","blocks":[{"kind":"paragraph","text":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"kind":"code","source":"setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`areas`","`ReadonlyArray<CartesianBrushAreaInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","description":"Type definition"}]}]},{"id":"method-clearBrush","title":"clearBrush","blocks":[{"kind":"paragraph","text":"clear the brush areas (`brushChange` with source 'clear')."},{"kind":"code","source":"clearBrush(): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getBrush","title":"getBrush","blocks":[{"kind":"paragraph","text":"the persisted brush areas (primary data space)."},{"kind":"code","source":"getBrush(): Promise<CartesianBrushArea[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushArea[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":"Type definition"}]}]},{"id":"method-getBrushSelection","title":"getBrushSelection","blocks":[{"kind":"paragraph","text":"the points inside the brush areas, against the current layout."},{"kind":"code","source":"getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushSelectedSeries[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-hitTestPoint","title":"hitTestPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hitTestPoint(cssX: number, cssY: number): Promise<{ pointIndex: number; seriesIndex: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ pointIndex: number; seriesIndex: number } | null>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/bar","title":"Bar","summary":"Compare category values with horizontal bars.","kind":"component","tag":"sy-bar-chart","componentId":"bar","api":{"props":[{"name":"series","attribute":"series","type":"BarChartSeries[]","kind":"property","values":[],"default":"undefined","description":"The values array for each comparison group."},{"name":"activeSeriesIndex","attribute":"active-series-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesState","attribute":"series-state","type":"BarChartSeriesStateOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: BarChartSeriesStateOptions."},{"name":"seriesActiveTrigger","attribute":"series-active-trigger","type":"BarChartSeriesActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"'hover'","description":"Allowed values: hover, click, custom. Default: 'hover'."},{"name":"values","attribute":"values","type":"BarChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Values for a single list."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"600","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"300","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"thickness","attribute":"thickness","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"barPadding","attribute":"bar-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesPadding","attribute":"series-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Value the bars grow from. Always explicit (default `0`) so the start point is never ambiguous — set to a non-zero anchor when the chart measures variance against something other than zero."},{"name":"stacking","attribute":"stacking","type":"CartesianSeriesStackingMode","kind":"string","values":["normal","percent"],"default":"undefined","description":"Allowed values: normal, percent. Default: undefined."},{"name":"borderRadius","attribute":"border-radius","type":"CartesianSeriesCornerRadiusValue","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue."},{"name":"borderScope","attribute":"border-scope","type":"BarBorderScope","kind":"string","values":["point","stack","outline"],"default":"'stack'","description":"Allowed values: point, stack, outline. Default: 'stack'."},{"name":"borderColor","attribute":"border-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"borderWidth","attribute":"border-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"borderDashStyle","attribute":"border-dash-style","type":"CartesianSeriesBorderDashStyle","kind":"string","values":["Solid","Dash","Dot","DashDot","LongDash","LongDashDot"],"default":"undefined","description":"Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined."},{"name":"inactiveOtherPoints","attribute":"inactive-other-points","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactivePointOpacity","attribute":"inactive-point-opacity","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"engine","attribute":"engine","type":"BarChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"BarChartUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"BarChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"200","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"BarChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"BarChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"BarChartLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"seriesName","attribute":"series-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"Allowed values: start, center, end. Default: 'end'."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"Allowed values: top, bottom, middle. Default: 'top'."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"A linear axis defining the value range."},{"name":"yAxis","attribute":"y-axis","type":"CartesianYAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Use categories for the horizontal bars' category names."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes (bar: x = the value axis, y = the category rows); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"name":"brush","attribute":"brush","type":"CartesianBrushInput","kind":"property","values":["auto","off","true","false","rect","lasso"],"default":"undefined","description":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"name":"drawings","attribute":"drawings","type":"ChartDrawingsInput","kind":"property","values":[],"default":"undefined","description":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"name":"drawingMode","attribute":"drawing-mode","type":"DrawingModeInput","kind":"property","values":["none","off","true","false","draw","select"],"default":"undefined","description":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"name":"drawingTool","attribute":"drawing-tool","type":"string","kind":"string","values":[],"default":"undefined","description":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"name":"drawingSpace","attribute":"drawing-space","type":"DrawingSpace","kind":"string","values":["data","pixel"],"default":"undefined","description":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<BarChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<BarChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendPoint","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<BarChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: BarChartEasing; enabled?: boolean; type?: BarChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"addSeries","parameters":[{"name":"options","type":"BarChartSeries","optional":false},{"name":"opts","type":"{ redraw?: boolean; insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<BarChartSeries>","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setSeriesData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"data","type":"BarChartValues","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addPoint","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"point","type":"number","optional":false},{"name":"opts","type":"{ shift?: boolean; redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showSeries","parameters":[{"name":"id","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"id","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showTooltipAtPoint","parameters":[{"name":"pointIndex","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"showCrosshairAt","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDrawings","parameters":[],"returns":"Promise<ChartDrawing[]>","description":"the drawings of the document (data-space anchors)."},{"name":"setDrawings","parameters":[{"name":"drawings","type":"ReadonlyArray<ChartDrawingInput> | null","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"name":"addDrawing","parameters":[{"name":"drawing","type":"ChartDrawingInput","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"name":"updateDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"patch","type":"Partial<Omit<ChartDrawing, 'id'>>","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"name":"removeDrawing","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"remove one drawing."},{"name":"removeDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string>","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"name":"setDrawingSpace","parameters":[{"name":"id","type":"string","optional":false},{"name":"space","type":"DrawingSpace","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"name":"clearDrawings","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"clear the document (undoable)."},{"name":"undoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"undo the last document change; null when there is nothing to undo."},{"name":"redoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"redo the last undone change; null when there is nothing to redo."},{"name":"getDrawingLayer","parameters":[],"returns":"Promise<DrawingLayerSnapshot | null>","description":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"name":"exportDrawings","parameters":[],"returns":"Promise<string>","description":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"name":"importDrawings","parameters":[{"name":"input","type":"ChartDrawingsInput","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"name":"selectDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string> | null","optional":false}],"returns":"Promise<DrawingSelectionChangeEventDetail | null>","description":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"name":"getDrawingSelection","parameters":[],"returns":"Promise<string[]>","description":"the selected drawing ids."},{"name":"setBrush","parameters":[{"name":"areas","type":"ReadonlyArray<CartesianBrushAreaInput> | null","optional":false}],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"name":"clearBrush","parameters":[],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"clear the brush areas (`brushChange` with source 'clear')."},{"name":"getBrush","parameters":[],"returns":"Promise<CartesianBrushArea[]>","description":"the persisted brush areas (primary data space)."},{"name":"getBrushSelection","parameters":[],"returns":"Promise<CartesianBrushSelectedSeries[]>","description":"the points inside the brush areas, against the current layout."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"hitTestBar","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ pointIndex: number; seriesIndex: number } | null>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rendered","type":"BarChartRenderResult & { tier: BarChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"name":"brushChange","type":"CartesianBrushChangeEventDetail","description":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"name":"brushStart","type":"CartesianBrushStartEventDetail","description":"a brush drag opened up (once per gesture)."},{"name":"brushMove","type":"CartesianBrushMoveEventDetail","description":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"name":"brushEnd","type":"CartesianBrushEndEventDetail","description":"the drag released (after `brushChange`), or was cancelled."},{"name":"drawingsChange","type":"DrawingsChangeEventDetail","description":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"name":"drawingSelectionChange","type":"DrawingSelectionChangeEventDetail","description":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"name":"pointHover","type":"CartesianPointEventDetail | null","description":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"name":"pointClick","type":"CartesianPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<CartesianPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"BarChartLegendItemEventDetail","description":"CustomEvent.detail type: BarChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"BarChartSeriesToggledEventDetail","description":"CustomEvent.detail type: BarChartSeriesToggledEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-bar-chart","blocks":[{"kind":"paragraph","text":"Use for long category names or ranked lists."},{"kind":"paragraph","text":"Keep units consistent and choose the order deliberately. Differences are read through length regardless of orientation."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`series`","The values array for each comparison group."],["`values`","Values for a single list."],["`xAxis`","A linear axis defining the value range."],["`yAxis`","Use categories for the horizontal bars' category names."]]},{"kind":"links","items":[{"path":"/charts/bar","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-bar-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-bar-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"series\": [\n          {\n            \"name\": \"Online\",\n            \"values\": [24, 29, 27, 38, 43, 40],\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"name\": \"Store\",\n            \"values\": [15, 19, 17, 24, 22, 29],\n            \"color\": \"#239c91\"\n          }\n        ],\n        \"xAxis\": {\n          \"kind\": \"linear\",\n          \"min\": 0\n        },\n        \"yAxis\": {\n          \"kind\": \"category\",\n          \"categories\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\"]\n        },\n        \"legend\": true,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'bar example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-series","title":"series","blocks":[{"kind":"paragraph","text":"The values array for each comparison group."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BarChartSeries[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BarChartSeries","title":"BarChartSeries","description":"Type definition"}]}]},{"id":"property-activeSeriesIndex","title":"activeSeriesIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSeriesIndex`"],["HTML attribute","`active-series-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-seriesState","title":"seriesState","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: BarChartSeriesStateOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesState`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BarChartSeriesStateOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BarChartSeriesStateOptions","title":"BarChartSeriesStateOptions","description":"Type definition"}]}]},{"id":"property-seriesActiveTrigger","title":"seriesActiveTrigger","blocks":[{"kind":"paragraph","text":"Allowed values: hover, click, custom. Default: 'hover'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesActiveTrigger`"],["HTML attribute","`series-active-trigger`"],["Type","`BarChartSeriesActiveTrigger`"],["Default","`'hover'`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"links","items":[{"path":"/docs/types/BarChartSeriesActiveTrigger","title":"BarChartSeriesActiveTrigger","description":"Type definition"}]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Values for a single list."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BarChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/BarChartValues","title":"BarChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-thickness","title":"thickness","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`thickness`"],["HTML attribute","`thickness`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-barPadding","title":"barPadding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barPadding`"],["HTML attribute","`bar-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-seriesPadding","title":"seriesPadding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesPadding`"],["HTML attribute","`series-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Value the bars grow from. Always explicit (default `0`) so the start point is never ambiguous — set to a non-zero anchor when the chart measures variance against something other than zero."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-stacking","title":"stacking","blocks":[{"kind":"paragraph","text":"Allowed values: normal, percent. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stacking`"],["HTML attribute","`stacking`"],["Type","`CartesianSeriesStackingMode`"],["Default","`undefined`"],["Allowed values","`normal`, `percent`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesStackingMode","title":"CartesianSeriesStackingMode","description":"Type definition"}]}]},{"id":"property-borderRadius","title":"borderRadius","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianSeriesCornerRadiusValue."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderRadius`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianSeriesCornerRadiusValue`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesCornerRadiusValue","title":"CartesianSeriesCornerRadiusValue","description":"Type definition"}]}]},{"id":"property-borderScope","title":"borderScope","blocks":[{"kind":"paragraph","text":"Allowed values: point, stack, outline. Default: 'stack'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderScope`"],["HTML attribute","`border-scope`"],["Type","`BarBorderScope`"],["Default","`'stack'`"],["Allowed values","`point`, `stack`, `outline`"]]},{"kind":"links","items":[{"path":"/docs/types/BarBorderScope","title":"BarBorderScope","description":"Type definition"}]}]},{"id":"property-borderColor","title":"borderColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderColor`"],["HTML attribute","`border-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-borderWidth","title":"borderWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderWidth`"],["HTML attribute","`border-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-borderDashStyle","title":"borderDashStyle","blocks":[{"kind":"paragraph","text":"Allowed values: Solid, Dash, Dot, DashDot, LongDash, LongDashDot. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderDashStyle`"],["HTML attribute","`border-dash-style`"],["Type","`CartesianSeriesBorderDashStyle`"],["Default","`undefined`"],["Allowed values","`Solid`, `Dash`, `Dot`, `DashDot`, `LongDash`, `LongDashDot`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBorderDashStyle","title":"CartesianSeriesBorderDashStyle","description":"Type definition"}]}]},{"id":"property-inactiveOtherPoints","title":"inactiveOtherPoints","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherPoints`"],["HTML attribute","`inactive-other-points`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactivePointOpacity","title":"inactivePointOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactivePointOpacity`"],["HTML attribute","`inactive-point-opacity`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`BarChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/BarChartEngineMode","title":"BarChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`BarChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/BarChartUnavailableBehaviour","title":"BarChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BarChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BarChartStreamSource","title":"BarChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`200`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`BarChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/BarChartEasing","title":"BarChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`BarChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BarChartAnimationType","title":"BarChartAnimationType","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`BarChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/BarChartLegendPosition","title":"BarChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-seriesName","title":"seriesName","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesName`"],["HTML attribute","`series-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"Allowed values: start, center, end. Default: 'end'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"Allowed values: top, bottom, middle. Default: 'top'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"A linear axis defining the value range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Use categories for the horizontal bars' category names."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianYAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes (bar: x = the value axis, y = the category rows); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-brush","title":"brush","blocks":[{"kind":"paragraph","text":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianBrushInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `rect`, `lasso`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","description":"Type definition"}]}]},{"id":"property-drawings","title":"drawings","blocks":[{"kind":"paragraph","text":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartDrawingsInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"property-drawingMode","title":"drawingMode","blocks":[{"kind":"paragraph","text":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingMode`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DrawingModeInput`"],["Default","`undefined`"],["Literals in the type","`none`, `off`, `true`, `false`, `draw`, `select`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","description":"Type definition"}]}]},{"id":"property-drawingTool","title":"drawingTool","blocks":[{"kind":"paragraph","text":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingTool`"],["HTML attribute","`drawing-tool`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-drawingSpace","title":"drawingSpace","blocks":[{"kind":"paragraph","text":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingSpace`"],["HTML attribute","`drawing-space`"],["Type","`DrawingSpace`"],["Default","`undefined`"],["Allowed values","`data`, `pixel`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BarChartRenderResult & { tier: BarChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // BarChartRenderResult & { tier: BarChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BarChartRenderResult","title":"BarChartRenderResult","description":"Type definition"},{"path":"/docs/types/BarChartEngineTier","title":"BarChartEngineTier","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushChange","title":"brushChange","blocks":[{"kind":"paragraph","text":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"kind":"paragraph","text":"Event name: `brushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushChange', event => {\n  console.log(event.detail); // CartesianBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushStart","title":"brushStart","blocks":[{"kind":"paragraph","text":"a brush drag opened up (once per gesture)."},{"kind":"paragraph","text":"Event name: `brushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushStartEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushStart', event => {\n  console.log(event.detail); // CartesianBrushStartEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","description":"Type definition"}]}]},{"id":"event-brushMove","title":"brushMove","blocks":[{"kind":"paragraph","text":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"kind":"paragraph","text":"Event name: `brushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushMoveEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushMove', event => {\n  console.log(event.detail); // CartesianBrushMoveEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","description":"Type definition"}]}]},{"id":"event-brushEnd","title":"brushEnd","blocks":[{"kind":"paragraph","text":"the drag released (after `brushChange`), or was cancelled."},{"kind":"paragraph","text":"Event name: `brushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushEndEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushEnd', event => {\n  console.log(event.detail); // CartesianBrushEndEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","description":"Type definition"}]}]},{"id":"event-drawingsChange","title":"drawingsChange","blocks":[{"kind":"paragraph","text":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"kind":"paragraph","text":"Event name: `drawingsChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingsChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingsChange', event => {\n  console.log(event.detail); // DrawingsChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drawingSelectionChange","title":"drawingSelectionChange","blocks":[{"kind":"paragraph","text":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"kind":"paragraph","text":"Event name: `drawingSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingSelectionChange', event => {\n  console.log(event.detail); // DrawingSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // CartesianPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // CartesianPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<CartesianPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<CartesianPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: BarChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BarChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // BarChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BarChartLegendItemEventDetail","title":"BarChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: BarChartSeriesToggledEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BarChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // BarChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BarChartSeriesToggledEventDetail","title":"BarChartSeriesToggledEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<BarChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BarChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BarChartRenderResult","title":"BarChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<BarChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BarChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BarChartEngineTier","title":"BarChartEngineTier","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(values: ReadonlyArray<number> | Float32Array): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number> | Float32Array`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<BarChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BarChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BarChartStreamSource","title":"BarChartStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: BarChartEasing; enabled?: boolean; type?: BarChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: BarChartEasing; enabled?: boolean; type?: BarChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BarChartEasing","title":"BarChartEasing","description":"Type definition"},{"path":"/docs/types/BarChartAnimationType","title":"BarChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-addSeries","title":"addSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSeries(options: BarChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`BarChartSeries`","Required"],["`opts`","`{ redraw?: boolean; insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BarChartSeries","title":"BarChartSeries","description":"Type definition"}]}]},{"id":"method-removeSeries","title":"removeSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSeries","title":"updateSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<BarChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<BarChartSeries>`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BarChartSeries","title":"BarChartSeries","description":"Type definition"}]}]},{"id":"method-setSeriesData","title":"setSeriesData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setSeriesData(idOrIndex: string | number, data: BarChartValues, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`data`","`BarChartValues`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BarChartValues","title":"BarChartValues","description":"Type definition"}]}]},{"id":"method-addPoint","title":"addPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addPoint(idOrIndex: string | number, point: number, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`point`","`number`","Required"],["`opts`","`{ shift?: boolean; redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(pointIndex: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pointIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDrawings","title":"getDrawings","blocks":[{"kind":"paragraph","text":"the drawings of the document (data-space anchors)."},{"kind":"code","source":"getDrawings(): Promise<ChartDrawing[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-setDrawings","title":"setDrawings","blocks":[{"kind":"paragraph","text":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"kind":"code","source":"setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawings`","`ReadonlyArray<ChartDrawingInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-addDrawing","title":"addDrawing","blocks":[{"kind":"paragraph","text":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"kind":"code","source":"addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawing`","`ChartDrawingInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-updateDrawing","title":"updateDrawing","blocks":[{"kind":"paragraph","text":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"kind":"code","source":"updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`patch`","`Partial<Omit<ChartDrawing, 'id'>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-removeDrawing","title":"removeDrawing","blocks":[{"kind":"paragraph","text":"remove one drawing."},{"kind":"code","source":"removeDrawing(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-removeDrawings","title":"removeDrawings","blocks":[{"kind":"paragraph","text":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"kind":"code","source":"removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-setDrawingSpace","title":"setDrawingSpace","blocks":[{"kind":"paragraph","text":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"kind":"code","source":"setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`space`","`DrawingSpace`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"method-clearDrawings","title":"clearDrawings","blocks":[{"kind":"paragraph","text":"clear the document (undoable)."},{"kind":"code","source":"clearDrawings(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-undoDrawing","title":"undoDrawing","blocks":[{"kind":"paragraph","text":"undo the last document change; null when there is nothing to undo."},{"kind":"code","source":"undoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-redoDrawing","title":"redoDrawing","blocks":[{"kind":"paragraph","text":"redo the last undone change; null when there is nothing to redo."},{"kind":"code","source":"redoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingLayer","title":"getDrawingLayer","blocks":[{"kind":"paragraph","text":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"kind":"code","source":"getDrawingLayer(): Promise<DrawingLayerSnapshot | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingLayerSnapshot | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","description":"Type definition"}]}]},{"id":"method-exportDrawings","title":"exportDrawings","blocks":[{"kind":"paragraph","text":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"kind":"code","source":"exportDrawings(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-importDrawings","title":"importDrawings","blocks":[{"kind":"paragraph","text":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"kind":"code","source":"importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`ChartDrawingsInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"method-selectDrawings","title":"selectDrawings","blocks":[{"kind":"paragraph","text":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"kind":"code","source":"selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingSelectionChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingSelection","title":"getDrawingSelection","blocks":[{"kind":"paragraph","text":"the selected drawing ids."},{"kind":"code","source":"getDrawingSelection(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setBrush","title":"setBrush","blocks":[{"kind":"paragraph","text":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"kind":"code","source":"setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`areas`","`ReadonlyArray<CartesianBrushAreaInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","description":"Type definition"}]}]},{"id":"method-clearBrush","title":"clearBrush","blocks":[{"kind":"paragraph","text":"clear the brush areas (`brushChange` with source 'clear')."},{"kind":"code","source":"clearBrush(): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getBrush","title":"getBrush","blocks":[{"kind":"paragraph","text":"the persisted brush areas (primary data space)."},{"kind":"code","source":"getBrush(): Promise<CartesianBrushArea[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushArea[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":"Type definition"}]}]},{"id":"method-getBrushSelection","title":"getBrushSelection","blocks":[{"kind":"paragraph","text":"the points inside the brush areas, against the current layout."},{"kind":"code","source":"getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushSelectedSeries[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestBar","title":"hitTestBar","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hitTestBar(cssX: number, cssY: number): Promise<{ pointIndex: number; seriesIndex: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ pointIndex: number; seriesIndex: number } | null>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/pie","title":"Pie","summary":"Show the proportions that make up a whole.","kind":"component","tag":"sy-pie-chart","componentId":"pie","api":{"props":[{"name":"values","attribute":"values","type":"PieChartValues","kind":"property","values":[],"default":"[]","description":"An array of { name, value, color? }. Positive values determine the angles."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"480","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"palette","attribute":"palette","type":"PieChartPaletteName","kind":"string","values":["tableau10","tableau20","observable10","paired12","set3_12"],"default":"'tableau10'","description":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"name":"borderColor","attribute":"border-color","type":"string","kind":"string","values":[],"default":"'#ffffff'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"borderWidth","attribute":"border-width","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"slicedOffset","attribute":"sliced-offset","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"innerSize","attribute":"inner-size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"The donut's inner radius ratio."},{"name":"size","attribute":"size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerX","attribute":"center-x","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerY","attribute":"center-y","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"minSize","attribute":"min-size","type":"number","kind":"number","values":[],"default":"80","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"thickness","attribute":"thickness","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"startAngle","attribute":"start-angle","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"endAngle","attribute":"end-angle","type":"number","kind":"number","values":[],"default":"360","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"variableRadius","attribute":"variable-radius","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Variable-radius mode (Highcharts variablepie). Each datum's `z` maps to the slice's outer radius between `min-point-size` and `max-point-size` while `value` keeps owning the angular sweep. Data without any finite `z` renders as a uniform pie even when this is on."},{"name":"sizeBy","attribute":"size-by","type":"PieChartSizeBy","kind":"string","values":["area","radius"],"default":"'area'","description":"`'area'` (default) scales slice AREA linearly with z (radius ∝ √z̄); `'radius'` scales the radius linearly."},{"name":"zMin","attribute":"z-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Lower z-domain bound. Defaults to the data minimum; smaller z clamp to the minimum radius."},{"name":"zMax","attribute":"z-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Upper z-domain bound. Defaults to the data maximum; larger z clamp to the maximum radius."},{"name":"minPointSize","attribute":"min-point-size","type":"number | string","kind":"property","values":[],"default":"'10%'","description":"Smallest slice outer DIAMETER — px number or `'%'` of the full outer diameter (Highcharts minPointSize)."},{"name":"maxPointSize","attribute":"max-point-size","type":"number | string","kind":"property","values":[],"default":"'100%'","description":"Largest slice outer DIAMETER — px number or `'%'` of the full outer diameter (Highcharts maxPointSize)."},{"name":"centerText","attribute":"center-text","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"centerSubtext","attribute":"center-subtext","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"PieChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"labelsMode","attribute":"labels-mode","type":"PieChartLabelMode","kind":"string","values":["none","auto","inside","outside"],"default":"'none'","description":"Allowed values: none, auto, inside, outside. Default: 'none'."},{"name":"labelsContent","attribute":"labels-content","type":"PieChartLabelContent","kind":"property","values":["percent","value","name","name-percent","name-value"],"default":"'name-percent'","description":"Choose names, values, or percentages for labels."},{"name":"labelsDistance","attribute":"labels-distance","type":"number","kind":"number","values":[],"default":"24","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"labelsFontSize","attribute":"labels-font-size","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"labelsFontWeight","attribute":"labels-font-weight","type":"number","kind":"number","values":[],"default":"500","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"labelsColor","attribute":"labels-color","type":"string","kind":"string","values":[],"default":"'#1f2937'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"labelsMinSweep","attribute":"labels-min-sweep","type":"number","kind":"number","values":[],"default":"0.02","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"labelsConnector","attribute":"labels-connector","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"labelsConnectorColor","attribute":"labels-connector-color","type":"string","kind":"string","values":[],"default":"'#9ca3af'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"labelsConnectorWidth","attribute":"labels-connector-width","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"labelsConnectorPadding","attribute":"labels-connector-padding","type":"number","kind":"number","values":[],"default":"5","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"labelsConnectorShape","attribute":"labels-connector-shape","type":"'crooked' | 'straight'","kind":"string","values":["straight","crooked"],"default":"'crooked'","description":"Allowed values: straight, crooked. Default: 'crooked'."},{"name":"labelsAllowOverlap","attribute":"labels-allow-overlap","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(slice: PieChartResolvedSlice) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (slice: PieChartResolvedSlice) => string."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"stickyTracking","attribute":"sticky-tracking","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"PieChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration object — the slice-flavoured counterpart to the cartesian `.tooltip` API. Enables `trigger` (hover/click/hover-click), `openMode` (single/multiple pinned), `connector`, `draggable`, `interactive` action buttons, custom `format`/`html`/`style`/`className`/`side` and fixed sizing. When set it takes precedence over the flat `tooltip-show` / `tooltipFormat` props (which stay for back-compat). Property-only — assign the object, not an attribute."},{"name":"allowSelect","attribute":"allow-select","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactiveOtherSlices","attribute":"inactive-other-slices","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactiveSliceOpacity","attribute":"inactive-slice-opacity","type":"number","kind":"number","values":[],"default":"0.45","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"activeSliceIndex","attribute":"active-slice-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"engine","attribute":"engine","type":"PieChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"PieChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"PieChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"PieChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"PieChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<PieChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<PieChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addSlice","parameters":[{"name":"datum","type":"PieChartDatum","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<Exclude<PieChartDatum, number>>","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setSliceData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"value","type":"number","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendPoint","parameters":[{"name":"datum","type":"PieChartDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"datums","type":"ReadonlyArray<PieChartDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"datums","type":"ReadonlyArray<PieChartDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<PieChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: PieChartEasing; enabled?: boolean; type?: PieChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep-from-zero reveal. No-op when animation is off."},{"name":"selectSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"selected","type":"boolean","optional":true}],"returns":"Promise<boolean>","description":"Pie-only — select a slice by id or index."},{"name":"deselectSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Pie-only — clear selection on a slice."},{"name":"getSelectedSlices","parameters":[],"returns":"Promise<string[]>","description":"Pie-only — read the current selection set."},{"name":"hitTestSlice","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ sliceIndex: number; sliceId: string } | null>","description":"Pie-only — hit-test slice at canvas-relative coordinates."},{"name":"showTooltipAtSlice","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<PieChartSliceEventDetail | null>","description":"Pie-only — programmatic tooltip open."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"PieChartRenderResult & { tier: PieChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"sliceClick","type":"PieChartSliceEventDetail","description":"CustomEvent.detail type: PieChartSliceEventDetail. Event names are case-sensitive."},{"name":"sliceHover","type":"PieChartSliceEventDetail | null","description":"CustomEvent.detail type: PieChartSliceEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<PieChartSliceEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<PieChartSliceEventDetail>. Event names are case-sensitive."},{"name":"sliceSelected","type":"PieChartSelectedEventDetail","description":"CustomEvent.detail type: PieChartSelectedEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"{ index: number; sliceId: string; label: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sliceId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"name":"sliceToggled","type":"{ index: number; sliceId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sliceId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"PieChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"PieChartTooltipActionEventDetail","description":"CustomEvent.detail type: PieChartTooltipActionEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-pie-chart","blocks":[{"kind":"paragraph","text":"Use when the total is meaningful and there are few categories."},{"kind":"paragraph","text":"Not suitable for negative values or overlapping categories. Use bars for precise comparisons between similar values."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","An array of { name, value, color? }. Positive values determine the angles."],["`innerSize`","The donut's inner radius ratio."],["`labelsContent`","Choose names, values, or percentages for labels."]]},{"kind":"links","items":[{"path":"/charts/pie","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-pie-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-pie-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [\n          {\n            \"name\": \"Product A\",\n            \"value\": 42,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"name\": \"Product B\",\n            \"value\": 28,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"name\": \"Product C\",\n            \"value\": 18,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"name\": \"Other\",\n            \"value\": 12,\n            \"color\": \"#d76c8f\"\n          }\n        ],\n        \"legend\": true,\n        \"labelsContent\": \"name-percent\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'pie example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('sliceClick', event.detail);\n  };\n  chart.addEventListener('sliceClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('sliceClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"An array of { name, value, color? }. Positive values determine the angles."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PieChartValues`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartValues","title":"PieChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`480`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-palette","title":"palette","blocks":[{"kind":"paragraph","text":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`palette`"],["HTML attribute","`palette`"],["Type","`PieChartPaletteName`"],["Default","`'tableau10'`"],["Allowed values","`tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartPaletteName","title":"PieChartPaletteName","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-borderColor","title":"borderColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderColor`"],["HTML attribute","`border-color`"],["Type","`string`"],["Default","`'#ffffff'`"]]}]},{"id":"property-borderWidth","title":"borderWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderWidth`"],["HTML attribute","`border-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-slicedOffset","title":"slicedOffset","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`slicedOffset`"],["HTML attribute","`sliced-offset`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-innerSize","title":"innerSize","blocks":[{"kind":"paragraph","text":"The donut's inner radius ratio."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`innerSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-size","title":"size","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`size`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerX","title":"centerX","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerX`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerY","title":"centerY","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerY`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-minSize","title":"minSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minSize`"],["HTML attribute","`min-size`"],["Type","`number`"],["Default","`80`"]]}]},{"id":"property-thickness","title":"thickness","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`thickness`"],["HTML attribute","`thickness`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-startAngle","title":"startAngle","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startAngle`"],["HTML attribute","`start-angle`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-endAngle","title":"endAngle","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`endAngle`"],["HTML attribute","`end-angle`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-variableRadius","title":"variableRadius","blocks":[{"kind":"paragraph","text":"Variable-radius mode (Highcharts variablepie). Each datum's `z` maps to the slice's outer radius between `min-point-size` and `max-point-size` while `value` keeps owning the angular sweep. Data without any finite `z` renders as a uniform pie even when this is on."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`variableRadius`"],["HTML attribute","`variable-radius`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-sizeBy","title":"sizeBy","blocks":[{"kind":"paragraph","text":"`'area'` (default) scales slice AREA linearly with z (radius ∝ √z̄); `'radius'` scales the radius linearly."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sizeBy`"],["HTML attribute","`size-by`"],["Type","`PieChartSizeBy`"],["Default","`'area'`"],["Allowed values","`area`, `radius`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartSizeBy","title":"PieChartSizeBy","description":"Type definition"}]}]},{"id":"property-zMin","title":"zMin","blocks":[{"kind":"paragraph","text":"Lower z-domain bound. Defaults to the data minimum; smaller z clamp to the minimum radius."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zMin`"],["HTML attribute","`z-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zMax","title":"zMax","blocks":[{"kind":"paragraph","text":"Upper z-domain bound. Defaults to the data maximum; larger z clamp to the maximum radius."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zMax`"],["HTML attribute","`z-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-minPointSize","title":"minPointSize","blocks":[{"kind":"paragraph","text":"Smallest slice outer DIAMETER — px number or `'%'` of the full outer diameter (Highcharts minPointSize)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minPointSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`'10%'`"]]}]},{"id":"property-maxPointSize","title":"maxPointSize","blocks":[{"kind":"paragraph","text":"Largest slice outer DIAMETER — px number or `'%'` of the full outer diameter (Highcharts maxPointSize)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`maxPointSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`'100%'`"]]}]},{"id":"property-centerText","title":"centerText","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerText`"],["HTML attribute","`center-text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerSubtext","title":"centerSubtext","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerSubtext`"],["HTML attribute","`center-subtext`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`PieChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartLegendPosition","title":"PieChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-labelsMode","title":"labelsMode","blocks":[{"kind":"paragraph","text":"Allowed values: none, auto, inside, outside. Default: 'none'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsMode`"],["HTML attribute","`labels-mode`"],["Type","`PieChartLabelMode`"],["Default","`'none'`"],["Allowed values","`none`, `auto`, `inside`, `outside`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartLabelMode","title":"PieChartLabelMode","description":"Type definition"}]}]},{"id":"property-labelsContent","title":"labelsContent","blocks":[{"kind":"paragraph","text":"Choose names, values, or percentages for labels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsContent`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PieChartLabelContent`"],["Default","`'name-percent'`"],["Literals in the type","`percent`, `value`, `name`, `name-percent`, `name-value`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartLabelContent","title":"PieChartLabelContent","description":"Type definition"}]}]},{"id":"property-labelsDistance","title":"labelsDistance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsDistance`"],["HTML attribute","`labels-distance`"],["Type","`number`"],["Default","`24`"]]}]},{"id":"property-labelsFontSize","title":"labelsFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsFontSize`"],["HTML attribute","`labels-font-size`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-labelsFontWeight","title":"labelsFontWeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsFontWeight`"],["HTML attribute","`labels-font-weight`"],["Type","`number`"],["Default","`500`"]]}]},{"id":"property-labelsColor","title":"labelsColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsColor`"],["HTML attribute","`labels-color`"],["Type","`string`"],["Default","`'#1f2937'`"]]}]},{"id":"property-labelsMinSweep","title":"labelsMinSweep","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsMinSweep`"],["HTML attribute","`labels-min-sweep`"],["Type","`number`"],["Default","`0.02`"]]}]},{"id":"property-labelsConnector","title":"labelsConnector","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnector`"],["HTML attribute","`labels-connector`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-labelsConnectorColor","title":"labelsConnectorColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorColor`"],["HTML attribute","`labels-connector-color`"],["Type","`string`"],["Default","`'#9ca3af'`"]]}]},{"id":"property-labelsConnectorWidth","title":"labelsConnectorWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorWidth`"],["HTML attribute","`labels-connector-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-labelsConnectorPadding","title":"labelsConnectorPadding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorPadding`"],["HTML attribute","`labels-connector-padding`"],["Type","`number`"],["Default","`5`"]]}]},{"id":"property-labelsConnectorShape","title":"labelsConnectorShape","blocks":[{"kind":"paragraph","text":"Allowed values: straight, crooked. Default: 'crooked'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsConnectorShape`"],["HTML attribute","`labels-connector-shape`"],["Type","`'crooked' | 'straight'`"],["Default","`'crooked'`"],["Allowed values","`straight`, `crooked`"]]}]},{"id":"property-labelsAllowOverlap","title":"labelsAllowOverlap","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelsAllowOverlap`"],["HTML attribute","`labels-allow-overlap`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (slice: PieChartResolvedSlice) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(slice: PieChartResolvedSlice) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartResolvedSlice","title":"PieChartResolvedSlice","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-stickyTracking","title":"stickyTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stickyTracking`"],["HTML attribute","`sticky-tracking`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration object — the slice-flavoured counterpart to the cartesian `.tooltip` API. Enables `trigger` (hover/click/hover-click), `openMode` (single/multiple pinned), `connector`, `draggable`, `interactive` action buttons, custom `format`/`html`/`style`/`className`/`side` and fixed sizing. When set it takes precedence over the flat `tooltip-show` / `tooltipFormat` props (which stay for back-compat). Property-only — assign the object, not an attribute."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PieChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipInput","title":"PieChartTooltipInput","description":"Type definition"}]}]},{"id":"property-allowSelect","title":"allowSelect","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`allowSelect`"],["HTML attribute","`allow-select`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-inactiveOtherSlices","title":"inactiveOtherSlices","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherSlices`"],["HTML attribute","`inactive-other-slices`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactiveSliceOpacity","title":"inactiveSliceOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveSliceOpacity`"],["HTML attribute","`inactive-slice-opacity`"],["Type","`number`"],["Default","`0.45`"]]}]},{"id":"property-activeSliceIndex","title":"activeSliceIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSliceIndex`"],["HTML attribute","`active-slice-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`PieChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartEngineMode","title":"PieChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`PieChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartUnavailableBehaviour","title":"PieChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PieChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartStreamSource","title":"PieChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`PieChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/PieChartEasing","title":"PieChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`PieChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PieChartAnimationType","title":"PieChartAnimationType","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartRenderResult & { tier: PieChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // PieChartRenderResult & { tier: PieChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartRenderResult","title":"PieChartRenderResult","description":"Type definition"},{"path":"/docs/types/PieChartEngineTier","title":"PieChartEngineTier","description":"Type definition"}]}]},{"id":"event-sliceClick","title":"sliceClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: PieChartSliceEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sliceClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartSliceEventDetail>`."},{"kind":"code","source":"chart.addEventListener('sliceClick', event => {\n  console.log(event.detail); // PieChartSliceEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":"Type definition"}]}]},{"id":"event-sliceHover","title":"sliceHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: PieChartSliceEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sliceHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartSliceEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('sliceHover', event => {\n  console.log(event.detail); // PieChartSliceEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<PieChartSliceEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<PieChartSliceEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<PieChartSliceEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":"Type definition"}]}]},{"id":"event-sliceSelected","title":"sliceSelected","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: PieChartSelectedEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sliceSelected`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartSelectedEventDetail>`."},{"kind":"code","source":"chart.addEventListener('sliceSelected', event => {\n  console.log(event.detail); // PieChartSelectedEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartSelectedEventDetail","title":"PieChartSelectedEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; sliceId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sliceId: string; label: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // { index: number; sliceId: string; label: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-sliceToggled","title":"sliceToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; sliceId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sliceToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sliceId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('sliceToggled', event => {\n  console.log(event.detail); // { index: number; sliceId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // PieChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipShowEventDetail","title":"PieChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: PieChartTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PieChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // PieChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipActionEventDetail","title":"PieChartTooltipActionEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<PieChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PieChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartRenderResult","title":"PieChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<PieChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PieChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartEngineTier","title":"PieChartEngineTier","description":"Type definition"}]}]},{"id":"method-addSlice","title":"addSlice","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSlice(datum: PieChartDatum, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`PieChartDatum`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"}]}]},{"id":"method-removeSlice","title":"removeSlice","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSlice(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSlice","title":"updateSlice","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSlice(idOrIndex: string | number, patch: Partial<Exclude<PieChartDatum, number>>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<Exclude<PieChartDatum, number>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"}]}]},{"id":"method-setSliceData","title":"setSliceData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setSliceData(idOrIndex: string | number, value: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: PieChartDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`PieChartDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(datums: ReadonlyArray<PieChartDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<PieChartDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(datums: ReadonlyArray<PieChartDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<PieChartDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<PieChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PieChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartStreamSource","title":"PieChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: PieChartEasing; enabled?: boolean; type?: PieChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: PieChartEasing; enabled?: boolean; type?: PieChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartEasing","title":"PieChartEasing","description":"Type definition"},{"path":"/docs/types/PieChartAnimationType","title":"PieChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep-from-zero reveal. No-op when animation is off."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-selectSlice","title":"selectSlice","blocks":[{"kind":"paragraph","text":"Pie-only — select a slice by id or index."},{"kind":"code","source":"selectSlice(idOrIndex: string | number, selected?: boolean): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`selected`","`boolean`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-deselectSlice","title":"deselectSlice","blocks":[{"kind":"paragraph","text":"Pie-only — clear selection on a slice."},{"kind":"code","source":"deselectSlice(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelectedSlices","title":"getSelectedSlices","blocks":[{"kind":"paragraph","text":"Pie-only — read the current selection set."},{"kind":"code","source":"getSelectedSlices(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestSlice","title":"hitTestSlice","blocks":[{"kind":"paragraph","text":"Pie-only — hit-test slice at canvas-relative coordinates."},{"kind":"code","source":"hitTestSlice(cssX: number, cssY: number): Promise<{ sliceIndex: number; sliceId: string } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ sliceIndex: number; sliceId: string } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtSlice","title":"showTooltipAtSlice","blocks":[{"kind":"paragraph","text":"Pie-only — programmatic tooltip open."},{"kind":"code","source":"showTooltipAtSlice(idOrIndex: string | number): Promise<PieChartSliceEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<PieChartSliceEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/scatter","title":"Scatter","summary":"Show relationships between two continuous variables as individual points.","kind":"component","tag":"sy-scatter-chart","componentId":"scatter","api":{"props":[{"name":"series","attribute":"series","type":"ScatterChartSeries[]","kind":"property","values":[],"default":"undefined","description":"Set values, name, and color for each group."},{"name":"activeSeriesIndex","attribute":"active-series-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesState","attribute":"series-state","type":"ScatterChartSeriesStateOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ScatterChartSeriesStateOptions."},{"name":"seriesActiveTrigger","attribute":"series-active-trigger","type":"ScatterChartSeriesActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"'hover'","description":"Allowed values: hover, click, custom. Default: 'hover'."},{"name":"values","attribute":"values","type":"ScatterChartValues","kind":"property","values":[],"default":"[]","description":"An array of [x, y] or { x, y }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"600","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"marker","attribute":"marker","type":"ScatterChartMarkerSymbol","kind":"string","values":["circle","square","triangle","cross","diamond","star","triangle-down","wye"],"default":"'circle'","description":"Allowed values: circle, square, triangle, cross, diamond, star, triangle-down, wye. Default: 'circle'."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"4","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"markerLineWidth","attribute":"marker-line-width","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"inactiveOtherPoints","attribute":"inactive-other-points","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactivePointOpacity","attribute":"inactive-point-opacity","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"hitTolerance","attribute":"hit-tolerance","type":"number","kind":"number","values":[],"default":"8","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"engine","attribute":"engine","type":"ScatterChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"ScatterChartUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"ScatterChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"400","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ScatterChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ScatterChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"ScatterChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"seriesName","attribute":"series-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Use a linear axis for continuous coordinates."},{"name":"yAxis","attribute":"y-axis","type":"CartesianYAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"name":"brush","attribute":"brush","type":"CartesianBrushInput","kind":"property","values":["auto","off","true","false","rect","lasso"],"default":"undefined","description":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"name":"drawings","attribute":"drawings","type":"ChartDrawingsInput","kind":"property","values":[],"default":"undefined","description":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"name":"drawingMode","attribute":"drawing-mode","type":"DrawingModeInput","kind":"property","values":["none","off","true","false","draw","select"],"default":"undefined","description":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"name":"drawingTool","attribute":"drawing-tool","type":"string","kind":"string","values":[],"default":"undefined","description":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"name":"drawingSpace","attribute":"drawing-space","type":"DrawingSpace","kind":"string","values":["data","pixel"],"default":"undefined","description":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"name":"progressive","attribute":"progressive","type":"number | boolean","kind":"property","values":[],"default":"undefined","description":"paint a heavy frame in chunks on the Standard engine: false / 0 = off, true = 5,000 points per chunk, a number = points per chunk."},{"name":"progressiveThreshold","attribute":"progressive-threshold","type":"number","kind":"number","values":[],"default":"20000","description":"below this many drawn points the frame paints at once (default 20,000)."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<ScatterChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<ScatterChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addSeries","parameters":[{"name":"options","type":"ScatterChartSeries","optional":false},{"name":"opts","type":"{ redraw?: boolean; insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<ScatterChartSeries>","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setSeriesData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"data","type":"ScatterChartValues","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addPoint","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"point","type":"number | readonly [number, number] | { x?: number; y: number }","optional":false},{"name":"opts","type":"{ shift?: boolean; redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showSeries","parameters":[{"name":"id","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"id","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendPoint","parameters":[{"name":"point","type":"ScatterChartDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"points","type":"ReadonlyArray<unknown>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"points","type":"ReadonlyArray<unknown>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ScatterChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: ScatterChartEasing; enabled?: boolean; type?: ScatterChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"hitTestPoint","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ pointIndex: number; seriesIndex: number } | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showTooltipAtPoint","parameters":[{"name":"pointIndex","type":"number","optional":false},{"name":"seriesIndex","type":"number","optional":true}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"showCrosshairAt","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDrawings","parameters":[],"returns":"Promise<ChartDrawing[]>","description":"the drawings of the document (data-space anchors)."},{"name":"setDrawings","parameters":[{"name":"drawings","type":"ReadonlyArray<ChartDrawingInput> | null","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"name":"addDrawing","parameters":[{"name":"drawing","type":"ChartDrawingInput","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"name":"updateDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"patch","type":"Partial<Omit<ChartDrawing, 'id'>>","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"name":"removeDrawing","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"remove one drawing."},{"name":"removeDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string>","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"name":"setDrawingSpace","parameters":[{"name":"id","type":"string","optional":false},{"name":"space","type":"DrawingSpace","optional":false}],"returns":"Promise<ChartDrawing | null>","description":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"name":"clearDrawings","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"clear the document (undoable)."},{"name":"undoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"undo the last document change; null when there is nothing to undo."},{"name":"redoDrawing","parameters":[],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"redo the last undone change; null when there is nothing to redo."},{"name":"getDrawingLayer","parameters":[],"returns":"Promise<DrawingLayerSnapshot | null>","description":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"name":"exportDrawings","parameters":[],"returns":"Promise<string>","description":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"name":"importDrawings","parameters":[{"name":"input","type":"ChartDrawingsInput","optional":false}],"returns":"Promise<DrawingsChangeEventDetail | null>","description":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"name":"selectDrawings","parameters":[{"name":"ids","type":"ReadonlyArray<string> | null","optional":false}],"returns":"Promise<DrawingSelectionChangeEventDetail | null>","description":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"name":"getDrawingSelection","parameters":[],"returns":"Promise<string[]>","description":"the selected drawing ids."},{"name":"setBrush","parameters":[{"name":"areas","type":"ReadonlyArray<CartesianBrushAreaInput> | null","optional":false}],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"name":"clearBrush","parameters":[],"returns":"Promise<CartesianBrushChangeEventDetail | null>","description":"clear the brush areas (`brushChange` with source 'clear')."},{"name":"getBrush","parameters":[],"returns":"Promise<CartesianBrushArea[]>","description":"the persisted brush areas (primary data space)."},{"name":"getBrushSelection","parameters":[],"returns":"Promise<CartesianBrushSelectedSeries[]>","description":"the points inside the brush areas, against the current layout."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."}],"events":[{"name":"rendered","type":"ScatterChartRenderResult & { tier: ScatterChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"name":"brushChange","type":"CartesianBrushChangeEventDetail","description":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"name":"brushStart","type":"CartesianBrushStartEventDetail","description":"a brush drag opened up (once per gesture)."},{"name":"brushMove","type":"CartesianBrushMoveEventDetail","description":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"name":"brushEnd","type":"CartesianBrushEndEventDetail","description":"the drag released (after `brushChange`), or was cancelled."},{"name":"drawingsChange","type":"DrawingsChangeEventDetail","description":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"name":"drawingSelectionChange","type":"DrawingSelectionChangeEventDetail","description":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"name":"renderProgress","type":"{ drawn: number; total: number; done: boolean }","description":"after every progressively painted chunk (`drawn` / `total`); `done` on the last one."},{"name":"pointHover","type":"CartesianPointEventDetail | null","description":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"name":"pointClick","type":"CartesianPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<CartesianPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"ScatterChartLegendItemEventDetail","description":"CustomEvent.detail type: ScatterChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"ScatterChartSeriesToggledEventDetail","description":"CustomEvent.detail type: ScatterChartSeriesToggledEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-scatter-chart","blocks":[{"kind":"paragraph","text":"Explore correlation, clusters, and outliers. Use series to distinguish observation groups."},{"kind":"paragraph","text":"A visible relationship does not establish causation. Adjust marker size or sample count to inspect overlapping points."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","An array of [x, y] or { x, y }."],["`series`","Set values, name, and color for each group."],["`xAxis`","Use a linear axis for continuous coordinates."]]},{"kind":"links","items":[{"path":"/charts/scatter","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-scatter-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-scatter-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [\n          {\n            \"x\": 0,\n            \"y\": 7\n          },\n          {\n            \"x\": 16,\n            \"y\": 4\n          },\n          {\n            \"x\": 29,\n            \"y\": -3\n          },\n          {\n            \"x\": 37,\n            \"y\": -7\n          },\n          {\n            \"x\": 44,\n            \"y\": -5\n          },\n          {\n            \"x\": 55,\n            \"y\": 2\n          },\n          {\n            \"x\": -1,\n            \"y\": 17\n          },\n          {\n            \"x\": 15,\n            \"y\": 15\n          },\n          {\n            \"x\": 29,\n            \"y\": 9\n          },\n          {\n            \"x\": 38,\n            \"y\": 4\n          },\n          {\n            \"x\": 45,\n            \"y\": 4\n          },\n          {\n            \"x\": 55,\n            \"y\": 10\n          },\n          {\n            \"x\": -3,\n            \"y\": 26\n          },\n          {\n            \"x\": 14,\n            \"y\": 26\n          },\n          {\n            \"x\": 29,\n            \"y\": 21\n          },\n          {\n            \"x\": 39,\n            \"y\": 15\n          },\n          {\n            \"x\": 47,\n            \"y\": 13\n          },\n          {\n            \"x\": 55,\n            \"y\": 18\n          },\n          {\n            \"x\": -4,\n            \"y\": 35\n          },\n          {\n            \"x\": 13,\n            \"y\": 37\n          },\n          {\n            \"x\": 29,\n            \"y\": 33\n          },\n          {\n            \"x\": 40,\n            \"y\": 26\n          },\n          {\n            \"x\": 48,\n            \"y\": 23\n          },\n          {\n            \"x\": 56,\n            \"y\": 26\n          },\n          {\n            \"x\": -5,\n            \"y\": 43\n          },\n          {\n            \"x\": 11,\n            \"y\": 47\n          },\n          {\n            \"x\": 28,\n            \"y\": 45\n          },\n          {\n            \"x\": 41,\n            \"y\": 38\n          },\n          {\n            \"x\": 49,\n            \"y\": 33\n          },\n          {\n            \"x\": 57,\n            \"y\": 35\n          },\n          {\n            \"x\": -5,\n            \"y\": 51\n          },\n          {\n            \"x\": 10,\n            \"y\": 56\n          },\n          {\n            \"x\": 27,\n            \"y\": 56\n          },\n          {\n            \"x\": 41,\n            \"y\": 50\n          },\n          {\n            \"x\": 51,\n            \"y\": 44\n          },\n          {\n            \"x\": 58,\n            \"y\": 44\n          }\n        ],\n        \"markerSize\": 5,\n        \"xAxis\": {\n          \"kind\": \"linear\"\n        },\n        \"yAxis\": {\n          \"kind\": \"linear\"\n        },\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'scatter example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-series","title":"series","blocks":[{"kind":"paragraph","text":"Set values, name, and color for each group."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ScatterChartSeries[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","description":"Type definition"}]}]},{"id":"property-activeSeriesIndex","title":"activeSeriesIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSeriesIndex`"],["HTML attribute","`active-series-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-seriesState","title":"seriesState","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ScatterChartSeriesStateOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesState`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ScatterChartSeriesStateOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartSeriesStateOptions","title":"ScatterChartSeriesStateOptions","description":"Type definition"}]}]},{"id":"property-seriesActiveTrigger","title":"seriesActiveTrigger","blocks":[{"kind":"paragraph","text":"Allowed values: hover, click, custom. Default: 'hover'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesActiveTrigger`"],["HTML attribute","`series-active-trigger`"],["Type","`ScatterChartSeriesActiveTrigger`"],["Default","`'hover'`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"links","items":[{"path":"/docs/types/ScatterChartSeriesActiveTrigger","title":"ScatterChartSeriesActiveTrigger","description":"Type definition"}]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"An array of [x, y] or { x, y }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ScatterChartValues`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"Allowed values: circle, square, triangle, cross, diamond, star, triangle-down, wye. Default: 'circle'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","`marker`"],["Type","`ScatterChartMarkerSymbol`"],["Default","`'circle'`"],["Allowed values","`circle`, `square`, `triangle`, `cross`, `diamond`, `star`, `triangle-down`, `wye`"]]},{"kind":"links","items":[{"path":"/docs/types/ScatterChartMarkerSymbol","title":"ScatterChartMarkerSymbol","description":"Type definition"}]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"property-markerLineWidth","title":"markerLineWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerLineWidth`"],["HTML attribute","`marker-line-width`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-inactiveOtherPoints","title":"inactiveOtherPoints","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherPoints`"],["HTML attribute","`inactive-other-points`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactivePointOpacity","title":"inactivePointOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactivePointOpacity`"],["HTML attribute","`inactive-point-opacity`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-hitTolerance","title":"hitTolerance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`hitTolerance`"],["HTML attribute","`hit-tolerance`"],["Type","`number`"],["Default","`8`"]]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ScatterChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ScatterChartEngineMode","title":"ScatterChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ScatterChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/ScatterChartUnavailableBehaviour","title":"ScatterChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ScatterChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartStreamSource","title":"ScatterChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ScatterChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ScatterChartEasing","title":"ScatterChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ScatterChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartAnimationType","title":"ScatterChartAnimationType","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`ScatterChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/ScatterChartLegendPosition","title":"ScatterChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-seriesName","title":"seriesName","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesName`"],["HTML attribute","`series-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Use a linear axis for continuous coordinates."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianYAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle + keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton`. Off by default. `zoomTo` / `zoomBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-brush","title":"brush","blocks":[{"kind":"paragraph","text":"brush selection: 'rect' | true | { type, mode, modifier, minSizePx, keyboard, clearOnClick }; off by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianBrushInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `rect`, `lasso`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","description":"Type definition"}]}]},{"id":"property-drawings","title":"drawings","blocks":[{"kind":"paragraph","text":"the drawing document: a list of drawings, a serialized envelope, or a JSON string of either (replaces the document; the history restarts)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChartDrawingsInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"property-drawingMode","title":"drawingMode","blocks":[{"kind":"paragraph","text":"the pointer disposition: 'none' (default), 'draw' (the plain drag places `drawingTool`; precedence drawing > brush > zoom > pan), 'select' ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingMode`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DrawingModeInput`"],["Default","`undefined`"],["Literals in the type","`none`, `off`, `true`, `false`, `draw`, `select`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","description":"Type definition"}]}]},{"id":"property-drawingTool","title":"drawingTool","blocks":[{"kind":"paragraph","text":"the tool `drawingMode=\"draw\"` places (a registered tool name; default 'segment')."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingTool`"],["HTML attribute","`drawing-tool`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-drawingSpace","title":"drawingSpace","blocks":[{"kind":"paragraph","text":"the space new drawings are anchored in: 'data' (default — the primary axes) or 'pixel' (offsets from the plot's top-left; they stay put under zoom, pan and data changes)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawingSpace`"],["HTML attribute","`drawing-space`"],["Type","`DrawingSpace`"],["Default","`undefined`"],["Allowed values","`data`, `pixel`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"property-progressive","title":"progressive","blocks":[{"kind":"paragraph","text":"paint a heavy frame in chunks on the Standard engine: false / 0 = off, true = 5,000 points per chunk, a number = points per chunk."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`progressive`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-progressiveThreshold","title":"progressiveThreshold","blocks":[{"kind":"paragraph","text":"below this many drawn points the frame paints at once (default 20,000)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`progressiveThreshold`"],["HTML attribute","`progressive-threshold`"],["Type","`number`"],["Default","`20000`"]]}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"a visual map binding (a `sy-visual-map` snapshot + the data dimension): every mark is coloured through it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ScatterChartRenderResult & { tier: ScatterChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ScatterChartRenderResult & { tier: ScatterChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ScatterChartRenderResult","title":"ScatterChartRenderResult","description":"Type definition"},{"path":"/docs/types/ScatterChartEngineTier","title":"ScatterChartEngineTier","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"fired after every zoom change (drag / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushChange","title":"brushChange","blocks":[{"kind":"paragraph","text":"the brush areas / selection changed (drag, api, clear, keyboard)."},{"kind":"paragraph","text":"Event name: `brushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushChange', event => {\n  console.log(event.detail); // CartesianBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"event-brushStart","title":"brushStart","blocks":[{"kind":"paragraph","text":"a brush drag opened up (once per gesture)."},{"kind":"paragraph","text":"Event name: `brushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushStartEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushStart', event => {\n  console.log(event.detail); // CartesianBrushStartEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","description":"Type definition"}]}]},{"id":"event-brushMove","title":"brushMove","blocks":[{"kind":"paragraph","text":"a live frame of the drag (throttled; the selection only with `liveSelection`)."},{"kind":"paragraph","text":"Event name: `brushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushMoveEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushMove', event => {\n  console.log(event.detail); // CartesianBrushMoveEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","description":"Type definition"}]}]},{"id":"event-brushEnd","title":"brushEnd","blocks":[{"kind":"paragraph","text":"the drag released (after `brushChange`), or was cancelled."},{"kind":"paragraph","text":"Event name: `brushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianBrushEndEventDetail>`."},{"kind":"code","source":"chart.addEventListener('brushEnd', event => {\n  console.log(event.detail); // CartesianBrushEndEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","description":"Type definition"}]}]},{"id":"event-drawingsChange","title":"drawingsChange","blocks":[{"kind":"paragraph","text":"the drawing document changed (a placement, the api, undo / redo, clear, the prop)."},{"kind":"paragraph","text":"Event name: `drawingsChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingsChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingsChange', event => {\n  console.log(event.detail); // DrawingsChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drawingSelectionChange","title":"drawingSelectionChange","blocks":[{"kind":"paragraph","text":"the drawing selection changed (a click, a marquee, the api, Escape, a document change pruning it)."},{"kind":"paragraph","text":"Event name: `drawingSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DrawingSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drawingSelectionChange', event => {\n  console.log(event.detail); // DrawingSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-renderProgress","title":"renderProgress","blocks":[{"kind":"paragraph","text":"after every progressively painted chunk (`drawn` / `total`); `done` on the last one."},{"kind":"paragraph","text":"Event name: `renderProgress`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ drawn: number; total: number; done: boolean }>`."},{"kind":"code","source":"chart.addEventListener('renderProgress', event => {\n  console.log(event.detail); // { drawn: number; total: number; done: boolean }\n});","language":"javascript"}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // CartesianPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // CartesianPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CartesianPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<CartesianPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<CartesianPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ScatterChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ScatterChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // ScatterChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ScatterChartLegendItemEventDetail","title":"ScatterChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ScatterChartSeriesToggledEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ScatterChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // ScatterChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ScatterChartSeriesToggledEventDetail","title":"ScatterChartSeriesToggledEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ScatterChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ScatterChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartRenderResult","title":"ScatterChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<ScatterChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ScatterChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartEngineTier","title":"ScatterChartEngineTier","description":"Type definition"}]}]},{"id":"method-addSeries","title":"addSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSeries(options: ScatterChartSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`ScatterChartSeries`","Required"],["`opts`","`{ redraw?: boolean; insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","description":"Type definition"}]}]},{"id":"method-removeSeries","title":"removeSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSeries","title":"updateSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<ScatterChartSeries>, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<ScatterChartSeries>`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","description":"Type definition"}]}]},{"id":"method-setSeriesData","title":"setSeriesData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setSeriesData(idOrIndex: string | number, data: ScatterChartValues, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`data`","`ScatterChartValues`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":"Type definition"}]}]},{"id":"method-addPoint","title":"addPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addPoint(idOrIndex: string | number, point: number | readonly [number, number] | { x?: number; y: number }, opts?: { shift?: boolean; redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`point`","`number | readonly [number, number] | { x?: number; y: number }`","Required"],["`opts`","`{ shift?: boolean; redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(point: ScatterChartDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`point`","`ScatterChartDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartDatum","title":"ScatterChartDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(idOrIndex: string | number, points: ReadonlyArray<unknown>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`points`","`ReadonlyArray<unknown>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(idOrIndex: string | number, count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(idOrIndex: string | number, points: ReadonlyArray<unknown>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`points`","`ReadonlyArray<unknown>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ScatterChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ScatterChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartStreamSource","title":"ScatterChartStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: ScatterChartEasing; enabled?: boolean; type?: ScatterChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: ScatterChartEasing; enabled?: boolean; type?: ScatterChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ScatterChartEasing","title":"ScatterChartEasing","description":"Type definition"},{"path":"/docs/types/ScatterChartAnimationType","title":"ScatterChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestPoint","title":"hitTestPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hitTestPoint(cssX: number, cssY: number): Promise<{ pointIndex: number; seriesIndex: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ pointIndex: number; seriesIndex: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(pointIndex: number, seriesIndex?: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pointIndex`","`number`","Required"],["`seriesIndex`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDrawings","title":"getDrawings","blocks":[{"kind":"paragraph","text":"the drawings of the document (data-space anchors)."},{"kind":"code","source":"getDrawings(): Promise<ChartDrawing[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-setDrawings","title":"setDrawings","blocks":[{"kind":"paragraph","text":"replace the document from script (`null` clears); the history keeps the previous document as an undo step."},{"kind":"code","source":"setDrawings(drawings: ReadonlyArray<ChartDrawingInput> | null): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawings`","`ReadonlyArray<ChartDrawingInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-addDrawing","title":"addDrawing","blocks":[{"kind":"paragraph","text":"add one drawing (an explicit id replaces); answers the resolved drawing, or null when the input was malformed."},{"kind":"code","source":"addDrawing(drawing: ChartDrawingInput): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`drawing`","`ChartDrawingInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":"Type definition"}]}]},{"id":"method-updateDrawing","title":"updateDrawing","blocks":[{"kind":"paragraph","text":"merge a patch into one drawing (anchors, style, visible, locked, options, meta)."},{"kind":"code","source":"updateDrawing(id: string, patch: Partial<Omit<ChartDrawing, 'id'>>): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`patch`","`Partial<Omit<ChartDrawing, 'id'>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"}]}]},{"id":"method-removeDrawing","title":"removeDrawing","blocks":[{"kind":"paragraph","text":"remove one drawing."},{"kind":"code","source":"removeDrawing(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-removeDrawings","title":"removeDrawings","blocks":[{"kind":"paragraph","text":"remove several drawings in one undoable step (locked / unknown ids are skipped); the selection prunes itself."},{"kind":"code","source":"removeDrawings(ids: ReadonlyArray<string>): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-setDrawingSpace","title":"setDrawingSpace","blocks":[{"kind":"paragraph","text":"move a drawing to the other coordinate space at the current frame (its anchors convert, nothing moves on screen); one undoable step."},{"kind":"code","source":"setDrawingSpace(id: string, space: DrawingSpace): Promise<ChartDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`space`","`DrawingSpace`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChartDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":"Type definition"},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":"Type definition"}]}]},{"id":"method-clearDrawings","title":"clearDrawings","blocks":[{"kind":"paragraph","text":"clear the document (undoable)."},{"kind":"code","source":"clearDrawings(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-undoDrawing","title":"undoDrawing","blocks":[{"kind":"paragraph","text":"undo the last document change; null when there is nothing to undo."},{"kind":"code","source":"undoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-redoDrawing","title":"redoDrawing","blocks":[{"kind":"paragraph","text":"redo the last undone change; null when there is nothing to redo."},{"kind":"code","source":"redoDrawing(): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingLayer","title":"getDrawingLayer","blocks":[{"kind":"paragraph","text":"the drawing overlay as a standalone SVG layer in host pixels (selection chrome and the placement preview stripped; null without drawings) — what the facade composes into the image export."},{"kind":"code","source":"getDrawingLayer(): Promise<DrawingLayerSnapshot | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DrawingLayerSnapshot | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","description":"Type definition"}]}]},{"id":"method-exportDrawings","title":"exportDrawings","blocks":[{"kind":"paragraph","text":"the document as its versioned JSON envelope (feed it back through `drawings` or `importDrawings`)."},{"kind":"code","source":"exportDrawings(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-importDrawings","title":"importDrawings","blocks":[{"kind":"paragraph","text":"replace the document from an envelope / list / JSON string (undoable; malformed rows drop)."},{"kind":"code","source":"importDrawings(input: ChartDrawingsInput): Promise<DrawingsChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`ChartDrawingsInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingsChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":"Type definition"}]}]},{"id":"method-selectDrawings","title":"selectDrawings","blocks":[{"kind":"paragraph","text":"select drawings from script (`null` / `[]` clears); unknown ids are dropped."},{"kind":"code","source":"selectDrawings(ids: ReadonlyArray<string> | null): Promise<DrawingSelectionChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ids`","`ReadonlyArray<string> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DrawingSelectionChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrawingSelection","title":"getDrawingSelection","blocks":[{"kind":"paragraph","text":"the selected drawing ids."},{"kind":"code","source":"getDrawingSelection(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setBrush","title":"setBrush","blocks":[{"kind":"paragraph","text":"replace the brush areas from script (`null` clears); `brushChange` fires with source 'api'."},{"kind":"code","source":"setBrush(areas: ReadonlyArray<CartesianBrushAreaInput> | null): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`areas`","`ReadonlyArray<CartesianBrushAreaInput> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","description":"Type definition"}]}]},{"id":"method-clearBrush","title":"clearBrush","blocks":[{"kind":"paragraph","text":"clear the brush areas (`brushChange` with source 'clear')."},{"kind":"code","source":"clearBrush(): Promise<CartesianBrushChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getBrush","title":"getBrush","blocks":[{"kind":"paragraph","text":"the persisted brush areas (primary data space)."},{"kind":"code","source":"getBrush(): Promise<CartesianBrushArea[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushArea[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":"Type definition"}]}]},{"id":"method-getBrushSelection","title":"getBrushSelection","blocks":[{"kind":"paragraph","text":"the points inside the brush areas, against the current layout."},{"kind":"code","source":"getBrushSelection(): Promise<CartesianBrushSelectedSeries[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianBrushSelectedSeries[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension over the visible points — what a bound `sy-visual-map` adopts as its domain."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/bubble","title":"Bubble","summary":"Read three measures through point position and size.","kind":"component","tag":"sy-bubble-chart","componentId":"bubble","api":{"props":[{"name":"data","attribute":"data","type":"BubbleData","kind":"property","values":[],"default":"undefined","description":"An array of { x, y, z, name? }. x and y determine position; z determines size."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"xAxis","attribute":"x-axis","type":"XAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Grid lines: both axes on by default."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"BUBBLE_DEFAULT_PADDING","description":"The automatic domain pads each span by this share (default 5 %)."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"DEFAULT_COLOR","description":"The bubble colour: the border, and the fill at `fill-alpha`."},{"name":"fillAlpha","attribute":"fill-alpha","type":"number","kind":"number","values":[],"default":"DEFAULT_FILL_ALPHA","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"borderColor","attribute":"border-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"The border colour (`auto` = the bubble colour) and its thickness in CSS px (0 = none)."},{"name":"borderWidth","attribute":"border-width","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"DEFAULT_ACTIVE_COLOR","description":"The accent fill of the hovered / focused bubble."},{"name":"minRadius","attribute":"min-radius","type":"number","kind":"number","values":[],"default":"BUBBLE_DEFAULT_MIN_RADIUS","description":"The radius range in CSS px the z range maps onto."},{"name":"maxRadius","attribute":"max-radius","type":"number","kind":"number","values":[],"default":"BUBBLE_DEFAULT_MAX_RADIUS","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"sizeScale","attribute":"size-scale","type":"BubbleSizeScale | string","kind":"string","values":[],"default":"'area'","description":"`area` (the disc area proportional to z; the default) or `radius`."},{"name":"zMin","attribute":"z-min","type":"number","kind":"number","values":[],"default":"undefined","description":"The z range (the data's when unset): z at or below `z-min` takes the min radius, at or above `z-max` the max."},{"name":"zMax","attribute":"z-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"layout","attribute":"layout","type":"BubbleLayoutMode | string","kind":"string","values":[],"default":"'xy'","description":"`xy` places the bubbles on the two axes; `pack` packs them into a cluster centred on the plot (the axes hidden)."},{"name":"packPadding","attribute":"pack-padding","type":"number","kind":"number","values":[],"default":"2","description":"Pack mode: the gap between tangent bubbles in CSS px; `contain` only shrinks the cluster to fit, `fill` scales it to touch the shorter side."},{"name":"packFit","attribute":"pack-fit","type":"BubblePackFit | string","kind":"string","values":[],"default":"'contain'","description":"Set as an HTML attribute or JavaScript property. type: BubblePackFit | string."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual-map binding (a `sy-visual-map` snapshot + dimension: `value` / `z` colour by z, `x`, `y`, `index`) filling every bubble through its ramp; a datum's own `color` wins."},{"name":"shading","attribute":"shading","type":"BubbleShading | string","kind":"string","values":[],"default":"'flat'","description":"`flat` (the default) or `sphere` (a highlight towards the top-left and a darker rim — the three-dimensional cue) with its strength 0 … 1."},{"name":"shadeStrength","attribute":"shade-strength","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"The bubble tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: BubblePointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: BubblePointEventDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"BubbleEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"BubbleAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"BubbleStreamSource","kind":"property","values":[],"default":"undefined","description":"§3.6: an external stream source (bubbles append); without one the chart keeps its own on the first push. Chart Pro (`chart.streaming`): ignored without it."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Bubbles tracked by the internal stream at most (the oldest leave as `windowSlid`). Chart Pro (`chart.streaming`)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed bubbles the chart renders (the whole buffer when unset). Chart Pro (`chart.streaming`)."},{"name":"engine","attribute":"engine","type":"BubbleEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"`auto` (the Standard renderer below `pro-threshold` bubbles, the WebGPU renderer from there with Chart Pro), `standard` or `pro`."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"BUBBLE_DEFAULT_PRO_THRESHOLD","description":"`auto` switches to the WebGPU renderer at this many bubbles (a missing or non-positive value uses 50,000)."},{"name":"unavailable","attribute":"unavailable","type":"BubbleUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"`fallback` (the Standard renderer and the notice) or `error` (an explicit `engine=\"pro\"` that cannot run throws)."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<BubbleRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<BubbleEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"BubbleData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"BubbleDatumInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<BubbleDatumInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed bubbles (the `data` bubbles are not the stream); with nothing streamed it does nothing and asks nothing."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<BubbleDatumInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<BubbleStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: BubbleEasing; enabled?: boolean; type?: BubbleAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<BubblePointEventDetail | null>","description":"The bubble under a host-local CSS point (the smallest disc containing it), or null."},{"name":"getPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<BubblePoint | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getPointCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getPoints","parameters":[],"returns":"Promise<BubblePoint[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<BubbleExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDomain","parameters":[],"returns":"Promise<BubbleDomain>","description":"The data domain the grid spans."},{"name":"getRadiusScale","parameters":[],"returns":"Promise<BubbleRadiusScale>","description":"The z → radius mapping the chart resolved (the z range, the radius range in CSS px, the scale)."},{"name":"getPackLayout","parameters":[],"returns":"Promise<BubblePackLayout | null>","description":"the packed cluster in plot CSS px (null in xy mode): the scale applied to the radii, the enclosing circle, one circle per bubble."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every bubble is filled through it on the next frame (a datum's own colour still wins)."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent a bound `sy-visual-map` adopts as its domain: z (`value` / `z`), x, y, or the index range."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"Open the tooltip on a bubble (the facade's `showTooltipAtPoint` routes here); null off the bubbles or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusPointAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<BubblePointEventDetail | null>","description":"Move the keyboard focus ring to a bubble (null off the bubbles); emits pointHover like the walk."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — master axes (pack mode: the unit square)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why — the last engine decision. A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart and never list an entitlement."}],"events":[{"name":"rendered","type":"BubbleRenderResult & { tier: BubbleEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"BubblePointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"BubblePointEventDetail | null","description":"CustomEvent.detail type: BubblePointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<BubblePointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<BubblePointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"The shared tooltip events (the controller emits them)."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-bubble-chart","blocks":[{"kind":"paragraph","text":"Compare markets, products, or projects with two coordinates and a magnitude."},{"kind":"paragraph","text":"Overlapping bubbles can hide small items. State the meaning and unit of z."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { x, y, z, name? }. x and y determine position; z determines size."]]},{"kind":"links","items":[{"path":"/charts/bubble","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-bubble-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-bubble-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"x\": 20,\n            \"y\": 70,\n            \"z\": 30,\n            \"name\": \"A\"\n          },\n          {\n            \"x\": 45,\n            \"y\": 55,\n            \"z\": 60,\n            \"name\": \"B\"\n          },\n          {\n            \"x\": 75,\n            \"y\": 80,\n            \"z\": 45,\n            \"name\": \"C\"\n          },\n          {\n            \"x\": 60,\n            \"y\": 30,\n            \"z\": 20,\n            \"name\": \"D\"\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'bubble example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { x, y, z, name? }. x and y determine position; z determines size."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BubbleData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BubbleData","title":"BubbleData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`XAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/XAxisInput","title":"XAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Grid lines: both axes on by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"The automatic domain pads each span by this share (default 5 %)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`BUBBLE_DEFAULT_PADDING`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"The bubble colour: the border, and the fill at `fill-alpha`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`DEFAULT_COLOR`"]]}]},{"id":"property-fillAlpha","title":"fillAlpha","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillAlpha`"],["HTML attribute","`fill-alpha`"],["Type","`number`"],["Default","`DEFAULT_FILL_ALPHA`"]]}]},{"id":"property-borderColor","title":"borderColor","blocks":[{"kind":"paragraph","text":"The border colour (`auto` = the bubble colour) and its thickness in CSS px (0 = none)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderColor`"],["HTML attribute","`border-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-borderWidth","title":"borderWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`borderWidth`"],["HTML attribute","`border-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"The accent fill of the hovered / focused bubble."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`DEFAULT_ACTIVE_COLOR`"]]}]},{"id":"property-minRadius","title":"minRadius","blocks":[{"kind":"paragraph","text":"The radius range in CSS px the z range maps onto."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minRadius`"],["HTML attribute","`min-radius`"],["Type","`number`"],["Default","`BUBBLE_DEFAULT_MIN_RADIUS`"]]}]},{"id":"property-maxRadius","title":"maxRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`maxRadius`"],["HTML attribute","`max-radius`"],["Type","`number`"],["Default","`BUBBLE_DEFAULT_MAX_RADIUS`"]]}]},{"id":"property-sizeScale","title":"sizeScale","blocks":[{"kind":"paragraph","text":"`area` (the disc area proportional to z; the default) or `radius`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sizeScale`"],["HTML attribute","`size-scale`"],["Type","`BubbleSizeScale | string`"],["Default","`'area'`"]]},{"kind":"links","items":[{"path":"/docs/types/BubbleSizeScale","title":"BubbleSizeScale","description":"Type definition"}]}]},{"id":"property-zMin","title":"zMin","blocks":[{"kind":"paragraph","text":"The z range (the data's when unset): z at or below `z-min` takes the min radius, at or above `z-max` the max."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zMin`"],["HTML attribute","`z-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zMax","title":"zMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zMax`"],["HTML attribute","`z-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-layout","title":"layout","blocks":[{"kind":"paragraph","text":"`xy` places the bubbles on the two axes; `pack` packs them into a cluster centred on the plot (the axes hidden)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`layout`"],["HTML attribute","`layout`"],["Type","`BubbleLayoutMode | string`"],["Default","`'xy'`"]]},{"kind":"links","items":[{"path":"/docs/types/BubbleLayoutMode","title":"BubbleLayoutMode","description":"Type definition"}]}]},{"id":"property-packPadding","title":"packPadding","blocks":[{"kind":"paragraph","text":"Pack mode: the gap between tangent bubbles in CSS px; `contain` only shrinks the cluster to fit, `fill` scales it to touch the shorter side."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`packPadding`"],["HTML attribute","`pack-padding`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-packFit","title":"packFit","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: BubblePackFit | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`packFit`"],["HTML attribute","`pack-fit`"],["Type","`BubblePackFit | string`"],["Default","`'contain'`"]]},{"kind":"links","items":[{"path":"/docs/types/BubblePackFit","title":"BubblePackFit","description":"Type definition"}]}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"a visual-map binding (a `sy-visual-map` snapshot + dimension: `value` / `z` colour by z, `x`, `y`, `index`) filling every bubble through its ramp; a datum's own `color` wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"property-shading","title":"shading","blocks":[{"kind":"paragraph","text":"`flat` (the default) or `sphere` (a highlight towards the top-left and a darker rim — the three-dimensional cue) with its strength 0 … 1."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shading`"],["HTML attribute","`shading`"],["Type","`BubbleShading | string`"],["Default","`'flat'`"]]},{"kind":"links","items":[{"path":"/docs/types/BubbleShading","title":"BubbleShading","description":"Type definition"}]}]},{"id":"property-shadeStrength","title":"shadeStrength","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shadeStrength`"],["HTML attribute","`shade-strength`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"The bubble tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: BubblePointEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: BubblePointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`BubbleEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/BubbleEasing","title":"BubbleEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`BubbleAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BubbleAnimationType","title":"BubbleAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"§3.6: an external stream source (bubbles append); without one the chart keeps its own on the first push. Chart Pro (`chart.streaming`): ignored without it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BubbleStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BubbleStreamSource","title":"BubbleStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Bubbles tracked by the internal stream at most (the oldest leave as `windowSlid`). Chart Pro (`chart.streaming`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed bubbles the chart renders (the whole buffer when unset). Chart Pro (`chart.streaming`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"`auto` (the Standard renderer below `pro-threshold` bubbles, the WebGPU renderer from there with Chart Pro), `standard` or `pro`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`BubbleEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/BubbleEngineMode","title":"BubbleEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"`auto` switches to the WebGPU renderer at this many bubbles (a missing or non-positive value uses 50,000)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`BUBBLE_DEFAULT_PRO_THRESHOLD`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"`fallback` (the Standard renderer and the notice) or `error` (an explicit `engine=\"pro\"` that cannot run throws)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`BubbleUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/BubbleUnavailableBehaviour","title":"BubbleUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BubbleRenderResult & { tier: BubbleEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // BubbleRenderResult & { tier: BubbleEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BubbleRenderResult","title":"BubbleRenderResult","description":"Type definition"},{"path":"/docs/types/BubbleEngineTier","title":"BubbleEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BubblePointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // BubblePointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: BubblePointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BubblePointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // BubblePointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<BubblePointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<BubblePointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<BubblePointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"The shared tooltip events (the controller emits them)."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<BubbleRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubbleRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleRenderResult","title":"BubbleRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<BubbleEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubbleEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleEngineTier","title":"BubbleEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: BubbleData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`BubbleData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleData","title":"BubbleData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: BubbleDatumInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`BubbleDatumInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<BubbleDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<BubbleDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed bubbles (the `data` bubbles are not the stream); with nothing streamed it does nothing and asks nothing."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<BubbleDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<BubbleDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<BubbleStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubbleStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleStreamSource","title":"BubbleStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: BubbleEasing; enabled?: boolean; type?: BubbleAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: BubbleEasing; enabled?: boolean; type?: BubbleAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleEasing","title":"BubbleEasing","description":"Type definition"},{"path":"/docs/types/BubbleAnimationType","title":"BubbleAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The bubble under a host-local CSS point (the smallest disc containing it), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<BubblePointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BubblePointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":"Type definition"}]}]},{"id":"method-getPoint","title":"getPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getPoint(index: number): Promise<BubblePoint | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BubblePoint | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubblePoint","title":"BubblePoint","description":"Type definition"}]}]},{"id":"method-getPointCount","title":"getPointCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getPointCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getPoints","title":"getPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getPoints(): Promise<BubblePoint[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubblePoint[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubblePoint","title":"BubblePoint","description":"Type definition"}]}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<BubbleExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubbleExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleExtent","title":"BubbleExtent","description":"Type definition"}]}]},{"id":"method-getDomain","title":"getDomain","blocks":[{"kind":"paragraph","text":"The data domain the grid spans."},{"kind":"code","source":"getDomain(): Promise<BubbleDomain>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubbleDomain>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleDomain","title":"BubbleDomain","description":"Type definition"}]}]},{"id":"method-getRadiusScale","title":"getRadiusScale","blocks":[{"kind":"paragraph","text":"The z → radius mapping the chart resolved (the z range, the radius range in CSS px, the scale)."},{"kind":"code","source":"getRadiusScale(): Promise<BubbleRadiusScale>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubbleRadiusScale>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubbleRadiusScale","title":"BubbleRadiusScale","description":"Type definition"}]}]},{"id":"method-getPackLayout","title":"getPackLayout","blocks":[{"kind":"paragraph","text":"the packed cluster in plot CSS px (null in xy mode): the scale applied to the radii, the enclosing circle, one circle per bubble."},{"kind":"code","source":"getPackLayout(): Promise<BubblePackLayout | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BubblePackLayout | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubblePackLayout","title":"BubblePackLayout","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every bubble is filled through it on the next frame (a datum's own colour still wins)."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent a bound `sy-visual-map` adopts as its domain: z (`value` / `z`), x, y, or the index range."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"Open the tooltip on a bubble (the facade's `showTooltipAtPoint` routes here); null off the bubbles or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusPointAt","title":"focusPointAt","blocks":[{"kind":"paragraph","text":"Move the keyboard focus ring to a bubble (null off the bubbles); emits pointHover like the walk."},{"kind":"code","source":"focusPointAt(index: number): Promise<BubblePointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BubblePointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — master axes (pack mode: the unit square)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why — the last engine decision. A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart and never list an entitlement."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/polar","title":"Polar","summary":"Arrange directions or cycles in polar coordinates.","kind":"component","tag":"sy-polar-chart","componentId":"polar","api":{"props":[{"name":"variant","attribute":"variant","type":"PolarChartVariant","kind":"string","values":["line","rose","bar"],"default":"'rose'","description":"Choose rose, bar, or line."},{"name":"data","attribute":"data","type":"PolarChartData","kind":"property","values":[],"default":"undefined","description":"A number array or series array of { name, data, color? }."},{"name":"categories","attribute":"categories","type":"string[]","kind":"property","values":[],"default":"undefined","description":"Names for each direction or angle."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"440","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"palette","attribute":"palette","type":"PolarChartPaletteName","kind":"string","values":["tableau10","tableau20","observable10","paired12","set3_12"],"default":"'tableau10'","description":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"name":"stacking","attribute":"stacking","type":"PolarChartStackingMode","kind":"string","values":["normal","percent"],"default":"'normal'","description":"Stack mode — `normal` (value units) or `percent` (each direction fills 100%)."},{"name":"sectorPadding","attribute":"sector-padding","type":"number","kind":"number","values":[],"default":"0.12","description":"Fraction of each angular slot kept as whitespace (half each side), 0..0.8."},{"name":"barPadding","attribute":"bar-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"`bar`: the fraction of each series' sub-slot kept as whitespace (half each side), 0..0.8."},{"name":"lineWidth","attribute":"line-width","type":"number","kind":"number","values":[],"default":"2","description":"`line`: the stroke width in CSS px."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"4","description":"`line`: the marker radius in CSS px (0 hides the markers)."},{"name":"fillOpacity","attribute":"fill-opacity","type":"number","kind":"number","values":[],"default":"0","description":"`line`: the area fill opacity under each polyline (0 = no fill)."},{"name":"max","attribute":"max","type":"number | 'auto'","kind":"property","values":["auto"],"default":"'auto'","description":"Radial-axis max in value units; 'auto' (default) nice-ceils the stacked max."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"gridColor","attribute":"grid-color","type":"string","kind":"string","values":[],"default":"'#e2e8f0'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"showRingLabels","attribute":"show-ring-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"ringLabelColor","attribute":"ring-label-color","type":"string","kind":"string","values":[],"default":"'#6b7280'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"ringLabelFontSize","attribute":"ring-label-font-size","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"categoryLabelColor","attribute":"category-label-color","type":"string","kind":"string","values":[],"default":"'#374151'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"categoryLabelFontSize","attribute":"category-label-font-size","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"PolarChartLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Edge to dock the legend on, or `float` — an overlay inside the rose's drawing rectangle (Storybook parity, 2026-09-10)."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(segment: PolarRoseSegment) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (segment: PolarRoseSegment) => string."},{"name":"tooltip","attribute":"tooltip","type":"PolarChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration object (family-parity surface). Property-only."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Storybook parity (2026-09-10) — viewport zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) over the rose's drawing rectangle (x 0 → 1 left → right, y 0 → 1 bottom → top, like a cartesian plot); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches. Property-only (an object or a mode string)."},{"name":"engine","attribute":"engine","type":"PolarChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"PolarChartUnavailableBehaviour","kind":"string","values":["fallback","throw"],"default":"'fallback'","description":"Allowed values: fallback, throw. Default: 'fallback'."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"POLAR_DEFAULT_PRO_THRESHOLD","description":"`auto` goes Pro at this many marks (the stacked sectors the rose draws) and stays there while Pro is available."},{"name":"streamSource","attribute":"stream-source","type":"PolarChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"PolarChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"PolarChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<PolarChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<PolarChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized source table, including retained streaming rows, independent of the renderer."},{"name":"setData","parameters":[{"name":"data","type":"PolarChartData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"PolarRoseRowDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"datums","type":"ReadonlyArray<PolarRoseRowDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"datums","type":"ReadonlyArray<PolarRoseRowDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<PolarChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: PolarChartEasing; enabled?: boolean; type?: PolarChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the radial-grow reveal. No-op when animation is off."},{"name":"hitTestSegment","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<PolarChartPointEventDetail | null>","description":"Polar-only — hit-test the rose segment at canvas-relative coordinates."},{"name":"showTooltipAtSegment","parameters":[{"name":"categoryIndex","type":"number","optional":false},{"name":"seriesIdOrIndex","type":"string | number","optional":false}],"returns":"Promise<PolarChartPointEventDetail | null>","description":"Polar-only — programmatic tooltip open on a (direction, series) cell."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` fractions 0 … 1; `null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by fractions of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent of the viewport axes (`[0, 1]` each, key `'0'`)."}],"events":[{"name":"rendered","type":"PolarChartRenderResult & { tier: PolarChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"PolarChartPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"PolarChartPointEventDetail | null","description":"CustomEvent.detail type: PolarChartPointEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<PolarChartPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<PolarChartPointEventDetail>. Event names are case-sensitive."},{"name":"legendItemClick","type":"{ index: number; seriesId: string; label: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; seriesId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"name":"seriesToggled","type":"{ index: number; seriesId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"PolarChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"PolarChartTooltipActionEventDetail","description":"CustomEvent.detail type: PolarChartTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Storybook parity (2026-09-10) — fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-polar-chart","blocks":[{"kind":"paragraph","text":"Use for categories whose end connects to the beginning, such as wind direction or time of day."},{"kind":"paragraph","text":"Cartesian coordinates are easier to read for ordinary rankings. Category order determines the meaning of the circle."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","A number array or series array of { name, data, color? }."],["`categories`","Names for each direction or angle."],["`variant`","Choose rose, bar, or line."]]},{"kind":"links","items":[{"path":"/charts/polar","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-polar-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-polar-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"data\": [45, 70, 55, 35, 65, 80, 50, 40],\n        \"categories\": [\"N\", \"NE\", \"E\", \"SE\", \"S\", \"SW\", \"W\", \"NW\"],\n        \"variant\": \"rose\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'polar example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-variant","title":"variant","blocks":[{"kind":"paragraph","text":"Choose rose, bar, or line."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`variant`"],["HTML attribute","`variant`"],["Type","`PolarChartVariant`"],["Default","`'rose'`"],["Allowed values","`line`, `rose`, `bar`"]]},{"kind":"links","items":[{"path":"/docs/types/PolarChartVariant","title":"PolarChartVariant","description":"Type definition"}]}]},{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"A number array or series array of { name, data, color? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PolarChartData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PolarChartData","title":"PolarChartData","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Names for each direction or angle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`440`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-palette","title":"palette","blocks":[{"kind":"paragraph","text":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`palette`"],["HTML attribute","`palette`"],["Type","`PolarChartPaletteName`"],["Default","`'tableau10'`"],["Allowed values","`tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12`"]]},{"kind":"links","items":[{"path":"/docs/types/PolarChartPaletteName","title":"PolarChartPaletteName","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-stacking","title":"stacking","blocks":[{"kind":"paragraph","text":"Stack mode — `normal` (value units) or `percent` (each direction fills 100%)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stacking`"],["HTML attribute","`stacking`"],["Type","`PolarChartStackingMode`"],["Default","`'normal'`"],["Allowed values","`normal`, `percent`"]]},{"kind":"links","items":[{"path":"/docs/types/PolarChartStackingMode","title":"PolarChartStackingMode","description":"Type definition"}]}]},{"id":"property-sectorPadding","title":"sectorPadding","blocks":[{"kind":"paragraph","text":"Fraction of each angular slot kept as whitespace (half each side), 0..0.8."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sectorPadding`"],["HTML attribute","`sector-padding`"],["Type","`number`"],["Default","`0.12`"]]}]},{"id":"property-barPadding","title":"barPadding","blocks":[{"kind":"paragraph","text":"`bar`: the fraction of each series' sub-slot kept as whitespace (half each side), 0..0.8."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barPadding`"],["HTML attribute","`bar-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-lineWidth","title":"lineWidth","blocks":[{"kind":"paragraph","text":"`line`: the stroke width in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineWidth`"],["HTML attribute","`line-width`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"`line`: the marker radius in CSS px (0 hides the markers)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"property-fillOpacity","title":"fillOpacity","blocks":[{"kind":"paragraph","text":"`line`: the area fill opacity under each polyline (0 = no fill)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillOpacity`"],["HTML attribute","`fill-opacity`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-max","title":"max","blocks":[{"kind":"paragraph","text":"Radial-axis max in value units; 'auto' (default) nice-ceils the stacked max."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`max`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'auto'`"],["Default","`'auto'`"],["Literals in the type","`auto`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-gridColor","title":"gridColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridColor`"],["HTML attribute","`grid-color`"],["Type","`string`"],["Default","`'#e2e8f0'`"]]}]},{"id":"property-showRingLabels","title":"showRingLabels","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showRingLabels`"],["HTML attribute","`show-ring-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-ringLabelColor","title":"ringLabelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelColor`"],["HTML attribute","`ring-label-color`"],["Type","`string`"],["Default","`'#6b7280'`"]]}]},{"id":"property-ringLabelFontSize","title":"ringLabelFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelFontSize`"],["HTML attribute","`ring-label-font-size`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-categoryLabelColor","title":"categoryLabelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categoryLabelColor`"],["HTML attribute","`category-label-color`"],["Type","`string`"],["Default","`'#374151'`"]]}]},{"id":"property-categoryLabelFontSize","title":"categoryLabelFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categoryLabelFontSize`"],["HTML attribute","`category-label-font-size`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Edge to dock the legend on, or `float` — an overlay inside the rose's drawing rectangle (Storybook parity, 2026-09-10)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`PolarChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/PolarChartLegendPosition","title":"PolarChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (segment: PolarRoseSegment) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(segment: PolarRoseSegment) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PolarRoseSegment","title":"PolarRoseSegment","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration object (family-parity surface). Property-only."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PolarChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipInput","title":"PolarChartTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Storybook parity (2026-09-10) — viewport zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) over the rose's drawing rectangle (x 0 → 1 left → right, y 0 → 1 bottom → top, like a cartesian plot); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches. Property-only (an object or a mode string)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`PolarChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/PolarChartEngineMode","title":"PolarChartEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`PolarChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/PolarChartUnavailableBehaviour","title":"PolarChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"`auto` goes Pro at this many marks (the stacked sectors the rose draws) and stays there while Pro is available."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`POLAR_DEFAULT_PRO_THRESHOLD`"]]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PolarChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PolarChartStreamSource","title":"PolarChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`PolarChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/PolarChartEasing","title":"PolarChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`PolarChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PolarChartAnimationType","title":"PolarChartAnimationType","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PolarChartRenderResult & { tier: PolarChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // PolarChartRenderResult & { tier: PolarChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PolarChartRenderResult","title":"PolarChartRenderResult","description":"Type definition"},{"path":"/docs/types/PolarChartEngineTier","title":"PolarChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PolarChartPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // PolarChartPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: PolarChartPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PolarChartPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // PolarChartPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<PolarChartPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<PolarChartPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<PolarChartPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; seriesId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; label: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // { index: number; seriesId: string; label: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // { index: number; seriesId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PolarChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // PolarChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipShowEventDetail","title":"PolarChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: PolarChartTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PolarChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // PolarChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipActionEventDetail","title":"PolarChartTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Storybook parity (2026-09-10) — fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<PolarChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PolarChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartRenderResult","title":"PolarChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<PolarChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PolarChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartEngineTier","title":"PolarChartEngineTier","description":"Type definition"}]}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized source table, including retained streaming rows, independent of the renderer."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: PolarChartData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`PolarChartData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartData","title":"PolarChartData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: PolarRoseRowDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`PolarRoseRowDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarRoseRowDatum","title":"PolarRoseRowDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(datums: ReadonlyArray<PolarRoseRowDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<PolarRoseRowDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarRoseRowDatum","title":"PolarRoseRowDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(datums: ReadonlyArray<PolarRoseRowDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<PolarRoseRowDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarRoseRowDatum","title":"PolarRoseRowDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<PolarChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PolarChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartStreamSource","title":"PolarChartStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: PolarChartEasing; enabled?: boolean; type?: PolarChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: PolarChartEasing; enabled?: boolean; type?: PolarChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartEasing","title":"PolarChartEasing","description":"Type definition"},{"path":"/docs/types/PolarChartAnimationType","title":"PolarChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the radial-grow reveal. No-op when animation is off."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestSegment","title":"hitTestSegment","blocks":[{"kind":"paragraph","text":"Polar-only — hit-test the rose segment at canvas-relative coordinates."},{"kind":"code","source":"hitTestSegment(cssX: number, cssY: number): Promise<PolarChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<PolarChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtSegment","title":"showTooltipAtSegment","blocks":[{"kind":"paragraph","text":"Polar-only — programmatic tooltip open on a (direction, series) cell."},{"kind":"code","source":"showTooltipAtSegment(categoryIndex: number, seriesIdOrIndex: string | number): Promise<PolarChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`categoryIndex`","`number`","Required"],["`seriesIdOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<PolarChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` fractions 0 … 1; `null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by fractions of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent of the viewport axes (`[0, 1]` each, key `'0'`)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/radar","title":"Radar","summary":"Compare multiple metrics in a single outline.","kind":"component","tag":"sy-radar-chart","componentId":"radar","api":{"props":[{"name":"data","attribute":"data","type":"RadarChartData","kind":"property","values":[],"default":"[]","description":"Each series is { name, data, color? }."},{"name":"categories","attribute":"categories","type":"string[]","kind":"property","values":[],"default":"[]","description":"Metric names in the same order as data."},{"name":"min","attribute":"min","type":"number | 'auto'","kind":"property","values":["auto"],"default":"'auto'","description":"Together with max, defines the shared measurement range."},{"name":"max","attribute":"max","type":"number | 'auto'","kind":"property","values":["auto"],"default":"'auto'","description":"Allowed values: auto. Default: 'auto'."},{"name":"tickInterval","attribute":"tick-interval","type":"number | 'auto'","kind":"property","values":["auto"],"default":"'auto'","description":"Allowed values: auto. Default: 'auto'."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"360","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"variant","attribute":"variant","type":"RadarChartVariant","kind":"string","values":["area","line"],"default":"'line'","description":"Allowed values: area, line. Default: 'line'."},{"name":"startAngle","attribute":"start-angle","type":"number","kind":"number","values":[],"default":"0","description":"Angle of category 0 in DEGREES (0 = 12 o'clock, clockwise +)."},{"name":"size","attribute":"size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerX","attribute":"center-x","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerY","attribute":"center-y","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Multi-series palette. Per-series `color` always wins."},{"name":"lineWidth","attribute":"line-width","type":"number","kind":"number","values":[],"default":"2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"fillOpacity","attribute":"fill-opacity","type":"number","kind":"number","values":[],"default":"0.25","description":"Area-variant fill alpha (0..1)."},{"name":"gridShape","attribute":"grid-shape","type":"RadarGridShape","kind":"string","values":["circle","polygon"],"default":"'polygon'","description":"Allowed values: circle, polygon. Default: 'polygon'."},{"name":"gridColor","attribute":"grid-color","type":"string","kind":"string","values":[],"default":"'#e5e7eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"showMarkers","attribute":"show-markers","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"markerRadius","attribute":"marker-radius","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"showRingLabels","attribute":"show-ring-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"ringLabelColor","attribute":"ring-label-color","type":"string","kind":"string","values":[],"default":"'#9ca3af'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"ringLabelFontSize","attribute":"ring-label-font-size","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"ringLabelFormat","attribute":"ring-label-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"categoryLabelColor","attribute":"category-label-color","type":"string","kind":"string","values":[],"default":"'#374151'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"categoryLabelFontSize","attribute":"category-label-font-size","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: RadarChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: RadarChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"RadarChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair guide — the SAME parameter names as the cartesian charts, read on the polar pane. Off by default. Accepts `true` / a partial spec `{ show, mode, snap, color, dash }`. `mode 'vertical'` → the category axis guide = a radial spoke; `mode 'horizontal'` → the value axis guide = a concentric ring; `mode 'cross'` → both. `snap 'nearest'` snaps to the nearest vertex, `'index'` to the nearest category, `'off'` is the raw pointer. Objects can't ride an attribute — set it as a property (or via a `<sy-chart>` script)."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"RadarChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"activeSeriesIndex","attribute":"active-series-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"seriesActiveTrigger","attribute":"series-active-trigger","type":"RadarChartSeriesActiveTrigger","kind":"string","values":["hover","click","custom"],"default":"'click'","description":"Allowed values: hover, click, custom. Default: 'click'."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"450","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"RadarChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"RadarChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"editable","attribute":"editable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Enables direct pointer editing of point values."},{"name":"streamSource","attribute":"stream-source","type":"RadarChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"RadarChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"RadarChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<RadarChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<RadarChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"data","type":"RadarChartData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"addSeries","parameters":[{"name":"series","type":"RadarChartData[number]","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<RadarChartData[number]>","optional":false}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updatePoint","parameters":[{"name":"seriesIdOrIndex","type":"string | number","optional":false},{"name":"categoryIdOrIndex","type":"string | number","optional":false},{"name":"value","type":"number | null","optional":false}],"returns":"Promise<boolean>","description":"Radar-only — patch one category value in a series."},{"name":"appendPoint","parameters":[{"name":"frame","type":"RadarStreamFrame","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"frames","type":"ReadonlyArray<RadarStreamFrame>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"frames","type":"ReadonlyArray<RadarStreamFrame>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<RadarChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: RadarChartEasing; enabled?: boolean; type?: RadarChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<RadarChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAt","parameters":[{"name":"seriesIndex","type":"number","optional":false},{"name":"categoryIndex","type":"number","optional":false}],"returns":"Promise<RadarChartPointerEventDetail | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"RadarChartRenderResult & { tier: RadarChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"RadarChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"RadarChartPointerEventDetail | null","description":"CustomEvent.detail type: RadarChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<RadarChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<RadarChartPointerEventDetail>. Event names are case-sensitive."},{"name":"pointChange","type":"RadarChartPointerEventDetail","description":"CustomEvent.detail type: RadarChartPointerEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"{ index: number; seriesId: string; label: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; seriesId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"name":"seriesToggled","type":"{ index: number; seriesId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"RadarChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"RadarChartTooltipActionEventDetail","description":"CustomEvent.detail type: RadarChartTooltipActionEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-radar-chart","blocks":[{"kind":"paragraph","text":"Compare product or team capabilities normalized to the same scale."},{"kind":"paragraph","text":"Axis order changes the shape's appearance. Do not directly compare raw values with different units."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","Each series is { name, data, color? }."],["`categories`","Metric names in the same order as data."],["`min`","Together with max, defines the shared measurement range."]]},{"kind":"links","items":[{"path":"/charts/radar","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-radar-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-radar-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"categories\": [\"Performance\", \"Quality\", \"Price\", \"Support\", \"Scalability\"],\n        \"data\": [\n          {\n            \"name\": \"A\",\n            \"data\": [90, 80, 65, 85, 70],\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"name\": \"B\",\n            \"data\": [70, 90, 85, 60, 80],\n            \"color\": \"#239c91\"\n          }\n        ],\n        \"min\": 0,\n        \"max\": 100,\n        \"variant\": \"area\",\n        \"legend\": true,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'radar example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"Each series is { name, data, color? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`RadarChartData`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarChartData","title":"RadarChartData","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Metric names in the same order as data."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string[]`"],["Default","`[]`"]]}]},{"id":"property-min","title":"min","blocks":[{"kind":"paragraph","text":"Together with max, defines the shared measurement range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`min`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'auto'`"],["Default","`'auto'`"],["Literals in the type","`auto`"]]}]},{"id":"property-max","title":"max","blocks":[{"kind":"paragraph","text":"Allowed values: auto. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`max`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'auto'`"],["Default","`'auto'`"],["Literals in the type","`auto`"]]}]},{"id":"property-tickInterval","title":"tickInterval","blocks":[{"kind":"paragraph","text":"Allowed values: auto. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickInterval`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'auto'`"],["Default","`'auto'`"],["Literals in the type","`auto`"]]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-variant","title":"variant","blocks":[{"kind":"paragraph","text":"Allowed values: area, line. Default: 'line'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`variant`"],["HTML attribute","`variant`"],["Type","`RadarChartVariant`"],["Default","`'line'`"],["Allowed values","`area`, `line`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarChartVariant","title":"RadarChartVariant","description":"Type definition"}]}]},{"id":"property-startAngle","title":"startAngle","blocks":[{"kind":"paragraph","text":"Angle of category 0 in DEGREES (0 = 12 o'clock, clockwise +)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startAngle`"],["HTML attribute","`start-angle`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-size","title":"size","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`size`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerX","title":"centerX","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerX`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerY","title":"centerY","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerY`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Multi-series palette. Per-series `color` always wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-lineWidth","title":"lineWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineWidth`"],["HTML attribute","`line-width`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-fillOpacity","title":"fillOpacity","blocks":[{"kind":"paragraph","text":"Area-variant fill alpha (0..1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillOpacity`"],["HTML attribute","`fill-opacity`"],["Type","`number`"],["Default","`0.25`"]]}]},{"id":"property-gridShape","title":"gridShape","blocks":[{"kind":"paragraph","text":"Allowed values: circle, polygon. Default: 'polygon'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridShape`"],["HTML attribute","`grid-shape`"],["Type","`RadarGridShape`"],["Default","`'polygon'`"],["Allowed values","`circle`, `polygon`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarGridShape","title":"RadarGridShape","description":"Type definition"}]}]},{"id":"property-gridColor","title":"gridColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridColor`"],["HTML attribute","`grid-color`"],["Type","`string`"],["Default","`'#e5e7eb'`"]]}]},{"id":"property-showMarkers","title":"showMarkers","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showMarkers`"],["HTML attribute","`show-markers`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-markerRadius","title":"markerRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerRadius`"],["HTML attribute","`marker-radius`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-showRingLabels","title":"showRingLabels","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showRingLabels`"],["HTML attribute","`show-ring-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-ringLabelColor","title":"ringLabelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelColor`"],["HTML attribute","`ring-label-color`"],["Type","`string`"],["Default","`'#9ca3af'`"]]}]},{"id":"property-ringLabelFontSize","title":"ringLabelFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelFontSize`"],["HTML attribute","`ring-label-font-size`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-ringLabelFormat","title":"ringLabelFormat","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ringLabelFormat`"],["HTML attribute","`ring-label-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-categoryLabelColor","title":"categoryLabelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categoryLabelColor`"],["HTML attribute","`category-label-color`"],["Type","`string`"],["Default","`'#374151'`"]]}]},{"id":"property-categoryLabelFontSize","title":"categoryLabelFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categoryLabelFontSize`"],["HTML attribute","`category-label-font-size`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: RadarChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: RadarChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`RadarChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipInput","title":"RadarChartTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair guide — the SAME parameter names as the cartesian charts, read on the polar pane. Off by default. Accepts `true` / a partial spec `{ show, mode, snap, color, dash }`. `mode 'vertical'` → the category axis guide = a radial spoke; `mode 'horizontal'` → the value axis guide = a concentric ring; `mode 'cross'` → both. `snap 'nearest'` snaps to the nearest vertex, `'index'` to the nearest category, `'off'` is the raw pointer. Objects can't ride an attribute — set it as a property (or via a `<sy-chart>` script)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`RadarChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarChartLegendPosition","title":"RadarChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-activeSeriesIndex","title":"activeSeriesIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSeriesIndex`"],["HTML attribute","`active-series-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-seriesActiveTrigger","title":"seriesActiveTrigger","blocks":[{"kind":"paragraph","text":"Allowed values: hover, click, custom. Default: 'click'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesActiveTrigger`"],["HTML attribute","`series-active-trigger`"],["Type","`RadarChartSeriesActiveTrigger`"],["Default","`'click'`"],["Allowed values","`hover`, `click`, `custom`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarChartSeriesActiveTrigger","title":"RadarChartSeriesActiveTrigger","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`450`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`RadarChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarChartEasing","title":"RadarChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`RadarChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/RadarChartAnimationType","title":"RadarChartAnimationType","description":"Type definition"}]}]},{"id":"property-editable","title":"editable","blocks":[{"kind":"paragraph","text":"Enables direct pointer editing of point values."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`editable`"],["HTML attribute","`editable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`RadarChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/RadarChartStreamSource","title":"RadarChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`RadarChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarChartEngineMode","title":"RadarChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`RadarChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/RadarChartUnavailableBehaviour","title":"RadarChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<RadarChartRenderResult & { tier: RadarChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // RadarChartRenderResult & { tier: RadarChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/RadarChartRenderResult","title":"RadarChartRenderResult","description":"Type definition"},{"path":"/docs/types/RadarChartEngineTier","title":"RadarChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<RadarChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // RadarChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: RadarChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<RadarChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // RadarChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<RadarChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<RadarChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<RadarChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointChange","title":"pointChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: RadarChartPointerEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<RadarChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointChange', event => {\n  console.log(event.detail); // RadarChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; seriesId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; label: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // { index: number; seriesId: string; label: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // { index: number; seriesId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<RadarChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // RadarChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipShowEventDetail","title":"RadarChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: RadarChartTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<RadarChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // RadarChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipActionEventDetail","title":"RadarChartTooltipActionEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<RadarChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<RadarChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartRenderResult","title":"RadarChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<RadarChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<RadarChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartEngineTier","title":"RadarChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: RadarChartData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`RadarChartData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartData","title":"RadarChartData","description":"Type definition"}]}]},{"id":"method-addSeries","title":"addSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSeries(series: RadarChartData[number], opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`RadarChartData[number]`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartData","title":"RadarChartData","description":"Type definition"}]}]},{"id":"method-removeSeries","title":"removeSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSeries(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSeries","title":"updateSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<RadarChartData[number]>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<RadarChartData[number]>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartData","title":"RadarChartData","description":"Type definition"}]}]},{"id":"method-updatePoint","title":"updatePoint","blocks":[{"kind":"paragraph","text":"Radar-only — patch one category value in a series."},{"kind":"code","source":"updatePoint(seriesIdOrIndex: string | number, categoryIdOrIndex: string | number, value: number | null): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`seriesIdOrIndex`","`string | number`","Required"],["`categoryIdOrIndex`","`string | number`","Required"],["`value`","`number | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(frame: RadarStreamFrame): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frame`","`RadarStreamFrame`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(frames: ReadonlyArray<RadarStreamFrame>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frames`","`ReadonlyArray<RadarStreamFrame>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(frames: ReadonlyArray<RadarStreamFrame>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frames`","`ReadonlyArray<RadarStreamFrame>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<RadarChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<RadarChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartStreamSource","title":"RadarChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: RadarChartEasing; enabled?: boolean; type?: RadarChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: RadarChartEasing; enabled?: boolean; type?: RadarChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartEasing","title":"RadarChartEasing","description":"Type definition"},{"path":"/docs/types/RadarChartAnimationType","title":"RadarChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<RadarChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<RadarChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAt","title":"showTooltipAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showTooltipAt(seriesIndex: number, categoryIndex: number): Promise<RadarChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`seriesIndex`","`number`","Required"],["`categoryIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<RadarChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/lollipop","title":"Lollipop","summary":"Compare category values with simple dots and stems.","kind":"component","tag":"sy-lollipop-chart","componentId":"lollipop","api":{"props":[{"name":"values","attribute":"values","type":"LollipopChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"A number array for the categories."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Category names in value order."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"Stem + marker colour. Accepts a single CSS colour, an array, or a comma-separated string (the first colour is used)."},{"name":"markerColor","attribute":"marker-color","type":"string","kind":"string","values":[],"default":"undefined","description":"Marker fill override (defaults to `color`)."},{"name":"lineWidth","attribute":"line-width","type":"number","kind":"number","values":[],"default":"2","description":"Stem width in CSS px."},{"name":"marker","attribute":"marker","type":"LollipopMarkerSymbol","kind":"string","values":["circle","square","triangle","diamond"],"default":"'circle'","description":"Marker glyph."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"6","description":"Marker radius in CSS px."},{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Value the stems grow from. Default 0."},{"name":"sortDescending","attribute":"sort-descending","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Sort categories by value, largest first. Default false (source order)."},{"name":"orientation","attribute":"orientation","type":"LollipopOrientation","kind":"string","values":["vertical","horizontal"],"default":"'horizontal'","description":"vertical or horizontal."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: LollipopChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: LollipopChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"LollipopChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"LollipopChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"LollipopChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"LollipopChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"LollipopChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<LollipopChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<LollipopChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"values","type":"LollipopChartValues","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"LollipopBarDatum | number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<LollipopBarDatum | number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<LollipopBarDatum | number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<LollipopChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: LollipopChartEasing; enabled?: boolean; type?: LollipopChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<LollipopChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"LollipopChartRenderResult & { tier: LollipopChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"LollipopChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"LollipopChartPointerEventDetail | null","description":"CustomEvent.detail type: LollipopChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<LollipopChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<LollipopChartPointerEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-lollipop-chart","blocks":[{"kind":"paragraph","text":"Use to emphasize rankings or differences across a modest number of categories."},{"kind":"paragraph","text":"Small dots can be difficult to click. Provide tooltips and a data table."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","A number array for the categories."],["`categories`","Category names in value order."],["`orientation`","vertical or horizontal."]]},{"kind":"links","items":[{"path":"/charts/lollipop","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-lollipop-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-lollipop-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [42, 28, 18, 12],\n        \"categories\": [\"A\", \"B\", \"C\", \"D\"],\n        \"orientation\": \"vertical\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'lollipop example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"A number array for the categories."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LollipopChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/LollipopChartValues","title":"LollipopChartValues","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Category names in value order."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Stem + marker colour. Accepts a single CSS colour, an array, or a comma-separated string (the first colour is used)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"property-markerColor","title":"markerColor","blocks":[{"kind":"paragraph","text":"Marker fill override (defaults to `color`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerColor`"],["HTML attribute","`marker-color`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-lineWidth","title":"lineWidth","blocks":[{"kind":"paragraph","text":"Stem width in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineWidth`"],["HTML attribute","`line-width`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"Marker glyph."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","`marker`"],["Type","`LollipopMarkerSymbol`"],["Default","`'circle'`"],["Allowed values","`circle`, `square`, `triangle`, `diamond`"]]},{"kind":"links","items":[{"path":"/docs/types/LollipopMarkerSymbol","title":"LollipopMarkerSymbol","description":"Type definition"}]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"Marker radius in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`6`"]]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Value the stems grow from. Default 0."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-sortDescending","title":"sortDescending","blocks":[{"kind":"paragraph","text":"Sort categories by value, largest first. Default false (source order)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sortDescending`"],["HTML attribute","`sort-descending`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"vertical or horizontal."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`LollipopOrientation`"],["Default","`'horizontal'`"],["Allowed values","`vertical`, `horizontal`"]]},{"kind":"links","items":[{"path":"/docs/types/LollipopOrientation","title":"LollipopOrientation","description":"Type definition"}]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: LollipopChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: LollipopChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`LollipopChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/LollipopChartEasing","title":"LollipopChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`LollipopChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartAnimationType","title":"LollipopChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LollipopChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartStreamSource","title":"LollipopChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`LollipopChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/LollipopChartEngineMode","title":"LollipopChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`LollipopChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/LollipopChartUnavailableBehaviour","title":"LollipopChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LollipopChartRenderResult & { tier: LollipopChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // LollipopChartRenderResult & { tier: LollipopChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LollipopChartRenderResult","title":"LollipopChartRenderResult","description":"Type definition"},{"path":"/docs/types/LollipopChartEngineTier","title":"LollipopChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LollipopChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // LollipopChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: LollipopChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<LollipopChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // LollipopChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<LollipopChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<LollipopChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<LollipopChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<LollipopChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<LollipopChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartRenderResult","title":"LollipopChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<LollipopChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<LollipopChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartEngineTier","title":"LollipopChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(values: LollipopChartValues): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`LollipopChartValues`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartValues","title":"LollipopChartValues","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: LollipopBarDatum | number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`LollipopBarDatum | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopBarDatum","title":"LollipopBarDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<LollipopBarDatum | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<LollipopBarDatum | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopBarDatum","title":"LollipopBarDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<LollipopBarDatum | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<LollipopBarDatum | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopBarDatum","title":"LollipopBarDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<LollipopChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<LollipopChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartStreamSource","title":"LollipopChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: LollipopChartEasing; enabled?: boolean; type?: LollipopChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: LollipopChartEasing; enabled?: boolean; type?: LollipopChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartEasing","title":"LollipopChartEasing","description":"Type definition"},{"path":"/docs/types/LollipopChartAnimationType","title":"LollipopChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<LollipopChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<LollipopChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/dumbbell","title":"Dumbbell","summary":"Connect two measurements to show their difference.","kind":"component","tag":"sy-dumbbell-chart","componentId":"dumbbell","api":{"props":[{"name":"data","attribute":"data","type":"ReadonlyArray<DumbbellDatum>","kind":"property","values":[],"default":"[]","description":"An array of { category, values: [low, high] }."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Optional category-label override. When set, replaces the per-datum `category` labels."},{"name":"groups","attribute":"groups","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Names for the two endpoints."},{"name":"lowName","attribute":"low-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Compatibility alias for `groups[0]`."},{"name":"highName","attribute":"high-name","type":"string","kind":"string","values":[],"default":"undefined","description":"Compatibility alias for `groups[1]`."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"''","description":"Set endpoint colors as [first, second]."},{"name":"lineColor","attribute":"line-color","type":"string","kind":"string","values":[],"default":"'#cbd5e1'","description":"Connector (bar) stroke colour — its own faint default, independent of the `color` pair."},{"name":"lineWidth","attribute":"line-width","type":"number","kind":"number","values":[],"default":"3","description":"Connector width in CSS px."},{"name":"marker","attribute":"marker","type":"DumbbellMarkerSymbol | string | ReadonlyArray<string>","kind":"property","values":[],"default":"'circle'","description":"Marker glyph. Polymorphic (like `color`): a single symbol applies to BOTH ends; an array or comma-string is read as `[lowMarker, highMarker]` (a single token leaves the low end on `'circle'` and applies the token to the high end, mirroring the pair rule). Resolved once via `resolvePair`. Per-datum `DumbbellDatum.lowMarker`/`highMarker` override this for individual dumbbells."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"6","description":"Marker radius in CSS px."},{"name":"sortDescending","attribute":"sort-descending","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the low/high legend. When `false` no legend renders and its reserved space is reclaimed."},{"name":"legendPosition","attribute":"legend-position","type":"DumbbellChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'top'","description":"Edge the low/high legend attaches to. Default `'top'`."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: DumbbellChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: DumbbellChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted. The hit is the dumbbell PAIR (low+high) under the cursor; the default text is `category: low → high`."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"DumbbellChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"DumbbellChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"DumbbellChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"DumbbellChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"DumbbellChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<DumbbellChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<DumbbellChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"data","type":"ReadonlyArray<DumbbellDatum>","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"DumbbellDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<DumbbellPairDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<DumbbellPairDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<DumbbellChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"showSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: DumbbellChartEasing; enabled?: boolean; type?: DumbbellChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<DumbbellChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"DumbbellChartRenderResult & { tier: DumbbellChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"DumbbellChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"DumbbellChartPointerEventDetail | null","description":"CustomEvent.detail type: DumbbellChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<DumbbellChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DumbbellChartPointerEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"DumbbellChartLegendItemEventDetail","description":"CustomEvent.detail type: DumbbellChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"DumbbellChartSeriesToggledEventDetail","description":"CustomEvent.detail type: DumbbellChartSeriesToggledEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-dumbbell-chart","blocks":[{"kind":"paragraph","text":"Compare two reference points per category, such as before and after or target and actual."},{"kind":"paragraph","text":"Explain the meaning and unit of both endpoints. The connecting length represents their difference."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { category, values: [low, high] }."],["`color`","Set endpoint colors as [first, second]."],["`groups`","Names for the two endpoints."]]},{"kind":"links","items":[{"path":"/charts/dumbbell","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-dumbbell-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-dumbbell-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"data\": [\n          {\n            \"category\": \"Team A\",\n            \"values\": [35, 65]\n          },\n          {\n            \"category\": \"Team B\",\n            \"values\": [50, 75]\n          },\n          {\n            \"category\": \"Team C\",\n            \"values\": [42, 82]\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'dumbbell example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { category, values: [low, high] }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<DumbbellDatum>`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/DumbbellDatum","title":"DumbbellDatum","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Optional category-label override. When set, replaces the per-datum `category` labels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-groups","title":"groups","blocks":[{"kind":"paragraph","text":"Names for the two endpoints."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`groups`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-lowName","title":"lowName","blocks":[{"kind":"paragraph","text":"Compatibility alias for `groups[0]`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lowName`"],["HTML attribute","`low-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-highName","title":"highName","blocks":[{"kind":"paragraph","text":"Compatibility alias for `groups[1]`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`highName`"],["HTML attribute","`high-name`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set endpoint colors as [first, second]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`''`"]]}]},{"id":"property-lineColor","title":"lineColor","blocks":[{"kind":"paragraph","text":"Connector (bar) stroke colour — its own faint default, independent of the `color` pair."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineColor`"],["HTML attribute","`line-color`"],["Type","`string`"],["Default","`'#cbd5e1'`"]]}]},{"id":"property-lineWidth","title":"lineWidth","blocks":[{"kind":"paragraph","text":"Connector width in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineWidth`"],["HTML attribute","`line-width`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"Marker glyph. Polymorphic (like `color`): a single symbol applies to BOTH ends; an array or comma-string is read as `[lowMarker, highMarker]` (a single token leaves the low end on `'circle'` and applies the token to the high end, mirroring the pair rule). Resolved once via `resolvePair`. Per-datum `DumbbellDatum.lowMarker`/`highMarker` override this for individual dumbbells."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DumbbellMarkerSymbol | string | ReadonlyArray<string>`"],["Default","`'circle'`"]]},{"kind":"links","items":[{"path":"/docs/types/DumbbellMarkerSymbol","title":"DumbbellMarkerSymbol","description":"Type definition"}]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"Marker radius in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`6`"]]}]},{"id":"property-sortDescending","title":"sortDescending","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sortDescending`"],["HTML attribute","`sort-descending`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Show the low/high legend. When `false` no legend renders and its reserved space is reclaimed."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Edge the low/high legend attaches to. Default `'top'`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`DumbbellChartLegendPosition`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartLegendPosition","title":"DumbbellChartLegendPosition","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: DumbbellChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: DumbbellChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted. The hit is the dumbbell PAIR (low+high) under the cursor; the default text is `category: low → high`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`DumbbellChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartEasing","title":"DumbbellChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`DumbbellChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartAnimationType","title":"DumbbellChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DumbbellChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartStreamSource","title":"DumbbellChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`DumbbellChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartEngineMode","title":"DumbbellChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`DumbbellChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartUnavailableBehaviour","title":"DumbbellChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DumbbellChartRenderResult & { tier: DumbbellChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // DumbbellChartRenderResult & { tier: DumbbellChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartRenderResult","title":"DumbbellChartRenderResult","description":"Type definition"},{"path":"/docs/types/DumbbellChartEngineTier","title":"DumbbellChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DumbbellChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // DumbbellChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DumbbellChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DumbbellChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // DumbbellChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DumbbellChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<DumbbellChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<DumbbellChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DumbbellChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DumbbellChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // DumbbellChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartLegendItemEventDetail","title":"DumbbellChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DumbbellChartSeriesToggledEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DumbbellChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // DumbbellChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartSeriesToggledEventDetail","title":"DumbbellChartSeriesToggledEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<DumbbellChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DumbbellChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartRenderResult","title":"DumbbellChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<DumbbellChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DumbbellChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartEngineTier","title":"DumbbellChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ReadonlyArray<DumbbellDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<DumbbellDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellDatum","title":"DumbbellDatum","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: DumbbellDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`DumbbellDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellDatum","title":"DumbbellDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<DumbbellPairDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<DumbbellPairDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellPairDatum","title":"DumbbellPairDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<DumbbellPairDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<DumbbellPairDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellPairDatum","title":"DumbbellPairDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<DumbbellChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DumbbellChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartStreamSource","title":"DumbbellChartStreamSource","description":"Type definition"}]}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: DumbbellChartEasing; enabled?: boolean; type?: DumbbellChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: DumbbellChartEasing; enabled?: boolean; type?: DumbbellChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartEasing","title":"DumbbellChartEasing","description":"Type definition"},{"path":"/docs/types/DumbbellChartAnimationType","title":"DumbbellChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<DumbbellChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DumbbellChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/tornado","title":"Tornado","summary":"Compare two groups on opposite sides of a center line.","kind":"component","tag":"sy-tornado-chart","componentId":"tornado","api":{"props":[{"name":"data","attribute":"data","type":"ReadonlyArray<TornadoDatum>","kind":"property","values":[],"default":"[]","description":"An array of { category, values: [left, right] }."},{"name":"groups","attribute":"groups","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"[]","description":"Names for the two groups."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"name":"leftValues","attribute":"left-values","type":"TornadoChartValues","kind":"property","values":[],"default":"undefined","description":"Deprecated fallback: prefer `data` + `groups`, matching dot-plot."},{"name":"rightValues","attribute":"right-values","type":"TornadoChartValues","kind":"property","values":[],"default":"undefined","description":"Deprecated fallback: prefer `data` + `groups`, matching dot-plot."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"680","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"380","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"''","description":"Set group colors as [left, right]."},{"name":"leftLabel","attribute":"left-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Deprecated fallback: prefer `groups[0]`."},{"name":"rightLabel","attribute":"right-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Deprecated fallback: prefer `groups[1]`."},{"name":"barPadding","attribute":"bar-padding","type":"number","kind":"number","values":[],"default":"0.3","description":"Vertical gap between bars as a fraction of each band (0..0.6)."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: TornadoChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: TornadoChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"TornadoChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"TornadoChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"TornadoChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"TornadoChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"TornadoChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<TornadoChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<TornadoChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"data","type":"ReadonlyArray<TornadoDatum> | TornadoChartValues","optional":false},{"name":"rightValues","type":"TornadoChartValues","optional":true}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"TornadoRowDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<TornadoRowDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<TornadoRowDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<TornadoChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: TornadoChartEasing; enabled?: boolean; type?: TornadoChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<TornadoChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false},{"name":"seriesIndex","type":"number | TornadoChartSide","optional":true}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"TornadoChartRenderResult & { tier: TornadoChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"TornadoChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"TornadoChartPointerEventDetail | null","description":"CustomEvent.detail type: TornadoChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<TornadoChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<TornadoChartPointerEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-tornado-chart","blocks":[{"kind":"paragraph","text":"Use for two groups with shared categories, such as age bands or products."},{"kind":"paragraph","text":"The two sides separate direction. Do not arbitrarily negate the input values."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { category, values: [left, right] }."],["`color`","Set group colors as [left, right]."],["`groups`","Names for the two groups."]]},{"kind":"links","items":[{"path":"/charts/tornado","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-tornado-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-tornado-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"data\": [\n          {\n            \"category\": \"20s\",\n            \"values\": [35, 42]\n          },\n          {\n            \"category\": \"30s\",\n            \"values\": [52, 48]\n          },\n          {\n            \"category\": \"40s\",\n            \"values\": [41, 36]\n          },\n          {\n            \"category\": \"50s\",\n            \"values\": [28, 32]\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'tornado example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { category, values: [left, right] }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<TornadoDatum>`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/TornadoDatum","title":"TornadoDatum","description":"Type definition"}]}]},{"id":"property-groups","title":"groups","blocks":[{"kind":"paragraph","text":"Names for the two groups."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`groups`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`[]`"]]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-leftValues","title":"leftValues","blocks":[{"kind":"paragraph","text":"Deprecated fallback: prefer `data` + `groups`, matching dot-plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`leftValues`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TornadoChartValues`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartValues","title":"TornadoChartValues","description":"Type definition"}]}]},{"id":"property-rightValues","title":"rightValues","blocks":[{"kind":"paragraph","text":"Deprecated fallback: prefer `data` + `groups`, matching dot-plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rightValues`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TornadoChartValues`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartValues","title":"TornadoChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`680`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`380`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set group colors as [left, right]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`''`"]]}]},{"id":"property-leftLabel","title":"leftLabel","blocks":[{"kind":"paragraph","text":"Deprecated fallback: prefer `groups[0]`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`leftLabel`"],["HTML attribute","`left-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-rightLabel","title":"rightLabel","blocks":[{"kind":"paragraph","text":"Deprecated fallback: prefer `groups[1]`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rightLabel`"],["HTML attribute","`right-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-barPadding","title":"barPadding","blocks":[{"kind":"paragraph","text":"Vertical gap between bars as a fraction of each band (0..0.6)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barPadding`"],["HTML attribute","`bar-padding`"],["Type","`number`"],["Default","`0.3`"]]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: TornadoChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: TornadoChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`TornadoChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/TornadoChartEasing","title":"TornadoChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`TornadoChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartAnimationType","title":"TornadoChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TornadoChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartStreamSource","title":"TornadoChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`TornadoChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/TornadoChartEngineMode","title":"TornadoChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`TornadoChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/TornadoChartUnavailableBehaviour","title":"TornadoChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TornadoChartRenderResult & { tier: TornadoChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // TornadoChartRenderResult & { tier: TornadoChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TornadoChartRenderResult","title":"TornadoChartRenderResult","description":"Type definition"},{"path":"/docs/types/TornadoChartEngineTier","title":"TornadoChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TornadoChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // TornadoChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: TornadoChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TornadoChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // TornadoChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<TornadoChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<TornadoChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<TornadoChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<TornadoChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TornadoChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartRenderResult","title":"TornadoChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<TornadoChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TornadoChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartEngineTier","title":"TornadoChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ReadonlyArray<TornadoDatum> | TornadoChartValues, rightValues?: TornadoChartValues): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<TornadoDatum> | TornadoChartValues`","Required"],["`rightValues`","`TornadoChartValues`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoDatum","title":"TornadoDatum","description":"Type definition"},{"path":"/docs/types/TornadoChartValues","title":"TornadoChartValues","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: TornadoRowDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`TornadoRowDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoRowDatum","title":"TornadoRowDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<TornadoRowDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<TornadoRowDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoRowDatum","title":"TornadoRowDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<TornadoRowDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<TornadoRowDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoRowDatum","title":"TornadoRowDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<TornadoChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TornadoChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartStreamSource","title":"TornadoChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: TornadoChartEasing; enabled?: boolean; type?: TornadoChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: TornadoChartEasing; enabled?: boolean; type?: TornadoChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartEasing","title":"TornadoChartEasing","description":"Type definition"},{"path":"/docs/types/TornadoChartAnimationType","title":"TornadoChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<TornadoChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TornadoChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number, seriesIndex?: number | TornadoChartSide): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"],["`seriesIndex`","`number | TornadoChartSide`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"},{"path":"/docs/types/TornadoChartSide","title":"TornadoChartSide","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/dot-plot","title":"Dot Plot","summary":"Compare multiple measurements per category using dots.","kind":"component","tag":"sy-dot-plot-chart","componentId":"dot-plot","api":{"props":[{"name":"data","attribute":"data","type":"ReadonlyArray<DotPlotDatum>","kind":"property","values":[],"default":"[]","description":"An array of { category, values: [...] }. Each index represents the same group."},{"name":"groups","attribute":"groups","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"[]","description":"Group names corresponding to values indices. Match the group count to each values array's length."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Optional override for category (row) labels; else derived from `data`."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"380","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"''","description":"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."},{"name":"marker","attribute":"marker","type":"DotPlotMarkerSymbol | string | ReadonlyArray<string>","kind":"property","values":[],"default":"'circle'","description":"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."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"6","description":"Marker radius in CSS px."},{"name":"showRowLines","attribute":"show-row-lines","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Draw a faint guide line across each row between its min and max dot."},{"name":"sortDescending","attribute":"sort-descending","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Sort categories by the first series' value, largest first."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis (Y/row) labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"DotPlotChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'top'","description":"Edge the series legend attaches to. Default `'top'`."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: DotPlotChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: DotPlotChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"DotPlotChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"DotPlotChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"DotPlotChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"DotPlotChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"DotPlotChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<DotPlotChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<DotPlotChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"data","type":"ReadonlyArray<DotPlotDatum>","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"DotPlotDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<DotPlotDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<DotPlotDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<DotPlotChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: DotPlotChartEasing; enabled?: boolean; type?: DotPlotChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<DotPlotChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"pointIndex","type":"number","optional":false},{"name":"seriesIndex","type":"number","optional":true}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"showSeries","parameters":[{"name":"id","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"id","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"DotPlotChartRenderResult & { tier: DotPlotChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"DotPlotChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"DotPlotChartPointerEventDetail | null","description":"CustomEvent.detail type: DotPlotChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<DotPlotChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DotPlotChartPointerEventDetail>. Event names are case-sensitive."},{"name":"legendItemClick","type":"DotPlotChartLegendItemEventDetail","description":"CustomEvent.detail type: DotPlotChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"DotPlotChartSeriesToggledEventDetail","description":"CustomEvent.detail type: DotPlotChartSeriesToggledEventDetail. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-dot-plot-chart","blocks":[{"kind":"paragraph","text":"Use to read differences between groups on the same scale."},{"kind":"paragraph","text":"Dots overlap at identical positions. Limit the number of groups and explain the colors and legend."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`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."]]},{"kind":"links","items":[{"path":"/charts/dot-plot","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-dot-plot-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-dot-plot-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"groups\": [\"Reference\", \"Target\", \"Actual\"],\n        \"legend\": true,\n        \"data\": [\n          {\n            \"category\": \"A\",\n            \"values\": [25, 45, 62]\n          },\n          {\n            \"category\": \"B\",\n            \"values\": [38, 55, 70]\n          },\n          {\n            \"category\": \"C\",\n            \"values\": [30, 50, 82]\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'dot-plot example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { category, values: [...] }. Each index represents the same group."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<DotPlotDatum>`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","description":"Type definition"}]}]},{"id":"property-groups","title":"groups","blocks":[{"kind":"paragraph","text":"Group names corresponding to values indices. Match the group count to each values array's length."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`groups`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`[]`"]]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Optional override for category (row) labels; else derived from `data`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`380`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"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."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`''`"]]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"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."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DotPlotMarkerSymbol | string | ReadonlyArray<string>`"],["Default","`'circle'`"]]},{"kind":"links","items":[{"path":"/docs/types/DotPlotMarkerSymbol","title":"DotPlotMarkerSymbol","description":"Type definition"}]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"Marker radius in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`6`"]]}]},{"id":"property-showRowLines","title":"showRowLines","blocks":[{"kind":"paragraph","text":"Draw a faint guide line across each row between its min and max dot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showRowLines`"],["HTML attribute","`show-row-lines`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-sortDescending","title":"sortDescending","blocks":[{"kind":"paragraph","text":"Sort categories by the first series' value, largest first."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sortDescending`"],["HTML attribute","`sort-descending`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis (Y/row) labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Edge the series legend attaches to. Default `'top'`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`DotPlotChartLegendPosition`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartLegendPosition","title":"DotPlotChartLegendPosition","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: DotPlotChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: DotPlotChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`DotPlotChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartEasing","title":"DotPlotChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`DotPlotChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartAnimationType","title":"DotPlotChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DotPlotChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartStreamSource","title":"DotPlotChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`DotPlotChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartEngineMode","title":"DotPlotChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`DotPlotChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartUnavailableBehaviour","title":"DotPlotChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DotPlotChartRenderResult & { tier: DotPlotChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // DotPlotChartRenderResult & { tier: DotPlotChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartRenderResult","title":"DotPlotChartRenderResult","description":"Type definition"},{"path":"/docs/types/DotPlotChartEngineTier","title":"DotPlotChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DotPlotChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // DotPlotChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DotPlotChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DotPlotChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // DotPlotChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DotPlotChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<DotPlotChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<DotPlotChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DotPlotChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DotPlotChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // DotPlotChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartLegendItemEventDetail","title":"DotPlotChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DotPlotChartSeriesToggledEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DotPlotChartSeriesToggledEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // DotPlotChartSeriesToggledEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartSeriesToggledEventDetail","title":"DotPlotChartSeriesToggledEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<DotPlotChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DotPlotChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartRenderResult","title":"DotPlotChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<DotPlotChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DotPlotChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartEngineTier","title":"DotPlotChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ReadonlyArray<DotPlotDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<DotPlotDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: DotPlotDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`DotPlotDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<DotPlotDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<DotPlotDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<DotPlotDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<DotPlotDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<DotPlotChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DotPlotChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartStreamSource","title":"DotPlotChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: DotPlotChartEasing; enabled?: boolean; type?: DotPlotChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: DotPlotChartEasing; enabled?: boolean; type?: DotPlotChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartEasing","title":"DotPlotChartEasing","description":"Type definition"},{"path":"/docs/types/DotPlotChartAnimationType","title":"DotPlotChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<DotPlotChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DotPlotChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(pointIndex: number, seriesIndex?: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pointIndex`","`number`","Required"],["`seriesIndex`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(id: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/variwide","title":"Variwide","summary":"Show two measures through bar height and width.","kind":"component","tag":"sy-variwide-chart","componentId":"variwide","api":{"props":[{"name":"data","attribute":"data","type":"ReadonlyArray<VariwideDatum>","kind":"property","values":[],"default":"[]","description":"An array of { category, value, weight }. value determines height; weight determines width."},{"name":"values","attribute":"values","type":"VariwideChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},{"name":"weights","attribute":"weights","type":"VariwideChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Deprecated fallback: prefer `data` rows with `{ category, value, weight, color? }`."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Deprecated fallback: prefer `data` rows with `{ category, value, weight, color? }`."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"Fallback fill colour for rows without `color`. Accepts a single CSS colour, an array, or a comma-separated string (the first colour is used)."},{"name":"colorful","attribute":"colorful","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Fallback palette mode for rows without `color`."},{"name":"columnGap","attribute":"column-gap","type":"number","kind":"number","values":[],"default":"0.04","description":"Gap between columns as a fraction of each column slot (0..0.45)."},{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"sortDescending","attribute":"sort-descending","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis (column) labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: VariwideChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: VariwideChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"VariwideChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"VariwideChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"VariwideChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"VariwideChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"VariwideChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<VariwideChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<VariwideChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"data","type":"ReadonlyArray<VariwideDatum> | VariwideChartValues","optional":false},{"name":"weights","type":"VariwideChartValues","optional":true}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"VariwideColumnDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<VariwideColumnDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<VariwideColumnDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<VariwideChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: VariwideChartEasing; enabled?: boolean; type?: VariwideChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<VariwideChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"VariwideChartRenderResult & { tier: VariwideChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"VariwideChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"VariwideChartPointerEventDetail | null","description":"CustomEvent.detail type: VariwideChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<VariwideChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<VariwideChartPointerEventDetail>. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-variwide-chart","blocks":[{"kind":"paragraph","text":"Use to express the relationship between two magnitudes, such as unit price and quantity."},{"kind":"paragraph","text":"Label both units so readers do not confuse height with area when widths vary."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { category, value, weight }. value determines height; weight determines width."]]},{"kind":"links","items":[{"path":"/charts/variwide","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-variwide-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-variwide-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"data\": [\n          {\n            \"category\": \"A\",\n            \"value\": 42,\n            \"weight\": 30\n          },\n          {\n            \"category\": \"B\",\n            \"value\": 28,\n            \"weight\": 60\n          },\n          {\n            \"category\": \"C\",\n            \"value\": 18,\n            \"weight\": 20\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'variwide example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { category, value, weight }. value determines height; weight determines width."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<VariwideDatum>`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/VariwideDatum","title":"VariwideDatum","description":"Type definition"}]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Values for a single series. Use the data type required by the selected chart, such as a number array for Line or coordinate array for Scatter. Assign arrays and objects as JavaScript properties."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VariwideChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/VariwideChartValues","title":"VariwideChartValues","description":"Type definition"}]}]},{"id":"property-weights","title":"weights","blocks":[{"kind":"paragraph","text":"Deprecated fallback: prefer `data` rows with `{ category, value, weight, color? }`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weights`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VariwideChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/VariwideChartValues","title":"VariwideChartValues","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Deprecated fallback: prefer `data` rows with `{ category, value, weight, color? }`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Fallback fill colour for rows without `color`. Accepts a single CSS colour, an array, or a comma-separated string (the first colour is used)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"property-colorful","title":"colorful","blocks":[{"kind":"paragraph","text":"Fallback palette mode for rows without `color`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorful`"],["HTML attribute","`colorful`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-columnGap","title":"columnGap","blocks":[{"kind":"paragraph","text":"Gap between columns as a fraction of each column slot (0..0.45)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`columnGap`"],["HTML attribute","`column-gap`"],["Type","`number`"],["Default","`0.04`"]]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-sortDescending","title":"sortDescending","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sortDescending`"],["HTML attribute","`sort-descending`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis (column) labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: VariwideChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: VariwideChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`VariwideChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/VariwideChartEasing","title":"VariwideChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`VariwideChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartAnimationType","title":"VariwideChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VariwideChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartStreamSource","title":"VariwideChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`VariwideChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/VariwideChartEngineMode","title":"VariwideChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`VariwideChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/VariwideChartUnavailableBehaviour","title":"VariwideChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<VariwideChartRenderResult & { tier: VariwideChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // VariwideChartRenderResult & { tier: VariwideChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/VariwideChartRenderResult","title":"VariwideChartRenderResult","description":"Type definition"},{"path":"/docs/types/VariwideChartEngineTier","title":"VariwideChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<VariwideChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // VariwideChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: VariwideChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<VariwideChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // VariwideChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<VariwideChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<VariwideChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<VariwideChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<VariwideChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VariwideChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartRenderResult","title":"VariwideChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<VariwideChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VariwideChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartEngineTier","title":"VariwideChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ReadonlyArray<VariwideDatum> | VariwideChartValues, weights?: VariwideChartValues): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<VariwideDatum> | VariwideChartValues`","Required"],["`weights`","`VariwideChartValues`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideDatum","title":"VariwideDatum","description":"Type definition"},{"path":"/docs/types/VariwideChartValues","title":"VariwideChartValues","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: VariwideColumnDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`VariwideColumnDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideColumnDatum","title":"VariwideColumnDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<VariwideColumnDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<VariwideColumnDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideColumnDatum","title":"VariwideColumnDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<VariwideColumnDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<VariwideColumnDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideColumnDatum","title":"VariwideColumnDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<VariwideChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VariwideChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartStreamSource","title":"VariwideChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: VariwideChartEasing; enabled?: boolean; type?: VariwideChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: VariwideChartEasing; enabled?: boolean; type?: VariwideChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartEasing","title":"VariwideChartEasing","description":"Type definition"},{"path":"/docs/types/VariwideChartAnimationType","title":"VariwideChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<VariwideChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VariwideChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/marimekko","title":"Marimekko","summary":"Show group size and internal proportions together.","kind":"component","tag":"sy-marimekko-chart","componentId":"marimekko","api":{"props":[{"name":"series","attribute":"series","type":"ReadonlyArray<MarimekkoSeries>","kind":"property","values":[],"default":"[]","description":"An array of { name, values }. Columns in values correspond to categories."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Names of the groups whose widths are compared."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"680","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"380","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"columnGap","attribute":"column-gap","type":"number","kind":"number","values":[],"default":"0.01","description":"Horizontal gap between columns as a fraction of each slot (0..0.3)."},{"name":"showColumnShare","attribute":"show-column-share","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the per-column total percentage above each column."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis (column) labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"Segment colours. Overrides the built-in per-series palette: a single CSS colour, an array, or a comma-separated string. Colour `i` applies to segment `i`; where the list is shorter than the segment count the built-in palette fills the remaining indices. A segment's own `color` (in `series`) always wins over this attribute."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"MarimekkoChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'top'","description":"Where the legend is positioned."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: MarimekkoChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: MarimekkoChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"MarimekkoChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"MarimekkoChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"MarimekkoChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"MarimekkoChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"MarimekkoChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<MarimekkoChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<MarimekkoChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"series","type":"ReadonlyArray<MarimekkoSeries>","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"MarimekkoColumnDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<MarimekkoColumnDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<MarimekkoColumnDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<MarimekkoChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: MarimekkoChartEasing; enabled?: boolean; type?: MarimekkoChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<MarimekkoChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"columnIndex","type":"number","optional":false},{"name":"seriesIndex","type":"number","optional":true}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"addSeries","parameters":[{"name":"series","type":"MarimekkoSeries","optional":false},{"name":"opts","type":"{ redraw?: boolean; insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"removeSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"updateSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<MarimekkoSeries>","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setSeriesData","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"values","type":"ReadonlyArray<number> | Float32Array","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideSeries","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"opts","type":"{ redraw?: boolean }","optional":true}],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"MarimekkoChartRenderResult & { tier: MarimekkoChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"MarimekkoChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"MarimekkoChartPointerEventDetail | null","description":"CustomEvent.detail type: MarimekkoChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<MarimekkoChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<MarimekkoChartPointerEventDetail>. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"MarimekkoChartLegendItemEventDetail","description":"CustomEvent.detail type: MarimekkoChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"{ index: number; seriesId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-marimekko-chart","blocks":[{"kind":"paragraph","text":"Compare market totals alongside product shares."},{"kind":"paragraph","text":"Both width and vertical proportions vary. Supplement precise values with tooltips or a table."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`series`","An array of { name, values }. Columns in values correspond to categories."],["`categories`","Names of the groups whose widths are compared."]]},{"kind":"links","items":[{"path":"/charts/marimekko","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-marimekko-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-marimekko-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"categories\": [\"Domestic\", \"Asia\", \"Europe\"],\n        \"series\": [\n          {\n            \"name\": \"A\",\n            \"values\": [40, 30, 20],\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"name\": \"B\",\n            \"values\": [25, 45, 15],\n            \"color\": \"#239c91\"\n          }\n        ],\n        \"legend\": true,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'marimekko example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-series","title":"series","blocks":[{"kind":"paragraph","text":"An array of { name, values }. Columns in values correspond to categories."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<MarimekkoSeries>`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/MarimekkoSeries","title":"MarimekkoSeries","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Names of the groups whose widths are compared."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`680`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`380`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-columnGap","title":"columnGap","blocks":[{"kind":"paragraph","text":"Horizontal gap between columns as a fraction of each slot (0..0.3)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`columnGap`"],["HTML attribute","`column-gap`"],["Type","`number`"],["Default","`0.01`"]]}]},{"id":"property-showColumnShare","title":"showColumnShare","blocks":[{"kind":"paragraph","text":"Show the per-column total percentage above each column."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showColumnShare`"],["HTML attribute","`show-column-share`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis (column) labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Segment colours. Overrides the built-in per-series palette: a single CSS colour, an array, or a comma-separated string. Colour `i` applies to segment `i`; where the list is shorter than the segment count the built-in palette fills the remaining indices. A segment's own `color` (in `series`) always wins over this attribute."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`MarimekkoChartLegendPosition`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartLegendPosition","title":"MarimekkoChartLegendPosition","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: MarimekkoChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: MarimekkoChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`MarimekkoChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartEasing","title":"MarimekkoChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`MarimekkoChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartAnimationType","title":"MarimekkoChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`MarimekkoChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartStreamSource","title":"MarimekkoChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`MarimekkoChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartEngineMode","title":"MarimekkoChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`MarimekkoChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartUnavailableBehaviour","title":"MarimekkoChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<MarimekkoChartRenderResult & { tier: MarimekkoChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // MarimekkoChartRenderResult & { tier: MarimekkoChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartRenderResult","title":"MarimekkoChartRenderResult","description":"Type definition"},{"path":"/docs/types/MarimekkoChartEngineTier","title":"MarimekkoChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<MarimekkoChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // MarimekkoChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: MarimekkoChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<MarimekkoChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // MarimekkoChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<MarimekkoChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<MarimekkoChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<MarimekkoChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: MarimekkoChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<MarimekkoChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // MarimekkoChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartLegendItemEventDetail","title":"MarimekkoChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // { index: number; seriesId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<MarimekkoChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<MarimekkoChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartRenderResult","title":"MarimekkoChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<MarimekkoChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<MarimekkoChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartEngineTier","title":"MarimekkoChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(series: ReadonlyArray<MarimekkoSeries>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`ReadonlyArray<MarimekkoSeries>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoSeries","title":"MarimekkoSeries","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: MarimekkoColumnDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`MarimekkoColumnDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoColumnDatum","title":"MarimekkoColumnDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<MarimekkoColumnDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<MarimekkoColumnDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoColumnDatum","title":"MarimekkoColumnDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<MarimekkoColumnDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<MarimekkoColumnDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoColumnDatum","title":"MarimekkoColumnDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<MarimekkoChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<MarimekkoChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartStreamSource","title":"MarimekkoChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: MarimekkoChartEasing; enabled?: boolean; type?: MarimekkoChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: MarimekkoChartEasing; enabled?: boolean; type?: MarimekkoChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartEasing","title":"MarimekkoChartEasing","description":"Type definition"},{"path":"/docs/types/MarimekkoChartAnimationType","title":"MarimekkoChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<MarimekkoChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<MarimekkoChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(columnIndex: number, seriesIndex?: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`columnIndex`","`number`","Required"],["`seriesIndex`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-addSeries","title":"addSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"addSeries(series: MarimekkoSeries, opts?: { redraw?: boolean; insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`MarimekkoSeries`","Required"],["`opts`","`{ redraw?: boolean; insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoSeries","title":"MarimekkoSeries","description":"Type definition"}]}]},{"id":"method-removeSeries","title":"removeSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"removeSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSeries","title":"updateSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"updateSeries(idOrIndex: string | number, patch: Partial<MarimekkoSeries>, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<MarimekkoSeries>`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/MarimekkoSeries","title":"MarimekkoSeries","description":"Type definition"}]}]},{"id":"method-setSeriesData","title":"setSeriesData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setSeriesData(idOrIndex: string | number, values: ReadonlyArray<number> | Float32Array, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`values`","`ReadonlyArray<number> | Float32Array`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showSeries","title":"showSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideSeries","title":"hideSeries","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hideSeries(idOrIndex: string | number, opts?: { redraw?: boolean }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`opts`","`{ redraw?: boolean }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/waterfall","title":"Waterfall","summary":"Show how increases and decreases accumulate into a final value.","kind":"component","tag":"sy-waterfall-chart","componentId":"waterfall","api":{"props":[{"name":"data","attribute":"data","type":"WaterfallData","kind":"property","values":[],"default":"undefined","description":"An array of { category, value?, kind? }. kind is delta, subtotal, or total."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"xAxis","attribute":"x-axis","type":"XAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Grid lines: the value axis's on by default, the category axis's off."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"name":"yMin","attribute":"y-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMax","attribute":"y-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"0.05","description":"The automatic domain pads the value span by this share (default 5 %); zero is always inside."},{"name":"upColor","attribute":"up-color","type":"string","kind":"string","values":[],"default":"DEFAULT_UP_COLOR","description":"The bar colours: a rising delta, a falling delta, a total / subtotal; the connectors; the hovered / focused bar."},{"name":"downColor","attribute":"down-color","type":"string","kind":"string","values":[],"default":"DEFAULT_DOWN_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"totalColor","attribute":"total-color","type":"string","kind":"string","values":[],"default":"DEFAULT_TOTAL_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"connectorColor","attribute":"connector-color","type":"string","kind":"string","values":[],"default":"DEFAULT_CONNECTOR_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"DEFAULT_ACTIVE_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"barWidth","attribute":"bar-width","type":"number","kind":"number","values":[],"default":"WATERFALL_DEFAULT_WIDTH_RATIO","description":"The bar's share of the slot pitch (0.6), clamped between `bar-min-px` and `bar-max-px`."},{"name":"barMinPx","attribute":"bar-min-px","type":"number","kind":"number","values":[],"default":"WATERFALL_DEFAULT_MIN_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"barMaxPx","attribute":"bar-max-px","type":"number","kind":"number","values":[],"default":"WATERFALL_DEFAULT_MAX_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"connectorWidth","attribute":"connector-width","type":"number","kind":"number","values":[],"default":"1","description":"The connector's thickness in CSS px, and its switch."},{"name":"showConnectors","attribute":"show-connectors","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"showTotal","attribute":"show-total","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Append a grand-total bar after the last step (unless it already is a total), named `total-label` ()."},{"name":"totalLabel","attribute":"total-label","type":"string","kind":"string","values":[],"default":"WATERFALL_DEFAULT_TOTAL_LABEL","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"detectResult","attribute":"detect-result","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Recognise a last step given as a plain value equal to the running total as the RESULT bar (a total from zero; `detected: true`); off → it stays a delta."},{"name":"lastResult","attribute":"last-result","type":"boolean","kind":"boolean","values":[],"default":"undefined","description":"True: the last merged step is a result spanning zero and the preceding running total, ignoring its value/colour. False: disable detection, preserving explicit datum kinds. Omitted: use detect-result."},{"name":"showLabels","attribute":"show-labels","type":"boolean","kind":"boolean","values":[],"default":"false","description":"The value labels (off by default): `label-mode` value (a delta's signed change, a total's running total) / running / both; `labelFormat(bar)` replaces the text."},{"name":"labelMode","attribute":"label-mode","type":"WaterfallLabelMode","kind":"string","values":["value","running","both"],"default":"'value'","description":"Allowed values: value, running, both. Default: 'value'."},{"name":"labelFormat","attribute":"label-format","type":"(bar: WaterfallBar) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (bar: WaterfallBar) => string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"The bar tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: WaterfallPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: WaterfallPointEventDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"WaterfallEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"WaterfallAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"WaterfallStreamSource","kind":"property","values":[],"default":"undefined","description":"§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Steps tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed steps the chart renders (the whole buffer when unset)."},{"name":"engine","attribute":"engine","type":"WaterfallEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"WaterfallUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<WaterfallRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<WaterfallEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"WaterfallData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"WaterfallDatumInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<WaterfallDatumInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed steps (the `data` bars are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<WaterfallDatumInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<WaterfallStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: WaterfallEasing; enabled?: boolean; type?: WaterfallAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<WaterfallPointEventDetail | null>","description":"The bar under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"getBar","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<WaterfallBar | null>","description":"The normalised bar at an index (null outside)."},{"name":"getBarByCategory","parameters":[{"name":"category","type":"string","optional":false}],"returns":"Promise<WaterfallBar | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getBarCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getBars","parameters":[],"returns":"Promise<WaterfallBar[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getCategories","parameters":[],"returns":"Promise<string[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<WaterfallExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDomain","parameters":[],"returns":"Promise<WaterfallDomain>","description":"The data domain the grid spans."},{"name":"getRunningTotal","parameters":[],"returns":"Promise<number>","description":"The running total after the last bar (0 without bars)."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"Open the tooltip on a bar (the facade's `showTooltipAtPoint` routes here); null off the bars or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusBarAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<WaterfallPointEventDetail | null>","description":"Move the keyboard focus ring to a bar (null off the bars); emits pointHover like the walk."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation; x is in slots — bar i sits at i); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }` — x in slots); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — master axes (x: the slot range −0.5 … n − 0.5)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"WaterfallRenderResult & { tier: WaterfallEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"WaterfallPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"WaterfallPointEventDetail | null","description":"CustomEvent.detail type: WaterfallPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<WaterfallPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<WaterfallPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"The shared tooltip events (the controller emits them)."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-waterfall-chart","blocks":[{"kind":"paragraph","text":"Explain the opening value, changes, and total for revenue, costs, or inventory."},{"kind":"paragraph","text":"total and subtotal differ from ordinary changes. Do not add a total again as a delta."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { category, value?, kind? }. kind is delta, subtotal, or total."]]},{"kind":"links","items":[{"path":"/charts/waterfall","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-waterfall-chart.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-waterfall-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"category\": \"Opening\",\n            \"value\": 100\n          },\n          {\n            \"category\": \"New\",\n            \"value\": 45\n          },\n          {\n            \"category\": \"Cancellations\",\n            \"value\": -20\n          },\n          {\n            \"category\": \"Additions\",\n            \"value\": 15\n          },\n          {\n            \"category\": \"Total\",\n            \"kind\": \"total\"\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'waterfall example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { category, value?, kind? }. kind is delta, subtotal, or total."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaterfallData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaterfallData","title":"WaterfallData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`XAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/XAxisInput","title":"XAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Grid lines: the value axis's on by default, the category axis's off."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-yMin","title":"yMin","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMin`"],["HTML attribute","`y-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMax","title":"yMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMax`"],["HTML attribute","`y-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"The automatic domain pads the value span by this share (default 5 %); zero is always inside."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`0.05`"]]}]},{"id":"property-upColor","title":"upColor","blocks":[{"kind":"paragraph","text":"The bar colours: a rising delta, a falling delta, a total / subtotal; the connectors; the hovered / focused bar."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`upColor`"],["HTML attribute","`up-color`"],["Type","`string`"],["Default","`DEFAULT_UP_COLOR`"]]}]},{"id":"property-downColor","title":"downColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`downColor`"],["HTML attribute","`down-color`"],["Type","`string`"],["Default","`DEFAULT_DOWN_COLOR`"]]}]},{"id":"property-totalColor","title":"totalColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`totalColor`"],["HTML attribute","`total-color`"],["Type","`string`"],["Default","`DEFAULT_TOTAL_COLOR`"]]}]},{"id":"property-connectorColor","title":"connectorColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectorColor`"],["HTML attribute","`connector-color`"],["Type","`string`"],["Default","`DEFAULT_CONNECTOR_COLOR`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`DEFAULT_ACTIVE_COLOR`"]]}]},{"id":"property-barWidth","title":"barWidth","blocks":[{"kind":"paragraph","text":"The bar's share of the slot pitch (0.6), clamped between `bar-min-px` and `bar-max-px`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barWidth`"],["HTML attribute","`bar-width`"],["Type","`number`"],["Default","`WATERFALL_DEFAULT_WIDTH_RATIO`"]]}]},{"id":"property-barMinPx","title":"barMinPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barMinPx`"],["HTML attribute","`bar-min-px`"],["Type","`number`"],["Default","`WATERFALL_DEFAULT_MIN_PX`"]]}]},{"id":"property-barMaxPx","title":"barMaxPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barMaxPx`"],["HTML attribute","`bar-max-px`"],["Type","`number`"],["Default","`WATERFALL_DEFAULT_MAX_PX`"]]}]},{"id":"property-connectorWidth","title":"connectorWidth","blocks":[{"kind":"paragraph","text":"The connector's thickness in CSS px, and its switch."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectorWidth`"],["HTML attribute","`connector-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-showConnectors","title":"showConnectors","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showConnectors`"],["HTML attribute","`show-connectors`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-showTotal","title":"showTotal","blocks":[{"kind":"paragraph","text":"Append a grand-total bar after the last step (unless it already is a total), named `total-label` ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showTotal`"],["HTML attribute","`show-total`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-totalLabel","title":"totalLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`totalLabel`"],["HTML attribute","`total-label`"],["Type","`string`"],["Default","`WATERFALL_DEFAULT_TOTAL_LABEL`"]]}]},{"id":"property-detectResult","title":"detectResult","blocks":[{"kind":"paragraph","text":"Recognise a last step given as a plain value equal to the running total as the RESULT bar (a total from zero; `detected: true`); off → it stays a delta."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`detectResult`"],["HTML attribute","`detect-result`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-lastResult","title":"lastResult","blocks":[{"kind":"paragraph","text":"True: the last merged step is a result spanning zero and the preceding running total, ignoring its value/colour. False: disable detection, preserving explicit datum kinds. Omitted: use detect-result."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lastResult`"],["HTML attribute","`last-result`"],["Type","`boolean`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-showLabels","title":"showLabels","blocks":[{"kind":"paragraph","text":"The value labels (off by default): `label-mode` value (a delta's signed change, a total's running total) / running / both; `labelFormat(bar)` replaces the text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showLabels`"],["HTML attribute","`show-labels`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-labelMode","title":"labelMode","blocks":[{"kind":"paragraph","text":"Allowed values: value, running, both. Default: 'value'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelMode`"],["HTML attribute","`label-mode`"],["Type","`WaterfallLabelMode`"],["Default","`'value'`"],["Allowed values","`value`, `running`, `both`"]]},{"kind":"links","items":[{"path":"/docs/types/WaterfallLabelMode","title":"WaterfallLabelMode","description":"Type definition"}]}]},{"id":"property-labelFormat","title":"labelFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (bar: WaterfallBar) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(bar: WaterfallBar) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaterfallBar","title":"WaterfallBar","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"The bar tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: WaterfallPointEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: WaterfallPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`WaterfallEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/WaterfallEasing","title":"WaterfallEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`WaterfallAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaterfallAnimationType","title":"WaterfallAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaterfallStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaterfallStreamSource","title":"WaterfallStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Steps tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed steps the chart renders (the whole buffer when unset)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`WaterfallEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/WaterfallEngineMode","title":"WaterfallEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`WaterfallUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/WaterfallUnavailableBehaviour","title":"WaterfallUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaterfallRenderResult & { tier: WaterfallEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // WaterfallRenderResult & { tier: WaterfallEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaterfallRenderResult","title":"WaterfallRenderResult","description":"Type definition"},{"path":"/docs/types/WaterfallEngineTier","title":"WaterfallEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaterfallPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // WaterfallPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: WaterfallPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaterfallPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // WaterfallPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<WaterfallPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<WaterfallPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<WaterfallPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"The shared tooltip events (the controller emits them)."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<WaterfallRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaterfallRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallRenderResult","title":"WaterfallRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<WaterfallEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaterfallEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallEngineTier","title":"WaterfallEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: WaterfallData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`WaterfallData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallData","title":"WaterfallData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: WaterfallDatumInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`WaterfallDatumInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<WaterfallDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<WaterfallDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed steps (the `data` bars are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<WaterfallDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<WaterfallDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<WaterfallStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaterfallStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallStreamSource","title":"WaterfallStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: WaterfallEasing; enabled?: boolean; type?: WaterfallAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: WaterfallEasing; enabled?: boolean; type?: WaterfallAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallEasing","title":"WaterfallEasing","description":"Type definition"},{"path":"/docs/types/WaterfallAnimationType","title":"WaterfallAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The bar under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<WaterfallPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WaterfallPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":"Type definition"}]}]},{"id":"method-getBar","title":"getBar","blocks":[{"kind":"paragraph","text":"The normalised bar at an index (null outside)."},{"kind":"code","source":"getBar(index: number): Promise<WaterfallBar | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WaterfallBar | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallBar","title":"WaterfallBar","description":"Type definition"}]}]},{"id":"method-getBarByCategory","title":"getBarByCategory","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBarByCategory(category: string): Promise<WaterfallBar | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`category`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WaterfallBar | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallBar","title":"WaterfallBar","description":"Type definition"}]}]},{"id":"method-getBarCount","title":"getBarCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBarCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getBars","title":"getBars","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBars(): Promise<WaterfallBar[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaterfallBar[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallBar","title":"WaterfallBar","description":"Type definition"}]}]},{"id":"method-getCategories","title":"getCategories","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getCategories(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<WaterfallExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaterfallExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallExtent","title":"WaterfallExtent","description":"Type definition"}]}]},{"id":"method-getDomain","title":"getDomain","blocks":[{"kind":"paragraph","text":"The data domain the grid spans."},{"kind":"code","source":"getDomain(): Promise<WaterfallDomain>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaterfallDomain>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallDomain","title":"WaterfallDomain","description":"Type definition"}]}]},{"id":"method-getRunningTotal","title":"getRunningTotal","blocks":[{"kind":"paragraph","text":"The running total after the last bar (0 without bars)."},{"kind":"code","source":"getRunningTotal(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"Open the tooltip on a bar (the facade's `showTooltipAtPoint` routes here); null off the bars or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusBarAt","title":"focusBarAt","blocks":[{"kind":"paragraph","text":"Move the keyboard focus ring to a bar (null off the bars); emits pointHover like the walk."},{"kind":"code","source":"focusBarAt(index: number): Promise<WaterfallPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WaterfallPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation; x is in slots — bar i sits at i); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }` — x in slots); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — master axes (x: the slot range −0.5 … n − 0.5)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/pareto","title":"Pareto","summary":"Identify major causes using counts and cumulative percentages.","kind":"component","tag":"sy-pareto-chart","componentId":"pareto","api":{"props":[{"name":"values","attribute":"values","type":"ParetoChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Occurrence counts for each category."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Cause names at the same indices as the values."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"Bar fill colour. Accepts a single CSS colour, an array, or a comma-separated string (the first colour is used)."},{"name":"lineColor","attribute":"line-color","type":"string","kind":"string","values":[],"default":"'#ef4444'","description":"Cumulative-line colour."},{"name":"lineWidth","attribute":"line-width","type":"number","kind":"number","values":[],"default":"2","description":"Cumulative-line width in CSS px."},{"name":"marker","attribute":"marker","type":"'circle' | 'square' | 'diamond' | 'none'","kind":"string","values":["none","circle","square","diamond"],"default":"'circle'","description":"Endpoint marker symbol on the cumulative line. `none` hides markers."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"3.5","description":"Marker radius in CSS px."},{"name":"baseline","attribute":"baseline","type":"number","kind":"number","values":[],"default":"0","description":"Value the bars grow from. Default 0."},{"name":"barPadding","attribute":"bar-padding","type":"number","kind":"number","values":[],"default":"0.2","description":"Gap between adjacent bars as a fraction of the band width (0..1)."},{"name":"sortDescending","attribute":"sort-descending","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Sort categories by value, largest first (classic Pareto ordering)."},{"name":"referenceValue","attribute":"reference-value","type":"number","kind":"number","values":[],"default":"80","description":"80/20 reference percentage drawn as a horizontal line on the cumulative axis."},{"name":"showReference","attribute":"show-reference","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the reference line."},{"name":"referenceColor","attribute":"reference-color","type":"string","kind":"string","values":[],"default":"'#94a3b8'","description":"Reference-line colour."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Left value-axis label."},{"name":"cumulativeAxisLabel","attribute":"cumulative-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Right cumulative-axis label."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"yAxis","attribute":"y-axis","type":"CartesianYAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping vertical line; pass an object to set mode/snap/color/dash."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: ParetoChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: ParetoChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"ParetoChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"700","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ParetoChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ParetoChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"ParetoChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"ParetoChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"ParetoChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<ParetoChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<ParetoChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"values","type":"ParetoChartValues","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"ParetoBarDatum | number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<ParetoBarDatum | number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<ParetoBarDatum | number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ParetoChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: ParetoChartEasing; enabled?: boolean; type?: ParetoChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<ParetoChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"ParetoChartRenderResult & { tier: ParetoChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"ParetoChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"ParetoChartPointerEventDetail | null","description":"CustomEvent.detail type: ParetoChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<ParetoChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ParetoChartPointerEventDetail>. Event names are case-sensitive."},{"name":"legendItemClick","type":"ParetoChartLegendItemEventDetail","description":"CustomEvent.detail type: ParetoChartLegendItemEventDetail. Event names are case-sensitive."},{"name":"seriesToggled","type":"{ index: number; seriesId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-pareto-chart","blocks":[{"kind":"paragraph","text":"Explore defect or support-request causes in priority order."},{"kind":"paragraph","text":"Frequency and severity differ. Assess infrequent, high-risk causes separately."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","Occurrence counts for each category."],["`categories`","Cause names at the same indices as the values."]]},{"kind":"links","items":[{"path":"/charts/pareto","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-pareto-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-pareto-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [45, 28, 15, 8, 4],\n        \"categories\": [\"Scratches\", \"Contamination\", \"Sort\", \"Bonding\", \"Other\"],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'pareto example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Occurrence counts for each category."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParetoChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/ParetoChartValues","title":"ParetoChartValues","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Cause names at the same indices as the values."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Bar fill colour. Accepts a single CSS colour, an array, or a comma-separated string (the first colour is used)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"property-lineColor","title":"lineColor","blocks":[{"kind":"paragraph","text":"Cumulative-line colour."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineColor`"],["HTML attribute","`line-color`"],["Type","`string`"],["Default","`'#ef4444'`"]]}]},{"id":"property-lineWidth","title":"lineWidth","blocks":[{"kind":"paragraph","text":"Cumulative-line width in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineWidth`"],["HTML attribute","`line-width`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"Endpoint marker symbol on the cumulative line. `none` hides markers."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","`marker`"],["Type","`'circle' | 'square' | 'diamond' | 'none'`"],["Default","`'circle'`"],["Allowed values","`none`, `circle`, `square`, `diamond`"]]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"Marker radius in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`3.5`"]]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Value the bars grow from. Default 0."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","`baseline`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-barPadding","title":"barPadding","blocks":[{"kind":"paragraph","text":"Gap between adjacent bars as a fraction of the band width (0..1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barPadding`"],["HTML attribute","`bar-padding`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-sortDescending","title":"sortDescending","blocks":[{"kind":"paragraph","text":"Sort categories by value, largest first (classic Pareto ordering)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sortDescending`"],["HTML attribute","`sort-descending`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-referenceValue","title":"referenceValue","blocks":[{"kind":"paragraph","text":"80/20 reference percentage drawn as a horizontal line on the cumulative axis."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`referenceValue`"],["HTML attribute","`reference-value`"],["Type","`number`"],["Default","`80`"]]}]},{"id":"property-showReference","title":"showReference","blocks":[{"kind":"paragraph","text":"Show the reference line."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showReference`"],["HTML attribute","`show-reference`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-referenceColor","title":"referenceColor","blocks":[{"kind":"paragraph","text":"Reference-line colour."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`referenceColor`"],["HTML attribute","`reference-color`"],["Type","`string`"],["Default","`'#94a3b8'`"]]}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Left value-axis label."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-cumulativeAxisLabel","title":"cumulativeAxisLabel","blocks":[{"kind":"paragraph","text":"Right cumulative-axis label."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cumulativeAxisLabel`"],["HTML attribute","`cumulative-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianYAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping vertical line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: ParetoChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: ParetoChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column/lollipop family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`ParetoChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/ParetoChartLegendPosition","title":"ParetoChartLegendPosition","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`700`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ParetoChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ParetoChartEasing","title":"ParetoChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ParetoChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartAnimationType","title":"ParetoChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParetoChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartStreamSource","title":"ParetoChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ParetoChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ParetoChartEngineMode","title":"ParetoChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ParetoChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/ParetoChartUnavailableBehaviour","title":"ParetoChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParetoChartRenderResult & { tier: ParetoChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ParetoChartRenderResult & { tier: ParetoChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParetoChartRenderResult","title":"ParetoChartRenderResult","description":"Type definition"},{"path":"/docs/types/ParetoChartEngineTier","title":"ParetoChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParetoChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // ParetoChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParetoChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParetoChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // ParetoChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ParetoChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<ParetoChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<ParetoChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParetoChartLegendItemEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParetoChartLegendItemEventDetail>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // ParetoChartLegendItemEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParetoChartLegendItemEventDetail","title":"ParetoChartLegendItemEventDetail","description":"Type definition"}]}]},{"id":"event-seriesToggled","title":"seriesToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('seriesToggled', event => {\n  console.log(event.detail); // { index: number; seriesId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ParetoChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParetoChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartRenderResult","title":"ParetoChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<ParetoChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParetoChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartEngineTier","title":"ParetoChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(values: ParetoChartValues): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ParetoChartValues`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartValues","title":"ParetoChartValues","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: ParetoBarDatum | number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`ParetoBarDatum | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoBarDatum","title":"ParetoBarDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<ParetoBarDatum | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<ParetoBarDatum | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoBarDatum","title":"ParetoBarDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<ParetoBarDatum | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<ParetoBarDatum | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoBarDatum","title":"ParetoBarDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ParetoChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParetoChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartStreamSource","title":"ParetoChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: ParetoChartEasing; enabled?: boolean; type?: ParetoChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: ParetoChartEasing; enabled?: boolean; type?: ParetoChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartEasing","title":"ParetoChartEasing","description":"Type definition"},{"path":"/docs/types/ParetoChartAnimationType","title":"ParetoChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<ParetoChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParetoChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/histogram","title":"Histogram","summary":"Summarize continuous measurements as interval frequencies.","kind":"component","tag":"sy-histogram-chart","componentId":"histogram","api":{"props":[{"name":"values","attribute":"values","type":"HistogramValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Raw numeric samples, not pre-aggregated bin counts."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"bins","attribute":"bins","type":"HistogramBinsRule","kind":"property","values":["square-root","sturges","rice","scott","freedman-diaconis"],"default":"'square-root'","description":"The number of bins or the binning method."},{"name":"binWidth","attribute":"bin-width","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit bin width — wins over `bins`."},{"name":"domainMin","attribute":"domain-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Domain overrides (observations outside clamp into the edge bins)."},{"name":"domainMax","attribute":"domain-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"Bar fill. Accepts a single CSS colour, an array, or a comma string (first wins)."},{"name":"edgeColor","attribute":"edge-color","type":"string","kind":"string","values":[],"default":"'rgba(255,255,255,0.85)'","description":"1px separator between gapless bars."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#1d4ed8'","description":"Fill for the hovered bin."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"measure","attribute":"measure","type":"HistogramNormalize","kind":"string","values":["percent","count","density"],"default":"'count'","description":"The vertical axis represents count, percent, or density."},{"name":"cumulative","attribute":"cumulative","type":"boolean","kind":"boolean","values":[],"default":"false","description":"running sums (the empirical CDF for density)."},{"name":"barGap","attribute":"bar-gap","type":"number","kind":"number","values":[],"default":"0","description":"a CSS-px gap between the bars (0 = gapless with the edge separators)."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. The bins re-project through the zoomed frame; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: HistogramPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: HistogramPointEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column family)."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"HistogramEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"HistogramAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"HistogramStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"HistogramEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"HistogramUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<HistogramRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<HistogramEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getBinning","parameters":[],"returns":"Promise<HistogramBinning>","description":"the binning decision behind the current bins: the rule, its kind, n, σ, IQR, the width, the count, a fallback."},{"name":"setData","parameters":[{"name":"values","type":"HistogramValues","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<HistogramStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: HistogramEasing; enabled?: boolean; type?: HistogramAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<HistogramPointEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"binIndex","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."}],"events":[{"name":"rendered","type":"HistogramRenderResult & { tier: HistogramEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"HistogramPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"HistogramPointEventDetail | null","description":"CustomEvent.detail type: HistogramPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<HistogramPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<HistogramPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-histogram-chart","blocks":[{"kind":"paragraph","text":"Explore distributions of response times, measurements, prices, and other numeric values."},{"kind":"paragraph","text":"The shape changes with the bin count. Check the raw sample count and bin width together."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","Raw numeric samples, not pre-aggregated bin counts."],["`bins`","The number of bins or the binning method."],["`measure`","The vertical axis represents count, percent, or density."]]},{"kind":"links","items":[{"path":"/charts/histogram","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-histogram-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-histogram-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [23, 25, 28, 29, 30, 31, 31, 32, 32, 33, 34, 34, 35, 35, 36, 37, 38, 39, 42, 45, 48, 52],\n        \"bins\": 6,\n        \"measure\": \"count\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'histogram example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Raw numeric samples, not pre-aggregated bin counts."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HistogramValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/HistogramValues","title":"HistogramValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-bins","title":"bins","blocks":[{"kind":"paragraph","text":"The number of bins or the binning method."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bins`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HistogramBinsRule`"],["Default","`'square-root'`"],["Literals in the type","`square-root`, `sturges`, `rice`, `scott`, `freedman-diaconis`"]]},{"kind":"links","items":[{"path":"/docs/types/HistogramBinsRule","title":"HistogramBinsRule","description":"Type definition"}]}]},{"id":"property-binWidth","title":"binWidth","blocks":[{"kind":"paragraph","text":"Explicit bin width — wins over `bins`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`binWidth`"],["HTML attribute","`bin-width`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-domainMin","title":"domainMin","blocks":[{"kind":"paragraph","text":"Domain overrides (observations outside clamp into the edge bins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`domainMin`"],["HTML attribute","`domain-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-domainMax","title":"domainMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`domainMax`"],["HTML attribute","`domain-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Bar fill. Accepts a single CSS colour, an array, or a comma string (first wins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"property-edgeColor","title":"edgeColor","blocks":[{"kind":"paragraph","text":"1px separator between gapless bars."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeColor`"],["HTML attribute","`edge-color`"],["Type","`string`"],["Default","`'rgba(255,255,255,0.85)'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Fill for the hovered bin."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#1d4ed8'`"]]}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-measure","title":"measure","blocks":[{"kind":"paragraph","text":"The vertical axis represents count, percent, or density."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`measure`"],["HTML attribute","`measure`"],["Type","`HistogramNormalize`"],["Default","`'count'`"],["Allowed values","`percent`, `count`, `density`"]]},{"kind":"links","items":[{"path":"/docs/types/HistogramNormalize","title":"HistogramNormalize","description":"Type definition"}]}]},{"id":"property-cumulative","title":"cumulative","blocks":[{"kind":"paragraph","text":"running sums (the empirical CDF for density)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cumulative`"],["HTML attribute","`cumulative`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-barGap","title":"barGap","blocks":[{"kind":"paragraph","text":"a CSS-px gap between the bars (0 = gapless with the edge separators)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barGap`"],["HTML attribute","`bar-gap`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. The bins re-project through the zoomed frame; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: HistogramPointEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: HistogramPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column family)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`HistogramEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/HistogramEasing","title":"HistogramEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`HistogramAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HistogramAnimationType","title":"HistogramAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HistogramStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HistogramStreamSource","title":"HistogramStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`HistogramEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/HistogramEngineMode","title":"HistogramEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`HistogramUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/HistogramUnavailableBehaviour","title":"HistogramUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<HistogramRenderResult & { tier: HistogramEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // HistogramRenderResult & { tier: HistogramEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/HistogramRenderResult","title":"HistogramRenderResult","description":"Type definition"},{"path":"/docs/types/HistogramEngineTier","title":"HistogramEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<HistogramPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // HistogramPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: HistogramPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<HistogramPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // HistogramPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<HistogramPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<HistogramPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<HistogramPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<HistogramRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HistogramRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HistogramRenderResult","title":"HistogramRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<HistogramEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HistogramEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HistogramEngineTier","title":"HistogramEngineTier","description":"Type definition"}]}]},{"id":"method-getBinning","title":"getBinning","blocks":[{"kind":"paragraph","text":"the binning decision behind the current bins: the rule, its kind, n, σ, IQR, the width, the count, a fallback."},{"kind":"code","source":"getBinning(): Promise<HistogramBinning>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HistogramBinning>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HistogramBinning","title":"HistogramBinning","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(values: HistogramValues): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`HistogramValues`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HistogramValues","title":"HistogramValues","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(values: ReadonlyArray<number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(values: ReadonlyArray<number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<HistogramStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HistogramStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HistogramStreamSource","title":"HistogramStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The requested engine, the engine that draws and why . A Chart Pro license decision names `chart.webgpu` and its state; renderer causes (not in this build, no WebGPU, a failed GPU) stay apart."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: HistogramEasing; enabled?: boolean; type?: HistogramAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: HistogramEasing; enabled?: boolean; type?: HistogramAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HistogramEasing","title":"HistogramEasing","description":"Type definition"},{"path":"/docs/types/HistogramAnimationType","title":"HistogramAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<HistogramPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<HistogramPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(binIndex: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/box-plot","title":"Box Plot","summary":"Summarize the median and spread with boxes and whiskers.","kind":"component","tag":"sy-box-plot-chart","componentId":"box-plot","api":{"props":[{"name":"data","attribute":"data","type":"BoxPlotData","kind":"property","values":[],"default":"undefined","description":"Pass raw samples as { category, values: [...] } or provide summary statistics."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"xAxis","attribute":"x-axis","type":"XAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Grid lines: the value axis's on by default, the category axis's off (a category axis has no continuous grid)."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan (Shift + drag, the arrows), Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines them (`mode` / `drag` / `pan` / `wheel` / `pinch` / `keyboard` / `minRangePx` / `resetButton` / `inside`). Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"name":"yMin","attribute":"y-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMax","attribute":"y-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"0.05","description":"The automatic domain pads the value span by this share (default 5 %)."},{"name":"orientation","attribute":"orientation","type":"BoxPlotOrientation","kind":"string","values":["vertical","horizontal"],"default":"'vertical'","description":"The direction in which boxes are drawn."},{"name":"boxColor","attribute":"box-color","type":"string","kind":"string","values":[],"default":"DEFAULT_BOX_COLOR","description":"The box colour: its border (and, at `box-fill-alpha`, its fill); `auto` whiskers / outliers follow it."},{"name":"boxFillAlpha","attribute":"box-fill-alpha","type":"number","kind":"number","values":[],"default":"DEFAULT_FILL_ALPHA","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"medianColor","attribute":"median-color","type":"string","kind":"string","values":[],"default":"DEFAULT_MEDIAN_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"whiskerColor","attribute":"whisker-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"outlierColor","attribute":"outlier-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"boxWidth","attribute":"box-width","type":"number","kind":"number","values":[],"default":"BOX_DEFAULT_WIDTH_RATIO","description":"The box's share of the slot pitch (0.6), clamped between `box-min-px` and `box-max-px`."},{"name":"boxMinPx","attribute":"box-min-px","type":"number","kind":"number","values":[],"default":"BOX_DEFAULT_MIN_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"boxMaxPx","attribute":"box-max-px","type":"number","kind":"number","values":[],"default":"BOX_DEFAULT_MAX_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"capWidth","attribute":"cap-width","type":"number","kind":"number","values":[],"default":"BOX_DEFAULT_CAP_RATIO","description":"The whisker caps' share of the box width (0.5; 0 hides them)."},{"name":"whiskerWidth","attribute":"whisker-width","type":"number","kind":"number","values":[],"default":"1","description":"CSS px: the whisker / border thickness, the median thickness, the outlier radius."},{"name":"medianWidth","attribute":"median-width","type":"number","kind":"number","values":[],"default":"2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"outlierRadius","attribute":"outlier-radius","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"notched","attribute":"notched","type":"boolean","kind":"boolean","values":[],"default":"false","description":"the stepped notch: the box narrows to `notch-width` of itself between the notch bounds (median ± 1.57 × IQR / √n)."},{"name":"notchWidth","attribute":"notch-width","type":"number","kind":"number","values":[],"default":"0.5","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"showMean","attribute":"show-mean","type":"boolean","kind":"boolean","values":[],"default":"false","description":"the mean marker: a `mean-size` px square in `mean-color` (`auto` = the median colour) at the mean."},{"name":"meanColor","attribute":"mean-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"meanSize","attribute":"mean-size","type":"number","kind":"number","values":[],"default":"6","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"whiskerRule","attribute":"whisker-rule","type":"BoxPlotWhiskerRule | string","kind":"property","values":[],"default":"'tukey'","description":"`tukey` (1.5 × IQR, the default), `min-max` (no outliers), `percentile` (), or a number of IQRs."},{"name":"quantileMethod","attribute":"quantile-method","type":"BoxPlotQuantileMethod | string","kind":"string","values":[],"default":"'linear'","description":"the quantile method: `linear` (R-7, the default), `exclusive` (R-6), `nearest`, `lower`, `higher`, `midpoint`."},{"name":"whiskerPercentile","attribute":"whisker-percentile","type":"number","kind":"number","values":[],"default":"5","description":"the `percentile` whisker rule's p (0 … 50, default 5: the whiskers at Q(p %) and Q(100 − p %))."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"the box tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: BoxPlotPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: BoxPlotPointEventDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"BoxPlotEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"BoxPlotAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"BoxPlotStreamSource","kind":"property","values":[],"default":"undefined","description":"§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Categories tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed items the chart renders (the whole buffer when unset): the N categories pushed most recently keep their boxes, older streamed categories revert to their `data` box or leave."},{"name":"engine","attribute":"engine","type":"BoxPlotEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"BoxPlotUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<BoxPlotRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<BoxPlotEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"BoxPlotData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"BoxPlotDatumInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<BoxPlotDatumInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<BoxPlotDatumInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<BoxPlotStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: BoxPlotEasing; enabled?: boolean; type?: BoxPlotAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<BoxPlotPointEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"getBox","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<BoxPlotBox | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getBoxByCategory","parameters":[{"name":"category","type":"string","optional":false}],"returns":"Promise<BoxPlotBox | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getBoxCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getBoxes","parameters":[],"returns":"Promise<BoxPlotBox[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getStatistics","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<BoxPlotStatistics | null>","description":"the box with its derived numbers: the IQR, the variance, the whisker rule and its fences, the quantile method."},{"name":"getCategories","parameters":[],"returns":"Promise<string[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<BoxPlotExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDomain","parameters":[],"returns":"Promise<BoxPlotDomain>","description":"The data domain the grid spans."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusBoxAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<BoxPlotPointEventDetail | null>","description":"move the keyboard focus ring to a box (null off the boxes); emits pointHover like the walk."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — axes (`null` before the first layout)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"BoxPlotRenderResult & { tier: BoxPlotEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"BoxPlotPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"BoxPlotPointEventDetail | null","description":"CustomEvent.detail type: BoxPlotPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<BoxPlotPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<BoxPlotPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"the shared tooltip events (the controller emits them)."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-box-plot-chart","blocks":[{"kind":"paragraph","text":"Compare distributions across groups and explore outliers."},{"kind":"paragraph","text":"Whiskers follow the configured calculation rule. Inspect raw values as well when the sample is small."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","Pass raw samples as { category, values: [...] } or provide summary statistics."],["`orientation`","The direction in which boxes are drawn."]]},{"kind":"links","items":[{"path":"/charts/box-plot","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-box-plot-chart.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-box-plot-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"category\": \"Process A\",\n            \"values\": [21, 24, 25, 28, 29, 31, 35, 47]\n          },\n          {\n            \"category\": \"Process B\",\n            \"values\": [25, 28, 30, 32, 34, 35, 37, 39]\n          },\n          {\n            \"category\": \"Process C\",\n            \"values\": [20, 25, 29, 32, 35, 38, 45, 52]\n          }\n        ],\n        \"orientation\": \"vertical\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'box-plot example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"Pass raw samples as { category, values: [...] } or provide summary statistics."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BoxPlotData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotData","title":"BoxPlotData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`XAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/XAxisInput","title":"XAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Grid lines: the value axis's on by default, the category axis's off (a category axis has no continuous grid)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan (Shift + drag, the arrows), Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines them (`mode` / `drag` / `pan` / `wheel` / `pinch` / `keyboard` / `minRangePx` / `resetButton` / `inside`). Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-yMin","title":"yMin","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMin`"],["HTML attribute","`y-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMax","title":"yMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMax`"],["HTML attribute","`y-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"The automatic domain pads the value span by this share (default 5 %)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`0.05`"]]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"The direction in which boxes are drawn."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`BoxPlotOrientation`"],["Default","`'vertical'`"],["Allowed values","`vertical`, `horizontal`"]]},{"kind":"links","items":[{"path":"/docs/types/BoxPlotOrientation","title":"BoxPlotOrientation","description":"Type definition"}]}]},{"id":"property-boxColor","title":"boxColor","blocks":[{"kind":"paragraph","text":"The box colour: its border (and, at `box-fill-alpha`, its fill); `auto` whiskers / outliers follow it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxColor`"],["HTML attribute","`box-color`"],["Type","`string`"],["Default","`DEFAULT_BOX_COLOR`"]]}]},{"id":"property-boxFillAlpha","title":"boxFillAlpha","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxFillAlpha`"],["HTML attribute","`box-fill-alpha`"],["Type","`number`"],["Default","`DEFAULT_FILL_ALPHA`"]]}]},{"id":"property-medianColor","title":"medianColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`medianColor`"],["HTML attribute","`median-color`"],["Type","`string`"],["Default","`DEFAULT_MEDIAN_COLOR`"]]}]},{"id":"property-whiskerColor","title":"whiskerColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerColor`"],["HTML attribute","`whisker-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-outlierColor","title":"outlierColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`outlierColor`"],["HTML attribute","`outlier-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-boxWidth","title":"boxWidth","blocks":[{"kind":"paragraph","text":"The box's share of the slot pitch (0.6), clamped between `box-min-px` and `box-max-px`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxWidth`"],["HTML attribute","`box-width`"],["Type","`number`"],["Default","`BOX_DEFAULT_WIDTH_RATIO`"]]}]},{"id":"property-boxMinPx","title":"boxMinPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxMinPx`"],["HTML attribute","`box-min-px`"],["Type","`number`"],["Default","`BOX_DEFAULT_MIN_PX`"]]}]},{"id":"property-boxMaxPx","title":"boxMaxPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxMaxPx`"],["HTML attribute","`box-max-px`"],["Type","`number`"],["Default","`BOX_DEFAULT_MAX_PX`"]]}]},{"id":"property-capWidth","title":"capWidth","blocks":[{"kind":"paragraph","text":"The whisker caps' share of the box width (0.5; 0 hides them)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`capWidth`"],["HTML attribute","`cap-width`"],["Type","`number`"],["Default","`BOX_DEFAULT_CAP_RATIO`"]]}]},{"id":"property-whiskerWidth","title":"whiskerWidth","blocks":[{"kind":"paragraph","text":"CSS px: the whisker / border thickness, the median thickness, the outlier radius."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerWidth`"],["HTML attribute","`whisker-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-medianWidth","title":"medianWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`medianWidth`"],["HTML attribute","`median-width`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-outlierRadius","title":"outlierRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`outlierRadius`"],["HTML attribute","`outlier-radius`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-notched","title":"notched","blocks":[{"kind":"paragraph","text":"the stepped notch: the box narrows to `notch-width` of itself between the notch bounds (median ± 1.57 × IQR / √n)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`notched`"],["HTML attribute","`notched`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-notchWidth","title":"notchWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`notchWidth`"],["HTML attribute","`notch-width`"],["Type","`number`"],["Default","`0.5`"]]}]},{"id":"property-showMean","title":"showMean","blocks":[{"kind":"paragraph","text":"the mean marker: a `mean-size` px square in `mean-color` (`auto` = the median colour) at the mean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showMean`"],["HTML attribute","`show-mean`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-meanColor","title":"meanColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`meanColor`"],["HTML attribute","`mean-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-meanSize","title":"meanSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`meanSize`"],["HTML attribute","`mean-size`"],["Type","`number`"],["Default","`6`"]]}]},{"id":"property-whiskerRule","title":"whiskerRule","blocks":[{"kind":"paragraph","text":"`tukey` (1.5 × IQR, the default), `min-max` (no outliers), `percentile` (), or a number of IQRs."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerRule`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BoxPlotWhiskerRule | string`"],["Default","`'tukey'`"]]},{"kind":"links","items":[{"path":"/docs/types/BoxPlotWhiskerRule","title":"BoxPlotWhiskerRule","description":"Type definition"}]}]},{"id":"property-quantileMethod","title":"quantileMethod","blocks":[{"kind":"paragraph","text":"the quantile method: `linear` (R-7, the default), `exclusive` (R-6), `nearest`, `lower`, `higher`, `midpoint`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`quantileMethod`"],["HTML attribute","`quantile-method`"],["Type","`BoxPlotQuantileMethod | string`"],["Default","`'linear'`"]]},{"kind":"links","items":[{"path":"/docs/types/BoxPlotQuantileMethod","title":"BoxPlotQuantileMethod","description":"Type definition"}]}]},{"id":"property-whiskerPercentile","title":"whiskerPercentile","blocks":[{"kind":"paragraph","text":"the `percentile` whisker rule's p (0 … 50, default 5: the whiskers at Q(p %) and Q(100 − p %))."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerPercentile`"],["HTML attribute","`whisker-percentile`"],["Type","`number`"],["Default","`5`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"the box tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: BoxPlotPointEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: BoxPlotPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`BoxPlotEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/BoxPlotEasing","title":"BoxPlotEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`BoxPlotAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotAnimationType","title":"BoxPlotAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`BoxPlotStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotStreamSource","title":"BoxPlotStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Categories tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed items the chart renders (the whole buffer when unset): the N categories pushed most recently keep their boxes, older streamed categories revert to their `data` box or leave."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`BoxPlotEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/BoxPlotEngineMode","title":"BoxPlotEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`BoxPlotUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/BoxPlotUnavailableBehaviour","title":"BoxPlotUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BoxPlotRenderResult & { tier: BoxPlotEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // BoxPlotRenderResult & { tier: BoxPlotEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BoxPlotRenderResult","title":"BoxPlotRenderResult","description":"Type definition"},{"path":"/docs/types/BoxPlotEngineTier","title":"BoxPlotEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BoxPlotPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // BoxPlotPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: BoxPlotPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<BoxPlotPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // BoxPlotPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<BoxPlotPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<BoxPlotPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<BoxPlotPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"the shared tooltip events (the controller emits them)."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<BoxPlotRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotRenderResult","title":"BoxPlotRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<BoxPlotEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotEngineTier","title":"BoxPlotEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: BoxPlotData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`BoxPlotData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotData","title":"BoxPlotData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: BoxPlotDatumInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`BoxPlotDatumInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<BoxPlotDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<BoxPlotDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<BoxPlotDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<BoxPlotDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<BoxPlotStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotStreamSource","title":"BoxPlotStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: BoxPlotEasing; enabled?: boolean; type?: BoxPlotAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: BoxPlotEasing; enabled?: boolean; type?: BoxPlotAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotEasing","title":"BoxPlotEasing","description":"Type definition"},{"path":"/docs/types/BoxPlotAnimationType","title":"BoxPlotAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<BoxPlotPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":"Type definition"}]}]},{"id":"method-getBox","title":"getBox","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBox(index: number): Promise<BoxPlotBox | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotBox | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotBox","title":"BoxPlotBox","description":"Type definition"}]}]},{"id":"method-getBoxByCategory","title":"getBoxByCategory","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBoxByCategory(category: string): Promise<BoxPlotBox | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`category`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotBox | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotBox","title":"BoxPlotBox","description":"Type definition"}]}]},{"id":"method-getBoxCount","title":"getBoxCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBoxCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getBoxes","title":"getBoxes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBoxes(): Promise<BoxPlotBox[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotBox[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotBox","title":"BoxPlotBox","description":"Type definition"}]}]},{"id":"method-getStatistics","title":"getStatistics","blocks":[{"kind":"paragraph","text":"the box with its derived numbers: the IQR, the variance, the whisker rule and its fences, the quantile method."},{"kind":"code","source":"getStatistics(index: number): Promise<BoxPlotStatistics | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotStatistics | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotStatistics","title":"BoxPlotStatistics","description":"Type definition"}]}]},{"id":"method-getCategories","title":"getCategories","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getCategories(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<BoxPlotExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotExtent","title":"BoxPlotExtent","description":"Type definition"}]}]},{"id":"method-getDomain","title":"getDomain","blocks":[{"kind":"paragraph","text":"The data domain the grid spans."},{"kind":"code","source":"getDomain(): Promise<BoxPlotDomain>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotDomain>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotDomain","title":"BoxPlotDomain","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusBoxAt","title":"focusBoxAt","blocks":[{"kind":"paragraph","text":"move the keyboard focus ring to a box (null off the boxes); emits pointHover like the walk."},{"kind":"code","source":"focusBoxAt(index: number): Promise<BoxPlotPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<BoxPlotPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/error-bar","title":"Error Bar","summary":"Show uncertainty or a range around a central value.","kind":"component","tag":"sy-error-bar-chart","componentId":"error-bar","api":{"props":[{"name":"data","attribute":"data","type":"ErrorBarData","kind":"property","values":[],"default":"undefined","description":"Use { category, value, low, high } or a symmetric error."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"xAxis","attribute":"x-axis","type":"XAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Grid lines: the value axis's on by default, the category axis's off."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan (Shift + drag, the arrows), Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines them (`mode` / `drag` / `pan` / `wheel` / `pinch` / `keyboard` / `minRangePx` / `resetButton` / `inside`). Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"name":"yMin","attribute":"y-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMax","attribute":"y-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"0.05","description":"The automatic domain pads the span over the bounds by this share (default 5 %); bar mode joins zero."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"DEFAULT_FILL_COLOR","description":"The marker / column colour, the whisker + cap colour, the hovered / focused point."},{"name":"errorColor","attribute":"error-color","type":"string","kind":"string","values":[],"default":"DEFAULT_ERROR_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"DEFAULT_ACTIVE_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"showBars","attribute":"show-bars","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Bar mode: a column from zero to the value instead of a marker (the domain joins zero)."},{"name":"barWidth","attribute":"bar-width","type":"number","kind":"number","values":[],"default":"ERROR_BAR_DEFAULT_BAR_RATIO","description":"The column's share of the slot pitch (0.6), clamped between `bar-min-px` and `bar-max-px`."},{"name":"barMinPx","attribute":"bar-min-px","type":"number","kind":"number","values":[],"default":"ERROR_BAR_DEFAULT_MIN_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"barMaxPx","attribute":"bar-max-px","type":"number","kind":"number","values":[],"default":"ERROR_BAR_DEFAULT_MAX_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"capWidth","attribute":"cap-width","type":"number","kind":"number","values":[],"default":"ERROR_BAR_DEFAULT_CAP_RATIO","description":"The caps' share of the slot pitch (0.3; clamped 4 … 40 px; 0 hides them), their switch."},{"name":"showCaps","attribute":"show-caps","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"markerSize","attribute":"marker-size","type":"number","kind":"number","values":[],"default":"ERROR_BAR_DEFAULT_MARKER_PX","description":"The marker's size and the whisker's thickness in CSS px."},{"name":"whiskerWidth","attribute":"whisker-width","type":"number","kind":"number","values":[],"default":"ERROR_BAR_DEFAULT_WHISKER_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"The point tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: ErrorBarPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: ErrorBarPointEventDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ErrorBarEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ErrorBarAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"ErrorBarStreamSource","kind":"property","values":[],"default":"undefined","description":"§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Points tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed items the chart renders (the whole buffer when unset): the N categories pushed most recently keep their points, older streamed categories revert to their `data` point or leave."},{"name":"engine","attribute":"engine","type":"ErrorBarEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"ErrorBarUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<ErrorBarRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<ErrorBarEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"ErrorBarData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"ErrorBarDatumInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<ErrorBarDatumInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed points (the `data` points are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<ErrorBarDatumInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ErrorBarStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: ErrorBarEasing; enabled?: boolean; type?: ErrorBarAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<ErrorBarPointEventDetail | null>","description":"The point under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"getPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ErrorBarPoint | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getPointByCategory","parameters":[{"name":"category","type":"string","optional":false}],"returns":"Promise<ErrorBarPoint | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getPointCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getPoints","parameters":[],"returns":"Promise<ErrorBarPoint[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getCategories","parameters":[],"returns":"Promise<string[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<ErrorBarExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDomain","parameters":[],"returns":"Promise<ErrorBarDomain>","description":"The data domain the grid spans."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"Open the tooltip on a point (the facade's `showTooltipAtPoint` routes here); null off the points or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusPointAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ErrorBarPointEventDetail | null>","description":"Move the keyboard focus ring to a point (null off the points); emits pointHover like the walk."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — axes (`null` before the first layout)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"ErrorBarRenderResult & { tier: ErrorBarEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"ErrorBarPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"ErrorBarPointEventDetail | null","description":"CustomEvent.detail type: ErrorBarPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<ErrorBarPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ErrorBarPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"The shared tooltip events (the controller emits them)."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-error-bar-chart","blocks":[{"kind":"paragraph","text":"Represent means with confidence intervals, tolerances, or measurement ranges."},{"kind":"paragraph","text":"Error bars do not determine their own meaning. Explain whether they represent standard deviation, a confidence interval, or another range."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","Use { category, value, low, high } or a symmetric error."]]},{"kind":"links","items":[{"path":"/charts/error-bar","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-error-bar-chart.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-error-bar-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"category\": \"A\",\n            \"value\": 40,\n            \"low\": 32,\n            \"high\": 48\n          },\n          {\n            \"category\": \"B\",\n            \"value\": 55,\n            \"low\": 50,\n            \"high\": 63\n          },\n          {\n            \"category\": \"C\",\n            \"value\": 47,\n            \"low\": 38,\n            \"high\": 54\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'error-bar example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"Use { category, value, low, high } or a symmetric error."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ErrorBarData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarData","title":"ErrorBarData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`XAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/XAxisInput","title":"XAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Grid lines: the value axis's on by default, the category axis's off."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan (Shift + drag, the arrows), Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines them (`mode` / `drag` / `pan` / `wheel` / `pinch` / `keyboard` / `minRangePx` / `resetButton` / `inside`). Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-yMin","title":"yMin","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMin`"],["HTML attribute","`y-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMax","title":"yMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMax`"],["HTML attribute","`y-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"The automatic domain pads the span over the bounds by this share (default 5 %); bar mode joins zero."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`0.05`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"The marker / column colour, the whisker + cap colour, the hovered / focused point."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`DEFAULT_FILL_COLOR`"]]}]},{"id":"property-errorColor","title":"errorColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`errorColor`"],["HTML attribute","`error-color`"],["Type","`string`"],["Default","`DEFAULT_ERROR_COLOR`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`DEFAULT_ACTIVE_COLOR`"]]}]},{"id":"property-showBars","title":"showBars","blocks":[{"kind":"paragraph","text":"Bar mode: a column from zero to the value instead of a marker (the domain joins zero)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showBars`"],["HTML attribute","`show-bars`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-barWidth","title":"barWidth","blocks":[{"kind":"paragraph","text":"The column's share of the slot pitch (0.6), clamped between `bar-min-px` and `bar-max-px`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barWidth`"],["HTML attribute","`bar-width`"],["Type","`number`"],["Default","`ERROR_BAR_DEFAULT_BAR_RATIO`"]]}]},{"id":"property-barMinPx","title":"barMinPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barMinPx`"],["HTML attribute","`bar-min-px`"],["Type","`number`"],["Default","`ERROR_BAR_DEFAULT_MIN_PX`"]]}]},{"id":"property-barMaxPx","title":"barMaxPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barMaxPx`"],["HTML attribute","`bar-max-px`"],["Type","`number`"],["Default","`ERROR_BAR_DEFAULT_MAX_PX`"]]}]},{"id":"property-capWidth","title":"capWidth","blocks":[{"kind":"paragraph","text":"The caps' share of the slot pitch (0.3; clamped 4 … 40 px; 0 hides them), their switch."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`capWidth`"],["HTML attribute","`cap-width`"],["Type","`number`"],["Default","`ERROR_BAR_DEFAULT_CAP_RATIO`"]]}]},{"id":"property-showCaps","title":"showCaps","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showCaps`"],["HTML attribute","`show-caps`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-markerSize","title":"markerSize","blocks":[{"kind":"paragraph","text":"The marker's size and the whisker's thickness in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerSize`"],["HTML attribute","`marker-size`"],["Type","`number`"],["Default","`ERROR_BAR_DEFAULT_MARKER_PX`"]]}]},{"id":"property-whiskerWidth","title":"whiskerWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`whiskerWidth`"],["HTML attribute","`whisker-width`"],["Type","`number`"],["Default","`ERROR_BAR_DEFAULT_WHISKER_PX`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"The point tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: ErrorBarPointEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: ErrorBarPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ErrorBarEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ErrorBarEasing","title":"ErrorBarEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ErrorBarAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarAnimationType","title":"ErrorBarAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"§3.6: an external stream source (category upserts); without one the chart keeps its own on the first push."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ErrorBarStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarStreamSource","title":"ErrorBarStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Points tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed items the chart renders (the whole buffer when unset): the N categories pushed most recently keep their points, older streamed categories revert to their `data` point or leave."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ErrorBarEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ErrorBarEngineMode","title":"ErrorBarEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ErrorBarUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/ErrorBarUnavailableBehaviour","title":"ErrorBarUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ErrorBarRenderResult & { tier: ErrorBarEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ErrorBarRenderResult & { tier: ErrorBarEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ErrorBarRenderResult","title":"ErrorBarRenderResult","description":"Type definition"},{"path":"/docs/types/ErrorBarEngineTier","title":"ErrorBarEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ErrorBarPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // ErrorBarPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ErrorBarPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ErrorBarPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // ErrorBarPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ErrorBarPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<ErrorBarPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<ErrorBarPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"The shared tooltip events (the controller emits them)."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ErrorBarRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarRenderResult","title":"ErrorBarRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<ErrorBarEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarEngineTier","title":"ErrorBarEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ErrorBarData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ErrorBarData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarData","title":"ErrorBarData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: ErrorBarDatumInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`ErrorBarDatumInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<ErrorBarDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<ErrorBarDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed points (the `data` points are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<ErrorBarDatumInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<ErrorBarDatumInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ErrorBarStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarStreamSource","title":"ErrorBarStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: ErrorBarEasing; enabled?: boolean; type?: ErrorBarAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: ErrorBarEasing; enabled?: boolean; type?: ErrorBarAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarEasing","title":"ErrorBarEasing","description":"Type definition"},{"path":"/docs/types/ErrorBarAnimationType","title":"ErrorBarAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The point under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<ErrorBarPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":"Type definition"}]}]},{"id":"method-getPoint","title":"getPoint","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getPoint(index: number): Promise<ErrorBarPoint | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarPoint | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPoint","title":"ErrorBarPoint","description":"Type definition"}]}]},{"id":"method-getPointByCategory","title":"getPointByCategory","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getPointByCategory(category: string): Promise<ErrorBarPoint | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`category`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarPoint | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPoint","title":"ErrorBarPoint","description":"Type definition"}]}]},{"id":"method-getPointCount","title":"getPointCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getPointCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getPoints","title":"getPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getPoints(): Promise<ErrorBarPoint[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarPoint[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPoint","title":"ErrorBarPoint","description":"Type definition"}]}]},{"id":"method-getCategories","title":"getCategories","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getCategories(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<ErrorBarExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarExtent","title":"ErrorBarExtent","description":"Type definition"}]}]},{"id":"method-getDomain","title":"getDomain","blocks":[{"kind":"paragraph","text":"The data domain the grid spans."},{"kind":"code","source":"getDomain(): Promise<ErrorBarDomain>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarDomain>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarDomain","title":"ErrorBarDomain","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"Open the tooltip on a point (the facade's `showTooltipAtPoint` routes here); null off the points or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusPointAt","title":"focusPointAt","blocks":[{"kind":"paragraph","text":"Move the keyboard focus ring to a point (null off the points); emits pointHover like the walk."},{"kind":"code","source":"focusPointAt(index: number): Promise<ErrorBarPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ErrorBarPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/stem-leaf","title":"Stem Leaf","summary":"Read a distribution while retaining raw values.","kind":"component","tag":"sy-stem-leaf-chart","componentId":"stem-leaf","api":{"props":[{"name":"values","attribute":"values","type":"StemLeafValues","kind":"property","values":[],"default":"[]","description":"An array of raw numeric samples, displayed as stems and leaves."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"unit","attribute":"unit","type":"number","kind":"number","values":[],"default":"10","description":"Stem unit — one stem spans this much (default 10: stems are the tens digit)."},{"name":"split","attribute":"split","type":"1 | 2","kind":"number","values":[],"default":"1","description":"1 (default) or 2: each stem splits into 0–4 / 5–9 half-rows."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#111827'","description":"Ink colour (single CSS colour / array / comma string — first colour wins)."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Accent for the hovered/focused leaf."},{"name":"showKey","attribute":"show-key","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the reading key (`2 | 3 = 23`) under the plot."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(leaf: StemLeafPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (leaf: StemLeafPointEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"StemLeafTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration object (family mirror). Property-only."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (Storybook parity, 2026-09-10) — the shared zoom surface as a VIEWPORT zoom: the plot area of the stems and leaves (the chart box minus the title band, the margins and the key band) is the plot, x 0 → 1 left to right and y 0 → 1 bottom to top. `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`); an object refines the switches. Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless."},{"name":"engine","attribute":"engine","type":"StemLeafEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"StemLeafUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"StemLeafStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"StemLeafEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"StemLeafAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<StemLeafRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<StemLeafEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"values","type":"StemLeafValues","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<StemLeafStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: StemLeafEasing; enabled?: boolean; type?: StemLeafAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTestLeaf","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ sourceIndex: number; value: number; stemLabel: string; digit: number } | null>","description":"Stem-leaf-only — hit-test the leaf at canvas-relative coordinates."},{"name":"showTooltipAtLeaf","parameters":[{"name":"sourceIndex","type":"number","optional":false}],"returns":"Promise<StemLeafPointEventDetail | null>","description":"Stem-leaf-only — programmatic tooltip open on a leaf by source index."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit viewport windows: `x` / `y` as `{ min, max }` or `[min, max]` over 0..1 (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by viewport units (`{ x?, y? }`, 1 = the whole plot); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0..1 on both orientations, key `'0'`)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"StemLeafRenderResult & { tier: StemLeafEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"StemLeafPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"StemLeafPointEventDetail | null","description":"CustomEvent.detail type: StemLeafPointEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<StemLeafPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<StemLeafPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"StemLeafTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"StemLeafTooltipActionEventDetail","description":"CustomEvent.detail type: StemLeafTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new viewport windows."}]},"sections":[{"id":"overview","title":"sy-stem-leaf-chart","blocks":[{"kind":"paragraph","text":"Inspect the digit distribution of a small numeric sample."},{"kind":"paragraph","text":"Choose the digit split and rounding unit first. Use Histogram for very large samples."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","An array of raw numeric samples, displayed as stems and leaves."]]},{"kind":"links","items":[{"path":"/charts/stem-leaf","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-stem-leaf-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-stem-leaf-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [23, 25, 28, 29, 30, 31, 31, 32, 32, 33, 34, 34, 35, 35, 36, 37, 38, 39, 42, 45, 48, 52],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'stem-leaf example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"An array of raw numeric samples, displayed as stems and leaves."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`StemLeafValues`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/StemLeafValues","title":"StemLeafValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-unit","title":"unit","blocks":[{"kind":"paragraph","text":"Stem unit — one stem spans this much (default 10: stems are the tens digit)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unit`"],["HTML attribute","`unit`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-split","title":"split","blocks":[{"kind":"paragraph","text":"1 (default) or 2: each stem splits into 0–4 / 5–9 half-rows."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`split`"],["HTML attribute","`split`"],["Type","`1 | 2`"],["Default","`1`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Ink colour (single CSS colour / array / comma string — first colour wins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#111827'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Accent for the hovered/focused leaf."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-showKey","title":"showKey","blocks":[{"kind":"paragraph","text":"Show the reading key (`2 | 3 = 23`) under the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showKey`"],["HTML attribute","`show-key`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (leaf: StemLeafPointEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(leaf: StemLeafPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration object (family mirror). Property-only."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`StemLeafTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipInput","title":"StemLeafTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (Storybook parity, 2026-09-10) — the shared zoom surface as a VIEWPORT zoom: the plot area of the stems and leaves (the chart box minus the title band, the margins and the key band) is the plot, x 0 → 1 left to right and y 0 → 1 bottom to top. `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`); an object refines the switches. Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`StemLeafEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/StemLeafEngineMode","title":"StemLeafEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`StemLeafUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/StemLeafUnavailableBehaviour","title":"StemLeafUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`StemLeafStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StemLeafStreamSource","title":"StemLeafStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`StemLeafEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/StemLeafEasing","title":"StemLeafEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`StemLeafAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StemLeafAnimationType","title":"StemLeafAnimationType","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<StemLeafRenderResult & { tier: StemLeafEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // StemLeafRenderResult & { tier: StemLeafEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/StemLeafRenderResult","title":"StemLeafRenderResult","description":"Type definition"},{"path":"/docs/types/StemLeafEngineTier","title":"StemLeafEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<StemLeafPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // StemLeafPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: StemLeafPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<StemLeafPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // StemLeafPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<StemLeafPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<StemLeafPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<StemLeafPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<StemLeafTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // StemLeafTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipShowEventDetail","title":"StemLeafTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: StemLeafTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<StemLeafTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // StemLeafTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipActionEventDetail","title":"StemLeafTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new viewport windows."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<StemLeafRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<StemLeafRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StemLeafRenderResult","title":"StemLeafRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<StemLeafEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<StemLeafEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StemLeafEngineTier","title":"StemLeafEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(values: StemLeafValues): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`StemLeafValues`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StemLeafValues","title":"StemLeafValues","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(values: ReadonlyArray<number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(values: ReadonlyArray<number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<StemLeafStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<StemLeafStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StemLeafStreamSource","title":"StemLeafStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: StemLeafEasing; enabled?: boolean; type?: StemLeafAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: StemLeafEasing; enabled?: boolean; type?: StemLeafAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StemLeafEasing","title":"StemLeafEasing","description":"Type definition"},{"path":"/docs/types/StemLeafAnimationType","title":"StemLeafAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestLeaf","title":"hitTestLeaf","blocks":[{"kind":"paragraph","text":"Stem-leaf-only — hit-test the leaf at canvas-relative coordinates."},{"kind":"code","source":"hitTestLeaf(cssX: number, cssY: number): Promise<{ sourceIndex: number; value: number; stemLabel: string; digit: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ sourceIndex: number; value: number; stemLabel: string; digit: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtLeaf","title":"showTooltipAtLeaf","blocks":[{"kind":"paragraph","text":"Stem-leaf-only — programmatic tooltip open on a leaf by source index."},{"kind":"code","source":"showTooltipAtLeaf(sourceIndex: number): Promise<StemLeafPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`sourceIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<StemLeafPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit viewport windows: `x` / `y` as `{ min, max }` or `[min, max]` over 0..1 (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by viewport units (`{ x?, y? }`, 1 = the whole plot); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0..1 on both orientations, key `'0'`)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/heatmap","title":"Heatmap","summary":"Encode values at two coordinates using color.","kind":"component","tag":"sy-heatmap","componentId":"heatmap","api":{"props":[{"name":"data","attribute":"data","type":"HeatmapData","kind":"property","values":[],"default":"undefined","description":"An array of { x, y, value }. x and y are numeric or categorical coordinates."},{"name":"matrix","attribute":"matrix","type":"HeatmapMatrixInput","kind":"property","values":[],"default":"undefined","description":"A dense matrix: `{ columns, rows, values }` (row-major) or rows of columns."},{"name":"xCategories","attribute":"x-categories","type":"HeatmapCategoriesInput","kind":"property","values":[],"default":"undefined","description":"Column labels (array, or a comma list attribute). Given explicitly, they fix the column count."},{"name":"yCategories","attribute":"y-categories","type":"HeatmapCategoriesInput","kind":"property","values":[],"default":"undefined","description":"Row labels (row 0 is the top row)."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"colors","attribute":"colors","type":"HeatmapColorInput","kind":"property","values":[],"default":"undefined","description":"The colour ramp: a scheme name (`viridis`, `blues`, …), a colour list / comma list, or `[t, colour]` stops."},{"name":"valueMin","attribute":"value-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Domain ends; an omitted end follows the data extent."},{"name":"valueMax","attribute":"value-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"emptyColor","attribute":"empty-color","type":"string","kind":"string","values":[],"default":"'transparent'","description":"The colour of an empty cell (default transparent — the host background shows)."},{"name":"cellGap","attribute":"cell-gap","type":"number","kind":"number","values":[],"default":"0","description":"Gap between cells in CSS px."},{"name":"renderPath","attribute":"render-path","type":"HeatmapRenderPath","kind":"string","values":["auto","plane","cells"],"default":"'auto'","description":"the draw path: `auto` (the cells path from 3 device px per cell, else the plane), or a forced `plane` / `cells`."},{"name":"cellRadius","attribute":"cell-radius","type":"number","kind":"number","values":[],"default":"0","description":"cell corner radius in CSS px (the cells path)."},{"name":"cellBorder","attribute":"cell-border","type":"number","kind":"number","values":[],"default":"0","description":"cell border width in CSS px (the cells path)."},{"name":"cellBorderColor","attribute":"cell-border-color","type":"string","kind":"string","values":[],"default":"'rgba(17,24,39,0.35)'","description":"cell border colour."},{"name":"lod","attribute":"lod","type":"HeatmapLodMode","kind":"string","values":["auto","point","area","smooth"],"default":"'auto'","description":"the plane path's level of detail: `auto` (area-averaged once a cell is under a device px), `point`, `area`."},{"name":"areaReduce","attribute":"area-reduce","type":"'mean' | 'max'","kind":"string","values":["max","mean"],"default":"'mean'","description":"how the area LOD folds the cells a pixel covers: `mean` (default) or `max` (peak-hold)."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Grid lines default OFF (the cells tile the plot)."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (2026-09-10) — the shared cartesian zoom on the column / row indexes: a mode (`'x'` | `'y'` | `'xy'`), `true`, `'inside'` or the object (drag rectangle, pan, wheel, pinch, keyboard, reset button). Off by default."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: HeatmapPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"HeatmapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"HeatmapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"HeatmapStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Cells the internal stream source tracks at most (oldest cells empty first)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed upserts the chart renders (the whole buffer when unset); older tracked cells revert to the base plane."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"a visual-map binding (a `sy-visual-map` snapshot + dimension); it overrides `colors` / `value-min` / `value-max` while bound."},{"name":"engine","attribute":"engine","type":"HeatmapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"`auto`, `standard` and `pro` all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down."},{"name":"unavailable","attribute":"unavailable","type":"HeatmapUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"`fallback` shows the on-chart notice when the renderer cannot run; `error` throws."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<HeatmapRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<HeatmapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"The reason the renderer cannot run (`undefined` while it runs)."},{"name":"setData","parameters":[{"name":"data","type":"HeatmapData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"setMatrix","parameters":[{"name":"matrix","type":"HeatmapMatrixInput","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendPoint","parameters":[{"name":"cell","type":"HeatmapDatum | HeatmapTuple","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"cells","type":"ReadonlyArray<HeatmapDatum | HeatmapTuple>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"cells","type":"ReadonlyArray<HeatmapDatum | HeatmapTuple>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<HeatmapStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: HeatmapEasing; enabled?: boolean; type?: HeatmapAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"showTooltipAtCell","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell (col / row), honouring the tooltip input; null when the tooltip is off or the cell is outside."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell by its index (`row * columns + col`; the facade's showTooltipAtPoint)."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusCellAt","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<HeatmapPointEventDetail | null>","description":"move the keyboard focus to a cell (the arrow-key state); null clears it."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<HeatmapPointEventDetail | null>","description":"The cell under host-relative CSS coordinates (inside the plot, through the zoomed matrix), or null."},{"name":"getCellValue","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<number | null>","description":"The value of a cell (`null` when empty or outside the grid)."},{"name":"getValueExtent","parameters":[],"returns":"Promise<HeatmapValueExtent | null>","description":"Min / max / finite count of the current values (`null` when nothing is finite)."},{"name":"getGridSize","parameters":[],"returns":"Promise<{ columns: number; rows: number; cells: number }>","description":"Columns × rows of the current grid."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows in index units: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by index units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — axes: `-0.5 … columns - 0.5` / `-0.5 … rows - 0.5`."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every cell is coloured through it on the next frame."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent a bound `sy-visual-map` adopts as its domain: the finite cell values (`value`), or the index ranges (`x` = columns, `y` = rows, `index` = cells)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"HeatmapRenderResult & { tier: HeatmapEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"HeatmapPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"HeatmapPointEventDetail | null","description":"CustomEvent.detail type: HeatmapPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<HeatmapPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<HeatmapPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Zoom — every zoom / pan change (drag, keyboard, wheel, pinch, API, reset); `null` zoom = the full extent."}]},"sections":[{"id":"overview","title":"sy-heatmap","blocks":[{"kind":"paragraph","text":"Explore matrix patterns across time, products, sensor locations, and similar dimensions."},{"kind":"paragraph","text":"Color alone makes precise values difficult to read. Provide a legend, tooltips, and a table."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { x, y, value }. x and y are numeric or categorical coordinates."]]},{"kind":"links","items":[{"path":"/charts/heatmap","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-heatmap.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-heatmap\",\n      \"props\": {\n        \"data\": [\n          {\n            \"x\": 0,\n            \"y\": 0,\n            \"value\": 10\n          },\n          {\n            \"x\": 1,\n            \"y\": 0,\n            \"value\": 27\n          },\n          {\n            \"x\": 2,\n            \"y\": 0,\n            \"value\": 44\n          },\n          {\n            \"x\": 3,\n            \"y\": 0,\n            \"value\": 61\n          },\n          {\n            \"x\": 4,\n            \"y\": 0,\n            \"value\": 78\n          },\n          {\n            \"x\": 5,\n            \"y\": 0,\n            \"value\": 95\n          },\n          {\n            \"x\": 0,\n            \"y\": 1,\n            \"value\": 22\n          },\n          {\n            \"x\": 1,\n            \"y\": 1,\n            \"value\": 39\n          },\n          {\n            \"x\": 2,\n            \"y\": 1,\n            \"value\": 56\n          },\n          {\n            \"x\": 3,\n            \"y\": 1,\n            \"value\": 73\n          },\n          {\n            \"x\": 4,\n            \"y\": 1,\n            \"value\": 90\n          },\n          {\n            \"x\": 5,\n            \"y\": 1,\n            \"value\": 17\n          },\n          {\n            \"x\": 0,\n            \"y\": 2,\n            \"value\": 34\n          },\n          {\n            \"x\": 1,\n            \"y\": 2,\n            \"value\": 51\n          },\n          {\n            \"x\": 2,\n            \"y\": 2,\n            \"value\": 68\n          },\n          {\n            \"x\": 3,\n            \"y\": 2,\n            \"value\": 85\n          },\n          {\n            \"x\": 4,\n            \"y\": 2,\n            \"value\": 12\n          },\n          {\n            \"x\": 5,\n            \"y\": 2,\n            \"value\": 29\n          },\n          {\n            \"x\": 0,\n            \"y\": 3,\n            \"value\": 46\n          },\n          {\n            \"x\": 1,\n            \"y\": 3,\n            \"value\": 63\n          },\n          {\n            \"x\": 2,\n            \"y\": 3,\n            \"value\": 80\n          },\n          {\n            \"x\": 3,\n            \"y\": 3,\n            \"value\": 97\n          },\n          {\n            \"x\": 4,\n            \"y\": 3,\n            \"value\": 24\n          },\n          {\n            \"x\": 5,\n            \"y\": 3,\n            \"value\": 41\n          },\n          {\n            \"x\": 0,\n            \"y\": 4,\n            \"value\": 58\n          },\n          {\n            \"x\": 1,\n            \"y\": 4,\n            \"value\": 75\n          },\n          {\n            \"x\": 2,\n            \"y\": 4,\n            \"value\": 92\n          },\n          {\n            \"x\": 3,\n            \"y\": 4,\n            \"value\": 19\n          },\n          {\n            \"x\": 4,\n            \"y\": 4,\n            \"value\": 36\n          },\n          {\n            \"x\": 5,\n            \"y\": 4,\n            \"value\": 53\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'heatmap example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { x, y, value }. x and y are numeric or categorical coordinates."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapData","title":"HeatmapData","description":"Type definition"}]}]},{"id":"property-matrix","title":"matrix","blocks":[{"kind":"paragraph","text":"A dense matrix: `{ columns, rows, values }` (row-major) or rows of columns."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`matrix`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapMatrixInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapMatrixInput","title":"HeatmapMatrixInput","description":"Type definition"}]}]},{"id":"property-xCategories","title":"xCategories","blocks":[{"kind":"paragraph","text":"Column labels (array, or a comma list attribute). Given explicitly, they fix the column count."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapCategoriesInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapCategoriesInput","title":"HeatmapCategoriesInput","description":"Type definition"}]}]},{"id":"property-yCategories","title":"yCategories","blocks":[{"kind":"paragraph","text":"Row labels (row 0 is the top row)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapCategoriesInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapCategoriesInput","title":"HeatmapCategoriesInput","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"The colour ramp: a scheme name (`viridis`, `blues`, …), a colour list / comma list, or `[t, colour]` stops."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapColorInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":"Type definition"}]}]},{"id":"property-valueMin","title":"valueMin","blocks":[{"kind":"paragraph","text":"Domain ends; an omitted end follows the data extent."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMin`"],["HTML attribute","`value-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueMax","title":"valueMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMax`"],["HTML attribute","`value-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-emptyColor","title":"emptyColor","blocks":[{"kind":"paragraph","text":"The colour of an empty cell (default transparent — the host background shows)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`emptyColor`"],["HTML attribute","`empty-color`"],["Type","`string`"],["Default","`'transparent'`"]]}]},{"id":"property-cellGap","title":"cellGap","blocks":[{"kind":"paragraph","text":"Gap between cells in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellGap`"],["HTML attribute","`cell-gap`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-renderPath","title":"renderPath","blocks":[{"kind":"paragraph","text":"the draw path: `auto` (the cells path from 3 device px per cell, else the plane), or a forced `plane` / `cells`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`renderPath`"],["HTML attribute","`render-path`"],["Type","`HeatmapRenderPath`"],["Default","`'auto'`"],["Allowed values","`auto`, `plane`, `cells`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapRenderPath","title":"HeatmapRenderPath","description":"Type definition"}]}]},{"id":"property-cellRadius","title":"cellRadius","blocks":[{"kind":"paragraph","text":"cell corner radius in CSS px (the cells path)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellRadius`"],["HTML attribute","`cell-radius`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-cellBorder","title":"cellBorder","blocks":[{"kind":"paragraph","text":"cell border width in CSS px (the cells path)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellBorder`"],["HTML attribute","`cell-border`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-cellBorderColor","title":"cellBorderColor","blocks":[{"kind":"paragraph","text":"cell border colour."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellBorderColor`"],["HTML attribute","`cell-border-color`"],["Type","`string`"],["Default","`'rgba(17,24,39,0.35)'`"]]}]},{"id":"property-lod","title":"lod","blocks":[{"kind":"paragraph","text":"the plane path's level of detail: `auto` (area-averaged once a cell is under a device px), `point`, `area`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lod`"],["HTML attribute","`lod`"],["Type","`HeatmapLodMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `point`, `area`, `smooth`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapLodMode","title":"HeatmapLodMode","description":"Type definition"}]}]},{"id":"property-areaReduce","title":"areaReduce","blocks":[{"kind":"paragraph","text":"how the area LOD folds the cells a pixel covers: `mean` (default) or `max` (peak-hold)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`areaReduce`"],["HTML attribute","`area-reduce`"],["Type","`'mean' | 'max'`"],["Default","`'mean'`"],["Allowed values","`max`, `mean`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Grid lines default OFF (the cells tile the plot)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (2026-09-10) — the shared cartesian zoom on the column / row indexes: a mode (`'x'` | `'y'` | `'xy'`), `true`, `'inside'` or the object (drag rectangle, pan, wheel, pinch, keyboard, reset button). Off by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: HeatmapPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`HeatmapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`HeatmapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapStreamSource","title":"HeatmapStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Cells the internal stream source tracks at most (oldest cells empty first)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed upserts the chart renders (the whole buffer when unset); older tracked cells revert to the base plane."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"a visual-map binding (a `sy-visual-map` snapshot + dimension); it overrides `colors` / `value-min` / `value-max` while bound."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"`auto`, `standard` and `pro` all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`HeatmapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"`fallback` shows the on-chart notice when the renderer cannot run; `error` throws."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`HeatmapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<HeatmapRenderResult & { tier: HeatmapEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // HeatmapRenderResult & { tier: HeatmapEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/HeatmapRenderResult","title":"HeatmapRenderResult","description":"Type definition"},{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<HeatmapPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // HeatmapPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: HeatmapPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<HeatmapPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // HeatmapPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<HeatmapPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<HeatmapPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<HeatmapPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Zoom — every zoom / pan change (drag, keyboard, wheel, pinch, API, reset); `null` zoom = the full extent."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<HeatmapRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HeatmapRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapRenderResult","title":"HeatmapRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<HeatmapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HeatmapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"The reason the renderer cannot run (`undefined` while it runs)."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: HeatmapData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`HeatmapData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapData","title":"HeatmapData","description":"Type definition"}]}]},{"id":"method-setMatrix","title":"setMatrix","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setMatrix(matrix: HeatmapMatrixInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`matrix`","`HeatmapMatrixInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapMatrixInput","title":"HeatmapMatrixInput","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(cell: HeatmapDatum | HeatmapTuple): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cell`","`HeatmapDatum | HeatmapTuple`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","description":"Type definition"},{"path":"/docs/types/HeatmapTuple","title":"HeatmapTuple","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cells`","`ReadonlyArray<HeatmapDatum | HeatmapTuple>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","description":"Type definition"},{"path":"/docs/types/HeatmapTuple","title":"HeatmapTuple","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cells`","`ReadonlyArray<HeatmapDatum | HeatmapTuple>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","description":"Type definition"},{"path":"/docs/types/HeatmapTuple","title":"HeatmapTuple","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<HeatmapStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HeatmapStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapStreamSource","title":"HeatmapStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: HeatmapEasing; enabled?: boolean; type?: HeatmapAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: HeatmapEasing; enabled?: boolean; type?: HeatmapAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":"Type definition"},{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtCell","title":"showTooltipAtCell","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell (col / row), honouring the tooltip input; null when the tooltip is off or the cell is outside."},{"kind":"code","source":"showTooltipAtCell(col: number, row: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell by its index (`row * columns + col`; the facade's showTooltipAtPoint)."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusCellAt","title":"focusCellAt","blocks":[{"kind":"paragraph","text":"move the keyboard focus to a cell (the arrow-key state); null clears it."},{"kind":"code","source":"focusCellAt(col: number, row: number): Promise<HeatmapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<HeatmapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The cell under host-relative CSS coordinates (inside the plot, through the zoomed matrix), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<HeatmapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<HeatmapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"method-getCellValue","title":"getCellValue","blocks":[{"kind":"paragraph","text":"The value of a cell (`null` when empty or outside the grid)."},{"kind":"code","source":"getCellValue(col: number, row: number): Promise<number | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getValueExtent","title":"getValueExtent","blocks":[{"kind":"paragraph","text":"Min / max / finite count of the current values (`null` when nothing is finite)."},{"kind":"code","source":"getValueExtent(): Promise<HeatmapValueExtent | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HeatmapValueExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapValueExtent","title":"HeatmapValueExtent","description":"Type definition"}]}]},{"id":"method-getGridSize","title":"getGridSize","blocks":[{"kind":"paragraph","text":"Columns × rows of the current grid."},{"kind":"code","source":"getGridSize(): Promise<{ columns: number; rows: number; cells: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ columns: number; rows: number; cells: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows in index units: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by index units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — axes: `-0.5 … columns - 0.5` / `-0.5 … rows - 0.5`."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every cell is coloured through it on the next frame."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent a bound `sy-visual-map` adopts as its domain: the finite cell values (`value`), or the index ranges (`x` = columns, `y` = rows, `index` = cells)."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/calendar-heatmap","title":"Calendar Heatmap","summary":"Show daily activity as colors on a calendar.","kind":"component","tag":"sy-calendar-heatmap","componentId":"calendar-heatmap","api":{"props":[{"name":"data","attribute":"data","type":"CalendarHeatmapData","kind":"property","values":[],"default":"undefined","description":"An array of { date, value }. The example uses YYYY-MM-DD dates."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"180","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"year","attribute":"year","type":"number","kind":"number","values":[],"default":"undefined","description":"The range: a year (Jan 1 … Dec 31); `start-date` / `end-date` win over it; neither → the data's span."},{"name":"startDate","attribute":"start-date","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"endDate","attribute":"end-date","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"weekStart","attribute":"week-start","type":"CalendarWeekStart","kind":"string","values":["monday","sunday"],"default":"'monday'","description":"monday or sunday."},{"name":"aggregate","attribute":"aggregate","type":"CalendarAggregate","kind":"string","values":["sum","max","min","mean","last"],"default":"'sum'","description":"How several entries on one day fold: `sum` (default), `max`, `min`, `mean`, `last`."},{"name":"noDataValue","attribute":"no-data-value","type":"number | 'nan'","kind":"property","values":["nan"],"default":"0","description":"What a day without entries reads on the plane: a number (default 0 → the ramp's first colour) or `nan` (→ `empty-color`)."},{"name":"colors","attribute":"colors","type":"string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]>","kind":"property","values":[],"default":"undefined","description":"The colour ramp (a scheme name, a colour list / comma list, or `[t, colour]` stops); default GitHub's greens."},{"name":"valueMin","attribute":"value-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Domain ends; an omitted end follows the data (the min includes the fill, so 0 is the ramp start)."},{"name":"valueMax","attribute":"value-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"emptyColor","attribute":"empty-color","type":"string","kind":"string","values":[],"default":"'transparent'","description":"The colour of a NaN cell (the strip's corners outside the range, and no-data days under `no-data-value=\"nan\"`) — transparent by default."},{"name":"cellGap","attribute":"cell-gap","type":"number","kind":"number","values":[],"default":"2","description":"CSS px between cells."},{"name":"cellRadius","attribute":"cell-radius","type":"number","kind":"number","values":[],"default":"2","description":"The cell corner radius in CSS px."},{"name":"cellBorder","attribute":"cell-border","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"cellBorderColor","attribute":"cell-border-color","type":"string","kind":"string","values":[],"default":"'rgba(17,24,39,0.35)'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"renderPath","attribute":"render-path","type":"CalendarHeatmapRenderPath","kind":"string","values":["auto","plane","cells"],"default":"'auto'","description":"The draw path: `auto` (the cells path from 3 device px per cell — the usual case), or a forced `plane` / `cells`."},{"name":"lod","attribute":"lod","type":"HeatmapLodMode","kind":"string","values":["auto","point","area","smooth"],"default":"'auto'","description":"Allowed values: auto, point, area, smooth. Default: 'auto'."},{"name":"monthLabels","attribute":"month-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Month labels along the top (a month whose label would overlap the previous one is skipped)."},{"name":"weekdayLabels","attribute":"weekday-labels","type":"CalendarWeekdayLabels","kind":"string","values":["none","short","all"],"default":"'short'","description":"Weekday labels down the left: `short` (rows 0 / 2 / 4), `all`, `none`."},{"name":"monthLines","attribute":"month-lines","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Month boundaries as step lines between the cells."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: CalendarHeatmapPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"CalendarHeatmapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"CalendarHeatmapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"CalendarHeatmapStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Streamed entries kept at most (default 10,000): the oldest leave first."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed entries the chart folds in (the whole buffer when unset): the upserts of older entries revert to the `data` entries."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"A visual-map binding; it overrides `colors` / `value-min` / `value-max` while bound."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Viewport zoom (Storybook parity, 2026-09-10) — the `zoom` attribute the cartesian charts carry: a mode (`'x'` | `'y'` | `'xy'`), `true` (x) or an object (`mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`); off by default. The strip (the plot between the label bands) is the drawing rectangle — x runs 0 → 1 left to right over the weeks, y 0 → 1 bottom to top over the weekday rows — and the day cells are magnified into the window (their gap keeps its screen size); weeks and rows outside it leave the strip, the month lines, the labels and the hover / focus rings follow the visible cells. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches. Property-only (a mode string also works as an attribute)."},{"name":"engine","attribute":"engine","type":"CalendarHeatmapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"CalendarHeatmapUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<CalendarHeatmapRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<CalendarHeatmapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"CalendarHeatmapData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"entry","type":"CalendarHeatmapEntry","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"entries","type":"ReadonlyArray<CalendarHeatmapEntry>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the `count` oldest STREAMED entries (the `data` prop's entries are not a stream)."},{"name":"replace","parameters":[{"name":"entries","type":"ReadonlyArray<CalendarHeatmapEntry>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<CalendarHeatmapStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: CalendarHeatmapEasing; enabled?: boolean; type?: CalendarHeatmapAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<CalendarHeatmapPointEventDetail | null>","description":"The day under host-relative CSS coordinates, or null (outside the strip, or a corner cell outside the range)."},{"name":"getCellValue","parameters":[{"name":"date","type":"CalendarDateInput","optional":false}],"returns":"Promise<number | null>","description":"The folded value of a day (`null` for a day without entries or outside the range)."},{"name":"getValueExtent","parameters":[],"returns":"Promise<CalendarHeatmapValueExtent | null>","description":"The data's extent (the fill never counts)."},{"name":"getGridSize","parameters":[],"returns":"Promise<{ weeks: number; rows: number; cells: number; days: number; valued: number; entries: number; dropped: number }>","description":"Columns × rows of the current grid."},{"name":"getRange","parameters":[],"returns":"Promise<CalendarHeatmapRange>","description":"The resolved range."},{"name":"getMonthMarks","parameters":[],"returns":"Promise<CalendarMonthMark[]>","description":"The month marks (labels + boundary anchors)."},{"name":"showTooltipAtCell","parameters":[{"name":"week","type":"number","optional":false},{"name":"weekday","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell (week / weekday), honouring the tooltip input; null when the tooltip is off or the cell has no day."},{"name":"showTooltipAtDate","parameters":[{"name":"date","type":"CalendarDateInput","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a day (null outside the range)."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell by its public index (`week * 7 + weekday`; the facade's showTooltipAtPoint)."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusCellAt","parameters":[{"name":"week","type":"number","optional":false},{"name":"weekday","type":"number","optional":false}],"returns":"Promise<CalendarHeatmapPointEventDetail | null>","description":"move the keyboard focus ring to a cell and announce it (null for a cell without a day)."},{"name":"focusDate","parameters":[{"name":"date","type":"CalendarDateInput","optional":false}],"returns":"Promise<CalendarHeatmapPointEventDetail | null>","description":"move the keyboard focus ring to a day (null outside the range)."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension: `value` = the day values, `x` = the week columns, `y` = the weekday rows, `index` = the cells."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows of the strip (`x` / `y` as `{ min, max }` or `[min, max]` fractions 0 … 1; `null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by fractions of the strip (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent of the viewport axes (`[0, 1]` each, key `'0'`)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"CalendarHeatmapRenderResult & { tier: CalendarHeatmapEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"CalendarHeatmapPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"CalendarHeatmapPointEventDetail | null","description":"CustomEvent.detail type: CalendarHeatmapPointEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset)."}]},"sections":[{"id":"overview","title":"sy-calendar-heatmap","blocks":[{"kind":"paragraph","text":"Inspect weekly patterns in daily usage, performance, attendance, and similar measures."},{"kind":"paragraph","text":"Distinguish missing dates from actual zero values. Keep date formatting and the first day of the week consistent."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { date, value }. The example uses YYYY-MM-DD dates."],["`weekStart`","monday or sunday."]]},{"kind":"links","items":[{"path":"/charts/calendar-heatmap","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-calendar-heatmap.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-calendar-heatmap\",\n      \"props\": {\n        \"data\": [\n          {\n            \"date\": \"2026-01-01\",\n            \"value\": 0\n          },\n          {\n            \"date\": \"2026-01-02\",\n            \"value\": 13\n          },\n          {\n            \"date\": \"2026-01-03\",\n            \"value\": 26\n          },\n          {\n            \"date\": \"2026-01-04\",\n            \"value\": 39\n          },\n          {\n            \"date\": \"2026-01-05\",\n            \"value\": 52\n          },\n          {\n            \"date\": \"2026-01-06\",\n            \"value\": 65\n          },\n          {\n            \"date\": \"2026-01-07\",\n            \"value\": 78\n          },\n          {\n            \"date\": \"2026-01-08\",\n            \"value\": 91\n          },\n          {\n            \"date\": \"2026-01-09\",\n            \"value\": 4\n          },\n          {\n            \"date\": \"2026-01-10\",\n            \"value\": 17\n          },\n          {\n            \"date\": \"2026-01-11\",\n            \"value\": 30\n          },\n          {\n            \"date\": \"2026-01-12\",\n            \"value\": 43\n          },\n          {\n            \"date\": \"2026-01-13\",\n            \"value\": 56\n          },\n          {\n            \"date\": \"2026-01-14\",\n            \"value\": 69\n          },\n          {\n            \"date\": \"2026-01-15\",\n            \"value\": 82\n          },\n          {\n            \"date\": \"2026-01-16\",\n            \"value\": 95\n          },\n          {\n            \"date\": \"2026-01-17\",\n            \"value\": 8\n          },\n          {\n            \"date\": \"2026-01-18\",\n            \"value\": 21\n          },\n          {\n            \"date\": \"2026-01-19\",\n            \"value\": 34\n          },\n          {\n            \"date\": \"2026-01-20\",\n            \"value\": 47\n          },\n          {\n            \"date\": \"2026-01-21\",\n            \"value\": 60\n          },\n          {\n            \"date\": \"2026-01-22\",\n            \"value\": 73\n          },\n          {\n            \"date\": \"2026-01-23\",\n            \"value\": 86\n          },\n          {\n            \"date\": \"2026-01-24\",\n            \"value\": 99\n          },\n          {\n            \"date\": \"2026-01-25\",\n            \"value\": 12\n          },\n          {\n            \"date\": \"2026-01-26\",\n            \"value\": 25\n          },\n          {\n            \"date\": \"2026-01-27\",\n            \"value\": 38\n          },\n          {\n            \"date\": \"2026-01-28\",\n            \"value\": 51\n          },\n          {\n            \"date\": \"2026-01-29\",\n            \"value\": 64\n          },\n          {\n            \"date\": \"2026-01-30\",\n            \"value\": 77\n          },\n          {\n            \"date\": \"2026-01-31\",\n            \"value\": 90\n          },\n          {\n            \"date\": \"2026-02-01\",\n            \"value\": 3\n          },\n          {\n            \"date\": \"2026-02-02\",\n            \"value\": 16\n          },\n          {\n            \"date\": \"2026-02-03\",\n            \"value\": 29\n          },\n          {\n            \"date\": \"2026-02-04\",\n            \"value\": 42\n          },\n          {\n            \"date\": \"2026-02-05\",\n            \"value\": 55\n          },\n          {\n            \"date\": \"2026-02-06\",\n            \"value\": 68\n          },\n          {\n            \"date\": \"2026-02-07\",\n            \"value\": 81\n          },\n          {\n            \"date\": \"2026-02-08\",\n            \"value\": 94\n          },\n          {\n            \"date\": \"2026-02-09\",\n            \"value\": 7\n          },\n          {\n            \"date\": \"2026-02-10\",\n            \"value\": 20\n          },\n          {\n            \"date\": \"2026-02-11\",\n            \"value\": 33\n          },\n          {\n            \"date\": \"2026-02-12\",\n            \"value\": 46\n          },\n          {\n            \"date\": \"2026-02-13\",\n            \"value\": 59\n          },\n          {\n            \"date\": \"2026-02-14\",\n            \"value\": 72\n          },\n          {\n            \"date\": \"2026-02-15\",\n            \"value\": 85\n          },\n          {\n            \"date\": \"2026-02-16\",\n            \"value\": 98\n          },\n          {\n            \"date\": \"2026-02-17\",\n            \"value\": 11\n          },\n          {\n            \"date\": \"2026-02-18\",\n            \"value\": 24\n          },\n          {\n            \"date\": \"2026-02-19\",\n            \"value\": 37\n          },\n          {\n            \"date\": \"2026-02-20\",\n            \"value\": 50\n          },\n          {\n            \"date\": \"2026-02-21\",\n            \"value\": 63\n          },\n          {\n            \"date\": \"2026-02-22\",\n            \"value\": 76\n          },\n          {\n            \"date\": \"2026-02-23\",\n            \"value\": 89\n          },\n          {\n            \"date\": \"2026-02-24\",\n            \"value\": 2\n          },\n          {\n            \"date\": \"2026-02-25\",\n            \"value\": 15\n          },\n          {\n            \"date\": \"2026-02-26\",\n            \"value\": 28\n          },\n          {\n            \"date\": \"2026-02-27\",\n            \"value\": 41\n          },\n          {\n            \"date\": \"2026-02-28\",\n            \"value\": 54\n          },\n          {\n            \"date\": \"2026-03-01\",\n            \"value\": 67\n          },\n          {\n            \"date\": \"2026-03-02\",\n            \"value\": 80\n          },\n          {\n            \"date\": \"2026-03-03\",\n            \"value\": 93\n          },\n          {\n            \"date\": \"2026-03-04\",\n            \"value\": 6\n          },\n          {\n            \"date\": \"2026-03-05\",\n            \"value\": 19\n          },\n          {\n            \"date\": \"2026-03-06\",\n            \"value\": 32\n          },\n          {\n            \"date\": \"2026-03-07\",\n            \"value\": 45\n          },\n          {\n            \"date\": \"2026-03-08\",\n            \"value\": 58\n          },\n          {\n            \"date\": \"2026-03-09\",\n            \"value\": 71\n          },\n          {\n            \"date\": \"2026-03-10\",\n            \"value\": 84\n          },\n          {\n            \"date\": \"2026-03-11\",\n            \"value\": 97\n          },\n          {\n            \"date\": \"2026-03-12\",\n            \"value\": 10\n          },\n          {\n            \"date\": \"2026-03-13\",\n            \"value\": 23\n          },\n          {\n            \"date\": \"2026-03-14\",\n            \"value\": 36\n          },\n          {\n            \"date\": \"2026-03-15\",\n            \"value\": 49\n          },\n          {\n            \"date\": \"2026-03-16\",\n            \"value\": 62\n          },\n          {\n            \"date\": \"2026-03-17\",\n            \"value\": 75\n          },\n          {\n            \"date\": \"2026-03-18\",\n            \"value\": 88\n          },\n          {\n            \"date\": \"2026-03-19\",\n            \"value\": 1\n          },\n          {\n            \"date\": \"2026-03-20\",\n            \"value\": 14\n          },\n          {\n            \"date\": \"2026-03-21\",\n            \"value\": 27\n          },\n          {\n            \"date\": \"2026-03-22\",\n            \"value\": 40\n          },\n          {\n            \"date\": \"2026-03-23\",\n            \"value\": 53\n          },\n          {\n            \"date\": \"2026-03-24\",\n            \"value\": 66\n          },\n          {\n            \"date\": \"2026-03-25\",\n            \"value\": 79\n          },\n          {\n            \"date\": \"2026-03-26\",\n            \"value\": 92\n          },\n          {\n            \"date\": \"2026-03-27\",\n            \"value\": 5\n          },\n          {\n            \"date\": \"2026-03-28\",\n            \"value\": 18\n          },\n          {\n            \"date\": \"2026-03-29\",\n            \"value\": 31\n          },\n          {\n            \"date\": \"2026-03-30\",\n            \"value\": 44\n          },\n          {\n            \"date\": \"2026-03-31\",\n            \"value\": 57\n          }\n        ],\n        \"weekStart\": \"monday\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'calendar-heatmap example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { date, value }. The example uses YYYY-MM-DD dates."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CalendarHeatmapData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapData","title":"CalendarHeatmapData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`180`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-year","title":"year","blocks":[{"kind":"paragraph","text":"The range: a year (Jan 1 … Dec 31); `start-date` / `end-date` win over it; neither → the data's span."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`year`"],["HTML attribute","`year`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-startDate","title":"startDate","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startDate`"],["HTML attribute","`start-date`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-endDate","title":"endDate","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`endDate`"],["HTML attribute","`end-date`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-weekStart","title":"weekStart","blocks":[{"kind":"paragraph","text":"monday or sunday."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weekStart`"],["HTML attribute","`week-start`"],["Type","`CalendarWeekStart`"],["Default","`'monday'`"],["Allowed values","`monday`, `sunday`"]]},{"kind":"links","items":[{"path":"/docs/types/CalendarWeekStart","title":"CalendarWeekStart","description":"Type definition"}]}]},{"id":"property-aggregate","title":"aggregate","blocks":[{"kind":"paragraph","text":"How several entries on one day fold: `sum` (default), `max`, `min`, `mean`, `last`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`aggregate`"],["HTML attribute","`aggregate`"],["Type","`CalendarAggregate`"],["Default","`'sum'`"],["Allowed values","`sum`, `max`, `min`, `mean`, `last`"]]},{"kind":"links","items":[{"path":"/docs/types/CalendarAggregate","title":"CalendarAggregate","description":"Type definition"}]}]},{"id":"property-noDataValue","title":"noDataValue","blocks":[{"kind":"paragraph","text":"What a day without entries reads on the plane: a number (default 0 → the ramp's first colour) or `nan` (→ `empty-color`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`noDataValue`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'nan'`"],["Default","`0`"],["Literals in the type","`nan`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"The colour ramp (a scheme name, a colour list / comma list, or `[t, colour]` stops); default GitHub's greens."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueMin","title":"valueMin","blocks":[{"kind":"paragraph","text":"Domain ends; an omitted end follows the data (the min includes the fill, so 0 is the ramp start)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMin`"],["HTML attribute","`value-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueMax","title":"valueMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMax`"],["HTML attribute","`value-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-emptyColor","title":"emptyColor","blocks":[{"kind":"paragraph","text":"The colour of a NaN cell (the strip's corners outside the range, and no-data days under `no-data-value=\"nan\"`) — transparent by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`emptyColor`"],["HTML attribute","`empty-color`"],["Type","`string`"],["Default","`'transparent'`"]]}]},{"id":"property-cellGap","title":"cellGap","blocks":[{"kind":"paragraph","text":"CSS px between cells."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellGap`"],["HTML attribute","`cell-gap`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-cellRadius","title":"cellRadius","blocks":[{"kind":"paragraph","text":"The cell corner radius in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellRadius`"],["HTML attribute","`cell-radius`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-cellBorder","title":"cellBorder","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellBorder`"],["HTML attribute","`cell-border`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-cellBorderColor","title":"cellBorderColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellBorderColor`"],["HTML attribute","`cell-border-color`"],["Type","`string`"],["Default","`'rgba(17,24,39,0.35)'`"]]}]},{"id":"property-renderPath","title":"renderPath","blocks":[{"kind":"paragraph","text":"The draw path: `auto` (the cells path from 3 device px per cell — the usual case), or a forced `plane` / `cells`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`renderPath`"],["HTML attribute","`render-path`"],["Type","`CalendarHeatmapRenderPath`"],["Default","`'auto'`"],["Allowed values","`auto`, `plane`, `cells`"]]},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapRenderPath","title":"CalendarHeatmapRenderPath","description":"Type definition"}]}]},{"id":"property-lod","title":"lod","blocks":[{"kind":"paragraph","text":"Allowed values: auto, point, area, smooth. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lod`"],["HTML attribute","`lod`"],["Type","`HeatmapLodMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `point`, `area`, `smooth`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapLodMode","title":"HeatmapLodMode","description":"Type definition"}]}]},{"id":"property-monthLabels","title":"monthLabels","blocks":[{"kind":"paragraph","text":"Month labels along the top (a month whose label would overlap the previous one is skipped)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`monthLabels`"],["HTML attribute","`month-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-weekdayLabels","title":"weekdayLabels","blocks":[{"kind":"paragraph","text":"Weekday labels down the left: `short` (rows 0 / 2 / 4), `all`, `none`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weekdayLabels`"],["HTML attribute","`weekday-labels`"],["Type","`CalendarWeekdayLabels`"],["Default","`'short'`"],["Allowed values","`none`, `short`, `all`"]]},{"kind":"links","items":[{"path":"/docs/types/CalendarWeekdayLabels","title":"CalendarWeekdayLabels","description":"Type definition"}]}]},{"id":"property-monthLines","title":"monthLines","blocks":[{"kind":"paragraph","text":"Month boundaries as step lines between the cells."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`monthLines`"],["HTML attribute","`month-lines`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: CalendarHeatmapPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`CalendarHeatmapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEasing","title":"CalendarHeatmapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`CalendarHeatmapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapAnimationType","title":"CalendarHeatmapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CalendarHeatmapStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapStreamSource","title":"CalendarHeatmapStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Streamed entries kept at most (default 10,000): the oldest leave first."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed entries the chart folds in (the whole buffer when unset): the upserts of older entries revert to the `data` entries."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"A visual-map binding; it overrides `colors` / `value-min` / `value-max` while bound."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Viewport zoom (Storybook parity, 2026-09-10) — the `zoom` attribute the cartesian charts carry: a mode (`'x'` | `'y'` | `'xy'`), `true` (x) or an object (`mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`); off by default. The strip (the plot between the label bands) is the drawing rectangle — x runs 0 → 1 left to right over the weeks, y 0 → 1 bottom to top over the weekday rows — and the day cells are magnified into the window (their gap keeps its screen size); weeks and rows outside it leave the strip, the month lines, the labels and the hover / focus rings follow the visible cells. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches. Property-only (a mode string also works as an attribute)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`CalendarHeatmapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEngineMode","title":"CalendarHeatmapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`CalendarHeatmapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapUnavailableBehaviour","title":"CalendarHeatmapUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CalendarHeatmapRenderResult & { tier: CalendarHeatmapEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // CalendarHeatmapRenderResult & { tier: CalendarHeatmapEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapRenderResult","title":"CalendarHeatmapRenderResult","description":"Type definition"},{"path":"/docs/types/CalendarHeatmapEngineTier","title":"CalendarHeatmapEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CalendarHeatmapPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // CalendarHeatmapPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CalendarHeatmapPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CalendarHeatmapPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // CalendarHeatmapPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<CalendarHeatmapPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset)."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<CalendarHeatmapRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapRenderResult","title":"CalendarHeatmapRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<CalendarHeatmapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEngineTier","title":"CalendarHeatmapEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: CalendarHeatmapData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`CalendarHeatmapData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapData","title":"CalendarHeatmapData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(entry: CalendarHeatmapEntry): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`entry`","`CalendarHeatmapEntry`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(entries: ReadonlyArray<CalendarHeatmapEntry>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`entries`","`ReadonlyArray<CalendarHeatmapEntry>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the `count` oldest STREAMED entries (the `data` prop's entries are not a stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(entries: ReadonlyArray<CalendarHeatmapEntry>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`entries`","`ReadonlyArray<CalendarHeatmapEntry>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<CalendarHeatmapStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapStreamSource","title":"CalendarHeatmapStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: CalendarHeatmapEasing; enabled?: boolean; type?: CalendarHeatmapAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: CalendarHeatmapEasing; enabled?: boolean; type?: CalendarHeatmapAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEasing","title":"CalendarHeatmapEasing","description":"Type definition"},{"path":"/docs/types/CalendarHeatmapAnimationType","title":"CalendarHeatmapAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The day under host-relative CSS coordinates, or null (outside the strip, or a corner cell outside the range)."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<CalendarHeatmapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"method-getCellValue","title":"getCellValue","blocks":[{"kind":"paragraph","text":"The folded value of a day (`null` for a day without entries or outside the range)."},{"kind":"code","source":"getCellValue(date: CalendarDateInput): Promise<number | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`date`","`CalendarDateInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarDateInput","title":"CalendarDateInput","description":"Type definition"}]}]},{"id":"method-getValueExtent","title":"getValueExtent","blocks":[{"kind":"paragraph","text":"The data's extent (the fill never counts)."},{"kind":"code","source":"getValueExtent(): Promise<CalendarHeatmapValueExtent | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapValueExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapValueExtent","title":"CalendarHeatmapValueExtent","description":"Type definition"}]}]},{"id":"method-getGridSize","title":"getGridSize","blocks":[{"kind":"paragraph","text":"Columns × rows of the current grid."},{"kind":"code","source":"getGridSize(): Promise<{ weeks: number; rows: number; cells: number; days: number; valued: number; entries: number; dropped: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ weeks: number; rows: number; cells: number; days: number; valued: number; entries: number; dropped: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getRange","title":"getRange","blocks":[{"kind":"paragraph","text":"The resolved range."},{"kind":"code","source":"getRange(): Promise<CalendarHeatmapRange>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapRange>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapRange","title":"CalendarHeatmapRange","description":"Type definition"}]}]},{"id":"method-getMonthMarks","title":"getMonthMarks","blocks":[{"kind":"paragraph","text":"The month marks (labels + boundary anchors)."},{"kind":"code","source":"getMonthMarks(): Promise<CalendarMonthMark[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CalendarMonthMark[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarMonthMark","title":"CalendarMonthMark","description":"Type definition"}]}]},{"id":"method-showTooltipAtCell","title":"showTooltipAtCell","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell (week / weekday), honouring the tooltip input; null when the tooltip is off or the cell has no day."},{"kind":"code","source":"showTooltipAtCell(week: number, weekday: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`week`","`number`","Required"],["`weekday`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtDate","title":"showTooltipAtDate","blocks":[{"kind":"paragraph","text":"open the tooltip on a day (null outside the range)."},{"kind":"code","source":"showTooltipAtDate(date: CalendarDateInput): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`date`","`CalendarDateInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"},{"path":"/docs/types/CalendarDateInput","title":"CalendarDateInput","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell by its public index (`week * 7 + weekday`; the facade's showTooltipAtPoint)."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusCellAt","title":"focusCellAt","blocks":[{"kind":"paragraph","text":"move the keyboard focus ring to a cell and announce it (null for a cell without a day)."},{"kind":"code","source":"focusCellAt(week: number, weekday: number): Promise<CalendarHeatmapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`week`","`number`","Required"],["`weekday`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":"Type definition"}]}]},{"id":"method-focusDate","title":"focusDate","blocks":[{"kind":"paragraph","text":"move the keyboard focus ring to a day (null outside the range)."},{"kind":"code","source":"focusDate(date: CalendarDateInput): Promise<CalendarHeatmapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`date`","`CalendarDateInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CalendarHeatmapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":"Type definition"},{"path":"/docs/types/CalendarDateInput","title":"CalendarDateInput","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear) a visual map: every mark is coloured through it on the next paint."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension: `value` = the day values, `x` = the week columns, `y` = the weekday rows, `index` = the cells."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows of the strip (`x` / `y` as `{ min, max }` or `[min, max]` fractions 0 … 1; `null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by fractions of the strip (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent of the viewport axes (`[0, 1]` each, key `'0'`)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/density-map","title":"Density Map","summary":"Show concentrations of observations as a smooth density surface.","kind":"component","tag":"sy-density-map","componentId":"density-map","api":{"props":[{"name":"data","attribute":"data","type":"DensityMapInput","kind":"property","values":[],"default":"undefined","description":"An array of { x, y, weight? }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"xMin","attribute":"x-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit domain ends (an omitted end follows the point extent padded by `padding`; `x-axis` / `y-axis` `min` / `max` also set them)."},{"name":"xMax","attribute":"x-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMin","attribute":"y-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMax","attribute":"y-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"0.05","description":"The fraction of the span padded on each automatic domain end."},{"name":"cellSize","attribute":"cell-size","type":"number","kind":"number","values":[],"default":"3","description":"CSS px per estimate cell (the grid follows the plot size); `columns` / `rows` override it."},{"name":"columns","attribute":"columns","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"rows","attribute":"rows","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"bandwidth","attribute":"bandwidth","type":"DensityMapBandwidthInput","kind":"property","values":[],"default":"'auto'","description":"The range over which the kernel is applied."},{"name":"bandwidthUnit","attribute":"bandwidth-unit","type":"DensityMapBandwidthUnit","kind":"string","values":["data","px"],"default":"'data'","description":"`data` (default) — the bandwidth is in data units; `px` — in CSS px of the plot."},{"name":"kernel","attribute":"kernel","type":"DensityMapKernel","kind":"string","values":["gaussian","epanechnikov","quartic","triangular","uniform"],"default":"'gaussian'","description":"The kernel used for density estimation."},{"name":"threshold","attribute":"threshold","type":"number","kind":"number","values":[],"default":"0.02","description":"Cells under this fraction of the peak density are empty (the background shows through)."},{"name":"computePath","attribute":"compute-path","type":"DensityMapComputePathInput","kind":"string","values":["auto","cpu","gpu"],"default":"'auto'","description":"where the estimate runs: `auto` (the GPU compute once the renderer is up, else the CPU), `cpu`, `gpu`."},{"name":"colors","attribute":"colors","type":"string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]>","kind":"property","values":[],"default":"undefined","description":"The colour ramp over the density domain (a scheme name, a colour list / comma list, or `[t, colour]` stops)."},{"name":"valueMin","attribute":"value-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Density domain ends; an omitted end follows 0 … the peak."},{"name":"valueMax","attribute":"value-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"emptyColor","attribute":"empty-color","type":"string","kind":"string","values":[],"default":"'transparent'","description":"The colour of an empty (under-threshold) cell — transparent by default."},{"name":"lod","attribute":"lod","type":"DensityMapLodMode","kind":"string","values":["auto","point","area","smooth"],"default":"'smooth'","description":"The plane's level of detail: `smooth` (bilinear between cell centres — the default here), `auto`, `point`, `area`."},{"name":"fade","attribute":"fade","type":"number","kind":"number","values":[],"default":"0.06","description":"the fade band above the threshold cut, as a fraction of the peak (0 = a hard edge)."},{"name":"densityUnit","attribute":"density-unit","type":"DensityMapUnitInput","kind":"string","values":["mass","per-area"],"default":"'mass'","description":"how densities read: the cell's mass (default) or mass per unit area of the data space."},{"name":"xAxis","attribute":"x-axis","type":"XAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Grid lines default OFF (the plane tiles the plot)."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the x / y domains; the estimate is not re-run per gesture — the field's visible sub-rectangle is mapped onto the plot. An object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: DensityMapPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"DensityMapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"DensityMapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"DensityMapStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Points the internal stream source tracks at most (the oldest drop first)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed points that feed the estimate (the whole buffer when unset)."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"A visual-map binding (a `sy-visual-map` snapshot + dimension); it overrides `colors` / `value-min` / `value-max` while bound."},{"name":"engine","attribute":"engine","type":"DensityMapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"`auto`, `standard` and `pro` all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down."},{"name":"unavailable","attribute":"unavailable","type":"DensityMapUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"`fallback` shows the on-chart notice when the renderer cannot run; `error` throws."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<DensityMapRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<DensityMapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"The reason the renderer cannot run (`undefined` while it runs)."},{"name":"setData","parameters":[{"name":"data","type":"DensityMapInput","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"point","type":"DensityMapPoint | DensityMapTuple","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"points","type":"ReadonlyArray<DensityMapPoint | DensityMapTuple>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"(carry-over C9) — `shift(n)` drops the n oldest points of the cloud: the `data` prop's leading entries first (a plain cloud shifts too — before a shift without a stream was a no-op), then the streamed points through the stream source. Each part fires `windowSlid` with its own count."},{"name":"replace","parameters":[{"name":"points","type":"ReadonlyArray<DensityMapPoint | DensityMapTuple>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<DensityMapStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: DensityMapEasing; enabled?: boolean; type?: DensityMapAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<DensityMapPointEventDetail | null>","description":"The estimate cell under host-relative CSS coordinates, or null (the density waits for a pending readback)."},{"name":"getCellValue","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<number | null>","description":"The density of a cell in the public unit (`null` under the threshold or outside the grid)."},{"name":"getDensityAt","parameters":[{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<number | null>","description":"The density at a data-space point in the public unit (`null` outside the domain or under the threshold)."},{"name":"getValueExtent","parameters":[],"returns":"Promise<DensityMapValueExtent | null>","description":"The density extent of the estimate in the public unit (min 0, max = the peak, finite = cells over the threshold)."},{"name":"showTooltipAtCell","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell (col / row), honouring the tooltip input; null when off or outside."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell by its index (`row * columns + col`; the facade's showTooltipAtPoint)."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusCellAt","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<DensityMapPointEventDetail | null>","description":"move the keyboard focus to a cell (the arrow-key state); null clears it."},{"name":"getGridSize","parameters":[],"returns":"Promise<{ columns: number; rows: number; cells: number }>","description":"Columns × rows of the current grid."},{"name":"getDomain","parameters":[],"returns":"Promise<DensityMapDomain>","description":"The data domain the grid spans."},{"name":"getBandwidth","parameters":[],"returns":"Promise<DensityMapBandwidth>","description":"The resolved bandwidth (data units, CSS px, cells; `auto` when Silverman chose it)."},{"name":"getKernelTaps","parameters":[],"returns":"Promise<{ kernel: DensityMapKernel; x: number[]; y: number[]; radius: { x: number; y: number } }>","description":"the normalised kernel taps of the current estimate per axis (length 2 × radius + 1; they sum to 1)."},{"name":"getComputeStats","parameters":[],"returns":"Promise<DensityMapComputeStats>","description":"The statistics of the last estimate (points, grid, kernel, bandwidth, radius, compute time, peak, mass)."},{"name":"getPlaneValues","parameters":[],"returns":"Promise<Float32Array>","description":"a copy of the current plane (NaN = empty; cell mass), whichever path computed it (waits for a pending readback)."},{"name":"computeReference","parameters":[],"returns":"Promise<{ values: Float32Array; densityMax: number; mass: number; binned: number; finite: number; computeMs: number; radius: { x: number; y: number } }>","description":"the CPU reference estimate for the current inputs (the parity oracle of the GPU path; never cached)."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear with null) a visual-map snapshot; it wins over the `visualMap` prop until the prop changes again."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension: `value` = the density (0 … peak), `x` / `y` = the domain, `index` = the cell indexes."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows in data units: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — master axes (the field's x / y domain)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"DensityMapRenderResult & { tier: DensityMapEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"DensityMapPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"DensityMapPointEventDetail | null","description":"CustomEvent.detail type: DensityMapPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<DensityMapPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DensityMapPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-density-map","blocks":[{"kind":"paragraph","text":"Explore clusters and spatial concentration among many points."},{"kind":"paragraph","text":"Density is an estimate, not a raw observation. Results depend on bandwidth and coordinate units."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { x, y, weight? }."],["`bandwidth`","The range over which the kernel is applied."],["`kernel`","The kernel used for density estimation."]]},{"kind":"links","items":[{"path":"/charts/density-map","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-density-map.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-density-map\",\n      \"props\": {\n        \"data\": [\n          {\n            \"x\": 0,\n            \"y\": 7,\n            \"weight\": 1\n          },\n          {\n            \"x\": 16,\n            \"y\": 4,\n            \"weight\": 2\n          },\n          {\n            \"x\": 29,\n            \"y\": -3,\n            \"weight\": 3\n          },\n          {\n            \"x\": 37,\n            \"y\": -7,\n            \"weight\": 1\n          },\n          {\n            \"x\": 44,\n            \"y\": -5,\n            \"weight\": 2\n          },\n          {\n            \"x\": 55,\n            \"y\": 2,\n            \"weight\": 3\n          },\n          {\n            \"x\": -1,\n            \"y\": 17,\n            \"weight\": 1\n          },\n          {\n            \"x\": 15,\n            \"y\": 15,\n            \"weight\": 2\n          },\n          {\n            \"x\": 29,\n            \"y\": 9,\n            \"weight\": 3\n          },\n          {\n            \"x\": 38,\n            \"y\": 4,\n            \"weight\": 1\n          },\n          {\n            \"x\": 45,\n            \"y\": 4,\n            \"weight\": 2\n          },\n          {\n            \"x\": 55,\n            \"y\": 10,\n            \"weight\": 3\n          },\n          {\n            \"x\": -3,\n            \"y\": 26,\n            \"weight\": 1\n          },\n          {\n            \"x\": 14,\n            \"y\": 26,\n            \"weight\": 2\n          },\n          {\n            \"x\": 29,\n            \"y\": 21,\n            \"weight\": 3\n          },\n          {\n            \"x\": 39,\n            \"y\": 15,\n            \"weight\": 1\n          },\n          {\n            \"x\": 47,\n            \"y\": 13,\n            \"weight\": 2\n          },\n          {\n            \"x\": 55,\n            \"y\": 18,\n            \"weight\": 3\n          },\n          {\n            \"x\": -4,\n            \"y\": 35,\n            \"weight\": 1\n          },\n          {\n            \"x\": 13,\n            \"y\": 37,\n            \"weight\": 2\n          },\n          {\n            \"x\": 29,\n            \"y\": 33,\n            \"weight\": 3\n          },\n          {\n            \"x\": 40,\n            \"y\": 26,\n            \"weight\": 1\n          },\n          {\n            \"x\": 48,\n            \"y\": 23,\n            \"weight\": 2\n          },\n          {\n            \"x\": 56,\n            \"y\": 26,\n            \"weight\": 3\n          },\n          {\n            \"x\": -5,\n            \"y\": 43,\n            \"weight\": 1\n          },\n          {\n            \"x\": 11,\n            \"y\": 47,\n            \"weight\": 2\n          },\n          {\n            \"x\": 28,\n            \"y\": 45,\n            \"weight\": 3\n          },\n          {\n            \"x\": 41,\n            \"y\": 38,\n            \"weight\": 1\n          },\n          {\n            \"x\": 49,\n            \"y\": 33,\n            \"weight\": 2\n          },\n          {\n            \"x\": 57,\n            \"y\": 35,\n            \"weight\": 3\n          },\n          {\n            \"x\": -5,\n            \"y\": 51,\n            \"weight\": 1\n          },\n          {\n            \"x\": 10,\n            \"y\": 56,\n            \"weight\": 2\n          },\n          {\n            \"x\": 27,\n            \"y\": 56,\n            \"weight\": 3\n          },\n          {\n            \"x\": 41,\n            \"y\": 50,\n            \"weight\": 1\n          },\n          {\n            \"x\": 51,\n            \"y\": 44,\n            \"weight\": 2\n          },\n          {\n            \"x\": 58,\n            \"y\": 44,\n            \"weight\": 3\n          }\n        ],\n        \"kernel\": \"gaussian\",\n        \"bandwidth\": 9,\n        \"columns\": 60,\n        \"rows\": 40,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'density-map example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { x, y, weight? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DensityMapInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapInput","title":"DensityMapInput","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-xMin","title":"xMin","blocks":[{"kind":"paragraph","text":"Explicit domain ends (an omitted end follows the point extent padded by `padding`; `x-axis` / `y-axis` `min` / `max` also set them)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xMin`"],["HTML attribute","`x-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xMax","title":"xMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xMax`"],["HTML attribute","`x-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMin","title":"yMin","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMin`"],["HTML attribute","`y-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMax","title":"yMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMax`"],["HTML attribute","`y-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"The fraction of the span padded on each automatic domain end."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`0.05`"]]}]},{"id":"property-cellSize","title":"cellSize","blocks":[{"kind":"paragraph","text":"CSS px per estimate cell (the grid follows the plot size); `columns` / `rows` override it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`cellSize`"],["HTML attribute","`cell-size`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-columns","title":"columns","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`columns`"],["HTML attribute","`columns`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-rows","title":"rows","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rows`"],["HTML attribute","`rows`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-bandwidth","title":"bandwidth","blocks":[{"kind":"paragraph","text":"The range over which the kernel is applied."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandwidth`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DensityMapBandwidthInput`"],["Default","`'auto'`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapBandwidthInput","title":"DensityMapBandwidthInput","description":"Type definition"}]}]},{"id":"property-bandwidthUnit","title":"bandwidthUnit","blocks":[{"kind":"paragraph","text":"`data` (default) — the bandwidth is in data units; `px` — in CSS px of the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandwidthUnit`"],["HTML attribute","`bandwidth-unit`"],["Type","`DensityMapBandwidthUnit`"],["Default","`'data'`"],["Allowed values","`data`, `px`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapBandwidthUnit","title":"DensityMapBandwidthUnit","description":"Type definition"}]}]},{"id":"property-kernel","title":"kernel","blocks":[{"kind":"paragraph","text":"The kernel used for density estimation."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`kernel`"],["HTML attribute","`kernel`"],["Type","`DensityMapKernel`"],["Default","`'gaussian'`"],["Allowed values","`gaussian`, `epanechnikov`, `quartic`, `triangular`, `uniform`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapKernel","title":"DensityMapKernel","description":"Type definition"}]}]},{"id":"property-threshold","title":"threshold","blocks":[{"kind":"paragraph","text":"Cells under this fraction of the peak density are empty (the background shows through)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`threshold`"],["HTML attribute","`threshold`"],["Type","`number`"],["Default","`0.02`"]]}]},{"id":"property-computePath","title":"computePath","blocks":[{"kind":"paragraph","text":"where the estimate runs: `auto` (the GPU compute once the renderer is up, else the CPU), `cpu`, `gpu`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`computePath`"],["HTML attribute","`compute-path`"],["Type","`DensityMapComputePathInput`"],["Default","`'auto'`"],["Allowed values","`auto`, `cpu`, `gpu`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapComputePathInput","title":"DensityMapComputePathInput","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"The colour ramp over the density domain (a scheme name, a colour list / comma list, or `[t, colour]` stops)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueMin","title":"valueMin","blocks":[{"kind":"paragraph","text":"Density domain ends; an omitted end follows 0 … the peak."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMin`"],["HTML attribute","`value-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueMax","title":"valueMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMax`"],["HTML attribute","`value-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-emptyColor","title":"emptyColor","blocks":[{"kind":"paragraph","text":"The colour of an empty (under-threshold) cell — transparent by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`emptyColor`"],["HTML attribute","`empty-color`"],["Type","`string`"],["Default","`'transparent'`"]]}]},{"id":"property-lod","title":"lod","blocks":[{"kind":"paragraph","text":"The plane's level of detail: `smooth` (bilinear between cell centres — the default here), `auto`, `point`, `area`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lod`"],["HTML attribute","`lod`"],["Type","`DensityMapLodMode`"],["Default","`'smooth'`"],["Allowed values","`auto`, `point`, `area`, `smooth`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapLodMode","title":"DensityMapLodMode","description":"Type definition"}]}]},{"id":"property-fade","title":"fade","blocks":[{"kind":"paragraph","text":"the fade band above the threshold cut, as a fraction of the peak (0 = a hard edge)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fade`"],["HTML attribute","`fade`"],["Type","`number`"],["Default","`0.06`"]]}]},{"id":"property-densityUnit","title":"densityUnit","blocks":[{"kind":"paragraph","text":"how densities read: the cell's mass (default) or mass per unit area of the data space."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`densityUnit`"],["HTML attribute","`density-unit`"],["Type","`DensityMapUnitInput`"],["Default","`'mass'`"],["Allowed values","`mass`, `per-area`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapUnitInput","title":"DensityMapUnitInput","description":"Type definition"}]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`XAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/XAxisInput","title":"XAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Grid lines default OFF (the plane tiles the plot)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the x / y domains; the estimate is not re-run per gesture — the field's visible sub-rectangle is mapped onto the plot. An object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: DensityMapPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`DensityMapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapEasing","title":"DensityMapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`DensityMapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapAnimationType","title":"DensityMapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DensityMapStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DensityMapStreamSource","title":"DensityMapStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Points the internal stream source tracks at most (the oldest drop first)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed points that feed the estimate (the whole buffer when unset)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"A visual-map binding (a `sy-visual-map` snapshot + dimension); it overrides `colors` / `value-min` / `value-max` while bound."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"`auto`, `standard` and `pro` all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`DensityMapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapEngineMode","title":"DensityMapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"`fallback` shows the on-chart notice when the renderer cannot run; `error` throws."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`DensityMapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/DensityMapUnavailableBehaviour","title":"DensityMapUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DensityMapRenderResult & { tier: DensityMapEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // DensityMapRenderResult & { tier: DensityMapEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DensityMapRenderResult","title":"DensityMapRenderResult","description":"Type definition"},{"path":"/docs/types/DensityMapEngineTier","title":"DensityMapEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DensityMapPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // DensityMapPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DensityMapPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DensityMapPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // DensityMapPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DensityMapPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<DensityMapPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<DensityMapPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<DensityMapRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DensityMapRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapRenderResult","title":"DensityMapRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<DensityMapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DensityMapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapEngineTier","title":"DensityMapEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"The reason the renderer cannot run (`undefined` while it runs)."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: DensityMapInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`DensityMapInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapInput","title":"DensityMapInput","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(point: DensityMapPoint | DensityMapTuple): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`point`","`DensityMapPoint | DensityMapTuple`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","description":"Type definition"},{"path":"/docs/types/DensityMapTuple","title":"DensityMapTuple","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(points: ReadonlyArray<DensityMapPoint | DensityMapTuple>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<DensityMapPoint | DensityMapTuple>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","description":"Type definition"},{"path":"/docs/types/DensityMapTuple","title":"DensityMapTuple","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"(carry-over C9) — `shift(n)` drops the n oldest points of the cloud: the `data` prop's leading entries first (a plain cloud shifts too — before a shift without a stream was a no-op), then the streamed points through the stream source. Each part fires `windowSlid` with its own count."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(points: ReadonlyArray<DensityMapPoint | DensityMapTuple>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<DensityMapPoint | DensityMapTuple>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","description":"Type definition"},{"path":"/docs/types/DensityMapTuple","title":"DensityMapTuple","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<DensityMapStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DensityMapStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapStreamSource","title":"DensityMapStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: DensityMapEasing; enabled?: boolean; type?: DensityMapAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: DensityMapEasing; enabled?: boolean; type?: DensityMapAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapEasing","title":"DensityMapEasing","description":"Type definition"},{"path":"/docs/types/DensityMapAnimationType","title":"DensityMapAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The estimate cell under host-relative CSS coordinates, or null (the density waits for a pending readback)."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<DensityMapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DensityMapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":"Type definition"}]}]},{"id":"method-getCellValue","title":"getCellValue","blocks":[{"kind":"paragraph","text":"The density of a cell in the public unit (`null` under the threshold or outside the grid)."},{"kind":"code","source":"getCellValue(col: number, row: number): Promise<number | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDensityAt","title":"getDensityAt","blocks":[{"kind":"paragraph","text":"The density at a data-space point in the public unit (`null` outside the domain or under the threshold)."},{"kind":"code","source":"getDensityAt(x: number, y: number): Promise<number | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getValueExtent","title":"getValueExtent","blocks":[{"kind":"paragraph","text":"The density extent of the estimate in the public unit (min 0, max = the peak, finite = cells over the threshold)."},{"kind":"code","source":"getValueExtent(): Promise<DensityMapValueExtent | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DensityMapValueExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapValueExtent","title":"DensityMapValueExtent","description":"Type definition"}]}]},{"id":"method-showTooltipAtCell","title":"showTooltipAtCell","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell (col / row), honouring the tooltip input; null when off or outside."},{"kind":"code","source":"showTooltipAtCell(col: number, row: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell by its index (`row * columns + col`; the facade's showTooltipAtPoint)."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusCellAt","title":"focusCellAt","blocks":[{"kind":"paragraph","text":"move the keyboard focus to a cell (the arrow-key state); null clears it."},{"kind":"code","source":"focusCellAt(col: number, row: number): Promise<DensityMapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DensityMapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":"Type definition"}]}]},{"id":"method-getGridSize","title":"getGridSize","blocks":[{"kind":"paragraph","text":"Columns × rows of the current grid."},{"kind":"code","source":"getGridSize(): Promise<{ columns: number; rows: number; cells: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ columns: number; rows: number; cells: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDomain","title":"getDomain","blocks":[{"kind":"paragraph","text":"The data domain the grid spans."},{"kind":"code","source":"getDomain(): Promise<DensityMapDomain>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DensityMapDomain>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapDomain","title":"DensityMapDomain","description":"Type definition"}]}]},{"id":"method-getBandwidth","title":"getBandwidth","blocks":[{"kind":"paragraph","text":"The resolved bandwidth (data units, CSS px, cells; `auto` when Silverman chose it)."},{"kind":"code","source":"getBandwidth(): Promise<DensityMapBandwidth>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DensityMapBandwidth>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapBandwidth","title":"DensityMapBandwidth","description":"Type definition"}]}]},{"id":"method-getKernelTaps","title":"getKernelTaps","blocks":[{"kind":"paragraph","text":"the normalised kernel taps of the current estimate per axis (length 2 × radius + 1; they sum to 1)."},{"kind":"code","source":"getKernelTaps(): Promise<{ kernel: DensityMapKernel; x: number[]; y: number[]; radius: { x: number; y: number } }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ kernel: DensityMapKernel; x: number[]; y: number[]; radius: { x: number; y: number } }>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapKernel","title":"DensityMapKernel","description":"Type definition"}]}]},{"id":"method-getComputeStats","title":"getComputeStats","blocks":[{"kind":"paragraph","text":"The statistics of the last estimate (points, grid, kernel, bandwidth, radius, compute time, peak, mass)."},{"kind":"code","source":"getComputeStats(): Promise<DensityMapComputeStats>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DensityMapComputeStats>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DensityMapComputeStats","title":"DensityMapComputeStats","description":"Type definition"}]}]},{"id":"method-getPlaneValues","title":"getPlaneValues","blocks":[{"kind":"paragraph","text":"a copy of the current plane (NaN = empty; cell mass), whichever path computed it (waits for a pending readback)."},{"kind":"code","source":"getPlaneValues(): Promise<Float32Array>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Float32Array>`. Call the method after element registration and await its Promise result."}]},{"id":"method-computeReference","title":"computeReference","blocks":[{"kind":"paragraph","text":"the CPU reference estimate for the current inputs (the parity oracle of the GPU path; never cached)."},{"kind":"code","source":"computeReference(): Promise<{ values: Float32Array; densityMax: number; mass: number; binned: number; finite: number; computeMs: number; radius: { x: number; y: number } }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ values: Float32Array; densityMax: number; mass: number; binned: number; finite: number; computeMs: number; radius: { x: number; y: number } }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear with null) a visual-map snapshot; it wins over the `visualMap` prop until the prop changes again."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension: `value` = the density (0 … peak), `x` / `y` = the domain, `index` = the cell indexes."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows in data units: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — master axes (the field's x / y domain)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/spectrogram","title":"Spectrogram","summary":"Show frequency intensity over time using color.","kind":"component","tag":"sy-spectrogram","componentId":"spectrogram","api":{"props":[{"name":"data","attribute":"data","type":"SpectrogramInput","kind":"property","values":[],"default":"undefined","description":"The outer array contains time frames; each inner array contains frequency-bin intensities."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"sampleRate","attribute":"sample-rate","type":"number","kind":"number","values":[],"default":"undefined","description":"The sampling rate in Hz: the frequency axis then spans 0 … sampleRate / 2 (unless `freq-min` / `freq-max` say otherwise)."},{"name":"freqMin","attribute":"freq-min","type":"number","kind":"number","values":[],"default":"undefined","description":"The frequency axis ends in Hz (default 0 … sampleRate / 2, else 0 … bins as bin indexes)."},{"name":"freqMax","attribute":"freq-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"hopSeconds","attribute":"hop-seconds","type":"number","kind":"number","values":[],"default":"1","description":"Seconds per frame (the hop)."},{"name":"timeOrigin","attribute":"time-origin","type":"number","kind":"number","values":[],"default":"0","description":"Seconds at the first frame of the data (the window's drops advance it)."},{"name":"valueScale","attribute":"value-scale","type":"SpectrogramValueScale","kind":"string","values":["linear","db"],"default":"'db'","description":"linear or db."},{"name":"dbFloor","attribute":"db-floor","type":"number","kind":"number","values":[],"default":"SPECTROGRAM_DEFAULT_DB_FLOOR","description":"The dB a zero magnitude reads (the linear scale)."},{"name":"samples","attribute":"samples","type":"ArrayLike<number>","kind":"property","values":[],"default":"undefined","description":"Raw samples (a property; ignored while `data` is set): the FFT pipeline frames them into dB."},{"name":"fftSize","attribute":"fft-size","type":"number","kind":"number","values":[],"default":"1024","description":"The FFT size, a power of two (default 1,024): bins = fft-size / 2 and each bin is sample-rate / fft-size wide."},{"name":"fftHop","attribute":"fft-hop","type":"number","kind":"number","values":[],"default":"undefined","description":"Samples between frame starts (default fft-size / 2)."},{"name":"fftWindow","attribute":"fft-window","type":"SpectrogramWindowKind","kind":"string","values":["rect","hann","hamming","blackman"],"default":"'hann'","description":"The analysis window: `hann` (default), `hamming`, `blackman`, `rect`."},{"name":"colors","attribute":"colors","type":"string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]>","kind":"property","values":[],"default":"undefined","description":"The colour ramp over the dB domain (a scheme name, a colour list / comma list, or `[t, colour]` stops)."},{"name":"valueMin","attribute":"value-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Domain ends in dB; an omitted end follows the data (the min never more than 80 dB under the max)."},{"name":"valueMax","attribute":"value-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"emptyColor","attribute":"empty-color","type":"string","kind":"string","values":[],"default":"'transparent'","description":"The colour of an empty cell — transparent by default."},{"name":"lod","attribute":"lod","type":"SpectrogramLodMode","kind":"string","values":["auto","point","area","smooth"],"default":"'auto'","description":"The plane's level of detail: `auto` (area-folded once a frame or bin is under a device px — the usual case), `point`, `area`, `smooth`."},{"name":"areaReduce","attribute":"area-reduce","type":"'mean' | 'max'","kind":"string","values":["max","mean"],"default":"'max'","description":"how the area LOD folds sub-pixel bins / frames: `max` (default, peak-hold — a narrow line survives) or `mean`."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Grid lines default OFF (the plane tiles the plot)."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (2026-09-10) — the shared cartesian zoom on the time (s) / frequency (Hz) axes: a mode (`'x'` | `'y'` | `'xy'`), `true`, `'inside'` or the object (drag rectangle, pan, wheel, pinch, keyboard, reset button). Off by default."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: SpectrogramPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"SpectrogramEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"SpectrogramAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"SpectrogramStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The scrolling window: frames kept at most (default 4,096) — the oldest scroll out first and the time origin advances."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed frames the chart renders (the whole buffer when unset); the frames before the window stay buffered, the time axis starts at the window."},{"name":"visualMap","attribute":"visual-map","type":"VisualMapBinding | null","kind":"property","values":[],"default":"undefined","description":"A visual-map binding (a `sy-visual-map` snapshot + dimension); it overrides `colors` / `value-min` / `value-max` while bound."},{"name":"engine","attribute":"engine","type":"SpectrogramEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"`auto`, `standard` and `pro` all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down."},{"name":"unavailable","attribute":"unavailable","type":"SpectrogramUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"`fallback` shows the on-chart notice when the renderer cannot run; `error` throws."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<SpectrogramRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<SpectrogramEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"The reason the renderer cannot run (`undefined` while it runs)."},{"name":"setData","parameters":[{"name":"data","type":"SpectrogramInput","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendFrame","parameters":[{"name":"frame","type":"SpectrogramFrame","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendBatch","parameters":[{"name":"frames","type":"ReadonlyArray<SpectrogramFrame>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the `count` oldest frames — the data frames too (they fold into the internal source on the first shift as on the first append). (carry-over C8) — `shift(n)` drops the n oldest frames on screen. With an internal source the recording is folded into it (it shifts them itself); under an EXTERNAL source the recording's leading frames go first (before the source lost its frames while the recording's old frames came back into the window), then the source."},{"name":"replace","parameters":[{"name":"frames","type":"ReadonlyArray<SpectrogramFrame>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<SpectrogramStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: SpectrogramEasing; enabled?: boolean; type?: SpectrogramAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<SpectrogramPointEventDetail | null>","description":"The cell under host-relative CSS coordinates, or null."},{"name":"showTooltipAtCell","parameters":[{"name":"frame","type":"number","optional":false},{"name":"bin","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell (frame / bin), honouring the tooltip input; null when the tooltip is off or the cell is outside."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a cell by its index (`frame * bins + bin`; the facade's showTooltipAtPoint)."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusCellAt","parameters":[{"name":"frame","type":"number","optional":false},{"name":"bin","type":"number","optional":false}],"returns":"Promise<SpectrogramPointEventDetail | null>","description":"move the keyboard focus ring to a cell and announce it (null outside the grid)."},{"name":"getValue","parameters":[{"name":"frame","type":"number","optional":false},{"name":"bin","type":"number","optional":false}],"returns":"Promise<number | null>","description":"The dB value of a cell (`null` when empty or outside the grid)."},{"name":"getValueExtent","parameters":[],"returns":"Promise<SpectrogramValueExtent | null>","description":"The dB extent of the plane (min / max over the finite cells)."},{"name":"getGridSize","parameters":[],"returns":"Promise<{ frames: number; bins: number; cells: number; dropped: number }>","description":"Columns × rows of the current grid."},{"name":"getRanges","parameters":[],"returns":"Promise<SpectrogramRanges>","description":"The time and frequency ranges the plane spans."},{"name":"appendSamples","parameters":[{"name":"samples","type":"ArrayLike<number>","optional":false}],"returns":"Promise<SpectrogramAppendSamplesResult>","description":"feed raw samples: every completed window becomes a frame (appended through the stream); the rest waits."},{"name":"getFftInfo","parameters":[],"returns":"Promise<SpectrogramFftInfo>","description":"the FFT pipeline's resolved parameters (bins, bin width, frame seconds, the window's coherent gain)."},{"name":"setVisualMap","parameters":[{"name":"binding","type":"VisualMapBinding | null","optional":false}],"returns":"Promise<VisualMapBinding | null>","description":"Bind (or clear with null) a visual-map snapshot; it wins over the `visualMap` prop until the prop changes again."},{"name":"getVisualMap","parameters":[],"returns":"Promise<VisualMapBinding | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getVisualExtent","parameters":[{"name":"request","type":"VisualMapExtentRequest","optional":true}],"returns":"Promise<VisualMapExtent | null>","description":"The extent of a dimension: `value` = dB, `x` = time (s), `y` = frequency (Hz), `index` = the cell indexes."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows in axis units: `x` (seconds) / `y` (Hz) as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by axis units (`{ x?: seconds, y?: Hz }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — axes: the time span in seconds, the frequency span in Hz."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"SpectrogramRenderResult & { tier: SpectrogramEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"SpectrogramPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"SpectrogramPointEventDetail | null","description":"CustomEvent.detail type: SpectrogramPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<SpectrogramPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<SpectrogramPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Zoom — every zoom / pan change (drag, keyboard, wheel, pinch, API, reset); `null` zoom = the full extent."}]},"sections":[{"id":"overview","title":"sy-spectrogram","blocks":[{"kind":"paragraph","text":"Inspect frequency patterns in audio, vibration, and signals."},{"kind":"paragraph","text":"State the time interval, frequency spacing, and linear or dB scale. The example uses frequency frames that have already been calculated."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","The outer array contains time frames; each inner array contains frequency-bin intensities."],["`valueScale`","linear or db."]]},{"kind":"links","items":[{"path":"/charts/spectrogram","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-spectrogram.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-spectrogram\",\n      \"props\": {\n        \"data\": [\n          [0, 0, 0.19999999999999996, 0.4, 0.6, 0.8, 1, 0.8, 0.6, 0.4, 0.19999999999999996, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0.04106453536395094, 0.2410645353639509, 0.44106453536395096, 0.6410645353639509, 0.841064535363951, 0.9589354646360491, 0.7589354646360491, 0.558935464636049, 0.3589354646360491, 0.15893546463604902, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0.08846532615307956, 0.2884653261530795, 0.4884653261530796, 0.6884653261530795, 0.8884653261530795, 0.9115346738469204, 0.7115346738469205, 0.5115346738469204, 0.31153467384692046, 0.1115346738469205, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0.14828602128397184, 0.3482860212839718, 0.5482860212839717, 0.7482860212839718, 0.9482860212839718, 0.8517139787160282, 0.6517139787160282, 0.45171397871602825, 0.2517139787160282, 0.05171397871602823, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0.0261151272803819, 0.22611512728038186, 0.4261151272803818, 0.6261151272803819, 0.8261151272803818, 0.9738848727196181, 0.7738848727196181, 0.5738848727196182, 0.3738848727196181, 0.17388487271961817, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0, 0.12682321215368264, 0.3268232121536826, 0.5268232121536827, 0.7268232121536826, 0.9268232121536826, 0.8731767878463174, 0.6731767878463174, 0.47317678784631734, 0.2731767878463174, 0.07317678784631743, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0, 0.05436873122621899, 0.25436873122621895, 0.454368731226219, 0.654368731226219, 0.8543687312262189, 0.945631268773781, 0.745631268773781, 0.545631268773781, 0.34563126877378103, 0.14563126877378108, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0, 0.011640216009231708, 0.21164021600923166, 0.41164021600923173, 0.6116402160092317, 0.8116402160092318, 0.9883597839907683, 0.7883597839907683, 0.5883597839907683, 0.3883597839907683, 0.18835978399076825, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0, 0.0003411175667960009, 0.20034111756679596, 0.400341117566796, 0.600341117566796, 0.800341117566796, 0.999658882433204, 0.799658882433204, 0.599658882433204, 0.399658882433204, 0.19965888243320395, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0, 0.020921895297443927, 0.22092189529744388, 0.42092189529744384, 0.6209218952974439, 0.8209218952974439, 0.9790781047025561, 0.7790781047025561, 0.5790781047025562, 0.3790781047025561, 0.17907810470255614, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0, 0.07256205853945441, 0.2725620585394545, 0.47256205853945443, 0.6725620585394545, 0.8725620585394545, 0.9274379414605456, 0.7274379414605455, 0.5274379414605456, 0.3274379414605455, 0.12743794146054555, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0, 0.15320287694432788, 0.35320287694432795, 0.5532028769443279, 0.753202876944328, 0.9532028769443279, 0.8467971230556721, 0.646797123055672, 0.4467971230556721, 0.24679712305567203, 0.046797123055672074, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0.0596294555590795, 0.25962945555907946, 0.4596294555590795, 0.6596294555590795, 0.8596294555590795, 0.9403705444409205, 0.7403705444409205, 0.5403705444409205, 0.3403705444409205, 0.14037054444092045, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0, 0.18759890254282863, 0.3875989025428286, 0.5875989025428285, 0.7875989025428286, 0.9875989025428286, 0.8124010974571714, 0.6124010974571714, 0.41240109745717146, 0.2124010974571714, 0.01240109745717144, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0, 0.13200947987527623, 0.3320094798752763, 0.5320094798752762, 0.7320094798752763, 0.9320094798752763, 0.8679905201247238, 0.6679905201247237, 0.46799052012472375, 0.2679905201247237, 0.06799052012472373, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0, 0.0871039935521063, 0.28710399355210625, 0.4871039935521063, 0.6871039935521063, 0.8871039935521063, 0.9128960064478937, 0.7128960064478937, 0.5128960064478937, 0.3128960064478937, 0.11289600644789366, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0.046699314742064124, 0.2466993147420642, 0.44669931474206415, 0.6466993147420641, 0.8466993147420642, 0.9533006852579359, 0.7533006852579358, 0.5533006852579359, 0.3533006852579359, 0.15330068525793583, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.004432881621465379, 0.20443288162146533, 0.4044328816214653, 0.6044328816214654, 0.8044328816214653, 0.9955671183785346, 0.7955671183785347, 0.5955671183785347, 0.39556711837853464, 0.1955671183785347, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.15401635463588192, 0.3540163546358819, 0.554016354635882, 0.7540163546358819, 0.954016354635882, 0.8459836453641181, 0.6459836453641181, 0.44598364536411805, 0.2459836453641181, 0.04598364536411803, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.28948631275417536, 0.4894863127541754, 0.6894863127541754, 0.8894863127541754, 0.9105136872458246, 0.7105136872458246, 0.5105136872458246, 0.3105136872458246, 0.11051368724582455, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.4054419962463426, 0.6054419962463425, 0.8054419962463426, 0.9945580037536574, 0.7945580037536575, 0.5945580037536574, 0.39455800375365746, 0.1945580037536574, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.4972606179308705, 0.6972606179308706, 0.8972606179308705, 0.9027393820691294, 0.7027393820691294, 0.5027393820691295, 0.3027393820691294, 0.10273938206912947, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.5612816591116129, 0.7612816591116129, 0.9612816591116129, 0.8387183408883871, 0.6387183408883871, 0.4387183408883871, 0.23871834088838706, 0.038718340888387104, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.5949528029067717, 0.7949528029067716, 0.9949528029067716, 0.8050471970932284, 0.6050471970932284, 0.40504719709322834, 0.20504719709322838, 0.005047197093228428, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.5969316870686725, 0.7969316870686725, 0.9969316870686724, 0.8030683129313275, 0.6030683129313276, 0.4030683129313275, 0.20306831293132754, 0.003068312931327477, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.5671394197305107, 0.7671394197305108, 0.9671394197305108, 0.8328605802694893, 0.6328605802694892, 0.43286058026948926, 0.2328605802694892, 0.032860580269489126, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.5067637245761225, 0.7067637245761225, 0.9067637245761225, 0.8932362754238775, 0.6932362754238774, 0.4932362754238775, 0.29323627542387753, 0.09323627542387736, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.4182115900447897, 0.6182115900447898, 0.8182115900447897, 0.9817884099552103, 0.7817884099552103, 0.5817884099552103, 0.38178840995521024, 0.18178840995521028, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.3050133102978567, 0.5050133102978567, 0.7050133102978566, 0.9050133102978567, 0.8949866897021433, 0.6949866897021433, 0.4949866897021433, 0.29498668970214337, 0.0949866897021433, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.17168174353100518, 0.37168174353100514, 0.5716817435310052, 0.7716817435310052, 0.9716817435310052, 0.8283182564689948, 0.6283182564689949, 0.4283182564689948, 0.22831825646899484, 0.028318256468994774, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0.023532398559140688, 0.22353239855914064, 0.4235323985591407, 0.6235323985591407, 0.8235323985591407, 0.9764676014408593, 0.7764676014408594, 0.5764676014408593, 0.37646760144085933, 0.17646760144085927, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],\n          [0, 0.0664715222539971, 0.2664715222539972, 0.46647152225399713, 0.6664715222539972, 0.8664715222539972, 0.9335284777460029, 0.7335284777460028, 0.5335284777460029, 0.3335284777460028, 0.13352847774600285, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]\n        ],\n        \"valueScale\": \"linear\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'spectrogram example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"The outer array contains time frames; each inner array contains frequency-bin intensities."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`SpectrogramInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramInput","title":"SpectrogramInput","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-sampleRate","title":"sampleRate","blocks":[{"kind":"paragraph","text":"The sampling rate in Hz: the frequency axis then spans 0 … sampleRate / 2 (unless `freq-min` / `freq-max` say otherwise)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sampleRate`"],["HTML attribute","`sample-rate`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-freqMin","title":"freqMin","blocks":[{"kind":"paragraph","text":"The frequency axis ends in Hz (default 0 … sampleRate / 2, else 0 … bins as bin indexes)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`freqMin`"],["HTML attribute","`freq-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-freqMax","title":"freqMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`freqMax`"],["HTML attribute","`freq-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-hopSeconds","title":"hopSeconds","blocks":[{"kind":"paragraph","text":"Seconds per frame (the hop)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`hopSeconds`"],["HTML attribute","`hop-seconds`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-timeOrigin","title":"timeOrigin","blocks":[{"kind":"paragraph","text":"Seconds at the first frame of the data (the window's drops advance it)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`timeOrigin`"],["HTML attribute","`time-origin`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-valueScale","title":"valueScale","blocks":[{"kind":"paragraph","text":"linear or db."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueScale`"],["HTML attribute","`value-scale`"],["Type","`SpectrogramValueScale`"],["Default","`'db'`"],["Allowed values","`linear`, `db`"]]},{"kind":"links","items":[{"path":"/docs/types/SpectrogramValueScale","title":"SpectrogramValueScale","description":"Type definition"}]}]},{"id":"property-dbFloor","title":"dbFloor","blocks":[{"kind":"paragraph","text":"The dB a zero magnitude reads (the linear scale)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dbFloor`"],["HTML attribute","`db-floor`"],["Type","`number`"],["Default","`SPECTROGRAM_DEFAULT_DB_FLOOR`"]]}]},{"id":"property-samples","title":"samples","blocks":[{"kind":"paragraph","text":"Raw samples (a property; ignored while `data` is set): the FFT pipeline frames them into dB."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`samples`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ArrayLike<number>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-fftSize","title":"fftSize","blocks":[{"kind":"paragraph","text":"The FFT size, a power of two (default 1,024): bins = fft-size / 2 and each bin is sample-rate / fft-size wide."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fftSize`"],["HTML attribute","`fft-size`"],["Type","`number`"],["Default","`1024`"]]}]},{"id":"property-fftHop","title":"fftHop","blocks":[{"kind":"paragraph","text":"Samples between frame starts (default fft-size / 2)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fftHop`"],["HTML attribute","`fft-hop`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-fftWindow","title":"fftWindow","blocks":[{"kind":"paragraph","text":"The analysis window: `hann` (default), `hamming`, `blackman`, `rect`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fftWindow`"],["HTML attribute","`fft-window`"],["Type","`SpectrogramWindowKind`"],["Default","`'hann'`"],["Allowed values","`rect`, `hann`, `hamming`, `blackman`"]]},{"kind":"links","items":[{"path":"/docs/types/SpectrogramWindowKind","title":"SpectrogramWindowKind","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"The colour ramp over the dB domain (a scheme name, a colour list / comma list, or `[t, colour]` stops)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueMin","title":"valueMin","blocks":[{"kind":"paragraph","text":"Domain ends in dB; an omitted end follows the data (the min never more than 80 dB under the max)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMin`"],["HTML attribute","`value-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueMax","title":"valueMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueMax`"],["HTML attribute","`value-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-emptyColor","title":"emptyColor","blocks":[{"kind":"paragraph","text":"The colour of an empty cell — transparent by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`emptyColor`"],["HTML attribute","`empty-color`"],["Type","`string`"],["Default","`'transparent'`"]]}]},{"id":"property-lod","title":"lod","blocks":[{"kind":"paragraph","text":"The plane's level of detail: `auto` (area-folded once a frame or bin is under a device px — the usual case), `point`, `area`, `smooth`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lod`"],["HTML attribute","`lod`"],["Type","`SpectrogramLodMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `point`, `area`, `smooth`"]]},{"kind":"links","items":[{"path":"/docs/types/SpectrogramLodMode","title":"SpectrogramLodMode","description":"Type definition"}]}]},{"id":"property-areaReduce","title":"areaReduce","blocks":[{"kind":"paragraph","text":"how the area LOD folds sub-pixel bins / frames: `max` (default, peak-hold — a narrow line survives) or `mean`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`areaReduce`"],["HTML attribute","`area-reduce`"],["Type","`'mean' | 'max'`"],["Default","`'max'`"],["Allowed values","`max`, `mean`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Grid lines default OFF (the plane tiles the plot)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (2026-09-10) — the shared cartesian zoom on the time (s) / frequency (Hz) axes: a mode (`'x'` | `'y'` | `'xy'`), `true`, `'inside'` or the object (drag rectangle, pan, wheel, pinch, keyboard, reset button). Off by default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"the cell tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: SpectrogramPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`SpectrogramEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/SpectrogramEasing","title":"SpectrogramEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`SpectrogramAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramAnimationType","title":"SpectrogramAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`SpectrogramStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramStreamSource","title":"SpectrogramStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The scrolling window: frames kept at most (default 4,096) — the oldest scroll out first and the time origin advances."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed frames the chart renders (the whole buffer when unset); the frames before the window stay buffered, the time axis starts at the window."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-visualMap","title":"visualMap","blocks":[{"kind":"paragraph","text":"A visual-map binding (a `sy-visual-map` snapshot + dimension); it overrides `colors` / `value-min` / `value-max` while bound."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visualMap`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapBinding | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"`auto`, `standard` and `pro` all run the one WebGPU renderer (a Pro-only type has no other); switching never tears it down."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`SpectrogramEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/SpectrogramEngineMode","title":"SpectrogramEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"`fallback` shows the on-chart notice when the renderer cannot run; `error` throws."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`SpectrogramUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/SpectrogramUnavailableBehaviour","title":"SpectrogramUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SpectrogramRenderResult & { tier: SpectrogramEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // SpectrogramRenderResult & { tier: SpectrogramEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SpectrogramRenderResult","title":"SpectrogramRenderResult","description":"Type definition"},{"path":"/docs/types/SpectrogramEngineTier","title":"SpectrogramEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SpectrogramPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // SpectrogramPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SpectrogramPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SpectrogramPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // SpectrogramPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<SpectrogramPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<SpectrogramPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<SpectrogramPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Zoom — every zoom / pan change (drag, keyboard, wheel, pinch, API, reset); `null` zoom = the full extent."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<SpectrogramRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramRenderResult","title":"SpectrogramRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<SpectrogramEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramEngineTier","title":"SpectrogramEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"The reason the renderer cannot run (`undefined` while it runs)."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: SpectrogramInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`SpectrogramInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramInput","title":"SpectrogramInput","description":"Type definition"}]}]},{"id":"method-appendFrame","title":"appendFrame","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"appendFrame(frame: SpectrogramFrame): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frame`","`SpectrogramFrame`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(frames: ReadonlyArray<SpectrogramFrame>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frames`","`ReadonlyArray<SpectrogramFrame>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the `count` oldest frames — the data frames too (they fold into the internal source on the first shift as on the first append). (carry-over C8) — `shift(n)` drops the n oldest frames on screen. With an internal source the recording is folded into it (it shifts them itself); under an EXTERNAL source the recording's leading frames go first (before the source lost its frames while the recording's old frames came back into the window), then the source."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(frames: ReadonlyArray<SpectrogramFrame>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frames`","`ReadonlyArray<SpectrogramFrame>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<SpectrogramStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramStreamSource","title":"SpectrogramStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: SpectrogramEasing; enabled?: boolean; type?: SpectrogramAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: SpectrogramEasing; enabled?: boolean; type?: SpectrogramAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramEasing","title":"SpectrogramEasing","description":"Type definition"},{"path":"/docs/types/SpectrogramAnimationType","title":"SpectrogramAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The cell under host-relative CSS coordinates, or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<SpectrogramPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtCell","title":"showTooltipAtCell","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell (frame / bin), honouring the tooltip input; null when the tooltip is off or the cell is outside."},{"kind":"code","source":"showTooltipAtCell(frame: number, bin: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frame`","`number`","Required"],["`bin`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a cell by its index (`frame * bins + bin`; the facade's showTooltipAtPoint)."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusCellAt","title":"focusCellAt","blocks":[{"kind":"paragraph","text":"move the keyboard focus ring to a cell and announce it (null outside the grid)."},{"kind":"code","source":"focusCellAt(frame: number, bin: number): Promise<SpectrogramPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frame`","`number`","Required"],["`bin`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":"Type definition"}]}]},{"id":"method-getValue","title":"getValue","blocks":[{"kind":"paragraph","text":"The dB value of a cell (`null` when empty or outside the grid)."},{"kind":"code","source":"getValue(frame: number, bin: number): Promise<number | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`frame`","`number`","Required"],["`bin`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getValueExtent","title":"getValueExtent","blocks":[{"kind":"paragraph","text":"The dB extent of the plane (min / max over the finite cells)."},{"kind":"code","source":"getValueExtent(): Promise<SpectrogramValueExtent | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramValueExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramValueExtent","title":"SpectrogramValueExtent","description":"Type definition"}]}]},{"id":"method-getGridSize","title":"getGridSize","blocks":[{"kind":"paragraph","text":"Columns × rows of the current grid."},{"kind":"code","source":"getGridSize(): Promise<{ frames: number; bins: number; cells: number; dropped: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ frames: number; bins: number; cells: number; dropped: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getRanges","title":"getRanges","blocks":[{"kind":"paragraph","text":"The time and frequency ranges the plane spans."},{"kind":"code","source":"getRanges(): Promise<SpectrogramRanges>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramRanges>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramRanges","title":"SpectrogramRanges","description":"Type definition"}]}]},{"id":"method-appendSamples","title":"appendSamples","blocks":[{"kind":"paragraph","text":"feed raw samples: every completed window becomes a frame (appended through the stream); the rest waits."},{"kind":"code","source":"appendSamples(samples: ArrayLike<number>): Promise<SpectrogramAppendSamplesResult>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`samples`","`ArrayLike<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramAppendSamplesResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramAppendSamplesResult","title":"SpectrogramAppendSamplesResult","description":"Type definition"}]}]},{"id":"method-getFftInfo","title":"getFftInfo","blocks":[{"kind":"paragraph","text":"the FFT pipeline's resolved parameters (bins, bin width, frame seconds, the window's coherent gain)."},{"kind":"code","source":"getFftInfo(): Promise<SpectrogramFftInfo>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SpectrogramFftInfo>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SpectrogramFftInfo","title":"SpectrogramFftInfo","description":"Type definition"}]}]},{"id":"method-setVisualMap","title":"setVisualMap","blocks":[{"kind":"paragraph","text":"Bind (or clear with null) a visual-map snapshot; it wins over the `visualMap` prop until the prop changes again."},{"kind":"code","source":"setVisualMap(binding: VisualMapBinding | null): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`binding`","`VisualMapBinding | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualMap","title":"getVisualMap","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getVisualMap(): Promise<VisualMapBinding | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapBinding | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":"Type definition"}]}]},{"id":"method-getVisualExtent","title":"getVisualExtent","blocks":[{"kind":"paragraph","text":"The extent of a dimension: `value` = dB, `x` = time (s), `y` = frequency (Hz), `index` = the cell indexes."},{"kind":"code","source":"getVisualExtent(request?: VisualMapExtentRequest): Promise<VisualMapExtent | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`VisualMapExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":"Type definition"},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows in axis units: `x` (seconds) / `y` (Hz) as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by axis units (`{ x?: seconds, y?: Hz }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — axes: the time span in seconds, the frequency span in Hz."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/gauge","title":"Gauge","summary":"Read a metric's current state within a defined range.","kind":"component","tag":"sy-gauge-chart","componentId":"gauge","api":{"props":[{"name":"value","attribute":"value","type":"number","kind":"number","values":[],"default":"0","description":"The current measurement."},{"name":"min","attribute":"min","type":"number","kind":"number","values":[],"default":"0","description":"The start of the measurement range."},{"name":"max","attribute":"max","type":"number","kind":"number","values":[],"default":"100","description":"The end of the measurement range."},{"name":"needles","attribute":"needles","type":"GaugeNeedleSpec[]","kind":"property","values":[],"default":"undefined","description":"Multi-needle override (dial variant). When set + non-empty, drives the dial instead of `value`."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"320","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"280","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"variant","attribute":"variant","type":"GaugeChartVariant","kind":"string","values":["solid","dial","activity","vuMeter","speedometer","clock"],"default":"'dial'","description":"The gauge style, such as solid or dial."},{"name":"startAngle","attribute":"start-angle","type":"number","kind":"number","values":[],"default":"-150","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"endAngle","attribute":"end-angle","type":"number","kind":"number","values":[],"default":"150","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"size","attribute":"size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerX","attribute":"center-x","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerY","attribute":"center-y","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"innerRadius","attribute":"inner-radius","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Solid-variant inner radius. Number = px; `'%'` = fraction of outerRadius."},{"name":"thickness","attribute":"thickness","type":"number","kind":"number","values":[],"default":"undefined","description":"Band / solid-ring thickness in px. Wins over innerRadius for the solid variant."},{"name":"rings","attribute":"rings","type":"GaugeActivityRingSpec[]","kind":"property","values":[],"default":"undefined","description":"Activity-variant rings (property-only). Each ring has its OWN `value`/`max` (Move 500 kcal, Exercise 30 min…). Absent → the variant falls back to `needles` (shared chart max) or the scalar `value` (one ring)."},{"name":"time","attribute":"time","type":"string","kind":"string","values":[],"default":"undefined","description":"Clock-variant time. `'now'`/unset keeps the face ticking live (1 s interval, cleaned up on disconnect); `'HH:MM'`/`'HH:MM:SS'` freezes it."},{"name":"showSeconds","attribute":"show-seconds","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Clock-variant second hand (thin, red)."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Needle palette (multi-needle). Per-needle `color` always wins."},{"name":"stops","attribute":"stops","type":"GaugeColorStop[]","kind":"property","values":[],"default":"undefined","description":"Solid-variant colour stops (0..1 along min..max). Progress colour interpolates between them."},{"name":"needleShape","attribute":"needle-shape","type":"GaugeNeedleShape","kind":"string","values":["needle","arrow","line","wedge"],"default":"'needle'","description":"Allowed values: needle, arrow, line, wedge. Default: 'needle'."},{"name":"needleLength","attribute":"needle-length","type":"number | string","kind":"property","values":[],"default":"'88%'","description":"Pass as a JavaScript property. type: number | string."},{"name":"needleRearLength","attribute":"needle-rear-length","type":"number | string","kind":"property","values":[],"default":"'14%'","description":"Pass as a JavaScript property. type: number | string."},{"name":"needleWidth","attribute":"needle-width","type":"number","kind":"number","values":[],"default":"8","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"pivotRadius","attribute":"pivot-radius","type":"number","kind":"number","values":[],"default":"7","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"pivotColor","attribute":"pivot-color","type":"string","kind":"string","values":[],"default":"'#1f2937'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"plotBands","attribute":"plot-bands","type":"GaugePlotBand[] | 'auto'","kind":"property","values":["auto"],"default":"undefined","description":"Coloured zones — an array, or `'auto'` to split the axis by % of max."},{"name":"bandThickness","attribute":"band-thickness","type":"number","kind":"number","values":[],"default":"14","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"bandTrackColor","attribute":"band-track-color","type":"string","kind":"string","values":[],"default":"'#eef2f7'","description":"The 'empty' track behind plot bands — the un-zoned part of the axis."},{"name":"rounded","attribute":"rounded","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"trackColor","attribute":"track-color","type":"string","kind":"string","values":[],"default":"'#e5e7eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"showTicks","attribute":"show-ticks","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tickInterval","attribute":"tick-interval","type":"number | 'auto'","kind":"property","values":["auto"],"default":"'auto'","description":"Allowed values: auto. Default: 'auto'."},{"name":"minorTicks","attribute":"minor-ticks","type":"number","kind":"number","values":[],"default":"4","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"tickLength","attribute":"tick-length","type":"number","kind":"number","values":[],"default":"9","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"minorTickLength","attribute":"minor-tick-length","type":"number","kind":"number","values":[],"default":"6","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"tickWidth","attribute":"tick-width","type":"number","kind":"number","values":[],"default":"2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"minorTickWidth","attribute":"minor-tick-width","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"tickColor","attribute":"tick-color","type":"string","kind":"string","values":[],"default":"'#94a3b8'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"showTickLabels","attribute":"show-tick-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tickLabelDistance","attribute":"tick-label-distance","type":"number","kind":"number","values":[],"default":"7","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"tickLabelColor","attribute":"tick-label-color","type":"string","kind":"string","values":[],"default":"'#64748b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"tickLabelFontSize","attribute":"tick-label-font-size","type":"number","kind":"number","values":[],"default":"11","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"tickLabelFormat","attribute":"tick-label-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"showValue","attribute":"show-value","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"valueDisplay","attribute":"value-display","type":"GaugeValueDisplay","kind":"string","values":["percent","value"],"default":"'value'","description":"Print the raw `value` or its `percent` of the axis (gauges use both)."},{"name":"valueFormat","attribute":"value-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"valueColor","attribute":"value-color","type":"string","kind":"string","values":[],"default":"'#0f172a'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"valueFontSize","attribute":"value-font-size","type":"number","kind":"number","values":[],"default":"26","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unit","attribute":"unit","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"centerText","attribute":"center-text","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"centerSubtext","attribute":"center-subtext","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: GaugeChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: GaugeChartPointerEventDetail) => string."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"GaugeChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration object — the dial-flavoured counterpart to the cartesian / pie `.tooltip` API. Enables `trigger` (hover/click/hover-click), `openMode` (single/multiple pinned), `connector`, `draggable`, `interactive` action buttons, custom `format`/`html`/`style`/`className`/`side` and fixed sizing. When set it takes precedence over the flat `tooltip-show` / `tooltipFormat` props (which stay for back-compat). Property-only — assign the object, not an attribute."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"GaugeChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"900","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"GaugeChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out","analog"],"default":"'analog'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out, analog. Default: 'analog'."},{"name":"animationType","attribute":"animation-type","type":"GaugeChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"analogDamping","attribute":"analog-damping","type":"number","kind":"number","values":[],"default":"5","description":"`analog` damping (1..n) for long sweeps — LOWER = bigger overshoot + more wobbles, higher = calmer. Short updates are auto-damped calmer."},{"name":"analogFrequency","attribute":"analog-frequency","type":"number","kind":"number","values":[],"default":"18","description":"`analog` swing frequency (1..n) — higher = more wobbles packed into the settle."},{"name":"analogOvershootAngle","attribute":"analog-overshoot-angle","type":"number","kind":"number","values":[],"default":"14","description":"How far past the scale ends the needle may overshoot, in degrees (visible at min/max)."},{"name":"streamSource","attribute":"stream-source","type":"GaugeChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"GaugeChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"GaugeChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<GaugeChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<GaugeChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getValue","parameters":[],"returns":"Promise<number>","description":"The dB value of a cell (`null` when empty or outside the grid)."},{"name":"setValue","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Set the primary value (animates when `animated`)."},{"name":"addNeedle","parameters":[{"name":"needle","type":"GaugeNeedleSpec","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Gauge-only — add a needle (dial variant)."},{"name":"removeNeedle","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Gauge-only — remove a needle by id or index."},{"name":"setRings","parameters":[{"name":"rings","type":"GaugeActivityRingSpec[]","optional":false}],"returns":"Promise<void>","description":"Replace the activity ring set (animates per ring when `animated`)."},{"name":"setRingValue","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"value","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Update ONE activity ring's value by id, name, or index (animates when `animated`)."},{"name":"updateNeedle","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<GaugeNeedleSpec>","optional":false}],"returns":"Promise<boolean>","description":"Gauge-only — patch a needle."},{"name":"appendPoint","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"values","type":"ReadonlyArray<number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"values","type":"ReadonlyArray<number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<GaugeChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: GaugeChartEasing; enabled?: boolean; type?: GaugeChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<GaugeChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltip","parameters":[],"returns":"Promise<GaugeChartPointerEventDetail | null>","description":"Open the value tooltip programmatically at the primary value (needle 0, or the scalar `value`). Anchors on the dial along the value's angle."},{"name":"showTooltipAtValue","parameters":[{"name":"value","type":"number","optional":false}],"returns":"Promise<GaugeChartPointerEventDetail | null>","description":"Gauge analogue of pie's `showTooltipAtSlice` — compute the pointer detail at `value`'s angle on the dial and open the tooltip there."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"GaugeChartRenderResult & { tier: GaugeChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"gaugeClick","type":"GaugeChartPointerEventDetail","description":"CustomEvent.detail type: GaugeChartPointerEventDetail. Event names are case-sensitive."},{"name":"gaugeHover","type":"GaugeChartPointerEventDetail | null","description":"CustomEvent.detail type: GaugeChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<GaugeChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<GaugeChartPointerEventDetail>. Event names are case-sensitive."},{"name":"valueChange","type":"{ value: number; fraction: number }","description":"CustomEvent.detail type: { value: number; fraction: number }. Event names are case-sensitive."},{"name":"legendItemClick","type":"{ index: number; needleId: string; label: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; needleId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"name":"needleToggled","type":"{ index: number; needleId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; needleId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"GaugeChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"GaugeChartTooltipActionEventDetail","description":"CustomEvent.detail type: GaugeChartTooltipActionEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-gauge-chart","blocks":[{"kind":"paragraph","text":"Use for values with a clear range, such as target completion, capacity, or speed."},{"kind":"paragraph","text":"Show trends over time in a separate chart. Explain out-of-range values and the meaning of boundaries."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`value`","The current measurement."],["`min`","The start of the measurement range."],["`max`","The end of the measurement range."],["`variant`","The gauge style, such as solid or dial."]]},{"kind":"links","items":[{"path":"/charts/gauge","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-gauge-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-gauge-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"value\": 80,\n        \"min\": 0,\n        \"max\": 200,\n        \"variant\": \"dial\",\n        \"unit\": \"km/h\",\n        \"bandThickness\": 14,\n        \"plotBands\": [\n          {\n            \"from\": 0,\n            \"to\": 120,\n            \"color\": \"#16a34a\"\n          },\n          {\n            \"from\": 120,\n            \"to\": 160,\n            \"color\": \"#f59e0b\"\n          },\n          {\n            \"from\": 160,\n            \"to\": 200,\n            \"color\": \"#dc2626\"\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'gauge example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('valueChange', event.detail);\n  };\n  chart.addEventListener('valueChange', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('valueChange', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-value","title":"value","blocks":[{"kind":"paragraph","text":"The current measurement."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`value`"],["HTML attribute","`value`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-min","title":"min","blocks":[{"kind":"paragraph","text":"The start of the measurement range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`min`"],["HTML attribute","`min`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-max","title":"max","blocks":[{"kind":"paragraph","text":"The end of the measurement range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`max`"],["HTML attribute","`max`"],["Type","`number`"],["Default","`100`"]]}]},{"id":"property-needles","title":"needles","blocks":[{"kind":"paragraph","text":"Multi-needle override (dial variant). When set + non-empty, drives the dial instead of `value`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needles`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeNeedleSpec[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`320`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`280`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-variant","title":"variant","blocks":[{"kind":"paragraph","text":"The gauge style, such as solid or dial."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`variant`"],["HTML attribute","`variant`"],["Type","`GaugeChartVariant`"],["Default","`'dial'`"],["Allowed values","`solid`, `dial`, `activity`, `vuMeter`, `speedometer`, `clock`"]]},{"kind":"links","items":[{"path":"/docs/types/GaugeChartVariant","title":"GaugeChartVariant","description":"Type definition"}]}]},{"id":"property-startAngle","title":"startAngle","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startAngle`"],["HTML attribute","`start-angle`"],["Type","`number`"],["Default","`-150`"]]}]},{"id":"property-endAngle","title":"endAngle","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`endAngle`"],["HTML attribute","`end-angle`"],["Type","`number`"],["Default","`150`"]]}]},{"id":"property-size","title":"size","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`size`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerX","title":"centerX","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerX`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerY","title":"centerY","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerY`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-innerRadius","title":"innerRadius","blocks":[{"kind":"paragraph","text":"Solid-variant inner radius. Number = px; `'%'` = fraction of outerRadius."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`innerRadius`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-thickness","title":"thickness","blocks":[{"kind":"paragraph","text":"Band / solid-ring thickness in px. Wins over innerRadius for the solid variant."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`thickness`"],["HTML attribute","`thickness`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-rings","title":"rings","blocks":[{"kind":"paragraph","text":"Activity-variant rings (property-only). Each ring has its OWN `value`/`max` (Move 500 kcal, Exercise 30 min…). Absent → the variant falls back to `needles` (shared chart max) or the scalar `value` (one ring)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeActivityRingSpec[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeActivityRingSpec","title":"GaugeActivityRingSpec","description":"Type definition"}]}]},{"id":"property-time","title":"time","blocks":[{"kind":"paragraph","text":"Clock-variant time. `'now'`/unset keeps the face ticking live (1 s interval, cleaned up on disconnect); `'HH:MM'`/`'HH:MM:SS'` freezes it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`time`"],["HTML attribute","`time`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-showSeconds","title":"showSeconds","blocks":[{"kind":"paragraph","text":"Clock-variant second hand (thin, red)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showSeconds`"],["HTML attribute","`show-seconds`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Needle palette (multi-needle). Per-needle `color` always wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-stops","title":"stops","blocks":[{"kind":"paragraph","text":"Solid-variant colour stops (0..1 along min..max). Progress colour interpolates between them."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stops`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeColorStop[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeColorStop","title":"GaugeColorStop","description":"Type definition"}]}]},{"id":"property-needleShape","title":"needleShape","blocks":[{"kind":"paragraph","text":"Allowed values: needle, arrow, line, wedge. Default: 'needle'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleShape`"],["HTML attribute","`needle-shape`"],["Type","`GaugeNeedleShape`"],["Default","`'needle'`"],["Allowed values","`needle`, `arrow`, `line`, `wedge`"]]},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleShape","title":"GaugeNeedleShape","description":"Type definition"}]}]},{"id":"property-needleLength","title":"needleLength","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleLength`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`'88%'`"]]}]},{"id":"property-needleRearLength","title":"needleRearLength","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleRearLength`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`'14%'`"]]}]},{"id":"property-needleWidth","title":"needleWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`needleWidth`"],["HTML attribute","`needle-width`"],["Type","`number`"],["Default","`8`"]]}]},{"id":"property-pivotRadius","title":"pivotRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`pivotRadius`"],["HTML attribute","`pivot-radius`"],["Type","`number`"],["Default","`7`"]]}]},{"id":"property-pivotColor","title":"pivotColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`pivotColor`"],["HTML attribute","`pivot-color`"],["Type","`string`"],["Default","`'#1f2937'`"]]}]},{"id":"property-plotBands","title":"plotBands","blocks":[{"kind":"paragraph","text":"Coloured zones — an array, or `'auto'` to split the axis by % of max."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`plotBands`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugePlotBand[] | 'auto'`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugePlotBand","title":"GaugePlotBand","description":"Type definition"}]}]},{"id":"property-bandThickness","title":"bandThickness","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandThickness`"],["HTML attribute","`band-thickness`"],["Type","`number`"],["Default","`14`"]]}]},{"id":"property-bandTrackColor","title":"bandTrackColor","blocks":[{"kind":"paragraph","text":"The 'empty' track behind plot bands — the un-zoned part of the axis."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bandTrackColor`"],["HTML attribute","`band-track-color`"],["Type","`string`"],["Default","`'#eef2f7'`"]]}]},{"id":"property-rounded","title":"rounded","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rounded`"],["HTML attribute","`rounded`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-trackColor","title":"trackColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`trackColor`"],["HTML attribute","`track-color`"],["Type","`string`"],["Default","`'#e5e7eb'`"]]}]},{"id":"property-showTicks","title":"showTicks","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showTicks`"],["HTML attribute","`show-ticks`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tickInterval","title":"tickInterval","blocks":[{"kind":"paragraph","text":"Allowed values: auto. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickInterval`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | 'auto'`"],["Default","`'auto'`"],["Literals in the type","`auto`"]]}]},{"id":"property-minorTicks","title":"minorTicks","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minorTicks`"],["HTML attribute","`minor-ticks`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"property-tickLength","title":"tickLength","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLength`"],["HTML attribute","`tick-length`"],["Type","`number`"],["Default","`9`"]]}]},{"id":"property-minorTickLength","title":"minorTickLength","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minorTickLength`"],["HTML attribute","`minor-tick-length`"],["Type","`number`"],["Default","`6`"]]}]},{"id":"property-tickWidth","title":"tickWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickWidth`"],["HTML attribute","`tick-width`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-minorTickWidth","title":"minorTickWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minorTickWidth`"],["HTML attribute","`minor-tick-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-tickColor","title":"tickColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickColor`"],["HTML attribute","`tick-color`"],["Type","`string`"],["Default","`'#94a3b8'`"]]}]},{"id":"property-showTickLabels","title":"showTickLabels","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showTickLabels`"],["HTML attribute","`show-tick-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tickLabelDistance","title":"tickLabelDistance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelDistance`"],["HTML attribute","`tick-label-distance`"],["Type","`number`"],["Default","`7`"]]}]},{"id":"property-tickLabelColor","title":"tickLabelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelColor`"],["HTML attribute","`tick-label-color`"],["Type","`string`"],["Default","`'#64748b'`"]]}]},{"id":"property-tickLabelFontSize","title":"tickLabelFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelFontSize`"],["HTML attribute","`tick-label-font-size`"],["Type","`number`"],["Default","`11`"]]}]},{"id":"property-tickLabelFormat","title":"tickLabelFormat","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLabelFormat`"],["HTML attribute","`tick-label-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-showValue","title":"showValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showValue`"],["HTML attribute","`show-value`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-valueDisplay","title":"valueDisplay","blocks":[{"kind":"paragraph","text":"Print the raw `value` or its `percent` of the axis (gauges use both)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueDisplay`"],["HTML attribute","`value-display`"],["Type","`GaugeValueDisplay`"],["Default","`'value'`"],["Allowed values","`percent`, `value`"]]},{"kind":"links","items":[{"path":"/docs/types/GaugeValueDisplay","title":"GaugeValueDisplay","description":"Type definition"}]}]},{"id":"property-valueFormat","title":"valueFormat","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueFormat`"],["HTML attribute","`value-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueColor","title":"valueColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueColor`"],["HTML attribute","`value-color`"],["Type","`string`"],["Default","`'#0f172a'`"]]}]},{"id":"property-valueFontSize","title":"valueFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueFontSize`"],["HTML attribute","`value-font-size`"],["Type","`number`"],["Default","`26`"]]}]},{"id":"property-unit","title":"unit","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unit`"],["HTML attribute","`unit`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerText","title":"centerText","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerText`"],["HTML attribute","`center-text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerSubtext","title":"centerSubtext","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerSubtext`"],["HTML attribute","`center-subtext`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: GaugeChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: GaugeChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration object — the dial-flavoured counterpart to the cartesian / pie `.tooltip` API. Enables `trigger` (hover/click/hover-click), `openMode` (single/multiple pinned), `connector`, `draggable`, `interactive` action buttons, custom `format`/`html`/`style`/`className`/`side` and fixed sizing. When set it takes precedence over the flat `tooltip-show` / `tooltipFormat` props (which stay for back-compat). Property-only — assign the object, not an attribute."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipInput","title":"GaugeChartTooltipInput","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`GaugeChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/GaugeChartLegendPosition","title":"GaugeChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out, analog. Default: 'analog'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`GaugeChartEasing`"],["Default","`'analog'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`, `analog`"]]},{"kind":"links","items":[{"path":"/docs/types/GaugeChartEasing","title":"GaugeChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`GaugeChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartAnimationType","title":"GaugeChartAnimationType","description":"Type definition"}]}]},{"id":"property-analogDamping","title":"analogDamping","blocks":[{"kind":"paragraph","text":"`analog` damping (1..n) for long sweeps — LOWER = bigger overshoot + more wobbles, higher = calmer. Short updates are auto-damped calmer."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`analogDamping`"],["HTML attribute","`analog-damping`"],["Type","`number`"],["Default","`5`"]]}]},{"id":"property-analogFrequency","title":"analogFrequency","blocks":[{"kind":"paragraph","text":"`analog` swing frequency (1..n) — higher = more wobbles packed into the settle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`analogFrequency`"],["HTML attribute","`analog-frequency`"],["Type","`number`"],["Default","`18`"]]}]},{"id":"property-analogOvershootAngle","title":"analogOvershootAngle","blocks":[{"kind":"paragraph","text":"How far past the scale ends the needle may overshoot, in degrees (visible at min/max)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`analogOvershootAngle`"],["HTML attribute","`analog-overshoot-angle`"],["Type","`number`"],["Default","`14`"]]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GaugeChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartStreamSource","title":"GaugeChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`GaugeChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/GaugeChartEngineMode","title":"GaugeChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`GaugeChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/GaugeChartUnavailableBehaviour","title":"GaugeChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GaugeChartRenderResult & { tier: GaugeChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // GaugeChartRenderResult & { tier: GaugeChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GaugeChartRenderResult","title":"GaugeChartRenderResult","description":"Type definition"},{"path":"/docs/types/GaugeChartEngineTier","title":"GaugeChartEngineTier","description":"Type definition"}]}]},{"id":"event-gaugeClick","title":"gaugeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GaugeChartPointerEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `gaugeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GaugeChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('gaugeClick', event => {\n  console.log(event.detail); // GaugeChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-gaugeHover","title":"gaugeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GaugeChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `gaugeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GaugeChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('gaugeHover', event => {\n  console.log(event.detail); // GaugeChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<GaugeChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<GaugeChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<GaugeChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-valueChange","title":"valueChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { value: number; fraction: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `valueChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ value: number; fraction: number }>`."},{"kind":"code","source":"chart.addEventListener('valueChange', event => {\n  console.log(event.detail); // { value: number; fraction: number }\n});","language":"javascript"}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; needleId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; needleId: string; label: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // { index: number; needleId: string; label: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-needleToggled","title":"needleToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; needleId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `needleToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; needleId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('needleToggled', event => {\n  console.log(event.detail); // { index: number; needleId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GaugeChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // GaugeChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipShowEventDetail","title":"GaugeChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GaugeChartTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GaugeChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // GaugeChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipActionEventDetail","title":"GaugeChartTooltipActionEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<GaugeChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartRenderResult","title":"GaugeChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<GaugeChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartEngineTier","title":"GaugeChartEngineTier","description":"Type definition"}]}]},{"id":"method-getValue","title":"getValue","blocks":[{"kind":"paragraph","text":"The dB value of a cell (`null` when empty or outside the grid)."},{"kind":"code","source":"getValue(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setValue","title":"setValue","blocks":[{"kind":"paragraph","text":"Set the primary value (animates when `animated`)."},{"kind":"code","source":"setValue(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-addNeedle","title":"addNeedle","blocks":[{"kind":"paragraph","text":"Gauge-only — add a needle (dial variant)."},{"kind":"code","source":"addNeedle(needle: GaugeNeedleSpec, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`needle`","`GaugeNeedleSpec`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","description":"Type definition"}]}]},{"id":"method-removeNeedle","title":"removeNeedle","blocks":[{"kind":"paragraph","text":"Gauge-only — remove a needle by id or index."},{"kind":"code","source":"removeNeedle(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setRings","title":"setRings","blocks":[{"kind":"paragraph","text":"Replace the activity ring set (animates per ring when `animated`)."},{"kind":"code","source":"setRings(rings: GaugeActivityRingSpec[]): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rings`","`GaugeActivityRingSpec[]`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeActivityRingSpec","title":"GaugeActivityRingSpec","description":"Type definition"}]}]},{"id":"method-setRingValue","title":"setRingValue","blocks":[{"kind":"paragraph","text":"Update ONE activity ring's value by id, name, or index (animates when `animated`)."},{"kind":"code","source":"setRingValue(idOrIndex: string | number, value: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateNeedle","title":"updateNeedle","blocks":[{"kind":"paragraph","text":"Gauge-only — patch a needle."},{"kind":"code","source":"updateNeedle(idOrIndex: string | number, patch: Partial<GaugeNeedleSpec>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<GaugeNeedleSpec>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(value: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(values: ReadonlyArray<number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(values: ReadonlyArray<number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`ReadonlyArray<number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<GaugeChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartStreamSource","title":"GaugeChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: GaugeChartEasing; enabled?: boolean; type?: GaugeChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: GaugeChartEasing; enabled?: boolean; type?: GaugeChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartEasing","title":"GaugeChartEasing","description":"Type definition"},{"path":"/docs/types/GaugeChartAnimationType","title":"GaugeChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<GaugeChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltip","title":"showTooltip","blocks":[{"kind":"paragraph","text":"Open the value tooltip programmatically at the primary value (needle 0, or the scalar `value`). Anchors on the dial along the value's angle."},{"kind":"code","source":"showTooltip(): Promise<GaugeChartPointerEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtValue","title":"showTooltipAtValue","blocks":[{"kind":"paragraph","text":"Gauge analogue of pie's `showTooltipAtSlice` — compute the pointer detail at `value`'s angle on the dial and open the tooltip there."},{"kind":"code","source":"showTooltipAtValue(value: number): Promise<GaugeChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GaugeChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/funnel","title":"Funnel","summary":"Show the quantity remaining through successive stages.","kind":"component","tag":"sy-funnel-chart","componentId":"funnel","api":{"props":[{"name":"data","attribute":"data","type":"FunnelChartData","kind":"property","values":[],"default":"[]","description":"An array of stages as { name, value }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"420","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"reversed","attribute":"reversed","type":"boolean","kind":"boolean","values":[],"default":"false","description":"`true` makes a PYRAMID — point at the top, widening to the base."},{"name":"neckWidth","attribute":"neck-width","type":"number","kind":"number","values":[],"default":"0.3","description":"Neck width as a fraction of the full width (funnel only)."},{"name":"neckHeight","attribute":"neck-height","type":"number","kind":"number","values":[],"default":"0.25","description":"Neck height as a fraction of the total height (funnel only; the straight bottom band)."},{"name":"gap","attribute":"gap","type":"number","kind":"number","values":[],"default":"2","description":"Vertical gap between sections (px)."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Per-section palette. Per-section `color` always wins."},{"name":"labelPlacement","attribute":"label-placement","type":"FunnelLabelPlacement","kind":"string","values":["none","left","right","inside"],"default":"'inside'","description":"Allowed values: none, left, right, inside. Default: 'inside'."},{"name":"labelColor","attribute":"label-color","type":"string","kind":"string","values":[],"default":"'#374151'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"insideLabelColor","attribute":"inside-label-color","type":"string","kind":"string","values":[],"default":"'#ffffff'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"labelFontSize","attribute":"label-font-size","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"showValue","attribute":"show-value","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"showPercent","attribute":"show-percent","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show each stage's percentage of the sum of stage values."},{"name":"valueFormat","attribute":"value-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"leaderColor","attribute":"leader-color","type":"string","kind":"string","values":[],"default":"'#cbd5e1'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: FunnelChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: FunnelChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"FunnelChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactiveOtherSections","attribute":"inactive-other-sections","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactiveSectionOpacity","attribute":"inactive-section-opacity","type":"number","kind":"number","values":[],"default":"0.3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"activeSectionIndex","attribute":"active-section-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"FunnelChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"700","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"FunnelChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"FunnelChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"FunnelChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"FunnelChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"FunnelChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<FunnelChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<FunnelChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"data","type":"FunnelChartData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"addSection","parameters":[{"name":"section","type":"FunnelSectionSpec | number","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Funnel / pyramid-only — add a section (stage). Returns its index."},{"name":"removeSection","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Funnel / pyramid-only — remove a section by id or index."},{"name":"updateSection","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<FunnelSectionSpec>","optional":false}],"returns":"Promise<boolean>","description":"Funnel / pyramid-only — patch a section."},{"name":"appendPoint","parameters":[{"name":"section","type":"FunnelSectionSpec | number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"sections","type":"ReadonlyArray<FunnelSectionSpec | number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"sections","type":"ReadonlyArray<FunnelSectionSpec | number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<FunnelChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: FunnelChartEasing; enabled?: boolean; type?: FunnelChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<FunnelChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAt","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<FunnelChartPointerEventDetail | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"FunnelChartRenderResult & { tier: FunnelChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"sectionClick","type":"FunnelChartPointerEventDetail","description":"CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive."},{"name":"sectionHover","type":"FunnelChartPointerEventDetail | null","description":"CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>. Event names are case-sensitive."},{"name":"tooltipShow","type":"FunnelChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"FunnelChartTooltipActionEventDetail","description":"CustomEvent.detail type: FunnelChartTooltipActionEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"{ index: number; sectionId: string; label: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sectionId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"name":"sectionToggled","type":"{ index: number; sectionId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-funnel-chart","blocks":[{"kind":"paragraph","text":"Analyze conversion from visits to purchases or progression through sales stages."},{"kind":"paragraph","text":"Do not connect values from different populations as consecutive stages. Preserve the stage order."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of stages as { name, value }."],["`showPercent`","Whether to show each stage's percentage of the sum of stage values."]]},{"kind":"links","items":[{"path":"/charts/funnel","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-funnel-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-funnel-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"data\": [\n          {\n            \"name\": \"Visits\",\n            \"value\": 1000\n          },\n          {\n            \"name\": \"Views\",\n            \"value\": 680\n          },\n          {\n            \"name\": \"Cart\",\n            \"value\": 320\n          },\n          {\n            \"name\": \"Purchase\",\n            \"value\": 150\n          }\n        ],\n        \"colors\": [\"#8263d9\", \"#239c91\", \"#e99954\", \"#d76c8f\", \"#4d89c4\", \"#95a551\"],\n        \"showPercent\": true,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'funnel example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('sectionClick', event.detail);\n  };\n  chart.addEventListener('sectionClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('sectionClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of stages as { name, value }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FunnelChartData`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`420`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-reversed","title":"reversed","blocks":[{"kind":"paragraph","text":"`true` makes a PYRAMID — point at the top, widening to the base."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`reversed`"],["HTML attribute","`reversed`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-neckWidth","title":"neckWidth","blocks":[{"kind":"paragraph","text":"Neck width as a fraction of the full width (funnel only)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neckWidth`"],["HTML attribute","`neck-width`"],["Type","`number`"],["Default","`0.3`"]]}]},{"id":"property-neckHeight","title":"neckHeight","blocks":[{"kind":"paragraph","text":"Neck height as a fraction of the total height (funnel only; the straight bottom band)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neckHeight`"],["HTML attribute","`neck-height`"],["Type","`number`"],["Default","`0.25`"]]}]},{"id":"property-gap","title":"gap","blocks":[{"kind":"paragraph","text":"Vertical gap between sections (px)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gap`"],["HTML attribute","`gap`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Per-section palette. Per-section `color` always wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-labelPlacement","title":"labelPlacement","blocks":[{"kind":"paragraph","text":"Allowed values: none, left, right, inside. Default: 'inside'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelPlacement`"],["HTML attribute","`label-placement`"],["Type","`FunnelLabelPlacement`"],["Default","`'inside'`"],["Allowed values","`none`, `left`, `right`, `inside`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelLabelPlacement","title":"FunnelLabelPlacement","description":"Type definition"}]}]},{"id":"property-labelColor","title":"labelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelColor`"],["HTML attribute","`label-color`"],["Type","`string`"],["Default","`'#374151'`"]]}]},{"id":"property-insideLabelColor","title":"insideLabelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`insideLabelColor`"],["HTML attribute","`inside-label-color`"],["Type","`string`"],["Default","`'#ffffff'`"]]}]},{"id":"property-labelFontSize","title":"labelFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelFontSize`"],["HTML attribute","`label-font-size`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-showValue","title":"showValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showValue`"],["HTML attribute","`show-value`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-showPercent","title":"showPercent","blocks":[{"kind":"paragraph","text":"Whether to show each stage's percentage of the sum of stage values."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showPercent`"],["HTML attribute","`show-percent`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-valueFormat","title":"valueFormat","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueFormat`"],["HTML attribute","`value-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-leaderColor","title":"leaderColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`leaderColor`"],["HTML attribute","`leader-color`"],["Type","`string`"],["Default","`'#cbd5e1'`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: FunnelChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: FunnelChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FunnelChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipInput","title":"FunnelChartTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-inactiveOtherSections","title":"inactiveOtherSections","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherSections`"],["HTML attribute","`inactive-other-sections`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactiveSectionOpacity","title":"inactiveSectionOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveSectionOpacity`"],["HTML attribute","`inactive-section-opacity`"],["Type","`number`"],["Default","`0.3`"]]}]},{"id":"property-activeSectionIndex","title":"activeSectionIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSectionIndex`"],["HTML attribute","`active-section-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`FunnelChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartLegendPosition","title":"FunnelChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`700`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`FunnelChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEasing","title":"FunnelChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`FunnelChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartAnimationType","title":"FunnelChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FunnelChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartStreamSource","title":"FunnelChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`FunnelChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEngineMode","title":"FunnelChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`FunnelChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartUnavailableBehaviour","title":"FunnelChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartRenderResult & { tier: FunnelChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // FunnelChartRenderResult & { tier: FunnelChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartRenderResult","title":"FunnelChartRenderResult","description":"Type definition"},{"path":"/docs/types/FunnelChartEngineTier","title":"FunnelChartEngineTier","description":"Type definition"}]}]},{"id":"event-sectionClick","title":"sectionClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sectionClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('sectionClick', event => {\n  console.log(event.detail); // FunnelChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-sectionHover","title":"sectionHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sectionHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('sectionHover', event => {\n  console.log(event.detail); // FunnelChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // FunnelChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipShowEventDetail","title":"FunnelChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FunnelChartTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // FunnelChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipActionEventDetail","title":"FunnelChartTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; sectionId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sectionId: string; label: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // { index: number; sectionId: string; label: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-sectionToggled","title":"sectionToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sectionToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sectionId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('sectionToggled', event => {\n  console.log(event.detail); // { index: number; sectionId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<FunnelChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartRenderResult","title":"FunnelChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<FunnelChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEngineTier","title":"FunnelChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: FunnelChartData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`FunnelChartData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","description":"Type definition"}]}]},{"id":"method-addSection","title":"addSection","blocks":[{"kind":"paragraph","text":"Funnel / pyramid-only — add a section (stage). Returns its index."},{"kind":"code","source":"addSection(section: FunnelSectionSpec | number, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`section`","`FunnelSectionSpec | number`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-removeSection","title":"removeSection","blocks":[{"kind":"paragraph","text":"Funnel / pyramid-only — remove a section by id or index."},{"kind":"code","source":"removeSection(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSection","title":"updateSection","blocks":[{"kind":"paragraph","text":"Funnel / pyramid-only — patch a section."},{"kind":"code","source":"updateSection(idOrIndex: string | number, patch: Partial<FunnelSectionSpec>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<FunnelSectionSpec>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(section: FunnelSectionSpec | number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`section`","`FunnelSectionSpec | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(sections: ReadonlyArray<FunnelSectionSpec | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`sections`","`ReadonlyArray<FunnelSectionSpec | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(sections: ReadonlyArray<FunnelSectionSpec | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`sections`","`ReadonlyArray<FunnelSectionSpec | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<FunnelChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartStreamSource","title":"FunnelChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: FunnelChartEasing; enabled?: boolean; type?: FunnelChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: FunnelChartEasing; enabled?: boolean; type?: FunnelChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEasing","title":"FunnelChartEasing","description":"Type definition"},{"path":"/docs/types/FunnelChartAnimationType","title":"FunnelChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<FunnelChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAt","title":"showTooltipAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showTooltipAt(idOrIndex: string | number): Promise<FunnelChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/pyramid","title":"Pyramid","summary":"Represent stage sizes as a pyramid.","kind":"component","tag":"sy-funnel-chart","componentId":"pyramid","api":{"props":[{"name":"data","attribute":"data","type":"FunnelChartData","kind":"property","values":[],"default":"[]","description":"An array of { name, value }, starting with the widest layer."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"420","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"reversed","attribute":"reversed","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set true to form a pyramid."},{"name":"neckWidth","attribute":"neck-width","type":"number","kind":"number","values":[],"default":"0.3","description":"Set to 0."},{"name":"neckHeight","attribute":"neck-height","type":"number","kind":"number","values":[],"default":"0.25","description":"Set to 0."},{"name":"gap","attribute":"gap","type":"number","kind":"number","values":[],"default":"2","description":"Vertical gap between sections (px)."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Per-section palette. Per-section `color` always wins."},{"name":"labelPlacement","attribute":"label-placement","type":"FunnelLabelPlacement","kind":"string","values":["none","left","right","inside"],"default":"'inside'","description":"Allowed values: none, left, right, inside. Default: 'inside'."},{"name":"labelColor","attribute":"label-color","type":"string","kind":"string","values":[],"default":"'#374151'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"insideLabelColor","attribute":"inside-label-color","type":"string","kind":"string","values":[],"default":"'#ffffff'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"labelFontSize","attribute":"label-font-size","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"showValue","attribute":"show-value","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"showPercent","attribute":"show-percent","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"valueFormat","attribute":"value-format","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"leaderColor","attribute":"leader-color","type":"string","kind":"string","values":[],"default":"'#cbd5e1'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: FunnelChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: FunnelChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"FunnelChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactiveOtherSections","attribute":"inactive-other-sections","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactiveSectionOpacity","attribute":"inactive-section-opacity","type":"number","kind":"number","values":[],"default":"0.3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"activeSectionIndex","attribute":"active-section-index","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"FunnelChartLegendPosition","kind":"string","values":["top","bottom","left","right"],"default":"'bottom'","description":"Where the legend is positioned."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"700","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"FunnelChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"FunnelChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"FunnelChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"FunnelChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"FunnelChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<FunnelChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<FunnelChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"data","type":"FunnelChartData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"addSection","parameters":[{"name":"section","type":"FunnelSectionSpec | number","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Funnel / pyramid-only — add a section (stage). Returns its index."},{"name":"removeSection","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Funnel / pyramid-only — remove a section by id or index."},{"name":"updateSection","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<FunnelSectionSpec>","optional":false}],"returns":"Promise<boolean>","description":"Funnel / pyramid-only — patch a section."},{"name":"appendPoint","parameters":[{"name":"section","type":"FunnelSectionSpec | number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"sections","type":"ReadonlyArray<FunnelSectionSpec | number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"sections","type":"ReadonlyArray<FunnelSectionSpec | number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<FunnelChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: FunnelChartEasing; enabled?: boolean; type?: FunnelChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<FunnelChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAt","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<FunnelChartPointerEventDetail | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"FunnelChartRenderResult & { tier: FunnelChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"sectionClick","type":"FunnelChartPointerEventDetail","description":"CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive."},{"name":"sectionHover","type":"FunnelChartPointerEventDetail | null","description":"CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>. Event names are case-sensitive."},{"name":"tooltipShow","type":"FunnelChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"FunnelChartTooltipActionEventDetail","description":"CustomEvent.detail type: FunnelChartTooltipActionEventDetail. Event names are case-sensitive."},{"name":"legendItemClick","type":"{ index: number; sectionId: string; label: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sectionId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"name":"sectionToggled","type":"{ index: number; sectionId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-funnel-chart","blocks":[{"kind":"paragraph","text":"Use to explain layered structures such as foundation, growth, and expertise."},{"kind":"paragraph","text":"A pyramid uses Funnel's reversed and neck settings. Provide a table for precise size comparisons."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { name, value }, starting with the widest layer."],["`reversed`","Set true to form a pyramid."],["`neckWidth`","Set to 0."],["`neckHeight`","Set to 0."]]},{"kind":"links","items":[{"path":"/charts/pyramid","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-funnel-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-funnel-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"reversed\": true,\n        \"neckWidth\": 0,\n        \"neckHeight\": 0,\n        \"data\": [\n          {\n            \"name\": \"Opening\",\n            \"value\": 60\n          },\n          {\n            \"name\": \"Growth\",\n            \"value\": 30\n          },\n          {\n            \"name\": \"Expert\",\n            \"value\": 10\n          }\n        ],\n        \"colors\": [\"#8263d9\", \"#239c91\", \"#e99954\", \"#d76c8f\", \"#4d89c4\", \"#95a551\"],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'pyramid example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('sectionClick', event.detail);\n  };\n  chart.addEventListener('sectionClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('sectionClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { name, value }, starting with the widest layer."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FunnelChartData`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`420`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-reversed","title":"reversed","blocks":[{"kind":"paragraph","text":"Set true to form a pyramid."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`reversed`"],["HTML attribute","`reversed`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-neckWidth","title":"neckWidth","blocks":[{"kind":"paragraph","text":"Set to 0."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neckWidth`"],["HTML attribute","`neck-width`"],["Type","`number`"],["Default","`0.3`"]]}]},{"id":"property-neckHeight","title":"neckHeight","blocks":[{"kind":"paragraph","text":"Set to 0."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neckHeight`"],["HTML attribute","`neck-height`"],["Type","`number`"],["Default","`0.25`"]]}]},{"id":"property-gap","title":"gap","blocks":[{"kind":"paragraph","text":"Vertical gap between sections (px)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gap`"],["HTML attribute","`gap`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Per-section palette. Per-section `color` always wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-labelPlacement","title":"labelPlacement","blocks":[{"kind":"paragraph","text":"Allowed values: none, left, right, inside. Default: 'inside'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelPlacement`"],["HTML attribute","`label-placement`"],["Type","`FunnelLabelPlacement`"],["Default","`'inside'`"],["Allowed values","`none`, `left`, `right`, `inside`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelLabelPlacement","title":"FunnelLabelPlacement","description":"Type definition"}]}]},{"id":"property-labelColor","title":"labelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelColor`"],["HTML attribute","`label-color`"],["Type","`string`"],["Default","`'#374151'`"]]}]},{"id":"property-insideLabelColor","title":"insideLabelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`insideLabelColor`"],["HTML attribute","`inside-label-color`"],["Type","`string`"],["Default","`'#ffffff'`"]]}]},{"id":"property-labelFontSize","title":"labelFontSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelFontSize`"],["HTML attribute","`label-font-size`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-showValue","title":"showValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showValue`"],["HTML attribute","`show-value`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-showPercent","title":"showPercent","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showPercent`"],["HTML attribute","`show-percent`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-valueFormat","title":"valueFormat","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueFormat`"],["HTML attribute","`value-format`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-leaderColor","title":"leaderColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`leaderColor`"],["HTML attribute","`leader-color`"],["Type","`string`"],["Default","`'#cbd5e1'`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: FunnelChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: FunnelChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FunnelChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipInput","title":"FunnelChartTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-inactiveOtherSections","title":"inactiveOtherSections","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherSections`"],["HTML attribute","`inactive-other-sections`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactiveSectionOpacity","title":"inactiveSectionOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveSectionOpacity`"],["HTML attribute","`inactive-section-opacity`"],["Type","`number`"],["Default","`0.3`"]]}]},{"id":"property-activeSectionIndex","title":"activeSectionIndex","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeSectionIndex`"],["HTML attribute","`active-section-index`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Where the legend is positioned."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`FunnelChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartLegendPosition","title":"FunnelChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`700`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`FunnelChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEasing","title":"FunnelChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`FunnelChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartAnimationType","title":"FunnelChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FunnelChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartStreamSource","title":"FunnelChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`FunnelChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEngineMode","title":"FunnelChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`FunnelChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/FunnelChartUnavailableBehaviour","title":"FunnelChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartRenderResult & { tier: FunnelChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // FunnelChartRenderResult & { tier: FunnelChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartRenderResult","title":"FunnelChartRenderResult","description":"Type definition"},{"path":"/docs/types/FunnelChartEngineTier","title":"FunnelChartEngineTier","description":"Type definition"}]}]},{"id":"event-sectionClick","title":"sectionClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FunnelChartPointerEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sectionClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('sectionClick', event => {\n  console.log(event.detail); // FunnelChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-sectionHover","title":"sectionHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FunnelChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sectionHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('sectionHover', event => {\n  console.log(event.detail); // FunnelChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<FunnelChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // FunnelChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipShowEventDetail","title":"FunnelChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FunnelChartTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FunnelChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // FunnelChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipActionEventDetail","title":"FunnelChartTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; sectionId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sectionId: string; label: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // { index: number; sectionId: string; label: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-sectionToggled","title":"sectionToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; sectionId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `sectionToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; sectionId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('sectionToggled', event => {\n  console.log(event.detail); // { index: number; sectionId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<FunnelChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartRenderResult","title":"FunnelChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<FunnelChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEngineTier","title":"FunnelChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: FunnelChartData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`FunnelChartData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","description":"Type definition"}]}]},{"id":"method-addSection","title":"addSection","blocks":[{"kind":"paragraph","text":"Funnel / pyramid-only — add a section (stage). Returns its index."},{"kind":"code","source":"addSection(section: FunnelSectionSpec | number, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`section`","`FunnelSectionSpec | number`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-removeSection","title":"removeSection","blocks":[{"kind":"paragraph","text":"Funnel / pyramid-only — remove a section by id or index."},{"kind":"code","source":"removeSection(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateSection","title":"updateSection","blocks":[{"kind":"paragraph","text":"Funnel / pyramid-only — patch a section."},{"kind":"code","source":"updateSection(idOrIndex: string | number, patch: Partial<FunnelSectionSpec>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<FunnelSectionSpec>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(section: FunnelSectionSpec | number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`section`","`FunnelSectionSpec | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(sections: ReadonlyArray<FunnelSectionSpec | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`sections`","`ReadonlyArray<FunnelSectionSpec | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(sections: ReadonlyArray<FunnelSectionSpec | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`sections`","`ReadonlyArray<FunnelSectionSpec | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<FunnelChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartStreamSource","title":"FunnelChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: FunnelChartEasing; enabled?: boolean; type?: FunnelChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: FunnelChartEasing; enabled?: boolean; type?: FunnelChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartEasing","title":"FunnelChartEasing","description":"Type definition"},{"path":"/docs/types/FunnelChartAnimationType","title":"FunnelChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<FunnelChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAt","title":"showTooltipAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showTooltipAt(idOrIndex: string | number): Promise<FunnelChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FunnelChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/pictorial","title":"Pictorial","summary":"Express state through the filled portion of a familiar shape.","kind":"component","tag":"sy-pictorial-chart","componentId":"pictorial","api":{"props":[{"name":"values","attribute":"values","type":"PictorialChartValues","kind":"property","values":[],"default":"new Float32Array(0)","description":"Numeric values for each item."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Category names for the shapes."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"color","attribute":"color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"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."},{"name":"paths","attribute":"paths","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"SVG path definitions the icons cycle through per category (Highcharts `paths`). Property-only. Default: the person silhouette."},{"name":"iconPadding","attribute":"icon-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"Fraction of each band kept as whitespace around its icon, 0..0.9."},{"name":"trackOpacity","attribute":"track-opacity","type":"number","kind":"number","values":[],"default":"0.16","description":"Opacity of the unfilled remainder silhouette (0 hides the track)."},{"name":"xLabelMode","attribute":"x-label-mode","type":"'auto' | 'all' | 'thin' | 'rotate' | 'none'","kind":"string","values":["none","auto","all","thin","rotate"],"default":"undefined","description":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"name":"xLabelRotation","attribute":"x-label-rotation","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit category-label rotation in degrees (respected as a floor)."},{"name":"xLabelMaxCount","attribute":"x-label-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Hard cap on the number of category labels shown."},{"name":"valueAxisLabel","attribute":"value-axis-label","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"CartesianAxisInput | ReadonlyArray<CartesianAxisInput>","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. The icon bands re-project through the zoomed frame; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: PictorialChartPointerEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: PictorialChartPointerEventDetail) => string."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration (matches the line/area/column family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"PictorialChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"PictorialChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"PictorialChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"PictorialChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"proThreshold","attribute":"pro-threshold","type":"number","kind":"number","values":[],"default":"50_000","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"unavailable","attribute":"unavailable","type":"PictorialChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<PictorialChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<PictorialChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setData","parameters":[{"name":"values","type":"PictorialChartValues","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"datum","type":"PictorialBarDatum | number","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"data","type":"ReadonlyArray<PictorialBarDatum | number>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"data","type":"ReadonlyArray<PictorialBarDatum | number>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<PictorialChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: PictorialChartEasing; enabled?: boolean; type?: PictorialChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<PictorialChartPointerEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"PictorialChartRenderResult & { tier: PictorialChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"PictorialChartPointerEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"PictorialChartPointerEventDetail | null","description":"CustomEvent.detail type: PictorialChartPointerEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<PictorialChartPointerEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<PictorialChartPointerEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"seriesOutsideClick","type":"CartesianSeriesOutsideClickEventDetail","description":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-pictorial-chart","blocks":[{"kind":"paragraph","text":"Use in dashboards and infographics explaining a small number of metrics."},{"kind":"paragraph","text":"Readers may confuse area with height. Include numeric values and units."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","Numeric values for each item."],["`categories`","Category names for the shapes."]]},{"kind":"links","items":[{"path":"/charts/pictorial","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-pictorial-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-pictorial-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [65, 80, 45],\n        \"categories\": [\"A\", \"B\", \"C\"],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'pictorial example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Numeric values for each item."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PictorialChartValues`"],["Default","`new Float32Array(0)`"]]},{"kind":"links","items":[{"path":"/docs/types/PictorialChartValues","title":"PictorialChartValues","description":"Type definition"}]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Category names for the shapes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"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."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"property-paths","title":"paths","blocks":[{"kind":"paragraph","text":"SVG path definitions the icons cycle through per category (Highcharts `paths`). Property-only. Default: the person silhouette."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`paths`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-iconPadding","title":"iconPadding","blocks":[{"kind":"paragraph","text":"Fraction of each band kept as whitespace around its icon, 0..0.9."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`iconPadding`"],["HTML attribute","`icon-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-trackOpacity","title":"trackOpacity","blocks":[{"kind":"paragraph","text":"Opacity of the unfilled remainder silhouette (0 hides the track)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`trackOpacity`"],["HTML attribute","`track-opacity`"],["Type","`number`"],["Default","`0.16`"]]}]},{"id":"property-xLabelMode","title":"xLabelMode","blocks":[{"kind":"paragraph","text":"How crowded category-axis labels are decluttered. Default 'auto' thins labels horizontally."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMode`"],["HTML attribute","`x-label-mode`"],["Type","`'auto' | 'all' | 'thin' | 'rotate' | 'none'`"],["Default","`undefined`"],["Allowed values","`none`, `auto`, `all`, `thin`, `rotate`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelRotation","title":"xLabelRotation","blocks":[{"kind":"paragraph","text":"Explicit category-label rotation in degrees (respected as a floor)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelRotation`"],["HTML attribute","`x-label-rotation`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xLabelMaxCount","title":"xLabelMaxCount","blocks":[{"kind":"paragraph","text":"Hard cap on the number of category labels shown."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xLabelMaxCount`"],["HTML attribute","`x-label-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-valueAxisLabel","title":"valueAxisLabel","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`valueAxisLabel`"],["HTML attribute","`value-axis-label`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput | ReadonlyArray<CartesianAxisInput>`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot. `true`/`'auto'` enables a snapping line; pass an object to set mode/snap/color/dash."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. The icon bands re-project through the zoomed frame; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: PictorialChartPointerEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: PictorialChartPointerEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration (matches the line/area/column family). Pass an object to set `show`/`mode`/`side`/`format`/`html`/`style`/`connector`/`draggable`/`interactive`/`trigger`/`openMode`. The legacy `tooltipEnabled`/`tooltipFormat` props remain the fallback when `tooltip` is omitted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`PictorialChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/PictorialChartEasing","title":"PictorialChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`PictorialChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartAnimationType","title":"PictorialChartAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`PictorialChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartStreamSource","title":"PictorialChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`PictorialChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/PictorialChartEngineMode","title":"PictorialChartEngineMode","description":"Type definition"}]}]},{"id":"property-proThreshold","title":"proThreshold","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`proThreshold`"],["HTML attribute","`pro-threshold`"],["Type","`number`"],["Default","`50_000`"]]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`PictorialChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/PictorialChartUnavailableBehaviour","title":"PictorialChartUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PictorialChartRenderResult & { tier: PictorialChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // PictorialChartRenderResult & { tier: PictorialChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PictorialChartRenderResult","title":"PictorialChartRenderResult","description":"Type definition"},{"path":"/docs/types/PictorialChartEngineTier","title":"PictorialChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PictorialChartPointerEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // PictorialChartPointerEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: PictorialChartPointerEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<PictorialChartPointerEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // PictorialChartPointerEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<PictorialChartPointerEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<PictorialChartPointerEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<PictorialChartPointerEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-seriesOutsideClick","title":"seriesOutsideClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianSeriesOutsideClickEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `seriesOutsideClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianSeriesOutsideClickEventDetail>`."},{"kind":"code","source":"chart.addEventListener('seriesOutsideClick', event => {\n  console.log(event.detail); // CartesianSeriesOutsideClickEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<PictorialChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PictorialChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartRenderResult","title":"PictorialChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<PictorialChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PictorialChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartEngineTier","title":"PictorialChartEngineTier","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(values: PictorialChartValues): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`PictorialChartValues`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartValues","title":"PictorialChartValues","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: PictorialBarDatum | number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`PictorialBarDatum | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialBarDatum","title":"PictorialBarDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: ReadonlyArray<PictorialBarDatum | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<PictorialBarDatum | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialBarDatum","title":"PictorialBarDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: ReadonlyArray<PictorialBarDatum | number>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ReadonlyArray<PictorialBarDatum | number>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialBarDatum","title":"PictorialBarDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<PictorialChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<PictorialChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartStreamSource","title":"PictorialChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: PictorialChartEasing; enabled?: boolean; type?: PictorialChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: PictorialChartEasing; enabled?: boolean; type?: PictorialChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartEasing","title":"PictorialChartEasing","description":"Type definition"},{"path":"/docs/types/PictorialChartAnimationType","title":"PictorialChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<PictorialChartPointerEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<PictorialChartPointerEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/item","title":"Item","summary":"Show counts with repeated symbols.","kind":"component","tag":"sy-item-chart","componentId":"item","api":{"props":[{"name":"values","attribute":"values","type":"ItemChartValues","kind":"property","values":[],"default":"[]","description":"An array of { name, value, color? }. value is the symbol count."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"palette","attribute":"palette","type":"ItemChartPaletteName","kind":"string","values":["tableau10","tableau20","observable10","paired12","set3_12"],"default":"'tableau10'","description":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"name":"symbol","attribute":"symbol","type":"ItemChartSymbol","kind":"string","values":["circle","square","diamond"],"default":"'circle'","description":"circle, square, or diamond."},{"name":"rows","attribute":"rows","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit concentric ring count; auto (smallest that fits) when unset."},{"name":"itemPadding","attribute":"item-padding","type":"number","kind":"number","values":[],"default":"0.1","description":"0..0.9 — fraction of each cell kept as whitespace around its dot (Highcharts itemPadding)."},{"name":"startAngle","attribute":"start-angle","type":"number","kind":"number","values":[],"default":"-100","description":"Degrees, 0 = 12 o'clock, clockwise. Default −100…100 = parliament hemicycle."},{"name":"endAngle","attribute":"end-angle","type":"number","kind":"number","values":[],"default":"100","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"innerSize","attribute":"inner-size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Central hole — px or `%` of the outer radius (Highcharts innerSize)."},{"name":"size","attribute":"size","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerX","attribute":"center-x","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"centerY","attribute":"center-y","type":"number | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: number | string."},{"name":"minSize","attribute":"min-size","type":"number","kind":"number","values":[],"default":"80","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"centerText","attribute":"center-text","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"centerSubtext","attribute":"center-subtext","type":"string","kind":"string","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"legendPosition","attribute":"legend-position","type":"ItemChartLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Edge to dock the legend on, or `float` — an overlay inside the seats' drawing rectangle (Storybook parity, 2026-09-10)."},{"name":"legendItems","attribute":"legend-items","type":"LegendItem[]","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: LegendItem[]."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(party: ItemChartResolvedParty) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (party: ItemChartResolvedParty) => string."},{"name":"tooltip","attribute":"tooltip","type":"ItemChartTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration object — the party-flavoured counterpart of the pie `.tooltip` API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat `tooltip-show` / `tooltipFormat` props. Property-only."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (Storybook parity, 2026-09-10) — the shared zoom surface as a VIEWPORT zoom: the seats' drawing rectangle (the chart box minus the title and legend bands) is the plot, x 0 → 1 left to right and y 0 → 1 bottom to top. `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`); an object refines the switches. Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless."},{"name":"engine","attribute":"engine","type":"ItemChartEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"ItemChartUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"ItemChartStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ItemChartEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ItemChartAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<ItemChartRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<ItemChartEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addParty","parameters":[{"name":"datum","type":"ItemChartDatum","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Item-only — add a party (datum) to the parliament."},{"name":"removeParty","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Item-only — remove a party by id, name, or index."},{"name":"updateParty","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<Exclude<ItemChartDatum, number>>","optional":false}],"returns":"Promise<boolean>","description":"Item-only — patch a party's datum fields."},{"name":"setPartySeats","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"value","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Item-only — set a party's seat count."},{"name":"appendPoint","parameters":[{"name":"datum","type":"ItemChartDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"datums","type":"ReadonlyArray<ItemChartDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"datums","type":"ReadonlyArray<ItemChartDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ItemChartStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: ItemChartEasing; enabled?: boolean; type?: ItemChartAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial angular-wipe reveal. No-op when animation is off."},{"name":"hitTestSeat","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>","description":"Item-only — hit-test the seat dot at canvas-relative coordinates."},{"name":"showTooltipAtParty","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<ItemChartPointEventDetail | null>","description":"Item-only — programmatic tooltip open on a party."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit viewport windows: `x` / `y` as `{ min, max }` or `[min, max]` over 0..1 (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by viewport units (`{ x?, y? }`, 1 = the whole drawing); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0..1 on both orientations, key `'0'`)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"ItemChartRenderResult & { tier: ItemChartEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"ItemChartPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"ItemChartPointEventDetail | null","description":"CustomEvent.detail type: ItemChartPointEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<ItemChartPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ItemChartPointEventDetail>. Event names are case-sensitive."},{"name":"legendItemClick","type":"{ index: number; partyId: string; label: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; partyId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"name":"pointToggled","type":"{ index: number; seriesId: string; disabled: boolean }","description":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"ItemChartTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"ItemChartTooltipActionEventDetail","description":"CustomEvent.detail type: ItemChartTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new viewport windows."}]},"sections":[{"id":"overview","title":"sy-item-chart","blocks":[{"kind":"paragraph","text":"Represent whole-number counts such as seats, people, or individual items."},{"kind":"paragraph","text":"Not suitable for precise fractional comparisons. Explain what each symbol represents."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","An array of { name, value, color? }. value is the symbol count."],["`symbol`","circle, square, or diamond."]]},{"kind":"links","items":[{"path":"/charts/item","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-item-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-item-chart\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [\n          {\n            \"name\": \"Product A\",\n            \"value\": 42,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"name\": \"Product B\",\n            \"value\": 28,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"name\": \"Product C\",\n            \"value\": 18,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"name\": \"Other\",\n            \"value\": 12,\n            \"color\": \"#d76c8f\"\n          }\n        ],\n        \"legend\": true,\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'item example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"An array of { name, value, color? }. value is the symbol count."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ItemChartValues`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/ItemChartValues","title":"ItemChartValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-palette","title":"palette","blocks":[{"kind":"paragraph","text":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`palette`"],["HTML attribute","`palette`"],["Type","`ItemChartPaletteName`"],["Default","`'tableau10'`"],["Allowed values","`tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12`"]]},{"kind":"links","items":[{"path":"/docs/types/ItemChartPaletteName","title":"ItemChartPaletteName","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-symbol","title":"symbol","blocks":[{"kind":"paragraph","text":"circle, square, or diamond."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`symbol`"],["HTML attribute","`symbol`"],["Type","`ItemChartSymbol`"],["Default","`'circle'`"],["Allowed values","`circle`, `square`, `diamond`"]]},{"kind":"links","items":[{"path":"/docs/types/ItemChartSymbol","title":"ItemChartSymbol","description":"Type definition"}]}]},{"id":"property-rows","title":"rows","blocks":[{"kind":"paragraph","text":"Explicit concentric ring count; auto (smallest that fits) when unset."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rows`"],["HTML attribute","`rows`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-itemPadding","title":"itemPadding","blocks":[{"kind":"paragraph","text":"0..0.9 — fraction of each cell kept as whitespace around its dot (Highcharts itemPadding)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`itemPadding`"],["HTML attribute","`item-padding`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-startAngle","title":"startAngle","blocks":[{"kind":"paragraph","text":"Degrees, 0 = 12 o'clock, clockwise. Default −100…100 = parliament hemicycle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startAngle`"],["HTML attribute","`start-angle`"],["Type","`number`"],["Default","`-100`"]]}]},{"id":"property-endAngle","title":"endAngle","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`endAngle`"],["HTML attribute","`end-angle`"],["Type","`number`"],["Default","`100`"]]}]},{"id":"property-innerSize","title":"innerSize","blocks":[{"kind":"paragraph","text":"Central hole — px or `%` of the outer radius (Highcharts innerSize)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`innerSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-size","title":"size","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`size`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerX","title":"centerX","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerX`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerY","title":"centerY","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerY`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-minSize","title":"minSize","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minSize`"],["HTML attribute","`min-size`"],["Type","`number`"],["Default","`80`"]]}]},{"id":"property-centerText","title":"centerText","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerText`"],["HTML attribute","`center-text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-centerSubtext","title":"centerSubtext","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`centerSubtext`"],["HTML attribute","`center-subtext`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Edge to dock the legend on, or `float` — an overlay inside the seats' drawing rectangle (Storybook parity, 2026-09-10)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`ItemChartLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/ItemChartLegendPosition","title":"ItemChartLegendPosition","description":"Type definition"}]}]},{"id":"property-legendItems","title":"legendItems","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: LegendItem[]."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendItems`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`LegendItem[]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":"Type definition"}]}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (party: ItemChartResolvedParty) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(party: ItemChartResolvedParty) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ItemChartResolvedParty","title":"ItemChartResolvedParty","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration object — the party-flavoured counterpart of the pie `.tooltip` API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat `tooltip-show` / `tooltipFormat` props. Property-only."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ItemChartTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipInput","title":"ItemChartTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (Storybook parity, 2026-09-10) — the shared zoom surface as a VIEWPORT zoom: the seats' drawing rectangle (the chart box minus the title and legend bands) is the plot, x 0 → 1 left to right and y 0 → 1 bottom to top. `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`); an object refines the switches. Off by default; `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ItemChartEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ItemChartEngineMode","title":"ItemChartEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ItemChartUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/ItemChartUnavailableBehaviour","title":"ItemChartUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ItemChartStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ItemChartStreamSource","title":"ItemChartStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ItemChartEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ItemChartEasing","title":"ItemChartEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ItemChartAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ItemChartAnimationType","title":"ItemChartAnimationType","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ItemChartRenderResult & { tier: ItemChartEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ItemChartRenderResult & { tier: ItemChartEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ItemChartRenderResult","title":"ItemChartRenderResult","description":"Type definition"},{"path":"/docs/types/ItemChartEngineTier","title":"ItemChartEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ItemChartPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // ItemChartPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ItemChartPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ItemChartPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // ItemChartPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ItemChartPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<ItemChartPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<ItemChartPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","description":"Type definition"}]}]},{"id":"event-legendItemClick","title":"legendItemClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; partyId: string; label: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `legendItemClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; partyId: string; label: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('legendItemClick', event => {\n  console.log(event.detail); // { index: number; partyId: string; label: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-pointToggled","title":"pointToggled","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { index: number; seriesId: string; disabled: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointToggled`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; seriesId: string; disabled: boolean }>`."},{"kind":"code","source":"chart.addEventListener('pointToggled', event => {\n  console.log(event.detail); // { index: number; seriesId: string; disabled: boolean }\n});","language":"javascript"}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ItemChartTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // ItemChartTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipShowEventDetail","title":"ItemChartTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ItemChartTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ItemChartTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // ItemChartTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipActionEventDetail","title":"ItemChartTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new viewport windows."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ItemChartRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ItemChartRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartRenderResult","title":"ItemChartRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<ItemChartEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ItemChartEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartEngineTier","title":"ItemChartEngineTier","description":"Type definition"}]}]},{"id":"method-addParty","title":"addParty","blocks":[{"kind":"paragraph","text":"Item-only — add a party (datum) to the parliament."},{"kind":"code","source":"addParty(datum: ItemChartDatum, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`ItemChartDatum`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":"Type definition"}]}]},{"id":"method-removeParty","title":"removeParty","blocks":[{"kind":"paragraph","text":"Item-only — remove a party by id, name, or index."},{"kind":"code","source":"removeParty(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateParty","title":"updateParty","blocks":[{"kind":"paragraph","text":"Item-only — patch a party's datum fields."},{"kind":"code","source":"updateParty(idOrIndex: string | number, patch: Partial<Exclude<ItemChartDatum, number>>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<Exclude<ItemChartDatum, number>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":"Type definition"}]}]},{"id":"method-setPartySeats","title":"setPartySeats","blocks":[{"kind":"paragraph","text":"Item-only — set a party's seat count."},{"kind":"code","source":"setPartySeats(idOrIndex: string | number, value: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: ItemChartDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`ItemChartDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(datums: ReadonlyArray<ItemChartDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<ItemChartDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(datums: ReadonlyArray<ItemChartDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<ItemChartDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ItemChartStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ItemChartStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartStreamSource","title":"ItemChartStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: ItemChartEasing; enabled?: boolean; type?: ItemChartAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: ItemChartEasing; enabled?: boolean; type?: ItemChartAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartEasing","title":"ItemChartEasing","description":"Type definition"},{"path":"/docs/types/ItemChartAnimationType","title":"ItemChartAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial angular-wipe reveal. No-op when animation is off."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestSeat","title":"hitTestSeat","blocks":[{"kind":"paragraph","text":"Item-only — hit-test the seat dot at canvas-relative coordinates."},{"kind":"code","source":"hitTestSeat(cssX: number, cssY: number): Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ partyIndex: number; partyId: string; seatIndex: number; seatInParty: number } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtParty","title":"showTooltipAtParty","blocks":[{"kind":"paragraph","text":"Item-only — programmatic tooltip open on a party."},{"kind":"code","source":"showTooltipAtParty(idOrIndex: string | number): Promise<ItemChartPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ItemChartPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit viewport windows: `x` / `y` as `{ min, max }` or `[min, max]` over 0..1 (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by viewport units (`{ x?, y? }`, 1 = the whole drawing); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0..1 on both orientations, key `'0'`)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/word-cloud","title":"Word Cloud","summary":"Represent word weights through text size.","kind":"component","tag":"sy-word-cloud","componentId":"word-cloud","api":{"props":[{"name":"values","attribute":"values","type":"WordCloudValues","kind":"property","values":[],"default":"[]","description":"An array of [word, weight] or { name, weight }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"palette","attribute":"palette","type":"WordCloudPaletteName","kind":"string","values":["tableau10","tableau20","observable10","paired12","set3_12"],"default":"'tableau10'","description":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"name":"minFontSize","attribute":"min-font-size","type":"number","kind":"number","values":[],"default":"10","description":"Smallest rendered font in px (Highcharts `minFontSize`)."},{"name":"maxFontSize","attribute":"max-font-size","type":"number","kind":"number","values":[],"default":"44","description":"Font of the heaviest word in px (Highcharts `maxFontSize`)."},{"name":"weightScale","attribute":"weight-scale","type":"WordCloudWeightScale","kind":"string","values":["linear","sqrt","log"],"default":"'linear'","description":"The scale converting weights to text sizes."},{"name":"spiral","attribute":"spiral","type":"WordCloudSpiral","kind":"string","values":["rectangular","archimedean"],"default":"'rectangular'","description":"Spiral search pattern; `rectangular` = Highcharts default."},{"name":"orientations","attribute":"orientations","type":"number","kind":"number","values":[],"default":"2","description":"Number of distinct orientations in the rotation cycle (Highcharts `rotation.orientations`)."},{"name":"rotationFrom","attribute":"rotation-from","type":"number","kind":"number","values":[],"default":"0","description":"Rotation cycle start in degrees (Highcharts `rotation.from`)."},{"name":"rotationTo","attribute":"rotation-to","type":"number","kind":"number","values":[],"default":"90","description":"Rotation cycle end in degrees (Highcharts `rotation.to`)."},{"name":"wordPadding","attribute":"word-padding","type":"number","kind":"number","values":[],"default":"2","description":"Empty px kept between word boxes."},{"name":"fontFamily","attribute":"font-family","type":"string","kind":"string","values":[],"default":"'system-ui, sans-serif'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"fontWeight","attribute":"font-weight","type":"string","kind":"string","values":[],"default":"'600'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(word: WordCloudResolvedWord) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (word: WordCloudResolvedWord) => string."},{"name":"tooltip","attribute":"tooltip","type":"WordCloudTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration object — the word-flavoured counterpart of the item `.tooltip` API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat `tooltip-show` / `tooltipFormat` props. Property-only."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Viewport zoom — the `zoom` attribute the cartesian charts carry: a mode (`'x'` | `'y'` | `'xy'`), `true` (x) or an object; off by default. The drawing rectangle (the cloud below the title band) is the plot — x runs 0 → 1 left to right, y 0 → 1 bottom to top — and the words are magnified into the window; words outside it leave the rectangle. Property-only (a mode string also works as an attribute)."},{"name":"engine","attribute":"engine","type":"WordCloudEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"WordCloudUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"WordCloudStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"WordCloudEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"WordCloudAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<WordCloudRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<WordCloudEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addWord","parameters":[{"name":"datum","type":"WordCloudDatum","optional":false},{"name":"opts","type":"{ insertAt?: number }","optional":true}],"returns":"Promise<number>","description":"Word-cloud-only — add a word datum."},{"name":"removeWord","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<boolean>","description":"Word-cloud-only — remove a word by id, name, or index."},{"name":"updateWord","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"patch","type":"Partial<Exclude<WordCloudDatum, readonly [string, number]>>","optional":false}],"returns":"Promise<boolean>","description":"Word-cloud-only — patch a word's datum fields."},{"name":"setWordWeight","parameters":[{"name":"idOrIndex","type":"string | number","optional":false},{"name":"weight","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Word-cloud-only — set a word's weight."},{"name":"appendPoint","parameters":[{"name":"datum","type":"WordCloudDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"datums","type":"ReadonlyArray<WordCloudDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drops the LIGHTEST words (a cloud has no timeline; \"oldest\" is meaningless)."},{"name":"replace","parameters":[{"name":"datums","type":"ReadonlyArray<WordCloudDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<WordCloudStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: WordCloudEasing; enabled?: boolean; type?: WordCloudAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial staggered reveal. No-op when animation is off."},{"name":"hitTestWord","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ index: number; id: string; name: string } | null>","description":"The word under a host px position (the zoomed view is honoured: the point is taken back to the layout first)."},{"name":"getDroppedWords","parameters":[],"returns":"Promise<Array<{ index: number; id: string; name: string; weight: number }>>","description":"Words the spiral could not fit (diagnostics parity with the layout core)."},{"name":"showTooltipAtWord","parameters":[{"name":"idOrIndex","type":"string | number","optional":false}],"returns":"Promise<WordCloudPointEventDetail | null>","description":"Word-cloud-only — programmatic tooltip open on a word."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` over 0..1; `null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by a fraction of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent of the drawing (0..1 on both orientations, the id-less slot key)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"WordCloudRenderResult & { tier: WordCloudEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"WordCloudPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"WordCloudPointEventDetail | null","description":"CustomEvent.detail type: WordCloudPointEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<WordCloudPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<WordCloudPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"WordCloudTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"WordCloudTooltipActionEventDetail","description":"CustomEvent.detail type: WordCloudTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset)."}]},"sections":[{"id":"overview","title":"sy-word-cloud","blocks":[{"kind":"paragraph","text":"Use for a quick overview of keyword frequency and topics."},{"kind":"paragraph","text":"Word length also affects perceived size. Use a table for exact rankings and values."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","An array of [word, weight] or { name, weight }."],["`weightScale`","The scale converting weights to text sizes."]]},{"kind":"links","items":[{"path":"/charts/word-cloud","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-word-cloud.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-word-cloud\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [\n          [\"Data\", 40],\n          [\"Design\", 32],\n          [\"chart\", 28],\n          [\"Usability\", 24],\n          [\"Analysis\", 20],\n          [\"Trust\", 18],\n          [\"Collaboration\", 16],\n          [\"Accessibility\", 14],\n          [\"Performance\", 12]\n        ],\n        \"weightScale\": \"sqrt\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'word-cloud example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"An array of [word, weight] or { name, weight }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WordCloudValues`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/WordCloudValues","title":"WordCloudValues","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-palette","title":"palette","blocks":[{"kind":"paragraph","text":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`palette`"],["HTML attribute","`palette`"],["Type","`WordCloudPaletteName`"],["Default","`'tableau10'`"],["Allowed values","`tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12`"]]},{"kind":"links","items":[{"path":"/docs/types/WordCloudPaletteName","title":"WordCloudPaletteName","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-minFontSize","title":"minFontSize","blocks":[{"kind":"paragraph","text":"Smallest rendered font in px (Highcharts `minFontSize`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minFontSize`"],["HTML attribute","`min-font-size`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-maxFontSize","title":"maxFontSize","blocks":[{"kind":"paragraph","text":"Font of the heaviest word in px (Highcharts `maxFontSize`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`maxFontSize`"],["HTML attribute","`max-font-size`"],["Type","`number`"],["Default","`44`"]]}]},{"id":"property-weightScale","title":"weightScale","blocks":[{"kind":"paragraph","text":"The scale converting weights to text sizes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`weightScale`"],["HTML attribute","`weight-scale`"],["Type","`WordCloudWeightScale`"],["Default","`'linear'`"],["Allowed values","`linear`, `sqrt`, `log`"]]},{"kind":"links","items":[{"path":"/docs/types/WordCloudWeightScale","title":"WordCloudWeightScale","description":"Type definition"}]}]},{"id":"property-spiral","title":"spiral","blocks":[{"kind":"paragraph","text":"Spiral search pattern; `rectangular` = Highcharts default."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`spiral`"],["HTML attribute","`spiral`"],["Type","`WordCloudSpiral`"],["Default","`'rectangular'`"],["Allowed values","`rectangular`, `archimedean`"]]},{"kind":"links","items":[{"path":"/docs/types/WordCloudSpiral","title":"WordCloudSpiral","description":"Type definition"}]}]},{"id":"property-orientations","title":"orientations","blocks":[{"kind":"paragraph","text":"Number of distinct orientations in the rotation cycle (Highcharts `rotation.orientations`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientations`"],["HTML attribute","`orientations`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-rotationFrom","title":"rotationFrom","blocks":[{"kind":"paragraph","text":"Rotation cycle start in degrees (Highcharts `rotation.from`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rotationFrom`"],["HTML attribute","`rotation-from`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-rotationTo","title":"rotationTo","blocks":[{"kind":"paragraph","text":"Rotation cycle end in degrees (Highcharts `rotation.to`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rotationTo`"],["HTML attribute","`rotation-to`"],["Type","`number`"],["Default","`90`"]]}]},{"id":"property-wordPadding","title":"wordPadding","blocks":[{"kind":"paragraph","text":"Empty px kept between word boxes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wordPadding`"],["HTML attribute","`word-padding`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-fontFamily","title":"fontFamily","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fontFamily`"],["HTML attribute","`font-family`"],["Type","`string`"],["Default","`'system-ui, sans-serif'`"]]}]},{"id":"property-fontWeight","title":"fontWeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fontWeight`"],["HTML attribute","`font-weight`"],["Type","`string`"],["Default","`'600'`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (word: WordCloudResolvedWord) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(word: WordCloudResolvedWord) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WordCloudResolvedWord","title":"WordCloudResolvedWord","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration object — the word-flavoured counterpart of the item `.tooltip` API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat `tooltip-show` / `tooltipFormat` props. Property-only."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WordCloudTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipInput","title":"WordCloudTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Viewport zoom — the `zoom` attribute the cartesian charts carry: a mode (`'x'` | `'y'` | `'xy'`), `true` (x) or an object; off by default. The drawing rectangle (the cloud below the title band) is the plot — x runs 0 → 1 left to right, y 0 → 1 bottom to top — and the words are magnified into the window; words outside it leave the rectangle. Property-only (a mode string also works as an attribute)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`WordCloudEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/WordCloudEngineMode","title":"WordCloudEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`WordCloudUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/WordCloudUnavailableBehaviour","title":"WordCloudUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WordCloudStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WordCloudStreamSource","title":"WordCloudStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`WordCloudEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/WordCloudEasing","title":"WordCloudEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`WordCloudAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WordCloudAnimationType","title":"WordCloudAnimationType","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WordCloudRenderResult & { tier: WordCloudEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // WordCloudRenderResult & { tier: WordCloudEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WordCloudRenderResult","title":"WordCloudRenderResult","description":"Type definition"},{"path":"/docs/types/WordCloudEngineTier","title":"WordCloudEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WordCloudPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // WordCloudPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: WordCloudPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WordCloudPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // WordCloudPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<WordCloudPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<WordCloudPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<WordCloudPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WordCloudTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // WordCloudTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipShowEventDetail","title":"WordCloudTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: WordCloudTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WordCloudTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // WordCloudTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipActionEventDetail","title":"WordCloudTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset)."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<WordCloudRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WordCloudRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudRenderResult","title":"WordCloudRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<WordCloudEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WordCloudEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudEngineTier","title":"WordCloudEngineTier","description":"Type definition"}]}]},{"id":"method-addWord","title":"addWord","blocks":[{"kind":"paragraph","text":"Word-cloud-only — add a word datum."},{"kind":"code","source":"addWord(datum: WordCloudDatum, opts?: { insertAt?: number }): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`WordCloudDatum`","Required"],["`opts`","`{ insertAt?: number }`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":"Type definition"}]}]},{"id":"method-removeWord","title":"removeWord","blocks":[{"kind":"paragraph","text":"Word-cloud-only — remove a word by id, name, or index."},{"kind":"code","source":"removeWord(idOrIndex: string | number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateWord","title":"updateWord","blocks":[{"kind":"paragraph","text":"Word-cloud-only — patch a word's datum fields."},{"kind":"code","source":"updateWord(idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`patch`","`Partial<Exclude<WordCloudDatum, readonly [string, number]>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":"Type definition"}]}]},{"id":"method-setWordWeight","title":"setWordWeight","blocks":[{"kind":"paragraph","text":"Word-cloud-only — set a word's weight."},{"kind":"code","source":"setWordWeight(idOrIndex: string | number, weight: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"],["`weight`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: WordCloudDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`WordCloudDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(datums: ReadonlyArray<WordCloudDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<WordCloudDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drops the LIGHTEST words (a cloud has no timeline; \"oldest\" is meaningless)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(datums: ReadonlyArray<WordCloudDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<WordCloudDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<WordCloudStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WordCloudStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudStreamSource","title":"WordCloudStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: WordCloudEasing; enabled?: boolean; type?: WordCloudAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: WordCloudEasing; enabled?: boolean; type?: WordCloudAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudEasing","title":"WordCloudEasing","description":"Type definition"},{"path":"/docs/types/WordCloudAnimationType","title":"WordCloudAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial staggered reveal. No-op when animation is off."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestWord","title":"hitTestWord","blocks":[{"kind":"paragraph","text":"The word under a host px position (the zoomed view is honoured: the point is taken back to the layout first)."},{"kind":"code","source":"hitTestWord(cssX: number, cssY: number): Promise<{ index: number; id: string; name: string } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ index: number; id: string; name: string } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDroppedWords","title":"getDroppedWords","blocks":[{"kind":"paragraph","text":"Words the spiral could not fit (diagnostics parity with the layout core)."},{"kind":"code","source":"getDroppedWords(): Promise<Array<{ index: number; id: string; name: string; weight: number }>>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Array<{ index: number; id: string; name: string; weight: number }>>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtWord","title":"showTooltipAtWord","blocks":[{"kind":"paragraph","text":"Word-cloud-only — programmatic tooltip open on a word."},{"kind":"code","source":"showTooltipAtWord(idOrIndex: string | number): Promise<WordCloudPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrIndex`","`string | number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WordCloudPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` over 0..1; `null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by a fraction of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent of the drawing (0..1 on both orientations, the id-less slot key)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/tilemap","title":"Tilemap","summary":"Compare locations and values using equally sized tiles.","kind":"component","tag":"sy-tilemap","componentId":"tilemap","api":{"props":[{"name":"data","attribute":"data","type":"TilemapData","kind":"property","values":[],"default":"[]","description":"An array of { x, y, value?, name?, label? }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"420","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"palette","attribute":"palette","type":"TilemapPaletteName","kind":"string","values":["tableau10","tableau20","observable10","paired12","set3_12"],"default":"'tableau10'","description":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"name":"tileShape","attribute":"tile-shape","type":"TilemapTileShape","kind":"string","values":["circle","square","diamond","hexagon"],"default":"'hexagon'","description":"The tile shape."},{"name":"gap","attribute":"gap","type":"number","kind":"number","values":[],"default":"2","description":"Empty px kept between tiles."},{"name":"showLabels","attribute":"show-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Render each tile's `label` (falling back to `name`) inside the tile when it fits."},{"name":"colorAxis","attribute":"color-axis","type":"TilemapColorAxisInput","kind":"property","values":["auto"],"default":"undefined","description":"Continuous values can use an auto color axis."},{"name":"colorLegend","attribute":"color-legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the colour-axis gradient legend under the map (on while the axis is on)."},{"name":"legendPosition","attribute":"legend-position","type":"TilemapLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Storybook parity (2026-09-10) — where the colour legend sits: docked on an edge of the map (`top` / `bottom` / `left` / `right`; the band is taken off the map) or `float` — an overlay box inside the drawing rectangle anchored by `legend-float-align` / `legend-float-vertical-align`. The line chart's legend contract."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"name":"labelColor","attribute":"label-color","type":"string","kind":"string","values":[],"default":"'#ffffff'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to display the built-in tooltip."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(tile: TilemapResolvedTile) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (tile: TilemapResolvedTile) => string."},{"name":"tooltip","attribute":"tooltip","type":"TilemapTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Rich tooltip configuration object — the tile-flavoured counterpart of the item `.tooltip` API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat `tooltip-show` / `tooltipFormat` props. Property-only."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Viewport zoom — the `zoom` attribute the cartesian charts carry: a mode (`'x'` | `'y'` | `'xy'`), `true` (x) or an object; off by default. The drawing rectangle (the map between the title band and the colour legend) is the plot — x runs 0 → 1 left to right, y 0 → 1 bottom to top — and the tiles are magnified into the window; tiles outside it leave the rectangle. Property-only (a mode string also works as an attribute)."},{"name":"engine","attribute":"engine","type":"TilemapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"TilemapUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"name":"streamSource","attribute":"stream-source","type":"TilemapStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"TilemapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"TilemapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<TilemapRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<TilemapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"addTile","parameters":[{"name":"datum","type":"TilemapDatum","optional":false}],"returns":"Promise<number>","description":"Tilemap-only — append a tile datum (occupied cells update in place)."},{"name":"removeTile","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false}],"returns":"Promise<boolean>","description":"Tilemap-only — remove a tile by id, name, index, or `{x, y}` cell."},{"name":"updateTile","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false},{"name":"patch","type":"Partial<TilemapDatum>","optional":false}],"returns":"Promise<boolean>","description":"Tilemap-only — patch a tile's datum fields."},{"name":"setTileValue","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false},{"name":"value","type":"number","optional":false}],"returns":"Promise<boolean>","description":"Tilemap-only — set a tile's metric value."},{"name":"appendPoint","parameters":[{"name":"datum","type":"TilemapDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"datums","type":"ReadonlyArray<TilemapDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<void>","description":"Drops the OLDEST tiles (insertion order — a map has no value ranking)."},{"name":"replace","parameters":[{"name":"datums","type":"ReadonlyArray<TilemapDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<TilemapStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: TilemapEasing; enabled?: boolean; type?: TilemapAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial staggered reveal. No-op when animation is off."},{"name":"hitTestTile","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ index: number; id: string; col: number; row: number; name: string } | null>","description":"The tile under a host px position (the zoomed view is honoured: the point is taken back to the layout first)."},{"name":"showTooltipAtTile","parameters":[{"name":"idOrCell","type":"string | number | { x: number; y: number }","optional":false}],"returns":"Promise<TilemapPointEventDetail | null>","description":"Tilemap-only — programmatic tooltip open on a tile."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` over 0..1; `null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by a fraction of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent of the drawing (0..1 on both orientations, the id-less slot key)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"TilemapRenderResult & { tier: TilemapEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"TilemapPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"TilemapPointEventDetail | null","description":"CustomEvent.detail type: TilemapPointEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<TilemapPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<TilemapPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number }","description":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipShow","type":"TilemapTooltipShowEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"TilemapTooltipActionEventDetail","description":"CustomEvent.detail type: TilemapTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset)."}]},"sections":[{"id":"overview","title":"sy-tilemap","blocks":[{"kind":"paragraph","text":"Show administrative or logical regions in a normalized layout."},{"kind":"paragraph","text":"Tile coordinates do not represent actual geographic area or distance. Explain what the layout means."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { x, y, value?, name?, label? }."],["`tileShape`","The tile shape."],["`colorAxis`","Continuous values can use an auto color axis."]]},{"kind":"links","items":[{"path":"/charts/tilemap","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-tilemap.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-tilemap\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"data\": [\n          {\n            \"x\": 0,\n            \"y\": 0,\n            \"name\": \"Zone 1\",\n            \"label\": \"1\",\n            \"value\": 20\n          },\n          {\n            \"x\": 1,\n            \"y\": 0,\n            \"name\": \"Zone 2\",\n            \"label\": \"2\",\n            \"value\": 33\n          },\n          {\n            \"x\": 2,\n            \"y\": 0,\n            \"name\": \"Zone 3\",\n            \"label\": \"3\",\n            \"value\": 46\n          },\n          {\n            \"x\": 3,\n            \"y\": 0,\n            \"name\": \"Zone 4\",\n            \"label\": \"4\",\n            \"value\": 59\n          },\n          {\n            \"x\": 4,\n            \"y\": 0,\n            \"name\": \"Zone 5\",\n            \"label\": \"5\",\n            \"value\": 72\n          },\n          {\n            \"x\": 0,\n            \"y\": 1,\n            \"name\": \"Zone 6\",\n            \"label\": \"6\",\n            \"value\": 85\n          },\n          {\n            \"x\": 1,\n            \"y\": 1,\n            \"name\": \"Zone 7\",\n            \"label\": \"7\",\n            \"value\": 98\n          },\n          {\n            \"x\": 2,\n            \"y\": 1,\n            \"name\": \"Zone 8\",\n            \"label\": \"8\",\n            \"value\": 31\n          },\n          {\n            \"x\": 3,\n            \"y\": 1,\n            \"name\": \"Zone 9\",\n            \"label\": \"9\",\n            \"value\": 44\n          },\n          {\n            \"x\": 4,\n            \"y\": 1,\n            \"name\": \"Zone 10\",\n            \"label\": \"10\",\n            \"value\": 57\n          },\n          {\n            \"x\": 0,\n            \"y\": 2,\n            \"name\": \"Zone 11\",\n            \"label\": \"11\",\n            \"value\": 70\n          },\n          {\n            \"x\": 1,\n            \"y\": 2,\n            \"name\": \"Zone 12\",\n            \"label\": \"12\",\n            \"value\": 83\n          },\n          {\n            \"x\": 2,\n            \"y\": 2,\n            \"name\": \"Zone 13\",\n            \"label\": \"13\",\n            \"value\": 96\n          },\n          {\n            \"x\": 3,\n            \"y\": 2,\n            \"name\": \"Zone 14\",\n            \"label\": \"14\",\n            \"value\": 29\n          },\n          {\n            \"x\": 4,\n            \"y\": 2,\n            \"name\": \"Zone 15\",\n            \"label\": \"15\",\n            \"value\": 42\n          },\n          {\n            \"x\": 0,\n            \"y\": 3,\n            \"name\": \"Zone 16\",\n            \"label\": \"16\",\n            \"value\": 55\n          },\n          {\n            \"x\": 1,\n            \"y\": 3,\n            \"name\": \"Zone 17\",\n            \"label\": \"17\",\n            \"value\": 68\n          },\n          {\n            \"x\": 2,\n            \"y\": 3,\n            \"name\": \"Zone 18\",\n            \"label\": \"18\",\n            \"value\": 81\n          },\n          {\n            \"x\": 3,\n            \"y\": 3,\n            \"name\": \"Zone 19\",\n            \"label\": \"19\",\n            \"value\": 94\n          },\n          {\n            \"x\": 4,\n            \"y\": 3,\n            \"name\": \"Zone 20\",\n            \"label\": \"20\",\n            \"value\": 27\n          }\n        ],\n        \"tileShape\": \"hexagon\",\n        \"colorAxis\": \"auto\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'tilemap example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { x, y, value?, name?, label? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TilemapData`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/TilemapData","title":"TilemapData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`420`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-palette","title":"palette","blocks":[{"kind":"paragraph","text":"Allowed values: tableau10, tableau20, observable10, paired12, set3_12. Default: 'tableau10'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`palette`"],["HTML attribute","`palette`"],["Type","`TilemapPaletteName`"],["Default","`'tableau10'`"],["Allowed values","`tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12`"]]},{"kind":"links","items":[{"path":"/docs/types/TilemapPaletteName","title":"TilemapPaletteName","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tileShape","title":"tileShape","blocks":[{"kind":"paragraph","text":"The tile shape."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tileShape`"],["HTML attribute","`tile-shape`"],["Type","`TilemapTileShape`"],["Default","`'hexagon'`"],["Allowed values","`circle`, `square`, `diamond`, `hexagon`"]]},{"kind":"links","items":[{"path":"/docs/types/TilemapTileShape","title":"TilemapTileShape","description":"Type definition"}]}]},{"id":"property-gap","title":"gap","blocks":[{"kind":"paragraph","text":"Empty px kept between tiles."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gap`"],["HTML attribute","`gap`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-showLabels","title":"showLabels","blocks":[{"kind":"paragraph","text":"Render each tile's `label` (falling back to `name`) inside the tile when it fits."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showLabels`"],["HTML attribute","`show-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-colorAxis","title":"colorAxis","blocks":[{"kind":"paragraph","text":"Continuous values can use an auto color axis."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TilemapColorAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TilemapColorAxisInput","title":"TilemapColorAxisInput","description":"Type definition"}]}]},{"id":"property-colorLegend","title":"colorLegend","blocks":[{"kind":"paragraph","text":"Show the colour-axis gradient legend under the map (on while the axis is on)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorLegend`"],["HTML attribute","`color-legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Storybook parity (2026-09-10) — where the colour legend sits: docked on an edge of the map (`top` / `bottom` / `left` / `right`; the band is taken off the map) or `float` — an overlay box inside the drawing rectangle anchored by `legend-float-align` / `legend-float-vertical-align`. The line chart's legend contract."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`TilemapLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/TilemapLegendPosition","title":"TilemapLegendPosition","description":"Type definition"}]}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-labelColor","title":"labelColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelColor`"],["HTML attribute","`label-color`"],["Type","`string`"],["Default","`'#ffffff'`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (tile: TilemapResolvedTile) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(tile: TilemapResolvedTile) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TilemapResolvedTile","title":"TilemapResolvedTile","description":"Type definition"}]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Rich tooltip configuration object — the tile-flavoured counterpart of the item `.tooltip` API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat `tooltip-show` / `tooltipFormat` props. Property-only."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TilemapTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipInput","title":"TilemapTooltipInput","description":"Type definition"}]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Viewport zoom — the `zoom` attribute the cartesian charts carry: a mode (`'x'` | `'y'` | `'xy'`), `true` (x) or an object; off by default. The drawing rectangle (the map between the title band and the colour legend) is the plot — x runs 0 → 1 left to right, y 0 → 1 bottom to top — and the tiles are magnified into the window; tiles outside it leave the rectangle. Property-only (a mode string also works as an attribute)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`TilemapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/TilemapEngineMode","title":"TilemapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`TilemapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/TilemapUnavailableBehaviour","title":"TilemapUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TilemapStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TilemapStreamSource","title":"TilemapStreamSource","description":"Type definition"}]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`TilemapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/TilemapEasing","title":"TilemapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`TilemapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TilemapAnimationType","title":"TilemapAnimationType","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TilemapRenderResult & { tier: TilemapEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // TilemapRenderResult & { tier: TilemapEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TilemapRenderResult","title":"TilemapRenderResult","description":"Type definition"},{"path":"/docs/types/TilemapEngineTier","title":"TilemapEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TilemapPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // TilemapPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: TilemapPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TilemapPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // TilemapPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<TilemapPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<TilemapPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<TilemapPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TilemapTooltipShowEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // TilemapTooltipShowEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipShowEventDetail","title":"TilemapTooltipShowEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: TilemapTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TilemapTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // TilemapTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipActionEventDetail","title":"TilemapTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset)."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<TilemapRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TilemapRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapRenderResult","title":"TilemapRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<TilemapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TilemapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapEngineTier","title":"TilemapEngineTier","description":"Type definition"}]}]},{"id":"method-addTile","title":"addTile","blocks":[{"kind":"paragraph","text":"Tilemap-only — append a tile datum (occupied cells update in place)."},{"kind":"code","source":"addTile(datum: TilemapDatum): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`TilemapDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":"Type definition"}]}]},{"id":"method-removeTile","title":"removeTile","blocks":[{"kind":"paragraph","text":"Tilemap-only — remove a tile by id, name, index, or `{x, y}` cell."},{"kind":"code","source":"removeTile(idOrCell: string | number | { x: number; y: number }): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateTile","title":"updateTile","blocks":[{"kind":"paragraph","text":"Tilemap-only — patch a tile's datum fields."},{"kind":"code","source":"updateTile(idOrCell: string | number | { x: number; y: number }, patch: Partial<TilemapDatum>): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"],["`patch`","`Partial<TilemapDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":"Type definition"}]}]},{"id":"method-setTileValue","title":"setTileValue","blocks":[{"kind":"paragraph","text":"Tilemap-only — set a tile's metric value."},{"kind":"code","source":"setTileValue(idOrCell: string | number | { x: number; y: number }, value: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"],["`value`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: TilemapDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`TilemapDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(datums: ReadonlyArray<TilemapDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<TilemapDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drops the OLDEST tiles (insertion order — a map has no value ranking)."},{"kind":"code","source":"shift(count?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(datums: ReadonlyArray<TilemapDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datums`","`ReadonlyArray<TilemapDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<TilemapStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TilemapStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapStreamSource","title":"TilemapStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: TilemapEasing; enabled?: boolean; type?: TilemapAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: TilemapEasing; enabled?: boolean; type?: TilemapAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapEasing","title":"TilemapEasing","description":"Type definition"},{"path":"/docs/types/TilemapAnimationType","title":"TilemapAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial staggered reveal. No-op when animation is off."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestTile","title":"hitTestTile","blocks":[{"kind":"paragraph","text":"The tile under a host px position (the zoomed view is honoured: the point is taken back to the layout first)."},{"kind":"code","source":"hitTestTile(cssX: number, cssY: number): Promise<{ index: number; id: string; col: number; row: number; name: string } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ index: number; id: string; col: number; row: number; name: string } | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtTile","title":"showTooltipAtTile","blocks":[{"kind":"paragraph","text":"Tilemap-only — programmatic tooltip open on a tile."},{"kind":"code","source":"showTooltipAtTile(idOrCell: string | number | { x: number; y: number }): Promise<TilemapPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`idOrCell`","`string | number | { x: number; y: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TilemapPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` over 0..1; `null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by a fraction of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent of the drawing (0..1 on both orientations, the id-less slot key)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/treemap","title":"Treemap","summary":"Represent hierarchical sizes as rectangle areas.","kind":"component","tag":"sy-treemap","componentId":"treemap","api":{"props":[{"name":"data","attribute":"data","type":"TreemapData","kind":"property","values":[],"default":"undefined","description":"An array of nodes as { id, label?, value?, children? }. Branch values are calculated from their children."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"3","description":"Inner spacing of each branch, in CSS pixels."},{"name":"drilldown","attribute":"drilldown","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"name":"headerHeight","attribute":"header-height","type":"number","kind":"number","values":[],"default":"18","description":"Reserved header band inside each branch, in CSS pixels."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"nodeLabels","attribute":"node-labels","type":"TreemapLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: TreemapHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: TreemapHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"TreemapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"TreemapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"TreemapStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"engine","attribute":"engine","type":"TreemapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"TreemapUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<TreemapRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<TreemapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"TreemapData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getNodes","parameters":[],"returns":"Promise<TreemapNode[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<TreemapNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<TreemapNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<TreemapExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayout","parameters":[],"returns":"Promise<TreemapLayoutResult>","description":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"name":"appendPoint","parameters":[{"name":"node","type":"TreemapNodeInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"nodes","type":"ReadonlyArray<TreemapNodeInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"nodes","type":"ReadonlyArray<TreemapNodeInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.treemap license state."},{"name":"getStreamSource","parameters":[],"returns":"Promise<TreemapStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ enabled?: boolean; duration?: number; easing?: TreemapEasing; type?: TreemapAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<TreemapHitDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<TreemapHitDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<TreemapSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"drillTo","parameters":[{"name":"rootId","type":"string | null","optional":false}],"returns":"Promise<TreemapDrillChangeEventDetail | null>","description":"Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown."},{"name":"drillDown","parameters":[{"name":"nodeIndex","type":"number","optional":false}],"returns":"Promise<TreemapDrillChangeEventDetail | null>","description":"Enter a positive branch by its normalized data index. Requires drilldown."},{"name":"drillUp","parameters":[],"returns":"Promise<TreemapDrillChangeEventDetail | null>","description":"Return to the current branch's parent, then the forest."},{"name":"getDrillRoot","parameters":[],"returns":"Promise<TreemapNode | null>","description":"Treemap: current branch with its original identity and index, or null for the forest."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getLabels","parameters":[],"returns":"Promise<TreemapLabel[]>","description":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."}],"events":[{"name":"rendered","type":"TreemapRenderResult & { tier: TreemapEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"TreemapHitDetail","description":"CustomEvent.detail type: TreemapHitDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"TreemapHitDetail | null","description":"CustomEvent.detail type: TreemapHitDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"TreemapSelectionChangeEventDetail","description":"CustomEvent.detail type: TreemapSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<TreemapHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<TreemapHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"drillChange","type":"TreemapDrillChangeEventDetail","description":"CustomEvent.detail type: TreemapDrillChangeEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-treemap","blocks":[{"kind":"paragraph","text":"Explore part-to-whole proportions, such as product composition or storage usage."},{"kind":"paragraph","text":"Labels may be omitted in small areas. Use drilldown and a data table to inspect details."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of nodes as { id, label?, value?, children? }. Branch values are calculated from their children."]]},{"kind":"links","items":[{"path":"/charts/treemap","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-treemap.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-treemap\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"all\",\n            \"label\": \"All\",\n            \"children\": [\n              {\n                \"id\": \"platform\",\n                \"label\": \"Platform\",\n                \"color\": \"#8263d9\",\n                \"children\": [\n                  {\n                    \"id\": \"web\",\n                    \"label\": \"Web\",\n                    \"value\": 42\n                  },\n                  {\n                    \"id\": \"mobile\",\n                    \"label\": \"Mobile\",\n                    \"value\": 28\n                  }\n                ]\n              },\n              {\n                \"id\": \"service\",\n                \"label\": \"Services\",\n                \"color\": \"#239c91\",\n                \"children\": [\n                  {\n                    \"id\": \"consult\",\n                    \"label\": \"Consulting\",\n                    \"value\": 18\n                  },\n                  {\n                    \"id\": \"support\",\n                    \"label\": \"Support\",\n                    \"value\": 12\n                  }\n                ]\n              }\n            ]\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'treemap example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of nodes as { id, label?, value?, children? }. Branch values are calculated from their children."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TreemapData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TreemapData","title":"TreemapData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"Inner spacing of each branch, in CSS pixels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-drilldown","title":"drilldown","blocks":[{"kind":"paragraph","text":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drilldown`"],["HTML attribute","`drilldown`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-headerHeight","title":"headerHeight","blocks":[{"kind":"paragraph","text":"Reserved header band inside each branch, in CSS pixels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`headerHeight`"],["HTML attribute","`header-height`"],["Type","`number`"],["Default","`18`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`TreemapLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/TreemapLabelMode","title":"TreemapLabelMode","description":"Type definition"}]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: TreemapHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: TreemapHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`TreemapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/TreemapEasing","title":"TreemapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`TreemapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TreemapAnimationType","title":"TreemapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`TreemapStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/TreemapStreamSource","title":"TreemapStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`TreemapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/TreemapEngineMode","title":"TreemapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`TreemapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/TreemapUnavailableBehaviour","title":"TreemapUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapRenderResult & { tier: TreemapEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // TreemapRenderResult & { tier: TreemapEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TreemapRenderResult","title":"TreemapRenderResult","description":"Type definition"},{"path":"/docs/types/TreemapEngineTier","title":"TreemapEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: TreemapHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapHitDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // TreemapHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: TreemapHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // TreemapHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: TreemapSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // TreemapSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TreemapSelectionChangeEventDetail","title":"TreemapSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<TreemapHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<TreemapHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<TreemapHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drillChange","title":"drillChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: TreemapDrillChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `drillChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<TreemapDrillChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drillChange', event => {\n  console.log(event.detail); // TreemapDrillChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<TreemapRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapRenderResult","title":"TreemapRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<TreemapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapEngineTier","title":"TreemapEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: TreemapData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`TreemapData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapData","title":"TreemapData","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<TreemapNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<TreemapNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<TreemapNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<TreemapExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapExtent","title":"TreemapExtent","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"kind":"code","source":"getLayout(): Promise<TreemapLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapLayoutResult","title":"TreemapLayoutResult","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(node: TreemapNodeInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`node`","`TreemapNodeInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(nodes: ReadonlyArray<TreemapNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<TreemapNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(nodes: ReadonlyArray<TreemapNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<TreemapNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.treemap license state."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<TreemapStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapStreamSource","title":"TreemapStreamSource","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { enabled?: boolean; duration?: number; easing?: TreemapEasing; type?: TreemapAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ enabled?: boolean; duration?: number; easing?: TreemapEasing; type?: TreemapAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapEasing","title":"TreemapEasing","description":"Type definition"},{"path":"/docs/types/TreemapAnimationType","title":"TreemapAnimationType","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<TreemapHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<TreemapHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<TreemapSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapSelection","title":"TreemapSelection","description":"Type definition"}]}]},{"id":"method-drillTo","title":"drillTo","blocks":[{"kind":"paragraph","text":"Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown."},{"kind":"code","source":"drillTo(rootId: string | null): Promise<TreemapDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rootId`","`string | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillDown","title":"drillDown","blocks":[{"kind":"paragraph","text":"Enter a positive branch by its normalized data index. Requires drilldown."},{"kind":"code","source":"drillDown(nodeIndex: number): Promise<TreemapDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodeIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<TreemapDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillUp","title":"drillUp","blocks":[{"kind":"paragraph","text":"Return to the current branch's parent, then the forest."},{"kind":"code","source":"drillUp(): Promise<TreemapDrillChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrillRoot","title":"getDrillRoot","blocks":[{"kind":"paragraph","text":"Treemap: current branch with its original identity and index, or null for the forest."},{"kind":"code","source":"getDrillRoot(): Promise<TreemapNode | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."},{"kind":"code","source":"getLabels(): Promise<TreemapLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<TreemapLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/TreemapLabel","title":"TreemapLabel","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/sunburst","title":"Sunburst","summary":"Represent hierarchy depth and proportions with concentric rings.","kind":"component","tag":"sy-sunburst","componentId":"sunburst","api":{"props":[{"name":"data","attribute":"data","type":"SunburstData","kind":"property","values":[],"default":"undefined","description":"Hierarchy nodes with unique id and children or parent. Leaf values determine proportions."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"1","description":"Radial and angular separation between neighbouring sectors, in CSS pixels."},{"name":"drilldown","attribute":"drilldown","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"nodeLabels","attribute":"node-labels","type":"SunburstLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: SunburstHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: SunburstHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"SunburstEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"SunburstAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"SunburstStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"engine","attribute":"engine","type":"SunburstEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"SunburstUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<SunburstRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<SunburstEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"SunburstData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getNodes","parameters":[],"returns":"Promise<SunburstNode[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SunburstNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<SunburstNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<SunburstExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayout","parameters":[],"returns":"Promise<SunburstLayoutResult>","description":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"name":"appendPoint","parameters":[{"name":"node","type":"SunburstNodeInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"nodes","type":"ReadonlyArray<SunburstNodeInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"nodes","type":"ReadonlyArray<SunburstNodeInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.sunburst license state."},{"name":"getStreamSource","parameters":[],"returns":"Promise<SunburstStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ enabled?: boolean; duration?: number; easing?: SunburstEasing; type?: SunburstAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<SunburstHitDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SunburstHitDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<SunburstSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"drillTo","parameters":[{"name":"rootId","type":"string | null","optional":false}],"returns":"Promise<SunburstDrillChangeEventDetail | null>","description":"Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown."},{"name":"drillDown","parameters":[{"name":"nodeIndex","type":"number","optional":false}],"returns":"Promise<SunburstDrillChangeEventDetail | null>","description":"Enter a positive branch by its normalized data index. Requires drilldown."},{"name":"drillUp","parameters":[],"returns":"Promise<SunburstDrillChangeEventDetail | null>","description":"Return to the current branch's parent, then the forest."},{"name":"getDrillRoot","parameters":[],"returns":"Promise<SunburstNode | null>","description":"Treemap: current branch with its original identity and index, or null for the forest."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getLabels","parameters":[],"returns":"Promise<SunburstLabel[]>","description":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."}],"events":[{"name":"rendered","type":"SunburstRenderResult & { tier: SunburstEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"SunburstHitDetail","description":"CustomEvent.detail type: SunburstHitDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"SunburstHitDetail | null","description":"CustomEvent.detail type: SunburstHitDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"SunburstSelectionChangeEventDetail","description":"CustomEvent.detail type: SunburstSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<SunburstHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<SunburstHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"drillChange","type":"SunburstDrillChangeEventDetail","description":"CustomEvent.detail type: SunburstDrillChangeEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-sunburst","blocks":[{"kind":"paragraph","text":"Explore composition from the whole down to subcategories."},{"kind":"paragraph","text":"Do not directly compare arc lengths at different depths. Compare within the same depth."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","Hierarchy nodes with unique id and children or parent. Leaf values determine proportions."]]},{"kind":"links","items":[{"path":"/charts/sunburst","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-sunburst.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-sunburst\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"all\",\n            \"label\": \"All\",\n            \"children\": [\n              {\n                \"id\": \"platform\",\n                \"label\": \"Platform\",\n                \"color\": \"#8263d9\",\n                \"children\": [\n                  {\n                    \"id\": \"web\",\n                    \"label\": \"Web\",\n                    \"value\": 42\n                  },\n                  {\n                    \"id\": \"mobile\",\n                    \"label\": \"Mobile\",\n                    \"value\": 28\n                  }\n                ]\n              },\n              {\n                \"id\": \"service\",\n                \"label\": \"Services\",\n                \"color\": \"#239c91\",\n                \"children\": [\n                  {\n                    \"id\": \"consult\",\n                    \"label\": \"Consulting\",\n                    \"value\": 18\n                  },\n                  {\n                    \"id\": \"support\",\n                    \"label\": \"Support\",\n                    \"value\": 12\n                  }\n                ]\n              }\n            ]\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'sunburst example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"Hierarchy nodes with unique id and children or parent. Leaf values determine proportions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`SunburstData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SunburstData","title":"SunburstData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"Radial and angular separation between neighbouring sectors, in CSS pixels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-drilldown","title":"drilldown","blocks":[{"kind":"paragraph","text":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drilldown`"],["HTML attribute","`drilldown`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`SunburstLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/SunburstLabelMode","title":"SunburstLabelMode","description":"Type definition"}]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: SunburstHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: SunburstHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`SunburstEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/SunburstEasing","title":"SunburstEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`SunburstAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SunburstAnimationType","title":"SunburstAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`SunburstStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SunburstStreamSource","title":"SunburstStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`SunburstEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/SunburstEngineMode","title":"SunburstEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`SunburstUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/SunburstUnavailableBehaviour","title":"SunburstUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SunburstRenderResult & { tier: SunburstEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // SunburstRenderResult & { tier: SunburstEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SunburstRenderResult","title":"SunburstRenderResult","description":"Type definition"},{"path":"/docs/types/SunburstEngineTier","title":"SunburstEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SunburstHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SunburstHitDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // SunburstHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SunburstHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SunburstHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // SunburstHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SunburstSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SunburstSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // SunburstSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SunburstSelectionChangeEventDetail","title":"SunburstSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<SunburstHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<SunburstHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<SunburstHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drillChange","title":"drillChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SunburstDrillChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `drillChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SunburstDrillChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drillChange', event => {\n  console.log(event.detail); // SunburstDrillChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<SunburstRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstRenderResult","title":"SunburstRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<SunburstEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstEngineTier","title":"SunburstEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: SunburstData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`SunburstData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstData","title":"SunburstData","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<SunburstNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<SunburstNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SunburstNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<SunburstNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SunburstNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<SunburstExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstExtent","title":"SunburstExtent","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"kind":"code","source":"getLayout(): Promise<SunburstLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstLayoutResult","title":"SunburstLayoutResult","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(node: SunburstNodeInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`node`","`SunburstNodeInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(nodes: ReadonlyArray<SunburstNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<SunburstNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(nodes: ReadonlyArray<SunburstNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<SunburstNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.sunburst license state."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<SunburstStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstStreamSource","title":"SunburstStreamSource","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { enabled?: boolean; duration?: number; easing?: SunburstEasing; type?: SunburstAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ enabled?: boolean; duration?: number; easing?: SunburstEasing; type?: SunburstAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstEasing","title":"SunburstEasing","description":"Type definition"},{"path":"/docs/types/SunburstAnimationType","title":"SunburstAnimationType","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<SunburstHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SunburstHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<SunburstHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SunburstHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<SunburstSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstSelection","title":"SunburstSelection","description":"Type definition"}]}]},{"id":"method-drillTo","title":"drillTo","blocks":[{"kind":"paragraph","text":"Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown."},{"kind":"code","source":"drillTo(rootId: string | null): Promise<SunburstDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rootId`","`string | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SunburstDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillDown","title":"drillDown","blocks":[{"kind":"paragraph","text":"Enter a positive branch by its normalized data index. Requires drilldown."},{"kind":"code","source":"drillDown(nodeIndex: number): Promise<SunburstDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodeIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SunburstDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillUp","title":"drillUp","blocks":[{"kind":"paragraph","text":"Return to the current branch's parent, then the forest."},{"kind":"code","source":"drillUp(): Promise<SunburstDrillChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrillRoot","title":"getDrillRoot","blocks":[{"kind":"paragraph","text":"Treemap: current branch with its original identity and index, or null for the forest."},{"kind":"code","source":"getDrillRoot(): Promise<SunburstNode | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."},{"kind":"code","source":"getLabels(): Promise<SunburstLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SunburstLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SunburstLabel","title":"SunburstLabel","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/icicle","title":"Icicle","summary":"Show hierarchy depth as aligned bands.","kind":"component","tag":"sy-icicle","componentId":"icicle","api":{"props":[{"name":"data","attribute":"data","type":"IcicleData","kind":"property","values":[],"default":"undefined","description":"A hierarchy with unique id, children, and leaf values."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"1","description":"Separation between depth bands and siblings, in CSS pixels."},{"name":"direction","attribute":"direction","type":"IcicleDirection","kind":"string","values":["top-down","bottom-up","left-right","right-left"],"default":"'top-down'","description":"The layout direction: up, down, left, or right."},{"name":"drilldown","attribute":"drilldown","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"nodeLabels","attribute":"node-labels","type":"IcicleLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: IcicleHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: IcicleHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"IcicleEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"IcicleAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"IcicleStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"engine","attribute":"engine","type":"IcicleEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"IcicleUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<IcicleRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<IcicleEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"IcicleData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getNodes","parameters":[],"returns":"Promise<IcicleNode[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<IcicleNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<IcicleNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<IcicleExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayout","parameters":[],"returns":"Promise<IcicleLayoutResult>","description":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"name":"appendPoint","parameters":[{"name":"node","type":"IcicleNodeInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"nodes","type":"ReadonlyArray<IcicleNodeInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"nodes","type":"ReadonlyArray<IcicleNodeInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.icicle license state."},{"name":"getStreamSource","parameters":[],"returns":"Promise<IcicleStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ enabled?: boolean; duration?: number; easing?: IcicleEasing; type?: IcicleAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<IcicleHitDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<IcicleHitDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<IcicleSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"drillTo","parameters":[{"name":"rootId","type":"string | null","optional":false}],"returns":"Promise<IcicleDrillChangeEventDetail | null>","description":"Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown."},{"name":"drillDown","parameters":[{"name":"nodeIndex","type":"number","optional":false}],"returns":"Promise<IcicleDrillChangeEventDetail | null>","description":"Enter a positive branch by its normalized data index. Requires drilldown."},{"name":"drillUp","parameters":[],"returns":"Promise<IcicleDrillChangeEventDetail | null>","description":"Return to the current branch's parent, then the forest."},{"name":"getDrillRoot","parameters":[],"returns":"Promise<IcicleNode | null>","description":"Treemap: current branch with its original identity and index, or null for the forest."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getLabels","parameters":[],"returns":"Promise<IcicleLabel[]>","description":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."}],"events":[{"name":"rendered","type":"IcicleRenderResult & { tier: IcicleEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"IcicleHitDetail","description":"CustomEvent.detail type: IcicleHitDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"IcicleHitDetail | null","description":"CustomEvent.detail type: IcicleHitDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"IcicleSelectionChangeEventDetail","description":"CustomEvent.detail type: IcicleSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<IcicleHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<IcicleHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"drillChange","type":"IcicleDrillChangeEventDetail","description":"CustomEvent.detail type: IcicleDrillChangeEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-icicle","blocks":[{"kind":"paragraph","text":"Compare parent-child containment relationships at the same depth."},{"kind":"paragraph","text":"Very deep hierarchies need substantial space. Focus on the subtree of interest."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","A hierarchy with unique id, children, and leaf values."],["`direction`","The layout direction: up, down, left, or right."]]},{"kind":"links","items":[{"path":"/charts/icicle","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-icicle.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-icicle\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"all\",\n            \"label\": \"All\",\n            \"children\": [\n              {\n                \"id\": \"platform\",\n                \"label\": \"Platform\",\n                \"color\": \"#8263d9\",\n                \"children\": [\n                  {\n                    \"id\": \"web\",\n                    \"label\": \"Web\",\n                    \"value\": 42\n                  },\n                  {\n                    \"id\": \"mobile\",\n                    \"label\": \"Mobile\",\n                    \"value\": 28\n                  }\n                ]\n              },\n              {\n                \"id\": \"service\",\n                \"label\": \"Services\",\n                \"color\": \"#239c91\",\n                \"children\": [\n                  {\n                    \"id\": \"consult\",\n                    \"label\": \"Consulting\",\n                    \"value\": 18\n                  },\n                  {\n                    \"id\": \"support\",\n                    \"label\": \"Support\",\n                    \"value\": 12\n                  }\n                ]\n              }\n            ]\n          }\n        ],\n        \"direction\": \"top-down\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'icicle example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"A hierarchy with unique id, children, and leaf values."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`IcicleData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/IcicleData","title":"IcicleData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"Separation between depth bands and siblings, in CSS pixels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-direction","title":"direction","blocks":[{"kind":"paragraph","text":"The layout direction: up, down, left, or right."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`direction`"],["HTML attribute","`direction`"],["Type","`IcicleDirection`"],["Default","`'top-down'`"],["Allowed values","`top-down`, `bottom-up`, `left-right`, `right-left`"]]},{"kind":"links","items":[{"path":"/docs/types/IcicleDirection","title":"IcicleDirection","description":"Type definition"}]}]},{"id":"property-drilldown","title":"drilldown","blocks":[{"kind":"paragraph","text":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drilldown`"],["HTML attribute","`drilldown`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`IcicleLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/IcicleLabelMode","title":"IcicleLabelMode","description":"Type definition"}]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: IcicleHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: IcicleHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`IcicleEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/IcicleEasing","title":"IcicleEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`IcicleAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/IcicleAnimationType","title":"IcicleAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`IcicleStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/IcicleStreamSource","title":"IcicleStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`IcicleEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/IcicleEngineMode","title":"IcicleEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`IcicleUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/IcicleUnavailableBehaviour","title":"IcicleUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<IcicleRenderResult & { tier: IcicleEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // IcicleRenderResult & { tier: IcicleEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/IcicleRenderResult","title":"IcicleRenderResult","description":"Type definition"},{"path":"/docs/types/IcicleEngineTier","title":"IcicleEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: IcicleHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<IcicleHitDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // IcicleHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: IcicleHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<IcicleHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // IcicleHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: IcicleSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<IcicleSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // IcicleSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/IcicleSelectionChangeEventDetail","title":"IcicleSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<IcicleHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<IcicleHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<IcicleHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drillChange","title":"drillChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: IcicleDrillChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `drillChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<IcicleDrillChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drillChange', event => {\n  console.log(event.detail); // IcicleDrillChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<IcicleRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleRenderResult","title":"IcicleRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<IcicleEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleEngineTier","title":"IcicleEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: IcicleData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`IcicleData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleData","title":"IcicleData","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<IcicleNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<IcicleNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<IcicleNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<IcicleNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<IcicleNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<IcicleExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleExtent","title":"IcicleExtent","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"kind":"code","source":"getLayout(): Promise<IcicleLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleLayoutResult","title":"IcicleLayoutResult","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(node: IcicleNodeInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`node`","`IcicleNodeInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(nodes: ReadonlyArray<IcicleNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<IcicleNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(nodes: ReadonlyArray<IcicleNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<IcicleNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.icicle license state."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<IcicleStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleStreamSource","title":"IcicleStreamSource","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { enabled?: boolean; duration?: number; easing?: IcicleEasing; type?: IcicleAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ enabled?: boolean; duration?: number; easing?: IcicleEasing; type?: IcicleAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleEasing","title":"IcicleEasing","description":"Type definition"},{"path":"/docs/types/IcicleAnimationType","title":"IcicleAnimationType","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<IcicleHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<IcicleHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<IcicleHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<IcicleHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<IcicleSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleSelection","title":"IcicleSelection","description":"Type definition"}]}]},{"id":"method-drillTo","title":"drillTo","blocks":[{"kind":"paragraph","text":"Enter a positive branch by stable ID; null returns to the complete forest. Requires drilldown."},{"kind":"code","source":"drillTo(rootId: string | null): Promise<IcicleDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rootId`","`string | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<IcicleDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillDown","title":"drillDown","blocks":[{"kind":"paragraph","text":"Enter a positive branch by its normalized data index. Requires drilldown."},{"kind":"code","source":"drillDown(nodeIndex: number): Promise<IcicleDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodeIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<IcicleDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillUp","title":"drillUp","blocks":[{"kind":"paragraph","text":"Return to the current branch's parent, then the forest."},{"kind":"code","source":"drillUp(): Promise<IcicleDrillChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrillRoot","title":"getDrillRoot","blocks":[{"kind":"paragraph","text":"Treemap: current branch with its original identity and index, or null for the forest."},{"kind":"code","source":"getDrillRoot(): Promise<IcicleNode | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."},{"kind":"code","source":"getLabels(): Promise<IcicleLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<IcicleLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IcicleLabel","title":"IcicleLabel","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/dendrogram","title":"Dendrogram","summary":"Show parent-child connections as a tree.","kind":"component","tag":"sy-dendrogram","componentId":"dendrogram","api":{"props":[{"name":"data","attribute":"data","type":"DendrogramData","kind":"property","values":[],"default":"undefined","description":"An array of { id, label?, children? } or nodes linked by parent."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"16","description":"Outer layout padding in CSS pixels; leaf slots are equally spaced."},{"name":"nodeRadius","attribute":"node-radius","type":"number","kind":"number","values":[],"default":"5","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"linkWidth","attribute":"link-width","type":"number","kind":"number","values":[],"default":"1.5","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"linkOpacity","attribute":"link-opacity","type":"number","kind":"number","values":[],"default":".65","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"direction","attribute":"direction","type":"DendrogramDirection","kind":"string","values":["top-down","bottom-up","left-right","right-left"],"default":"'left-right'","description":"The tree's growth direction."},{"name":"drilldown","attribute":"drilldown","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"nodeLabels","attribute":"node-labels","type":"DendrogramLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: DendrogramHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: DendrogramHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"DendrogramEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"DendrogramAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"DendrogramStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"engine","attribute":"engine","type":"DendrogramEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"DendrogramUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<DendrogramRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<DendrogramEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"DendrogramData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getNodes","parameters":[],"returns":"Promise<DendrogramNode[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLinks","parameters":[],"returns":"Promise<DendrogramLink[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<DendrogramNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<DendrogramNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<DendrogramExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayout","parameters":[],"returns":"Promise<DendrogramLayoutResult>","description":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"name":"appendPoint","parameters":[{"name":"node","type":"DendrogramNodeInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"nodes","type":"ReadonlyArray<DendrogramNodeInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"nodes","type":"ReadonlyArray<DendrogramNodeInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.dendrogram license state."},{"name":"getStreamSource","parameters":[],"returns":"Promise<DendrogramStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ enabled?: boolean; duration?: number; easing?: DendrogramEasing; type?: DendrogramAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<DendrogramHitDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<DendrogramHitDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"selectLinkAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<DendrogramHitDetail|null>","description":"Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<DendrogramSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"drillTo","parameters":[{"name":"rootId","type":"string | null","optional":false}],"returns":"Promise<DendrogramDrillChangeEventDetail | null>","description":"Enter a structural branch by stable ID; null returns to the complete forest. Requires drilldown."},{"name":"drillDown","parameters":[{"name":"nodeIndex","type":"number","optional":false}],"returns":"Promise<DendrogramDrillChangeEventDetail | null>","description":"Enter a structural branch by its normalized data index. Requires drilldown."},{"name":"drillUp","parameters":[],"returns":"Promise<DendrogramDrillChangeEventDetail | null>","description":"Return to the current branch's parent, then the forest."},{"name":"getDrillRoot","parameters":[],"returns":"Promise<DendrogramNode | null>","description":"Treemap: current branch with its original identity and index, or null for the forest."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"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."},{"name":"showTooltipAtLink","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getLabels","parameters":[],"returns":"Promise<DendrogramLabel[]>","description":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."}],"events":[{"name":"rendered","type":"DendrogramRenderResult & { tier: DendrogramEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"DendrogramHitDetail","description":"CustomEvent.detail type: DendrogramHitDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"DendrogramHitDetail | null","description":"CustomEvent.detail type: DendrogramHitDetail | null. Event names are case-sensitive."},{"name":"linkClick","type":"DendrogramHitDetail","description":"CustomEvent.detail type: DendrogramHitDetail. Event names are case-sensitive."},{"name":"linkHover","type":"DendrogramHitDetail | null","description":"CustomEvent.detail type: DendrogramHitDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"DendrogramSelectionChangeEventDetail","description":"CustomEvent.detail type: DendrogramSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<DendrogramHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DendrogramHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"drillChange","type":"DendrogramDrillChangeEventDetail","description":"CustomEvent.detail type: DendrogramDrillChangeEventDetail. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-dendrogram","blocks":[{"kind":"paragraph","text":"Explore organizational, classification, or cluster structures."},{"kind":"paragraph","text":"Do not assume connection lengths represent statistical distances. This example displays hierarchy structure."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { id, label?, children? } or nodes linked by parent."],["`direction`","The tree's growth direction."]]},{"kind":"links","items":[{"path":"/charts/dendrogram","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-dendrogram.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-dendrogram\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"all\",\n            \"label\": \"All\",\n            \"children\": [\n              {\n                \"id\": \"platform\",\n                \"label\": \"Platform\",\n                \"color\": \"#8263d9\",\n                \"children\": [\n                  {\n                    \"id\": \"web\",\n                    \"label\": \"Web\",\n                    \"value\": 42\n                  },\n                  {\n                    \"id\": \"mobile\",\n                    \"label\": \"Mobile\",\n                    \"value\": 28\n                  }\n                ]\n              },\n              {\n                \"id\": \"service\",\n                \"label\": \"Services\",\n                \"color\": \"#239c91\",\n                \"children\": [\n                  {\n                    \"id\": \"consult\",\n                    \"label\": \"Consulting\",\n                    \"value\": 18\n                  },\n                  {\n                    \"id\": \"support\",\n                    \"label\": \"Support\",\n                    \"value\": 12\n                  }\n                ]\n              }\n            ]\n          }\n        ],\n        \"direction\": \"left-right\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'dendrogram example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { id, label?, children? } or nodes linked by parent."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DendrogramData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DendrogramData","title":"DendrogramData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"Outer layout padding in CSS pixels; leaf slots are equally spaced."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`16`"]]}]},{"id":"property-nodeRadius","title":"nodeRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeRadius`"],["HTML attribute","`node-radius`"],["Type","`number`"],["Default","`5`"]]}]},{"id":"property-linkWidth","title":"linkWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkWidth`"],["HTML attribute","`link-width`"],["Type","`number`"],["Default","`1.5`"]]}]},{"id":"property-linkOpacity","title":"linkOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkOpacity`"],["HTML attribute","`link-opacity`"],["Type","`number`"],["Default","`.65`"]]}]},{"id":"property-direction","title":"direction","blocks":[{"kind":"paragraph","text":"The tree's growth direction."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`direction`"],["HTML attribute","`direction`"],["Type","`DendrogramDirection`"],["Default","`'left-right'`"],["Allowed values","`top-down`, `bottom-up`, `left-right`, `right-left`"]]},{"kind":"links","items":[{"path":"/docs/types/DendrogramDirection","title":"DendrogramDirection","description":"Type definition"}]}]},{"id":"property-drilldown","title":"drilldown","blocks":[{"kind":"paragraph","text":"Enable branch navigation, breadcrumb controls and Alt+Enter / Backspace shortcuts."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drilldown`"],["HTML attribute","`drilldown`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`DendrogramLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/DendrogramLabelMode","title":"DendrogramLabelMode","description":"Type definition"}]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: DendrogramHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: DendrogramHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`DendrogramEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/DendrogramEasing","title":"DendrogramEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`DendrogramAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DendrogramAnimationType","title":"DendrogramAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DendrogramStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DendrogramStreamSource","title":"DendrogramStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`DendrogramEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/DendrogramEngineMode","title":"DendrogramEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`DendrogramUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/DendrogramUnavailableBehaviour","title":"DendrogramUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DendrogramRenderResult & { tier: DendrogramEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // DendrogramRenderResult & { tier: DendrogramEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DendrogramRenderResult","title":"DendrogramRenderResult","description":"Type definition"},{"path":"/docs/types/DendrogramEngineTier","title":"DendrogramEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DendrogramHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DendrogramHitDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // DendrogramHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DendrogramHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DendrogramHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // DendrogramHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"event-linkClick","title":"linkClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DendrogramHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DendrogramHitDetail>`."},{"kind":"code","source":"chart.addEventListener('linkClick', event => {\n  console.log(event.detail); // DendrogramHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"event-linkHover","title":"linkHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DendrogramHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DendrogramHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('linkHover', event => {\n  console.log(event.detail); // DendrogramHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DendrogramSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DendrogramSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // DendrogramSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DendrogramSelectionChangeEventDetail","title":"DendrogramSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<DendrogramHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<DendrogramHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<DendrogramHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-drillChange","title":"drillChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: DendrogramDrillChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `drillChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DendrogramDrillChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('drillChange', event => {\n  console.log(event.detail); // DendrogramDrillChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<DendrogramRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramRenderResult","title":"DendrogramRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<DendrogramEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramEngineTier","title":"DendrogramEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: DendrogramData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`DendrogramData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramData","title":"DendrogramData","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<DendrogramNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":"Type definition"}]}]},{"id":"method-getLinks","title":"getLinks","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLinks(): Promise<DendrogramLink[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramLink[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramLink","title":"DendrogramLink","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<DendrogramNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DendrogramNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<DendrogramNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DendrogramNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<DendrogramExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramExtent","title":"DendrogramExtent","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"The layout as shown (the frozen view while frozen); without a valid license it is refused and nothing is computed."},{"kind":"code","source":"getLayout(): Promise<DendrogramLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramLayoutResult","title":"DendrogramLayoutResult","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(node: DendrogramNodeInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`node`","`DendrogramNodeInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(nodes: ReadonlyArray<DendrogramNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<DendrogramNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(nodes: ReadonlyArray<DendrogramNodeInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<DendrogramNodeInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.dendrogram license state."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<DendrogramStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramStreamSource","title":"DendrogramStreamSource","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { enabled?: boolean; duration?: number; easing?: DendrogramEasing; type?: DendrogramAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ enabled?: boolean; duration?: number; easing?: DendrogramEasing; type?: DendrogramAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramEasing","title":"DendrogramEasing","description":"Type definition"},{"path":"/docs/types/DendrogramAnimationType","title":"DendrogramAnimationType","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<DendrogramHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DendrogramHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<DendrogramHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DendrogramHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"method-selectLinkAt","title":"selectLinkAt","blocks":[{"kind":"paragraph","text":"Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"kind":"code","source":"selectLinkAt(index: number): Promise<DendrogramHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DendrogramHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<DendrogramSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramSelection","title":"DendrogramSelection","description":"Type definition"}]}]},{"id":"method-drillTo","title":"drillTo","blocks":[{"kind":"paragraph","text":"Enter a structural branch by stable ID; null returns to the complete forest. Requires drilldown."},{"kind":"code","source":"drillTo(rootId: string | null): Promise<DendrogramDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rootId`","`string | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DendrogramDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillDown","title":"drillDown","blocks":[{"kind":"paragraph","text":"Enter a structural branch by its normalized data index. Requires drilldown."},{"kind":"code","source":"drillDown(nodeIndex: number): Promise<DendrogramDrillChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodeIndex`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DendrogramDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-drillUp","title":"drillUp","blocks":[{"kind":"paragraph","text":"Return to the current branch's parent, then the forest."},{"kind":"code","source":"drillUp(): Promise<DendrogramDrillChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramDrillChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getDrillRoot","title":"getDrillRoot","blocks":[{"kind":"paragraph","text":"Treemap: current branch with its original identity and index, or null for the forest."},{"kind":"code","source":"getDrillRoot(): Promise<DendrogramNode | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtLink","title":"showTooltipAtLink","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showTooltipAtLink(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"The labels as shown (the frozen view while frozen); without a valid license they are refused and nothing is computed."},{"kind":"code","source":"getLabels(): Promise<DendrogramLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<DendrogramLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DendrogramLabel","title":"DendrogramLabel","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/sankey","title":"Sankey","summary":"Represent quantities moving between nodes through link widths.","kind":"component","tag":"sy-sankey","componentId":"sankey","api":{"props":[{"name":"data","attribute":"data","type":"SankeyData","kind":"property","values":[],"default":"undefined","description":"{ nodes?, links: [{ source, target, value }] }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"nodeWidth","attribute":"node-width","type":"number","kind":"number","values":[],"default":"SANKEY_DEFAULT_NODE_WIDTH","description":"The nodes' width and the gap between stacked nodes (CSS px)."},{"name":"nodePadding","attribute":"node-padding","type":"number","kind":"number","values":[],"default":"SANKEY_DEFAULT_NODE_PADDING","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"nodeAlign","attribute":"node-align","type":"SankeyAlign","kind":"string","values":["left","right","center","justify"],"default":"'justify'","description":"How nodes align within stages."},{"name":"layoutIterations","attribute":"layout-iterations","type":"number","kind":"number","values":[],"default":"SANKEY_DEFAULT_ITERATIONS","description":"the relaxation passes that reorder the rows to reduce crossings (d3-sankey's barycentre schedule; 0 = the declared order)."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"AUTO_COLOR","description":"The nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins."},{"name":"linkColor","attribute":"link-color","type":"string","kind":"string","values":[],"default":"'source'","description":"The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins."},{"name":"linkOpacity","attribute":"link-opacity","type":"number","kind":"number","values":[],"default":"DEFAULT_LINK_OPACITY","description":"The ribbons' opacity (0 … 1)."},{"name":"linkCurvature","attribute":"link-curvature","type":"number","kind":"number","values":[],"default":"SANKEY_DEFAULT_CURVATURE","description":"the ribbons' centre line: 0 straight … 1 the full S-curve with horizontal tangents at both ends."},{"name":"nodeLabels","attribute":"node-labels","type":"SankeyLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"neighbourDim","attribute":"neighbour-dim","type":"number","kind":"number","values":[],"default":"DEFAULT_NEIGHBOUR_DIM","description":"with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim)."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"DEFAULT_ACTIVE_COLOR","description":"The hovered / focused node or link."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"The tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: SankeyHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: SankeyHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"SankeyEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"SankeyAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"SankeyStreamSource","kind":"property","values":[],"default":"undefined","description":"§3.6: an external stream source (link upserts); without one the chart keeps its own on the first push."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Links tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed links the chart renders (the whole buffer when unset)."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the wheel, the pinch and the keyboard over the diagram's unit extents (x 0 → 1 left → right, y 0 → 1 bottom → top — the hidden frame's extents); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"name":"engine","attribute":"engine","type":"SankeyEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"SankeyUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<SankeyRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<SankeyEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"SankeyData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"link","type":"SankeyLinkInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"links","type":"ReadonlyArray<SankeyLinkInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed links (the `data` links are not the stream)."},{"name":"replace","parameters":[{"name":"links","type":"ReadonlyArray<SankeyLinkInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<SankeyStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.sankey license state."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: SankeyEasing; enabled?: boolean; type?: SankeyAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<SankeyHitDetail | null>","description":"The node or link under a host-local CSS point (a node first, else the topmost ribbon), or null (always without a valid license)."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SankeyNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<SankeyNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodes","parameters":[],"returns":"Promise<SankeyNode[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLinks","parameters":[],"returns":"Promise<SankeyLink[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLinkCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<SankeyExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayoutStats","parameters":[],"returns":"Promise<{ iterations: number; crossings: number; energy: number; curvature: number; crossingsComputed: boolean }>","description":"the layout's statistics: the relaxation passes run, the proper crossings among the ribbons' centre lines (O(L²), on demand) and the energy Σ value × |y1 − y0| the relaxation minimises."},{"name":"getLabels","parameters":[],"returns":"Promise<SankeyNodeLabel[]>","description":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"name":"getLayout","parameters":[],"returns":"Promise<SankeyLayoutResult>","description":"The layout in HOST-local CSS px as shown (the plot offset added; under a zoom, the viewport transform applied; while an update morph runs, its current frame): the node rects, the ribbons, the scale."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"Open a tooltip by point index: nodes first, then directed links; null outside the graph or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SankeyNodeEventDetail | null>","description":"Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SankeyNodeEventDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"selectLinkAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<SankeyLinkEventDetail | null>","description":"Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<SankeySelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."}],"events":[{"name":"rendered","type":"SankeyRenderResult & { tier: SankeyEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"SankeyNodeEventDetail","description":"CustomEvent.detail type: SankeyNodeEventDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"SankeyNodeEventDetail | null","description":"CustomEvent.detail type: SankeyNodeEventDetail | null. Event names are case-sensitive."},{"name":"linkClick","type":"SankeyLinkEventDetail","description":"CustomEvent.detail type: SankeyLinkEventDetail. Event names are case-sensitive."},{"name":"linkHover","type":"SankeyLinkEventDetail | null","description":"CustomEvent.detail type: SankeyLinkEventDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"SankeySelectionChangeEventDetail","description":"the selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<SankeyHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<SankeyHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"The shared tooltip events (the controller emits them)."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-sankey","blocks":[{"kind":"paragraph","text":"Explain branching and merging flows of energy, users, or funds."},{"kind":"paragraph","text":"Keep link units consistent. Explain cases where inflow and outflow do not balance."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","{ nodes?, links: [{ source, target, value }] }."],["`nodeAlign`","How nodes align within stages."]]},{"kind":"links","items":[{"path":"/charts/sankey","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-sankey.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-sankey\",\n      \"props\": {\n        \"data\": {\n          \"links\": [\n            {\n              \"source\": \"Inflow\",\n              \"target\": \"Product A\",\n              \"value\": 42\n            },\n            {\n              \"source\": \"Inflow\",\n              \"target\": \"Product B\",\n              \"value\": 28\n            },\n            {\n              \"source\": \"Product A\",\n              \"target\": \"Purchase\",\n              \"value\": 30\n            },\n            {\n              \"source\": \"Product A\",\n              \"target\": \"Outflow\",\n              \"value\": 12\n            },\n            {\n              \"source\": \"Product B\",\n              \"target\": \"Purchase\",\n              \"value\": 18\n            },\n            {\n              \"source\": \"Product B\",\n              \"target\": \"Outflow\",\n              \"value\": 10\n            }\n          ]\n        },\n        \"nodeAlign\": \"justify\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'sankey example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"{ nodes?, links: [{ source, target, value }] }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`SankeyData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SankeyData","title":"SankeyData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-nodeWidth","title":"nodeWidth","blocks":[{"kind":"paragraph","text":"The nodes' width and the gap between stacked nodes (CSS px)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeWidth`"],["HTML attribute","`node-width`"],["Type","`number`"],["Default","`SANKEY_DEFAULT_NODE_WIDTH`"]]}]},{"id":"property-nodePadding","title":"nodePadding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodePadding`"],["HTML attribute","`node-padding`"],["Type","`number`"],["Default","`SANKEY_DEFAULT_NODE_PADDING`"]]}]},{"id":"property-nodeAlign","title":"nodeAlign","blocks":[{"kind":"paragraph","text":"How nodes align within stages."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeAlign`"],["HTML attribute","`node-align`"],["Type","`SankeyAlign`"],["Default","`'justify'`"],["Allowed values","`left`, `right`, `center`, `justify`"]]},{"kind":"links","items":[{"path":"/docs/types/SankeyAlign","title":"SankeyAlign","description":"Type definition"}]}]},{"id":"property-layoutIterations","title":"layoutIterations","blocks":[{"kind":"paragraph","text":"the relaxation passes that reorder the rows to reduce crossings (d3-sankey's barycentre schedule; 0 = the declared order)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`layoutIterations`"],["HTML attribute","`layout-iterations`"],["Type","`number`"],["Default","`SANKEY_DEFAULT_ITERATIONS`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"The nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`AUTO_COLOR`"]]}]},{"id":"property-linkColor","title":"linkColor","blocks":[{"kind":"paragraph","text":"The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkColor`"],["HTML attribute","`link-color`"],["Type","`string`"],["Default","`'source'`"]]}]},{"id":"property-linkOpacity","title":"linkOpacity","blocks":[{"kind":"paragraph","text":"The ribbons' opacity (0 … 1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkOpacity`"],["HTML attribute","`link-opacity`"],["Type","`number`"],["Default","`DEFAULT_LINK_OPACITY`"]]}]},{"id":"property-linkCurvature","title":"linkCurvature","blocks":[{"kind":"paragraph","text":"the ribbons' centre line: 0 straight … 1 the full S-curve with horizontal tangents at both ends."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkCurvature`"],["HTML attribute","`link-curvature`"],["Type","`number`"],["Default","`SANKEY_DEFAULT_CURVATURE`"]]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`SankeyLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/SankeyLabelMode","title":"SankeyLabelMode","description":"Type definition"}]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-neighbourDim","title":"neighbourDim","blocks":[{"kind":"paragraph","text":"with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neighbourDim`"],["HTML attribute","`neighbour-dim`"],["Type","`number`"],["Default","`DEFAULT_NEIGHBOUR_DIM`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"The hovered / focused node or link."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`DEFAULT_ACTIVE_COLOR`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"The tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: SankeyHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: SankeyHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SankeyHitDetail","title":"SankeyHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`SankeyEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/SankeyEasing","title":"SankeyEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`SankeyAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SankeyAnimationType","title":"SankeyAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"§3.6: an external stream source (link upserts); without one the chart keeps its own on the first push."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`SankeyStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/SankeyStreamSource","title":"SankeyStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Links tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed links the chart renders (the whole buffer when unset)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the wheel, the pinch and the keyboard over the diagram's unit extents (x 0 → 1 left → right, y 0 → 1 bottom → top — the hidden frame's extents); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`SankeyEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/SankeyEngineMode","title":"SankeyEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`SankeyUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/SankeyUnavailableBehaviour","title":"SankeyUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SankeyRenderResult & { tier: SankeyEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // SankeyRenderResult & { tier: SankeyEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SankeyRenderResult","title":"SankeyRenderResult","description":"Type definition"},{"path":"/docs/types/SankeyEngineTier","title":"SankeyEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SankeyNodeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SankeyNodeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // SankeyNodeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SankeyNodeEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SankeyNodeEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // SankeyNodeEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":"Type definition"}]}]},{"id":"event-linkClick","title":"linkClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SankeyLinkEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SankeyLinkEventDetail>`."},{"kind":"code","source":"chart.addEventListener('linkClick', event => {\n  console.log(event.detail); // SankeyLinkEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","description":"Type definition"}]}]},{"id":"event-linkHover","title":"linkHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: SankeyLinkEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SankeyLinkEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('linkHover', event => {\n  console.log(event.detail); // SankeyLinkEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"the selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<SankeySelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // SankeySelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/SankeySelectionChangeEventDetail","title":"SankeySelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<SankeyHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<SankeyHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<SankeyHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/SankeyHitDetail","title":"SankeyHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"The shared tooltip events (the controller emits them)."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<SankeyRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyRenderResult","title":"SankeyRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<SankeyEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyEngineTier","title":"SankeyEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: SankeyData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`SankeyData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyData","title":"SankeyData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(link: SankeyLinkInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`link`","`SankeyLinkInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(links: ReadonlyArray<SankeyLinkInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`links`","`ReadonlyArray<SankeyLinkInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed links (the `data` links are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(links: ReadonlyArray<SankeyLinkInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`links`","`ReadonlyArray<SankeyLinkInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<SankeyStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyStreamSource","title":"SankeyStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.sankey license state."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: SankeyEasing; enabled?: boolean; type?: SankeyAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: SankeyEasing; enabled?: boolean; type?: SankeyAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyEasing","title":"SankeyEasing","description":"Type definition"},{"path":"/docs/types/SankeyAnimationType","title":"SankeyAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The node or link under a host-local CSS point (a node first, else the topmost ribbon), or null (always without a valid license)."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<SankeyHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyHitDetail","title":"SankeyHitDetail","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<SankeyNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyNode","title":"SankeyNode","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<SankeyNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyNode","title":"SankeyNode","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<SankeyNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyNode","title":"SankeyNode","description":"Type definition"}]}]},{"id":"method-getLinks","title":"getLinks","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLinks(): Promise<SankeyLink[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyLink[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyLink","title":"SankeyLink","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLinkCount","title":"getLinkCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLinkCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<SankeyExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyExtent","title":"SankeyExtent","description":"Type definition"}]}]},{"id":"method-getLayoutStats","title":"getLayoutStats","blocks":[{"kind":"paragraph","text":"the layout's statistics: the relaxation passes run, the proper crossings among the ribbons' centre lines (O(L²), on demand) and the energy Σ value × |y1 − y0| the relaxation minimises."},{"kind":"code","source":"getLayoutStats(): Promise<{ iterations: number; crossings: number; energy: number; curvature: number; crossingsComputed: boolean }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ iterations: number; crossings: number; energy: number; curvature: number; crossingsComputed: boolean }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"kind":"code","source":"getLabels(): Promise<SankeyNodeLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyNodeLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyNodeLabel","title":"SankeyNodeLabel","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"The layout in HOST-local CSS px as shown (the plot offset added; under a zoom, the viewport transform applied; while an update morph runs, its current frame): the node rects, the ribbons, the scale."},{"kind":"code","source":"getLayout(): Promise<SankeyLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeyLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyLayoutResult","title":"SankeyLayoutResult","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"Open a tooltip by point index: nodes first, then directed links; null outside the graph or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusNodeAt","title":"focusNodeAt","blocks":[{"kind":"paragraph","text":"Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk."},{"kind":"code","source":"focusNodeAt(index: number): Promise<SankeyNodeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyNodeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<SankeyNodeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyNodeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":"Type definition"}]}]},{"id":"method-selectLinkAt","title":"selectLinkAt","blocks":[{"kind":"paragraph","text":"Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"kind":"code","source":"selectLinkAt(index: number): Promise<SankeyLinkEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<SankeyLinkEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<SankeySelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<SankeySelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/SankeySelection","title":"SankeySelection","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/chord","title":"Chord","summary":"Show connection volumes between groups as ribbons inside a circle.","kind":"component","tag":"sy-chord","componentId":"chord","api":{"props":[{"name":"data","attribute":"data","type":"ChordData","kind":"property","values":[],"default":"undefined","description":"{ links: [{ source, target, value }] } or a link array."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"nodeWidth","attribute":"node-width","type":"number","kind":"number","values":[],"default":"CHORD_DEFAULT_NODE_WIDTH","description":"The perimeter band's thickness in CSS px."},{"name":"padAngle","attribute":"pad-angle","type":"number","kind":"number","values":[],"default":"CHORD_DEFAULT_PAD_ANGLE","description":"The gap between perimeter groups, in degrees."},{"name":"startAngle","attribute":"start-angle","type":"number","kind":"number","values":[],"default":"CHORD_DEFAULT_START_ANGLE","description":"Clockwise start angle in degrees from the positive x axis; -90 starts at the top."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"AUTO_COLOR","description":"The nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins."},{"name":"linkColor","attribute":"link-color","type":"string","kind":"string","values":[],"default":"'source'","description":"The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins."},{"name":"linkOpacity","attribute":"link-opacity","type":"number","kind":"number","values":[],"default":"DEFAULT_LINK_OPACITY","description":"The ribbons' opacity (0 … 1)."},{"name":"linkCurvature","attribute":"link-curvature","type":"number","kind":"number","values":[],"default":"CHORD_DEFAULT_CURVATURE","description":"The ribbon bend: 0 straight between ports, 1 pulled through the circle interior."},{"name":"nodeLabels","attribute":"node-labels","type":"ChordLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"neighbourDim","attribute":"neighbour-dim","type":"number","kind":"number","values":[],"default":"DEFAULT_NEIGHBOUR_DIM","description":"with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim)."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"DEFAULT_ACTIVE_COLOR","description":"The hovered / focused node or link."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"The tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: ChordHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: ChordHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ChordEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ChordAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"ChordStreamSource","kind":"property","values":[],"default":"undefined","description":"§3.6: an external stream source (link upserts); without one the chart keeps its own on the first push."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Links tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed links the chart renders (the whole buffer when unset)."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the wheel, the pinch and the keyboard over the diagram's unit extents (x 0 → 1 left → right, y 0 → 1 bottom → top — the hidden frame's extents); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"name":"engine","attribute":"engine","type":"ChordEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"ChordUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<ChordRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<ChordEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"ChordData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"link","type":"ChordLinkInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"links","type":"ReadonlyArray<ChordLinkInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed links (the `data` links are not the stream)."},{"name":"replace","parameters":[{"name":"links","type":"ReadonlyArray<ChordLinkInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ChordStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.chord license state."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: ChordEasing; enabled?: boolean; type?: ChordAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<ChordHitDetail | null>","description":"The node or link under a host-local CSS point (a node first, else the topmost ribbon), or null (always without a valid license)."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ChordNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<ChordNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodes","parameters":[],"returns":"Promise<ChordNode[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLinks","parameters":[],"returns":"Promise<ChordLink[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLinkCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<ChordExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayoutStats","parameters":[],"returns":"Promise<{ nodes: number; links: number; total: number; dropped: number; radius: number; nodeWidth: number; padAngle: number; curvature: number }>","description":"Settled perimeter geometry and directed relationship totals."},{"name":"getLabels","parameters":[],"returns":"Promise<ChordNodeLabel[]>","description":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"name":"getLayout","parameters":[],"returns":"Promise<ChordLayoutResult>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"Open a tooltip by point index: perimeter nodes first, then ribbons."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ChordNodeEventDetail | null>","description":"Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ChordNodeEventDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"selectLinkAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ChordLinkEventDetail | null>","description":"Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<ChordSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."}],"events":[{"name":"rendered","type":"ChordRenderResult & { tier: ChordEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"ChordNodeEventDetail","description":"CustomEvent.detail type: ChordNodeEventDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"ChordNodeEventDetail | null","description":"CustomEvent.detail type: ChordNodeEventDetail | null. Event names are case-sensitive."},{"name":"linkClick","type":"ChordLinkEventDetail","description":"CustomEvent.detail type: ChordLinkEventDetail. Event names are case-sensitive."},{"name":"linkHover","type":"ChordLinkEventDetail | null","description":"CustomEvent.detail type: ChordLinkEventDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"ChordSelectionChangeEventDetail","description":"the selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<ChordHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ChordHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"The shared tooltip events (the controller emits them)."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-chord","blocks":[{"kind":"paragraph","text":"Compare relationships such as movement between regions or collaboration between departments."},{"kind":"paragraph","text":"Many connections cause ribbon overlap. Focus on key relationships or use a Network Graph alongside it."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","{ links: [{ source, target, value }] } or a link array."]]},{"kind":"links","items":[{"path":"/charts/chord","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-chord.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-chord\",\n      \"props\": {\n        \"data\": {\n          \"links\": [\n            {\n              \"source\": \"Seoul\",\n              \"target\": \"Busan\",\n              \"value\": 24\n            },\n            {\n              \"source\": \"Busan\",\n              \"target\": \"Daegu\",\n              \"value\": 18\n            },\n            {\n              \"source\": \"Daegu\",\n              \"target\": \"Seoul\",\n              \"value\": 30\n            },\n            {\n              \"source\": \"Seoul\",\n              \"target\": \"Jeju\",\n              \"value\": 12\n            },\n            {\n              \"source\": \"Jeju\",\n              \"target\": \"Busan\",\n              \"value\": 9\n            }\n          ]\n        },\n        \"nodeLabels\": \"show\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'chord example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"{ links: [{ source, target, value }] } or a link array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChordData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChordData","title":"ChordData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-nodeWidth","title":"nodeWidth","blocks":[{"kind":"paragraph","text":"The perimeter band's thickness in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeWidth`"],["HTML attribute","`node-width`"],["Type","`number`"],["Default","`CHORD_DEFAULT_NODE_WIDTH`"]]}]},{"id":"property-padAngle","title":"padAngle","blocks":[{"kind":"paragraph","text":"The gap between perimeter groups, in degrees."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padAngle`"],["HTML attribute","`pad-angle`"],["Type","`number`"],["Default","`CHORD_DEFAULT_PAD_ANGLE`"]]}]},{"id":"property-startAngle","title":"startAngle","blocks":[{"kind":"paragraph","text":"Clockwise start angle in degrees from the positive x axis; -90 starts at the top."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`startAngle`"],["HTML attribute","`start-angle`"],["Type","`number`"],["Default","`CHORD_DEFAULT_START_ANGLE`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"The nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`AUTO_COLOR`"]]}]},{"id":"property-linkColor","title":"linkColor","blocks":[{"kind":"paragraph","text":"The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkColor`"],["HTML attribute","`link-color`"],["Type","`string`"],["Default","`'source'`"]]}]},{"id":"property-linkOpacity","title":"linkOpacity","blocks":[{"kind":"paragraph","text":"The ribbons' opacity (0 … 1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkOpacity`"],["HTML attribute","`link-opacity`"],["Type","`number`"],["Default","`DEFAULT_LINK_OPACITY`"]]}]},{"id":"property-linkCurvature","title":"linkCurvature","blocks":[{"kind":"paragraph","text":"The ribbon bend: 0 straight between ports, 1 pulled through the circle interior."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkCurvature`"],["HTML attribute","`link-curvature`"],["Type","`number`"],["Default","`CHORD_DEFAULT_CURVATURE`"]]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`ChordLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/ChordLabelMode","title":"ChordLabelMode","description":"Type definition"}]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-neighbourDim","title":"neighbourDim","blocks":[{"kind":"paragraph","text":"with a hovered / focused node, the ribbons touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neighbourDim`"],["HTML attribute","`neighbour-dim`"],["Type","`number`"],["Default","`DEFAULT_NEIGHBOUR_DIM`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"The hovered / focused node or link."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`DEFAULT_ACTIVE_COLOR`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"The tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: ChordHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: ChordHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ChordEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ChordEasing","title":"ChordEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ChordAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChordAnimationType","title":"ChordAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"§3.6: an external stream source (link upserts); without one the chart keeps its own on the first push."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ChordStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ChordStreamSource","title":"ChordStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Links tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed links the chart renders (the whole buffer when unset)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the wheel, the pinch and the keyboard over the diagram's unit extents (x 0 → 1 left → right, y 0 → 1 bottom → top — the hidden frame's extents); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ChordEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ChordEngineMode","title":"ChordEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ChordUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/ChordUnavailableBehaviour","title":"ChordUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChordRenderResult & { tier: ChordEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ChordRenderResult & { tier: ChordEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChordRenderResult","title":"ChordRenderResult","description":"Type definition"},{"path":"/docs/types/ChordEngineTier","title":"ChordEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChordNodeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChordNodeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // ChordNodeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChordNodeEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChordNodeEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // ChordNodeEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":"Type definition"}]}]},{"id":"event-linkClick","title":"linkClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChordLinkEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChordLinkEventDetail>`."},{"kind":"code","source":"chart.addEventListener('linkClick', event => {\n  console.log(event.detail); // ChordLinkEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","description":"Type definition"}]}]},{"id":"event-linkHover","title":"linkHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChordLinkEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChordLinkEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('linkHover', event => {\n  console.log(event.detail); // ChordLinkEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"the selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChordSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // ChordSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChordSelectionChangeEventDetail","title":"ChordSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ChordHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<ChordHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<ChordHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"The shared tooltip events (the controller emits them)."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ChordRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordRenderResult","title":"ChordRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<ChordEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordEngineTier","title":"ChordEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ChordData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ChordData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordData","title":"ChordData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(link: ChordLinkInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`link`","`ChordLinkInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(links: ReadonlyArray<ChordLinkInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`links`","`ReadonlyArray<ChordLinkInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed links (the `data` links are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(links: ReadonlyArray<ChordLinkInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`links`","`ReadonlyArray<ChordLinkInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ChordStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordStreamSource","title":"ChordStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.chord license state."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: ChordEasing; enabled?: boolean; type?: ChordAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: ChordEasing; enabled?: boolean; type?: ChordAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordEasing","title":"ChordEasing","description":"Type definition"},{"path":"/docs/types/ChordAnimationType","title":"ChordAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The node or link under a host-local CSS point (a node first, else the topmost ribbon), or null (always without a valid license)."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<ChordHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChordHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<ChordNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChordNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordNode","title":"ChordNode","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<ChordNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChordNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordNode","title":"ChordNode","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<ChordNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordNode","title":"ChordNode","description":"Type definition"}]}]},{"id":"method-getLinks","title":"getLinks","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLinks(): Promise<ChordLink[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordLink[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordLink","title":"ChordLink","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLinkCount","title":"getLinkCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLinkCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<ChordExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordExtent","title":"ChordExtent","description":"Type definition"}]}]},{"id":"method-getLayoutStats","title":"getLayoutStats","blocks":[{"kind":"paragraph","text":"Settled perimeter geometry and directed relationship totals."},{"kind":"code","source":"getLayoutStats(): Promise<{ nodes: number; links: number; total: number; dropped: number; radius: number; nodeWidth: number; padAngle: number; curvature: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ nodes: number; links: number; total: number; dropped: number; radius: number; nodeWidth: number; padAngle: number; curvature: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"kind":"code","source":"getLabels(): Promise<ChordNodeLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordNodeLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordNodeLabel","title":"ChordNodeLabel","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<ChordLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordLayoutResult","title":"ChordLayoutResult","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"Open a tooltip by point index: perimeter nodes first, then ribbons."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusNodeAt","title":"focusNodeAt","blocks":[{"kind":"paragraph","text":"Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk."},{"kind":"code","source":"focusNodeAt(index: number): Promise<ChordNodeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChordNodeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<ChordNodeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChordNodeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":"Type definition"}]}]},{"id":"method-selectLinkAt","title":"selectLinkAt","blocks":[{"kind":"paragraph","text":"Select (pin) a link: its ribbon keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"kind":"code","source":"selectLinkAt(index: number): Promise<ChordLinkEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ChordLinkEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<ChordSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChordSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChordSelection","title":"ChordSelection","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/network-graph","title":"Network Graph","summary":"Explore entities and their connections as a network.","kind":"component","tag":"sy-network-graph","componentId":"network-graph","api":{"props":[{"name":"data","attribute":"data","type":"NetworkGraphData","kind":"property","values":[],"default":"undefined","description":"nodes and links with source and target."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"nodeRadius","attribute":"node-radius","type":"number","kind":"number","values":[],"default":"NETWORK_GRAPH_DEFAULT_NODE_RADIUS","description":"The radius of each node in CSS pixels, including isolated nodes."},{"name":"linkWidth","attribute":"link-width","type":"number","kind":"number","values":[],"default":"NETWORK_GRAPH_DEFAULT_LINK_WIDTH","description":"The connecting line's width in CSS pixels; link values do not change its width."},{"name":"layout","attribute":"layout","type":"NetworkGraphLayout","kind":"string","values":["circular","force","hierarchical"],"default":"'circular'","description":"Choose circular, force, or hierarchical."},{"name":"layoutIterations","attribute":"layout-iterations","type":"number","kind":"number","values":[],"default":"NETWORK_GRAPH_DEFAULT_LAYOUT_ITERATIONS","description":"Maximum force iterations, clamped to 0…10000; other layouts ignore this option. The solver also enforces its work budget."},{"name":"linkDistance","attribute":"link-distance","type":"number","kind":"number","values":[],"default":"NETWORK_GRAPH_DEFAULT_LINK_DISTANCE","description":"Desired force spring length in CSS pixels; other layouts ignore this option."},{"name":"repulsion","attribute":"repulsion","type":"number","kind":"number","values":[],"default":"NETWORK_GRAPH_DEFAULT_REPULSION","description":"Force repulsion strength; zero disables repulsion. Other layouts ignore this option."},{"name":"bundling","attribute":"bundling","type":"NetworkGraphBundling","kind":"string","values":["none","force"],"default":"'none'","description":"`none` or `force`: bundle the connecting lines of distinct endpoint pairs toward compatible neighbours; positions, identities, lanes and hit rules stay."},{"name":"bundleStrength","attribute":"bundle-strength","type":"number","kind":"number","values":[],"default":"NETWORK_GRAPH_BUNDLING_DEFAULT_STRENGTH","description":"The bundling attraction, 0 … 1 (0 keeps straight centrelines); ignored while bundling is `none`."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"AUTO_COLOR","description":"The nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins."},{"name":"linkColor","attribute":"link-color","type":"string","kind":"string","values":[],"default":"'source'","description":"The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins."},{"name":"linkOpacity","attribute":"link-opacity","type":"number","kind":"number","values":[],"default":"DEFAULT_LINK_OPACITY","description":"The connecting lines' opacity (0 … 1)."},{"name":"linkCurvature","attribute":"link-curvature","type":"number","kind":"number","values":[],"default":"NETWORK_GRAPH_DEFAULT_CURVATURE","description":"Connecting-line curvature (0 … 1). Self and parallel links keep distinct paths."},{"name":"clustering","attribute":"clustering","type":"NetworkGraphClustering","kind":"string","values":["none","louvain"],"default":"'none'","description":"Community detection over the current graph, independent of `layout`: `none` or `louvain`; with `color=\"auto\"` the palette follows the group instead of the node index."},{"name":"nodeLabels","attribute":"node-labels","type":"NetworkGraphLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"neighbourDim","attribute":"neighbour-dim","type":"number","kind":"number","values":[],"default":"DEFAULT_NEIGHBOUR_DIM","description":"with a hovered / focused node, the links touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim)."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"DEFAULT_ACTIVE_COLOR","description":"The hovered / focused node or link."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"nodeDrag","attribute":"node-drag","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Nodes can be dragged with a pointer (mouse, touch, pen) and nudged with Ctrl / ⌘ + arrows; a dragged node stays pinned where it was dropped."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"The tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: NetworkGraphHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: NetworkGraphHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"NetworkGraphEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"NetworkGraphAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"NetworkGraphStreamSource","kind":"property","values":[],"default":"undefined","description":"§3.6: an external stream source (link upserts); without one the chart keeps its own on the first push."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Links tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed links the chart renders (the whole buffer when unset)."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the wheel, the pinch and the keyboard over the diagram's unit extents (x 0 → 1 left → right, y 0 → 1 bottom → top — the hidden frame's extents); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"name":"engine","attribute":"engine","type":"NetworkGraphEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"NetworkGraphUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<NetworkGraphRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<NetworkGraphEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"NetworkGraphData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"link","type":"NetworkGraphLinkInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"links","type":"ReadonlyArray<NetworkGraphLinkInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed links (the `data` links are not the stream)."},{"name":"replace","parameters":[{"name":"links","type":"ReadonlyArray<NetworkGraphLinkInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<NetworkGraphStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.network-graph license state."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: NetworkGraphEasing; enabled?: boolean; type?: NetworkGraphAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<NetworkGraphHitDetail | null>","description":"The node or link under a host-local CSS point (a node first, else the topmost link), or null (always without a valid license)."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<NetworkGraphNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<NetworkGraphNode | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodes","parameters":[],"returns":"Promise<NetworkGraphNode[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLinks","parameters":[],"returns":"Promise<NetworkGraphLink[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLinkCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<NetworkGraphExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pinNode","parameters":[{"name":"id","type":"string","optional":false},{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<NetworkGraphPinnedNode | null>","description":"Holds a node (by id) at a plot-local, unzoomed position, as a finished drag does: the paths re-route and an update morph moves it there. Returns the applied (clamped) position, or null for an unknown id."},{"name":"unpinNode","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<boolean>","description":"Releases a pinned node back to its layout position (with an update morph); false when it was not pinned."},{"name":"clearPinnedNodes","parameters":[],"returns":"Promise<number>","description":"Network Graph — release every pinned node; the count released."},{"name":"getPinnedNodes","parameters":[],"returns":"Promise<NetworkGraphPinnedNode[]>","description":"The pinned nodes of the current graph in id order, at their applied (clamped) positions."},{"name":"getLayoutStats","parameters":[],"returns":"Promise<{ nodes: number; links: number; total: number; dropped: number; nodeRadius: number; linkWidth: number; layout: NetworkGraphLayout; curvature: number; force?: NetworkGraphForceStats; hierarchical?: NetworkGraphHierarchicalStats; bundling?: NetworkGraphBundlingStats; pinned?: number }>","description":"Settled node/link geometry, relationship totals and target layout diagnostics. A target's statistics do not describe animation progress."},{"name":"getClusters","parameters":[],"returns":"Promise<NetworkGraphClusteringResult | null>","description":"The current graph's communities while `clustering=\"louvain\"` (deep copies; null when `none`). Layout, zoom and animation do not change them."},{"name":"getLabels","parameters":[],"returns":"Promise<NetworkGraphNodeLabel[]>","description":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"name":"getLayout","parameters":[],"returns":"Promise<NetworkGraphLayoutResult>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"Open a tooltip by point index: all nodes first, then links."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<NetworkGraphNodeEventDetail | null>","description":"Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<NetworkGraphNodeEventDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"selectLinkAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<NetworkGraphLinkEventDetail | null>","description":"Select (pin) a link: its link keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<NetworkGraphSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."}],"events":[{"name":"rendered","type":"NetworkGraphRenderResult & { tier: NetworkGraphEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"NetworkGraphNodeEventDetail","description":"CustomEvent.detail type: NetworkGraphNodeEventDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"NetworkGraphNodeEventDetail | null","description":"CustomEvent.detail type: NetworkGraphNodeEventDetail | null. Event names are case-sensitive."},{"name":"linkClick","type":"NetworkGraphLinkEventDetail","description":"CustomEvent.detail type: NetworkGraphLinkEventDetail. Event names are case-sensitive."},{"name":"linkHover","type":"NetworkGraphLinkEventDetail | null","description":"CustomEvent.detail type: NetworkGraphLinkEventDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"NetworkGraphSelectionChangeEventDetail","description":"the selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it."},{"name":"nodeDragStart","type":"NetworkGraphNodeDragEventDetail","description":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"name":"nodeDragMove","type":"NetworkGraphNodeDragEventDetail","description":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"name":"nodeDragEnd","type":"NetworkGraphNodeDragEventDetail","description":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<NetworkGraphHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<NetworkGraphHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"The shared tooltip events (the controller emits them)."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-network-graph","blocks":[{"kind":"paragraph","text":"Inspect dependencies, collaboration, or service connections."},{"kind":"paragraph","text":"On-screen distance is a layout result. Do not interpret it as actual distance or relationship strength without an explicit definition."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","nodes and links with source and target."],["`layout`","Choose circular, force, or hierarchical."]]},{"kind":"links","items":[{"path":"/charts/network-graph","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-network-graph.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-network-graph\",\n      \"props\": {\n        \"data\": {\n          \"links\": [\n            {\n              \"source\": \"Seoul\",\n              \"target\": \"Busan\",\n              \"value\": 24\n            },\n            {\n              \"source\": \"Busan\",\n              \"target\": \"Daegu\",\n              \"value\": 18\n            },\n            {\n              \"source\": \"Daegu\",\n              \"target\": \"Seoul\",\n              \"value\": 30\n            },\n            {\n              \"source\": \"Seoul\",\n              \"target\": \"Jeju\",\n              \"value\": 12\n            },\n            {\n              \"source\": \"Jeju\",\n              \"target\": \"Busan\",\n              \"value\": 9\n            }\n          ]\n        },\n        \"layout\": \"circular\",\n        \"nodeLabels\": \"show\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'network-graph example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"nodes and links with source and target."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`NetworkGraphData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphData","title":"NetworkGraphData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-nodeRadius","title":"nodeRadius","blocks":[{"kind":"paragraph","text":"The radius of each node in CSS pixels, including isolated nodes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeRadius`"],["HTML attribute","`node-radius`"],["Type","`number`"],["Default","`NETWORK_GRAPH_DEFAULT_NODE_RADIUS`"]]}]},{"id":"property-linkWidth","title":"linkWidth","blocks":[{"kind":"paragraph","text":"The connecting line's width in CSS pixels; link values do not change its width."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkWidth`"],["HTML attribute","`link-width`"],["Type","`number`"],["Default","`NETWORK_GRAPH_DEFAULT_LINK_WIDTH`"]]}]},{"id":"property-layout","title":"layout","blocks":[{"kind":"paragraph","text":"Choose circular, force, or hierarchical."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`layout`"],["HTML attribute","`layout`"],["Type","`NetworkGraphLayout`"],["Default","`'circular'`"],["Allowed values","`circular`, `force`, `hierarchical`"]]},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLayout","title":"NetworkGraphLayout","description":"Type definition"}]}]},{"id":"property-layoutIterations","title":"layoutIterations","blocks":[{"kind":"paragraph","text":"Maximum force iterations, clamped to 0…10000; other layouts ignore this option. The solver also enforces its work budget."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`layoutIterations`"],["HTML attribute","`layout-iterations`"],["Type","`number`"],["Default","`NETWORK_GRAPH_DEFAULT_LAYOUT_ITERATIONS`"]]}]},{"id":"property-linkDistance","title":"linkDistance","blocks":[{"kind":"paragraph","text":"Desired force spring length in CSS pixels; other layouts ignore this option."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkDistance`"],["HTML attribute","`link-distance`"],["Type","`number`"],["Default","`NETWORK_GRAPH_DEFAULT_LINK_DISTANCE`"]]}]},{"id":"property-repulsion","title":"repulsion","blocks":[{"kind":"paragraph","text":"Force repulsion strength; zero disables repulsion. Other layouts ignore this option."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`repulsion`"],["HTML attribute","`repulsion`"],["Type","`number`"],["Default","`NETWORK_GRAPH_DEFAULT_REPULSION`"]]}]},{"id":"property-bundling","title":"bundling","blocks":[{"kind":"paragraph","text":"`none` or `force`: bundle the connecting lines of distinct endpoint pairs toward compatible neighbours; positions, identities, lanes and hit rules stay."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bundling`"],["HTML attribute","`bundling`"],["Type","`NetworkGraphBundling`"],["Default","`'none'`"],["Allowed values","`none`, `force`"]]},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphBundling","title":"NetworkGraphBundling","description":"Type definition"}]}]},{"id":"property-bundleStrength","title":"bundleStrength","blocks":[{"kind":"paragraph","text":"The bundling attraction, 0 … 1 (0 keeps straight centrelines); ignored while bundling is `none`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bundleStrength`"],["HTML attribute","`bundle-strength`"],["Type","`number`"],["Default","`NETWORK_GRAPH_BUNDLING_DEFAULT_STRENGTH`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"The nodes' fill: `auto` (the palette by index) or a CSS colour; a node's own `color` wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`AUTO_COLOR`"]]}]},{"id":"property-linkColor","title":"linkColor","blocks":[{"kind":"paragraph","text":"The links' colour: `source` / `target` (the node's colour at that end) or a CSS colour; a link's own `color` wins."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkColor`"],["HTML attribute","`link-color`"],["Type","`string`"],["Default","`'source'`"]]}]},{"id":"property-linkOpacity","title":"linkOpacity","blocks":[{"kind":"paragraph","text":"The connecting lines' opacity (0 … 1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkOpacity`"],["HTML attribute","`link-opacity`"],["Type","`number`"],["Default","`DEFAULT_LINK_OPACITY`"]]}]},{"id":"property-linkCurvature","title":"linkCurvature","blocks":[{"kind":"paragraph","text":"Connecting-line curvature (0 … 1). Self and parallel links keep distinct paths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`linkCurvature`"],["HTML attribute","`link-curvature`"],["Type","`number`"],["Default","`NETWORK_GRAPH_DEFAULT_CURVATURE`"]]}]},{"id":"property-clustering","title":"clustering","blocks":[{"kind":"paragraph","text":"Community detection over the current graph, independent of `layout`: `none` or `louvain`; with `color=\"auto\"` the palette follows the group instead of the node index."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`clustering`"],["HTML attribute","`clustering`"],["Type","`NetworkGraphClustering`"],["Default","`'none'`"],["Allowed values","`none`, `louvain`"]]},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphClustering","title":"NetworkGraphClustering","description":"Type definition"}]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"the node labels beside the nodes: `auto` (hidden where they would overlap), `show`, `hide`; `node-label-value` appends the throughput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`NetworkGraphLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLabelMode","title":"NetworkGraphLabelMode","description":"Type definition"}]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-neighbourDim","title":"neighbourDim","blocks":[{"kind":"paragraph","text":"with a hovered / focused node, the links touching neither of its ends fade to this alpha factor (0 … 1; 1 = no dim)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`neighbourDim`"],["HTML attribute","`neighbour-dim`"],["Type","`number`"],["Default","`DEFAULT_NEIGHBOUR_DIM`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"The hovered / focused node or link."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`DEFAULT_ACTIVE_COLOR`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-nodeDrag","title":"nodeDrag","blocks":[{"kind":"paragraph","text":"Nodes can be dragged with a pointer (mouse, touch, pen) and nudged with Ctrl / ⌘ + arrows; a dragged node stays pinned where it was dropped."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeDrag`"],["HTML attribute","`node-drag`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"The tooltip (the shared cartesian tooltip input: trigger, format, html, connector …), its switch, a formatter of the default text."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: NetworkGraphHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: NetworkGraphHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`NetworkGraphEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphEasing","title":"NetworkGraphEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`NetworkGraphAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphAnimationType","title":"NetworkGraphAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"§3.6: an external stream source (link upserts); without one the chart keeps its own on the first push."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`NetworkGraphStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphStreamSource","title":"NetworkGraphStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Links tracked by the internal stream at most (the oldest leave as `windowSlid`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed links the chart renders (the whole buffer when unset)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the wheel, the pinch and the keyboard over the diagram's unit extents (x 0 → 1 left → right, y 0 → 1 bottom → top — the hidden frame's extents); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`NetworkGraphEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphEngineMode","title":"NetworkGraphEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`NetworkGraphUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphUnavailableBehaviour","title":"NetworkGraphUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphRenderResult & { tier: NetworkGraphEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // NetworkGraphRenderResult & { tier: NetworkGraphEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphRenderResult","title":"NetworkGraphRenderResult","description":"Type definition"},{"path":"/docs/types/NetworkGraphEngineTier","title":"NetworkGraphEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: NetworkGraphNodeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // NetworkGraphNodeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: NetworkGraphNodeEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // NetworkGraphNodeEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":"Type definition"}]}]},{"id":"event-linkClick","title":"linkClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: NetworkGraphLinkEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphLinkEventDetail>`."},{"kind":"code","source":"chart.addEventListener('linkClick', event => {\n  console.log(event.detail); // NetworkGraphLinkEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","description":"Type definition"}]}]},{"id":"event-linkHover","title":"linkHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: NetworkGraphLinkEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `linkHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphLinkEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('linkHover', event => {\n  console.log(event.detail); // NetworkGraphLinkEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"the selection (the pinned highlight) changed: a node or a link (never both) or nothing, and what changed it."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // NetworkGraphSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphSelectionChangeEventDetail","title":"NetworkGraphSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-nodeDragStart","title":"nodeDragStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeDragStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeDragEventDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeDragStart', event => {\n  console.log(event.detail); // NetworkGraphNodeDragEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","description":"Type definition"}]}]},{"id":"event-nodeDragMove","title":"nodeDragMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeDragMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeDragEventDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeDragMove', event => {\n  console.log(event.detail); // NetworkGraphNodeDragEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","description":"Type definition"}]}]},{"id":"event-nodeDragEnd","title":"nodeDragEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: NetworkGraphNodeDragEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeDragEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<NetworkGraphNodeDragEventDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeDragEnd', event => {\n  console.log(event.detail); // NetworkGraphNodeDragEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<NetworkGraphHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<NetworkGraphHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<NetworkGraphHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"The shared tooltip events (the controller emits them)."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<NetworkGraphRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphRenderResult","title":"NetworkGraphRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<NetworkGraphEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphEngineTier","title":"NetworkGraphEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: NetworkGraphData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`NetworkGraphData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphData","title":"NetworkGraphData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(link: NetworkGraphLinkInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`link`","`NetworkGraphLinkInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(links: ReadonlyArray<NetworkGraphLinkInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`links`","`ReadonlyArray<NetworkGraphLinkInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed links (the `data` links are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(links: ReadonlyArray<NetworkGraphLinkInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`links`","`ReadonlyArray<NetworkGraphLinkInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<NetworkGraphStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphStreamSource","title":"NetworkGraphStreamSource","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested vs effective engine and why (CHART-ADD-08), with the chart.type.network-graph license state."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: NetworkGraphEasing; enabled?: boolean; type?: NetworkGraphAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: NetworkGraphEasing; enabled?: boolean; type?: NetworkGraphAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphEasing","title":"NetworkGraphEasing","description":"Type definition"},{"path":"/docs/types/NetworkGraphAnimationType","title":"NetworkGraphAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The node or link under a host-local CSS point (a node first, else the topmost link), or null (always without a valid license)."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<NetworkGraphHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<NetworkGraphNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNode","title":"NetworkGraphNode","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<NetworkGraphNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNode","title":"NetworkGraphNode","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<NetworkGraphNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNode","title":"NetworkGraphNode","description":"Type definition"}]}]},{"id":"method-getLinks","title":"getLinks","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLinks(): Promise<NetworkGraphLink[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphLink[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLink","title":"NetworkGraphLink","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLinkCount","title":"getLinkCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLinkCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<NetworkGraphExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphExtent","title":"NetworkGraphExtent","description":"Type definition"}]}]},{"id":"method-pinNode","title":"pinNode","blocks":[{"kind":"paragraph","text":"Holds a node (by id) at a plot-local, unzoomed position, as a finished drag does: the paths re-route and an update morph moves it there. Returns the applied (clamped) position, or null for an unknown id."},{"kind":"code","source":"pinNode(id: string, x: number, y: number): Promise<NetworkGraphPinnedNode | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphPinnedNode | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphPinnedNode","title":"NetworkGraphPinnedNode","description":"Type definition"}]}]},{"id":"method-unpinNode","title":"unpinNode","blocks":[{"kind":"paragraph","text":"Releases a pinned node back to its layout position (with an update morph); false when it was not pinned."},{"kind":"code","source":"unpinNode(id: string): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-clearPinnedNodes","title":"clearPinnedNodes","blocks":[{"kind":"paragraph","text":"Network Graph — release every pinned node; the count released."},{"kind":"code","source":"clearPinnedNodes(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getPinnedNodes","title":"getPinnedNodes","blocks":[{"kind":"paragraph","text":"The pinned nodes of the current graph in id order, at their applied (clamped) positions."},{"kind":"code","source":"getPinnedNodes(): Promise<NetworkGraphPinnedNode[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphPinnedNode[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphPinnedNode","title":"NetworkGraphPinnedNode","description":"Type definition"}]}]},{"id":"method-getLayoutStats","title":"getLayoutStats","blocks":[{"kind":"paragraph","text":"Settled node/link geometry, relationship totals and target layout diagnostics. A target's statistics do not describe animation progress."},{"kind":"code","source":"getLayoutStats(): Promise<{ nodes: number; links: number; total: number; dropped: number; nodeRadius: number; linkWidth: number; layout: NetworkGraphLayout; curvature: number; force?: NetworkGraphForceStats; hierarchical?: NetworkGraphHierarchicalStats; bundling?: NetworkGraphBundlingStats; pinned?: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ nodes: number; links: number; total: number; dropped: number; nodeRadius: number; linkWidth: number; layout: NetworkGraphLayout; curvature: number; force?: NetworkGraphForceStats; hierarchical?: NetworkGraphHierarchicalStats; bundling?: NetworkGraphBundlingStats; pinned?: number }>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLayout","title":"NetworkGraphLayout","description":"Type definition"},{"path":"/docs/types/NetworkGraphForceStats","title":"NetworkGraphForceStats","description":"Type definition"},{"path":"/docs/types/NetworkGraphHierarchicalStats","title":"NetworkGraphHierarchicalStats","description":"Type definition"},{"path":"/docs/types/NetworkGraphBundlingStats","title":"NetworkGraphBundlingStats","description":"Type definition"}]}]},{"id":"method-getClusters","title":"getClusters","blocks":[{"kind":"paragraph","text":"The current graph's communities while `clustering=\"louvain\"` (deep copies; null when `none`). Layout, zoom and animation do not change them."},{"kind":"code","source":"getClusters(): Promise<NetworkGraphClusteringResult | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphClusteringResult | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphClusteringResult","title":"NetworkGraphClusteringResult","description":"Type definition"}]}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"kind":"code","source":"getLabels(): Promise<NetworkGraphNodeLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphNodeLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeLabel","title":"NetworkGraphNodeLabel","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<NetworkGraphLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLayoutResult","title":"NetworkGraphLayoutResult","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"Open a tooltip by point index: all nodes first, then links."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusNodeAt","title":"focusNodeAt","blocks":[{"kind":"paragraph","text":"Move the keyboard focus ring to a node (null off the nodes); emits nodeHover like the walk."},{"kind":"code","source":"focusNodeAt(index: number): Promise<NetworkGraphNodeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphNodeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<NetworkGraphNodeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphNodeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":"Type definition"}]}]},{"id":"method-selectLinkAt","title":"selectLinkAt","blocks":[{"kind":"paragraph","text":"Select (pin) a link: its link keeps the accent after the pointer leaves; a negative or unknown index releases the selection."},{"kind":"code","source":"selectLinkAt(index: number): Promise<NetworkGraphLinkEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphLinkEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<NetworkGraphSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<NetworkGraphSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/NetworkGraphSelection","title":"NetworkGraphSelection","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/theme-river","title":"Theme River","summary":"Stack multiple flows as they change over time.","kind":"component","tag":"sy-theme-river","componentId":"theme-river","api":{"props":[{"name":"data","attribute":"data","type":"ThemeRiverData","kind":"property","values":[],"default":"undefined","description":"{ x: [...], series: [{ id, name?, values }] }. Align every values array with x."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"420","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"offset","attribute":"offset","type":"ThemeRiverOffset","kind":"string","values":["silhouette","zero","expand"],"default":"'silhouette'","description":"The baseline mode: silhouette, zero, or expand."},{"name":"order","attribute":"order","type":"ThemeRiverOrder","kind":"string","values":["input","reverse"],"default":"'input'","description":"Allowed values: input, reverse. Default: 'input'."},{"name":"colors","attribute":"colors","type":"ReadonlyArray<string>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"name":"opacity","attribute":"opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"axes","attribute":"axes","type":"ThemeRiverAxesOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ThemeRiverAxesOptions."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to show a legend for series or items."},{"name":"hiddenSeries","attribute":"hidden-series","type":"ReadonlyArray<ThemeRiverId>","kind":"property","values":[],"default":"[]","description":"Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"locale","attribute":"locale","type":"string","kind":"string","values":[],"default":"'en'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"showEmpty","attribute":"show-empty","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: ThemeRiverHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: ThemeRiverHitDetail) => string."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"crosshairSnapDistance","attribute":"crosshair-snap-distance","type":"number","kind":"number","values":[],"default":"24","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ThemeRiverEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ThemeRiverAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"ThemeRiverStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"128","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"engine","attribute":"engine","type":"ThemeRiverEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"ThemeRiverUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<ThemeRiverRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<HeatmapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"name":"recycleGpu","parameters":[],"returns":"Promise<void>","description":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"name":"setData","parameters":[{"name":"data","type":"ThemeRiverData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getData","parameters":[],"returns":"Promise<ThemeRiverData>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayout","parameters":[],"returns":"Promise<ThemeRiverLayout>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"getDiagnostics","parameters":[],"returns":"Promise<{ columns: number; series: number; points: number; missingValues: number; zeroValues: number; }>","description":"Normalization diagnostics for the effective base and stream source."},{"name":"appendPoint","parameters":[{"name":"row","type":"ThemeRiverRow","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"rows","type":"ReadonlyArray<ThemeRiverRow>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"replace","parameters":[{"name":"rows","type":"ReadonlyArray<ThemeRiverRow>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ThemeRiverStreamSource>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"clearStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setAnimation","parameters":[{"name":"options","type":"{\n        enabled?: boolean;\n        duration?: number;\n        easing?: ThemeRiverEasing;\n        type?: ThemeRiverAnimationType;\n    }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getCSV","parameters":[{"name":"options","type":"CsvOptions","optional":true}],"returns":"Promise<string>","description":"The tape as a CSV table (ISO time, OHLC, volume)."},{"name":"getTable","parameters":[],"returns":"Promise<string>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<{ cssX: number; cssY: number; kind: \"band\"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectPointAt","parameters":[{"name":"series","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<{ cssX: number; cssY: number; kind: \"band\"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>","description":"An asynchronous method. Check the argument and return types below."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<ThemeRiverSelection | null>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"showTooltipAtPoint","parameters":[{"name":"series","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail>","description":"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."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"showCrosshairAt","parameters":[{"name":"series","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"showCrosshairAtData","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"Quiet source-category synchronization. Categories retain their original string or number type."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{\n        x?: number;\n        y?: number;\n    }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."}],"events":[{"name":"rendered","type":"ThemeRiverRenderResult & {\n        tier: ThemeRiverEngineTier;\n    }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"ThemeRiverHitDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"ThemeRiverHitDetail | null","description":"CustomEvent.detail type: ThemeRiverHitDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"ThemeRiverSelectionChangeEventDetail","description":"CustomEvent.detail type: ThemeRiverSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"ThemeRiverCrosshairDetail | null","description":"CustomEvent.detail type: ThemeRiverCrosshairDetail | null. Event names are case-sensitive."},{"name":"appended","type":"{\n        count: number;\n        replaced: number;\n    }","description":"CustomEvent.detail type: {\n        count: number;\n        replaced: number;\n    }. Event names are case-sensitive."},{"name":"windowSlid","type":"{\n        dropped: number;\n    }","description":"CustomEvent.detail type: {\n        dropped: number;\n    }. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"dataValidationError","type":"{\n        message: string;\n    }","description":"CustomEvent.detail type: {\n        message: string;\n    }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<ThemeRiverHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ThemeRiverHitDetail>. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-theme-river","blocks":[{"kind":"paragraph","text":"Explore changes in topic interest or composition."},{"kind":"paragraph","text":"The central baseline moves, so read band thickness rather than vertical position. Use a table for precise comparisons."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","{ x: [...], series: [{ id, name?, values }] }. Align every values array with x."],["`offset`","The baseline mode: silhouette, zero, or expand."]]},{"kind":"links","items":[{"path":"/charts/theme-river","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-theme-river.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-theme-river\",\n      \"props\": {\n        \"data\": {\n          \"x\": [0, 1, 2, 3, 4, 5],\n          \"series\": [\n            {\n              \"id\": \"s0\",\n              \"name\": \"Online\",\n              \"values\": [24, 29, 27, 38, 43, 40],\n              \"color\": \"#8263d9\"\n            },\n            {\n              \"id\": \"s1\",\n              \"name\": \"Store\",\n              \"values\": [15, 19, 17, 24, 22, 29],\n              \"color\": \"#239c91\"\n            }\n          ]\n        },\n        \"offset\": \"silhouette\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'theme-river example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"{ x: [...], series: [{ id, name?, values }] }. Align every values array with x."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ThemeRiverData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`420`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-offset","title":"offset","blocks":[{"kind":"paragraph","text":"The baseline mode: silhouette, zero, or expand."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`offset`"],["HTML attribute","`offset`"],["Type","`ThemeRiverOffset`"],["Default","`'silhouette'`"],["Allowed values","`silhouette`, `zero`, `expand`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverOffset","title":"ThemeRiverOffset","description":"Type definition"}]}]},{"id":"property-order","title":"order","blocks":[{"kind":"paragraph","text":"Allowed values: input, reverse. Default: 'input'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`order`"],["HTML attribute","`order`"],["Type","`ThemeRiverOrder`"],["Default","`'input'`"],["Allowed values","`input`, `reverse`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverOrder","title":"ThemeRiverOrder","description":"Type definition"}]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<string>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-opacity","title":"opacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`opacity`"],["HTML attribute","`opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-axes","title":"axes","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ThemeRiverAxesOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ThemeRiverAxesOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverAxesOptions","title":"ThemeRiverAxesOptions","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-hiddenSeries","title":"hiddenSeries","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<ThemeRiverId>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`hiddenSeries`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<ThemeRiverId>`"],["Default","`[]`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-locale","title":"locale","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locale`"],["HTML attribute","`locale`"],["Type","`string`"],["Default","`'en'`"]]}]},{"id":"property-showEmpty","title":"showEmpty","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showEmpty`"],["HTML attribute","`show-empty`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: ThemeRiverHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: ThemeRiverHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-crosshairSnapDistance","title":"crosshairSnapDistance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairSnapDistance`"],["HTML attribute","`crosshair-snap-distance`"],["Type","`number`"],["Default","`24`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ThemeRiverEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverEasing","title":"ThemeRiverEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ThemeRiverAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverAnimationType","title":"ThemeRiverAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ThemeRiverStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverStreamSource","title":"ThemeRiverStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`128`"]]}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ThemeRiverEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverEngineMode","title":"ThemeRiverEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ThemeRiverUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverUnavailableBehaviour","title":"ThemeRiverUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ThemeRiverRenderResult & {\n        tier: ThemeRiverEngineTier;\n    }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ThemeRiverRenderResult & {\n        tier: ThemeRiverEngineTier;\n    }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverRenderResult","title":"ThemeRiverRenderResult","description":"Type definition"},{"path":"/docs/types/ThemeRiverEngineTier","title":"ThemeRiverEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ThemeRiverHitDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // ThemeRiverHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ThemeRiverHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ThemeRiverHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // ThemeRiverHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ThemeRiverSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ThemeRiverSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // ThemeRiverSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverSelectionChangeEventDetail","title":"ThemeRiverSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ThemeRiverCrosshairDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ThemeRiverCrosshairDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // ThemeRiverCrosshairDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverCrosshairDetail","title":"ThemeRiverCrosshairDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {\n        count: number;\n        replaced: number;\n    }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{\n        count: number;\n        replaced: number;\n    }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // {\n        count: number;\n        replaced: number;\n    }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {\n        dropped: number;\n    }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{\n        dropped: number;\n    }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // {\n        dropped: number;\n    }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-dataValidationError","title":"dataValidationError","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {\n        message: string;\n    }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{\n        message: string;\n    }>`."},{"kind":"code","source":"chart.addEventListener('dataValidationError', event => {\n  console.log(event.detail); // {\n        message: string;\n    }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ThemeRiverHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<ThemeRiverHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<ThemeRiverHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ThemeRiverRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverRenderResult","title":"ThemeRiverRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<HeatmapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<HeatmapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-recycleGpu","title":"recycleGpu","blocks":[{"kind":"paragraph","text":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"kind":"code","source":"recycleGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ThemeRiverData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ThemeRiverData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","description":"Type definition"}]}]},{"id":"method-getData","title":"getData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getData(): Promise<ThemeRiverData>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverData>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<ThemeRiverLayout>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverLayout>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverLayout","title":"ThemeRiverLayout","description":"Type definition"}]}]},{"id":"method-getDiagnostics","title":"getDiagnostics","blocks":[{"kind":"paragraph","text":"Normalization diagnostics for the effective base and stream source."},{"kind":"code","source":"getDiagnostics(): Promise<{ columns: number; series: number; points: number; missingValues: number; zeroValues: number; }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ columns: number; series: number; points: number; missingValues: number; zeroValues: number; }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(row: ThemeRiverRow): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`ThemeRiverRow`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rows`","`ReadonlyArray<ThemeRiverRow>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":"Type definition"}]}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(rows: ReadonlyArray<ThemeRiverRow>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rows`","`ReadonlyArray<ThemeRiverRow>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ThemeRiverStreamSource>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverStreamSource>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverStreamSource","title":"ThemeRiverStreamSource","description":"Type definition"}]}]},{"id":"method-clearStream","title":"clearStream","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"clearStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: {\n        enabled?: boolean;\n        duration?: number;\n        easing?: ThemeRiverEasing;\n        type?: ThemeRiverAnimationType;\n    }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{\n        enabled?: boolean;\n        duration?: number;\n        easing?: ThemeRiverEasing;\n        type?: ThemeRiverAnimationType;\n    }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverEasing","title":"ThemeRiverEasing","description":"Type definition"},{"path":"/docs/types/ThemeRiverAnimationType","title":"ThemeRiverAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getCSV","title":"getCSV","blocks":[{"kind":"paragraph","text":"The tape as a CSV table (ISO time, OHLC, volume)."},{"kind":"code","source":"getCSV(options?: CsvOptions): Promise<string>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`CsvOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CsvOptions","title":"CsvOptions","description":"Type definition"}]}]},{"id":"method-getTable","title":"getTable","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTable(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<{ cssX: number; cssY: number; kind: \"band\"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ cssX: number; cssY: number; kind: \"band\"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":"Type definition"}]}]},{"id":"method-selectPointAt","title":"selectPointAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectPointAt(series: number, column: number): Promise<{ cssX: number; cssY: number; kind: \"band\"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ cssX: number; cssY: number; kind: \"band\"; seriesIndex: number; seriesId: ThemeRiverId; seriesName: string; columnIndex: number; dataX: number; value: number; lower: number; upper: number; interpolated: boolean; }>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<ThemeRiverSelection | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ThemeRiverSelection | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ThemeRiverSelection","title":"ThemeRiverSelection","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(series: number, column: number): Promise<CartesianTooltipEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(series: number, column: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`series`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAtData","title":"showCrosshairAtData","blocks":[{"kind":"paragraph","text":"Quiet source-category synchronization. Categories retain their original string or number type."},{"kind":"code","source":"showCrosshairAtData(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: {\n        x?: number;\n        y?: number;\n    }): Promise<CartesianZoomChangeEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{\n        x?: number;\n        y?: number;\n    }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/parallel-coordinates","title":"Parallel Coordinates","summary":"Connect an observation's multiple metrics with one line.","kind":"component","tag":"sy-parallel-coordinates","componentId":"parallel-coordinates","api":{"props":[{"name":"data","attribute":"data","type":"ParallelCoordinatesData","kind":"property","values":[],"default":"undefined","description":"An array of { id, label?, values: { dimensionId: number } }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"dimensions","attribute":"dimensions","type":"ReadonlyArray<ParallelCoordinatesDimensionInput>","kind":"property","values":[],"default":"undefined","description":"Each axis's id, label, domain, and scale."},{"name":"lineWidth","attribute":"line-width","type":"number","kind":"number","values":[],"default":"1.5","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"lineOpacity","attribute":"line-opacity","type":"number","kind":"number","values":[],"default":".65","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"lineDash","attribute":"line-dash","type":"ReadonlyArray<number>|string","kind":"property","values":[],"default":"[]","description":"Pass as a JavaScript property. type: ReadonlyArray<number>|string."},{"name":"connectNulls","attribute":"connect-nulls","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactiveRowOpacity","attribute":"inactive-row-opacity","type":"number","kind":"number","values":[],"default":".25","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"axisLabels","attribute":"axis-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"axes","attribute":"axes","type":"ParallelCoordinatesAxesInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ParallelCoordinatesAxesInput."},{"name":"axisBrush","attribute":"axis-brush","type":"ParallelCoordinatesBrushInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ParallelCoordinatesBrushInput."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: ParallelCoordinatesHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: ParallelCoordinatesHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"ParallelCoordinatesEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"ParallelCoordinatesAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"ParallelCoordinatesStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"engine","attribute":"engine","type":"ParallelCoordinatesEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"ParallelCoordinatesUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"redraw","parameters":[],"returns":"Promise<ParallelCoordinatesRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"name":"getActiveTier","parameters":[],"returns":"Promise<ParallelCoordinatesEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"ParallelCoordinatesData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getRows","parameters":[],"returns":"Promise<ParallelCoordinatesRow[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getRow","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ParallelCoordinatesRow | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getRowById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<ParallelCoordinatesRow | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getRowCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayout","parameters":[],"returns":"Promise<ParallelCoordinatesLayoutResult>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"getAxes","parameters":[],"returns":"Promise<ParallelCoordinatesAxis[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLineModels","parameters":[],"returns":"Promise<ParallelCoordinatesLineModel[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getAxisModels","parameters":[],"returns":"Promise<ParallelCoordinatesAxisModel[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDiagnostics","parameters":[],"returns":"Promise<{ invalidRecords: number; invalidIds: number; invalidValues: number; duplicates: number; invalidDimensions: number; duplicateDimensions: number; }>","description":"Normalization diagnostics for the effective base and stream source."},{"name":"appendPoint","parameters":[{"name":"row","type":"ParallelCoordinatesRowInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"rows","type":"ReadonlyArray<ParallelCoordinatesRowInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"rows","type":"ReadonlyArray<ParallelCoordinatesRowInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<ParallelCoordinatesStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ enabled?: boolean; duration?: number; easing?: ParallelCoordinatesEasing; type?: ParallelCoordinatesAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setAxisBrushes","parameters":[{"name":"brushes","type":"ReadonlyArray<ParallelCoordinatesAxisBrush>|null","optional":false}],"returns":"Promise<ParallelCoordinatesBrushChangeEventDetail>","description":"Replace all inclusive axis ranges. Values stay in source units and dimensions combine with AND."},{"name":"setAxisBrush","parameters":[{"name":"dimensionId","type":"string","optional":false},{"name":"range","type":"readonly[number,number]|null","optional":false}],"returns":"Promise<ParallelCoordinatesBrushChangeEventDetail|null>","description":"Update one axis without replacing the other ranges; null clears only that axis. Invalid requests are no-ops."},{"name":"clearAxisBrushes","parameters":[{"name":"dimensionId","type":"string","optional":true}],"returns":"Promise<ParallelCoordinatesBrushChangeEventDetail>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getAxisBrushes","parameters":[],"returns":"Promise<ParallelCoordinatesAxisBrush[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getBrushedRows","parameters":[],"returns":"Promise<ParallelCoordinatesRow[]>","description":"Matching source rows, including hidden styles. With no ranges, every source row matches."},{"name":"getAxisBrushModels","parameters":[],"returns":"Promise<ParallelCoordinatesBrushModel[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<ParallelCoordinatesHitDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectRowAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<ParallelCoordinatesHitDetail | null>","description":"Treemap: enter a positive branch by ID, or null for the forest. Requires drilldown. Select a visible Gantt task by its normalized source index. Parallel Coordinates: source rows and independent axis geometry."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<ParallelCoordinatesSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to normalized 0..1 viewport windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by normalized viewport units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full normalized viewport extent and axis key (`null` before the first layout)."},{"name":"showCrosshairAt","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"Quiet sync: dataX is a zero-based dimension index; dataY uses that dimension's own units."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."}],"events":[{"name":"rendered","type":"ParallelCoordinatesRenderResult & { tier: ParallelCoordinatesEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"rowClick","type":"ParallelCoordinatesHitDetail","description":"CustomEvent.detail type: ParallelCoordinatesHitDetail. Event names are case-sensitive."},{"name":"rowHover","type":"ParallelCoordinatesHitDetail | null","description":"CustomEvent.detail type: ParallelCoordinatesHitDetail | null. Event names are case-sensitive."},{"name":"selectionChanged","type":"ParallelCoordinatesSelectionChangeEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"axisBrushChange","type":"ParallelCoordinatesBrushChangeEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive."},{"name":"axisBrushStart","type":"ParallelCoordinatesBrushGestureEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"name":"axisBrushMove","type":"ParallelCoordinatesBrushGestureEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"name":"axisBrushEnd","type":"ParallelCoordinatesBrushGestureEventDetail","description":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"ParallelCoordinatesCrosshairDetail|null","description":"CustomEvent.detail type: ParallelCoordinatesCrosshairDetail|null. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-parallel-coordinates","blocks":[{"kind":"paragraph","text":"Compare multidimensional patterns across products or observation groups."},{"kind":"paragraph","text":"Check units and axis directions. Use brushing to focus on a range when there are many lines."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { id, label?, values: { dimensionId: number } }."],["`dimensions`","Each axis's id, label, domain, and scale."]]},{"kind":"links","items":[{"path":"/charts/parallel-coordinates","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-parallel-coordinates.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-parallel-coordinates\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"a\",\n            \"label\": \"Product A\",\n            \"color\": \"#8263d9\",\n            \"values\": {\n              \"price\": 30,\n              \"quality\": 90,\n              \"speed\": 65,\n              \"support\": 80\n            }\n          },\n          {\n            \"id\": \"b\",\n            \"label\": \"Product B\",\n            \"color\": \"#239c91\",\n            \"values\": {\n              \"price\": 65,\n              \"quality\": 75,\n              \"speed\": 90,\n              \"support\": 60\n            }\n          },\n          {\n            \"id\": \"c\",\n            \"label\": \"Product C\",\n            \"color\": \"#e99954\",\n            \"values\": {\n              \"price\": 45,\n              \"quality\": 70,\n              \"speed\": 75,\n              \"support\": 95\n            }\n          }\n        ],\n        \"dimensions\": [\n          {\n            \"id\": \"price\",\n            \"label\": \"Price\",\n            \"domain\": [0, 100]\n          },\n          {\n            \"id\": \"quality\",\n            \"label\": \"Quality\",\n            \"domain\": [0, 100]\n          },\n          {\n            \"id\": \"speed\",\n            \"label\": \"Speed\",\n            \"domain\": [0, 100]\n          },\n          {\n            \"id\": \"support\",\n            \"label\": \"Support\",\n            \"domain\": [0, 100]\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'parallel-coordinates example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('rowClick', event.detail);\n  };\n  chart.addEventListener('rowClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('rowClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { id, label?, values: { dimensionId: number } }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParallelCoordinatesData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesData","title":"ParallelCoordinatesData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-dimensions","title":"dimensions","blocks":[{"kind":"paragraph","text":"Each axis's id, label, domain, and scale."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dimensions`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<ParallelCoordinatesDimensionInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesDimensionInput","title":"ParallelCoordinatesDimensionInput","description":"Type definition"}]}]},{"id":"property-lineWidth","title":"lineWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineWidth`"],["HTML attribute","`line-width`"],["Type","`number`"],["Default","`1.5`"]]}]},{"id":"property-lineOpacity","title":"lineOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineOpacity`"],["HTML attribute","`line-opacity`"],["Type","`number`"],["Default","`.65`"]]}]},{"id":"property-lineDash","title":"lineDash","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<number>|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineDash`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<number>|string`"],["Default","`[]`"]]}]},{"id":"property-connectNulls","title":"connectNulls","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectNulls`"],["HTML attribute","`connect-nulls`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactiveRowOpacity","title":"inactiveRowOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveRowOpacity`"],["HTML attribute","`inactive-row-opacity`"],["Type","`number`"],["Default","`.25`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-axisLabels","title":"axisLabels","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axisLabels`"],["HTML attribute","`axis-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-axes","title":"axes","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ParallelCoordinatesAxesInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParallelCoordinatesAxesInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxesInput","title":"ParallelCoordinatesAxesInput","description":"Type definition"}]}]},{"id":"property-axisBrush","title":"axisBrush","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ParallelCoordinatesBrushInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axisBrush`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParallelCoordinatesBrushInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushInput","title":"ParallelCoordinatesBrushInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: ParallelCoordinatesHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: ParallelCoordinatesHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`ParallelCoordinatesEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesEasing","title":"ParallelCoordinatesEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`ParallelCoordinatesAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAnimationType","title":"ParallelCoordinatesAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ParallelCoordinatesStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesStreamSource","title":"ParallelCoordinatesStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`ParallelCoordinatesEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesEngineMode","title":"ParallelCoordinatesEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`ParallelCoordinatesUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesUnavailableBehaviour","title":"ParallelCoordinatesUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesRenderResult & { tier: ParallelCoordinatesEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // ParallelCoordinatesRenderResult & { tier: ParallelCoordinatesEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRenderResult","title":"ParallelCoordinatesRenderResult","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesEngineTier","title":"ParallelCoordinatesEngineTier","description":"Type definition"}]}]},{"id":"event-rowClick","title":"rowClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `rowClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesHitDetail>`."},{"kind":"code","source":"chart.addEventListener('rowClick', event => {\n  console.log(event.detail); // ParallelCoordinatesHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"}]}]},{"id":"event-rowHover","title":"rowHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `rowHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('rowHover', event => {\n  console.log(event.detail); // ParallelCoordinatesHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // ParallelCoordinatesSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesSelectionChangeEventDetail","title":"ParallelCoordinatesSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<ParallelCoordinatesHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-axisBrushChange","title":"axisBrushChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesBrushChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `axisBrushChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushChange', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"event-axisBrushStart","title":"axisBrushStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `axisBrushStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushGestureEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushStart', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","description":"Type definition"}]}]},{"id":"event-axisBrushMove","title":"axisBrushMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `axisBrushMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushGestureEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushMove', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","description":"Type definition"}]}]},{"id":"event-axisBrushEnd","title":"axisBrushEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesBrushGestureEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `axisBrushEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesBrushGestureEventDetail>`."},{"kind":"code","source":"chart.addEventListener('axisBrushEnd', event => {\n  console.log(event.detail); // ParallelCoordinatesBrushGestureEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ParallelCoordinatesCrosshairDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ParallelCoordinatesCrosshairDetail|null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // ParallelCoordinatesCrosshairDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesCrosshairDetail","title":"ParallelCoordinatesCrosshairDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<ParallelCoordinatesRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRenderResult","title":"ParallelCoordinatesRenderResult","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<ParallelCoordinatesEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesEngineTier","title":"ParallelCoordinatesEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: ParallelCoordinatesData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`ParallelCoordinatesData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesData","title":"ParallelCoordinatesData","description":"Type definition"}]}]},{"id":"method-getRows","title":"getRows","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getRows(): Promise<ParallelCoordinatesRow[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"method-getRow","title":"getRow","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getRow(index: number): Promise<ParallelCoordinatesRow | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"method-getRowById","title":"getRowById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getRowById(id: string): Promise<ParallelCoordinatesRow | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"method-getRowCount","title":"getRowCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getRowCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<ParallelCoordinatesLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLayoutResult","title":"ParallelCoordinatesLayoutResult","description":"Type definition"}]}]},{"id":"method-getAxes","title":"getAxes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getAxes(): Promise<ParallelCoordinatesAxis[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesAxis[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","description":"Type definition"}]}]},{"id":"method-getLineModels","title":"getLineModels","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getLineModels(): Promise<ParallelCoordinatesLineModel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesLineModel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLineModel","title":"ParallelCoordinatesLineModel","description":"Type definition"}]}]},{"id":"method-getAxisModels","title":"getAxisModels","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getAxisModels(): Promise<ParallelCoordinatesAxisModel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesAxisModel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxisModel","title":"ParallelCoordinatesAxisModel","description":"Type definition"}]}]},{"id":"method-getDiagnostics","title":"getDiagnostics","blocks":[{"kind":"paragraph","text":"Normalization diagnostics for the effective base and stream source."},{"kind":"code","source":"getDiagnostics(): Promise<{ invalidRecords: number; invalidIds: number; invalidValues: number; duplicates: number; invalidDimensions: number; duplicateDimensions: number; }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ invalidRecords: number; invalidIds: number; invalidValues: number; duplicates: number; invalidDimensions: number; duplicateDimensions: number; }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(row: ParallelCoordinatesRowInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`ParallelCoordinatesRowInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(rows: ReadonlyArray<ParallelCoordinatesRowInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rows`","`ReadonlyArray<ParallelCoordinatesRowInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(rows: ReadonlyArray<ParallelCoordinatesRowInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rows`","`ReadonlyArray<ParallelCoordinatesRowInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<ParallelCoordinatesStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesStreamSource","title":"ParallelCoordinatesStreamSource","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { enabled?: boolean; duration?: number; easing?: ParallelCoordinatesEasing; type?: ParallelCoordinatesAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ enabled?: boolean; duration?: number; easing?: ParallelCoordinatesEasing; type?: ParallelCoordinatesAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesEasing","title":"ParallelCoordinatesEasing","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesAnimationType","title":"ParallelCoordinatesAnimationType","description":"Type definition"}]}]},{"id":"method-setAxisBrushes","title":"setAxisBrushes","blocks":[{"kind":"paragraph","text":"Replace all inclusive axis ranges. Values stay in source units and dimensions combine with AND."},{"kind":"code","source":"setAxisBrushes(brushes: ReadonlyArray<ParallelCoordinatesAxisBrush>|null): Promise<ParallelCoordinatesBrushChangeEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`brushes`","`ReadonlyArray<ParallelCoordinatesAxisBrush>|null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"},{"path":"/docs/types/ParallelCoordinatesAxisBrush","title":"ParallelCoordinatesAxisBrush","description":"Type definition"}]}]},{"id":"method-setAxisBrush","title":"setAxisBrush","blocks":[{"kind":"paragraph","text":"Update one axis without replacing the other ranges; null clears only that axis. Invalid requests are no-ops."},{"kind":"code","source":"setAxisBrush(dimensionId: string, range: readonly[number,number]|null): Promise<ParallelCoordinatesBrushChangeEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`dimensionId`","`string`","Required"],["`range`","`readonly[number,number]|null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"method-clearAxisBrushes","title":"clearAxisBrushes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"clearAxisBrushes(dimensionId?: string): Promise<ParallelCoordinatesBrushChangeEventDetail>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`dimensionId`","`string`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushChangeEventDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getAxisBrushes","title":"getAxisBrushes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getAxisBrushes(): Promise<ParallelCoordinatesAxisBrush[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesAxisBrush[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxisBrush","title":"ParallelCoordinatesAxisBrush","description":"Type definition"}]}]},{"id":"method-getBrushedRows","title":"getBrushedRows","blocks":[{"kind":"paragraph","text":"Matching source rows, including hidden styles. With no ranges, every source row matches."},{"kind":"code","source":"getBrushedRows(): Promise<ParallelCoordinatesRow[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesRow[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":"Type definition"}]}]},{"id":"method-getAxisBrushModels","title":"getAxisBrushModels","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getAxisBrushModels(): Promise<ParallelCoordinatesBrushModel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesBrushModel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushModel","title":"ParallelCoordinatesBrushModel","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<ParallelCoordinatesHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"}]}]},{"id":"method-selectRowAt","title":"selectRowAt","blocks":[{"kind":"paragraph","text":"Treemap: enter a positive branch by ID, or null for the forest. Requires drilldown. Select a visible Gantt task by its normalized source index. Parallel Coordinates: source rows and independent axis geometry."},{"kind":"code","source":"selectRowAt(index: number): Promise<ParallelCoordinatesHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<ParallelCoordinatesSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ParallelCoordinatesSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesSelection","title":"ParallelCoordinatesSelection","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to normalized 0..1 viewport windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by normalized viewport units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full normalized viewport extent and axis key (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"Quiet sync: dataX is a zero-based dimension index; dataY uses that dimension's own units."},{"kind":"code","source":"showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/geo-map","title":"Geo Map","summary":"Show geographic locations and magnitudes on a map.","kind":"component","tag":"sy-geo-map","componentId":"geo-map","api":{"props":[{"name":"data","attribute":"data","type":"GeoMapData","kind":"property","values":[],"default":"undefined","description":"An array of { longitude, latitude, value?, label? }."},{"name":"features","attribute":"features","type":"GeoMapFeatureCollection","kind":"property","values":[],"default":"undefined","description":"Owned geographic polygons and great-circle LineStrings, below data points."},{"name":"polygonColor","attribute":"polygon-color","type":"string","kind":"string","values":[],"default":"'#0d9488'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"polygonOpacity","attribute":"polygon-opacity","type":"number","kind":"number","values":[],"default":"0.7","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"connectionWidth","attribute":"connection-width","type":"number","kind":"number","values":[],"default":"2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"connectionColor","attribute":"connection-color","type":"string","kind":"string","values":[],"default":"'#7c3aed'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"connectionOpacity","attribute":"connection-opacity","type":"number","kind":"number","values":[],"default":"0.85","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"connectionPath","attribute":"connection-path","type":"GeoMapConnectionPath","kind":"string","values":["great-circle","straight"],"default":"'great-circle'","description":"Surface great-circle arcs (default), or flat-map straight routes. On globes, straight lifts the equirectangular route onto the surface."},{"name":"mapColorAxis","attribute":"map-color-axis","type":"GeoMapColorAxisInput","kind":"property","values":["auto"],"default":"undefined","description":"Choropleth: feature property to a shared color ramp and numeric legend."},{"name":"mapBubble","attribute":"map-bubble","type":"GeoMapBubbleInput","kind":"property","values":[],"default":"undefined","description":"Geographic bubbles encode point values by area; object options are property-bound."},{"name":"mapHeat","attribute":"map-heat","type":"GeoMapHeatInput","kind":"property","values":[],"default":"undefined","description":"Bounded screen-space Gaussian density below connections and points."},{"name":"mapLayers","attribute":"map-layers","type":"GeoMapLayersInput","kind":"property","values":[],"default":"undefined","description":"Layer presentation masks; assign an object property. Hidden sources retain selection and pinned-card identity."},{"name":"mapLegend","attribute":"map-legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Native buttons for point, polygon, connection and heat visibility."},{"name":"mapLegendLayers","attribute":"map-legend-layers","type":"ReadonlyArray<GeoMapLayer>","kind":"property","values":[],"default":"undefined","description":"Optional ordered legend subset for geographic specializations; source layers stay intact."},{"name":"mapLayerNames","attribute":"map-layer-names","type":"Partial<Record<GeoMapLayer,string>>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Partial<Record<GeoMapLayer,string>>."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"16","description":"Padding around the coordinate frame in CSS pixels."},{"name":"projection","attribute":"projection","type":"GeoMapProjection","kind":"property","values":["identity","mercator","equirectangular","albers","orthographic"],"default":"'identity'","description":"How geographic coordinates project onto the screen."},{"name":"mapRegion","attribute":"map-region","type":"GeoMapRegion","kind":"string","values":["world","africa","asia","europe","north-america","south-america","oceania","antarctica"],"default":"'world'","description":"The region shown initially."},{"name":"mapBackground","attribute":"map-background","type":"GeoMapBackground","kind":"string","values":["none","natural-earth"],"default":"'natural-earth'","description":"Bundled public-domain land/coastline data; no runtime map download or API key."},{"name":"mapFixed","attribute":"map-fixed","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Lock geographic dragging: flat maps wrap longitude inside a fixed frame; Albers/Orthographic rotate. Zoom is separate."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Geographic crosshair. Bare attribute or {} uses defaults; an object prop or JSON attribute overrides options. Omit/remove the attribute to disable."},{"name":"crosshairSnapDistance","attribute":"crosshair-snap-distance","type":"number","kind":"number","values":[],"default":"12","description":"Point-center capture distance in CSS pixels when crosshair.snap is enabled; direct marker hits also snap."},{"name":"nodeRadius","attribute":"node-radius","type":"number","kind":"number","values":[],"default":"5","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"inactiveOtherPoints","attribute":"inactive-other-points","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Dim other point/feature glyphs around the focused, hovered or selected source identity. Heat stays unchanged."},{"name":"inactivePointOpacity","attribute":"inactive-point-opacity","type":"number","kind":"number","values":[],"default":".2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"nodeLabels","attribute":"node-labels","type":"GeoMapLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"name":"featureLabels","attribute":"feature-labels","type":"GeoMapLabelMode","kind":"string","values":["auto","show","hide"],"default":"'hide'","description":"Optional region and connection names, sharing point-label collision avoidance."},{"name":"featureLabelValue","attribute":"feature-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"nodeLabelValue","attribute":"node-label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: GeoMapHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: GeoMapHitDetail) => string."},{"name":"featureTooltipFormat","attribute":"feature-tooltip-format","type":"(detail:GeoMapFeatureHitDetail)=>string","kind":"property","values":[],"default":"undefined","description":"Formats owned polygon/connection metadata; point tooltipFormat remains independent."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"GeoMapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"GeoMapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"GeoMapStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"engine","attribute":"engine","type":"GeoMapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"GeoMapUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getMapLayers","parameters":[],"returns":"Promise<GeoMapLayerDetail[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setMapLayerVisible","parameters":[{"name":"layer","type":"GeoMapLayer","optional":false},{"name":"visible","type":"boolean","optional":false}],"returns":"Promise<GeoMapLayerDetail|null>","description":"Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null."},{"name":"redraw","parameters":[],"returns":"Promise<GeoMapRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"recycleGpu","parameters":[],"returns":"Promise<void>","description":"Release and reacquire the shared GPU surface without resetting data, pins or geographic view. Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"name":"getConnections","parameters":[],"returns":"Promise<GeoMapConnectionView[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"name":"getActiveTier","parameters":[],"returns":"Promise<GeoMapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"getMapAvailability","parameters":[],"returns":"Promise<GeoMapAvailabilityDetail>","description":"Owned current engine status. A Pro decision can be pending before asynchronous device initialization finishes."},{"name":"setData","parameters":[{"name":"data","type":"GeoMapData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"setFeatures","parameters":[{"name":"features","type":"GeoMapFeatureCollection","optional":true}],"returns":"Promise<void>","description":"Validate atomically; invalid input rejects and leaves the previous layer intact."},{"name":"getFeatures","parameters":[],"returns":"Promise<GeoMapFeatureCollection>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getMapColorAxis","parameters":[],"returns":"Promise<GeoMapColorAxisDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getFeatureSelection","parameters":[],"returns":"Promise<GeoMapFeatureSelection>","description":"An asynchronous method. Check the argument and return types below."},{"name":"selectFeatureAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GeoMapFeatureHitDetail | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showTooltipAtFeature","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"parseTopoJSON","parameters":[{"name":"input","type":"unknown","optional":false},{"name":"objectName","type":"string","optional":true}],"returns":"Promise<GeoMapFeatureCollection>","description":"Decode a Topology (object or JSON text) into owned GeoJSON; does not change chart data."},{"name":"parseGeoJSON","parameters":[{"name":"input","type":"unknown","optional":false}],"returns":"Promise<GeoMapFeatureCollection>","description":"Decode RFC 7946 Geometry, Feature or FeatureCollection into owned features without changing chart data."},{"name":"getNodes","parameters":[],"returns":"Promise<GeoMapPoint[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNode","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GeoMapPoint | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<GeoMapPoint | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getNodeCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<GeoMapExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getMapDiagnostics","parameters":[],"returns":"Promise<GeoMapDiagnostics>","description":"Current base input and active normalized stream window; not lifetime ingestion counters. Returns an owned snapshot."},{"name":"getLayout","parameters":[],"returns":"Promise<GeoMapLayoutResult>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"appendPoint","parameters":[{"name":"node","type":"GeoMapPointInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"nodes","type":"ReadonlyArray<GeoMapPointInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"nodes","type":"ReadonlyArray<GeoMapPointInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<GeoMapStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ enabled?: boolean; duration?: number; easing?: GeoMapEasing; type?: GeoMapAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<GeoMapPickDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectNodeAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GeoMapHitDetail | null>","description":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<GeoMapSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"resetMapView","parameters":[],"returns":"Promise<void>","description":"Restore the configured projection/region and clear map movement and zoom."},{"name":"getMapView","parameters":[],"returns":"Promise<GeoMapViewDetail>","description":"Owned geographic camera, effective region and viewport state."},{"name":"fitMap","parameters":[{"name":"options","type":"GeoMapFitOptions","optional":true}],"returns":"Promise<GeoMapFitDetail|null>","description":"Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getLabels","parameters":[],"returns":"Promise<GeoMapLabel[]>","description":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"name":"getMapLabels","parameters":[],"returns":"Promise<GeoMapLabelView>","description":"Full source text and current screen placement for both point and feature names."},{"name":"getMapHeat","parameters":[],"returns":"Promise<GeoMapHeatDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getMapHeatAt","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<GeoMapHeatPointDetail|null>","description":"Read aggregate density at a host-relative point; original point/feature selection remains separate."},{"name":"getMapHeatAtCoordinate","parameters":[{"name":"longitude","type":"number","optional":false},{"name":"latitude","type":"number","optional":false}],"returns":"Promise<GeoMapHeatPointDetail|null>","description":"Read the current visible density at geography without requiring a source point or marker. Returns null for invalid, projection-clipped, offscreen or rear-hemisphere coordinates and hidden heat."},{"name":"getMapBubbleScale","parameters":[],"returns":"Promise<GeoMapBubbleScaleDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showCrosshairAtData","parameters":[{"name":"request","type":"{dataX:number;dataY:number}","optional":false}],"returns":"Promise<boolean>","description":"Quiet geographic synchronization; invalid, hidden or clipped coordinates leave no guide."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."}],"events":[{"name":"rendered","type":"GeoMapRenderResult & { tier: GeoMapEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"nodeClick","type":"GeoMapHitDetail","description":"CustomEvent.detail type: GeoMapHitDetail. Event names are case-sensitive."},{"name":"nodeHover","type":"GeoMapHitDetail | null","description":"CustomEvent.detail type: GeoMapHitDetail | null. Event names are case-sensitive."},{"name":"featureClick","type":"GeoMapFeatureHitDetail","description":"CustomEvent.detail type: GeoMapFeatureHitDetail. Event names are case-sensitive."},{"name":"featureHover","type":"GeoMapFeatureHitDetail | null","description":"CustomEvent.detail type: GeoMapFeatureHitDetail | null. Event names are case-sensitive."},{"name":"featureSelectionChange","type":"GeoMapFeatureSelectionChangeEventDetail","description":"CustomEvent.detail type: GeoMapFeatureSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"selectionChanged","type":"GeoMapSelectionChangeEventDetail","description":"CustomEvent.detail type: GeoMapSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<GeoMapPickDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<GeoMapPickDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"mapViewChange","type":"GeoMapViewChangeEventDetail","description":"CustomEvent.detail type: GeoMapViewChangeEventDetail. Event names are case-sensitive."},{"name":"mapLayerChange","type":"GeoMapLayerChangeEventDetail","description":"CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-geo-map","blocks":[{"kind":"paragraph","text":"Explore the distribution of cities, facilities, or observation sites."},{"kind":"paragraph","text":"Check the longitude and latitude order. Projection affects the representation of distances and areas."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { longitude, latitude, value?, label? }."],["`projection`","How geographic coordinates project onto the screen."],["`mapRegion`","The region shown initially."]]},{"kind":"links","items":[{"path":"/charts/geo-map","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-geo-map.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-geo-map\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"seoul\",\n            \"label\": \"Seoul\",\n            \"longitude\": 126.98,\n            \"latitude\": 37.57,\n            \"value\": 80\n          },\n          {\n            \"id\": \"tokyo\",\n            \"label\": \"Tokyo\",\n            \"longitude\": 139.69,\n            \"latitude\": 35.68,\n            \"value\": 65\n          },\n          {\n            \"id\": \"taipei\",\n            \"label\": \"Taipei\",\n            \"longitude\": 121.56,\n            \"latitude\": 25.03,\n            \"value\": 45\n          },\n          {\n            \"id\": \"singapore\",\n            \"label\": \"Singapore\",\n            \"longitude\": 103.82,\n            \"latitude\": 1.35,\n            \"value\": 55\n          }\n        ],\n        \"mapRegion\": \"asia\",\n        \"mapBackground\": \"natural-earth\",\n        \"projection\": \"mercator\",\n        \"nodeLabels\": \"show\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'geo-map example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('nodeClick', event.detail);\n  };\n  chart.addEventListener('nodeClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('nodeClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { longitude, latitude, value?, label? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapData","title":"GeoMapData","description":"Type definition"}]}]},{"id":"property-features","title":"features","blocks":[{"kind":"paragraph","text":"Owned geographic polygons and great-circle LineStrings, below data points."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`features`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapFeatureCollection`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"property-polygonColor","title":"polygonColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`polygonColor`"],["HTML attribute","`polygon-color`"],["Type","`string`"],["Default","`'#0d9488'`"]]}]},{"id":"property-polygonOpacity","title":"polygonOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`polygonOpacity`"],["HTML attribute","`polygon-opacity`"],["Type","`number`"],["Default","`0.7`"]]}]},{"id":"property-connectionWidth","title":"connectionWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionWidth`"],["HTML attribute","`connection-width`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-connectionColor","title":"connectionColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionColor`"],["HTML attribute","`connection-color`"],["Type","`string`"],["Default","`'#7c3aed'`"]]}]},{"id":"property-connectionOpacity","title":"connectionOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionOpacity`"],["HTML attribute","`connection-opacity`"],["Type","`number`"],["Default","`0.85`"]]}]},{"id":"property-connectionPath","title":"connectionPath","blocks":[{"kind":"paragraph","text":"Surface great-circle arcs (default), or flat-map straight routes. On globes, straight lifts the equirectangular route onto the surface."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`connectionPath`"],["HTML attribute","`connection-path`"],["Type","`GeoMapConnectionPath`"],["Default","`'great-circle'`"],["Allowed values","`great-circle`, `straight`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapConnectionPath","title":"GeoMapConnectionPath","description":"Type definition"}]}]},{"id":"property-mapColorAxis","title":"mapColorAxis","blocks":[{"kind":"paragraph","text":"Choropleth: feature property to a shared color ramp and numeric legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapColorAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapColorAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapColorAxisInput","title":"GeoMapColorAxisInput","description":"Type definition"}]}]},{"id":"property-mapBubble","title":"mapBubble","blocks":[{"kind":"paragraph","text":"Geographic bubbles encode point values by area; object options are property-bound."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapBubble`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapBubbleInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapBubbleInput","title":"GeoMapBubbleInput","description":"Type definition"}]}]},{"id":"property-mapHeat","title":"mapHeat","blocks":[{"kind":"paragraph","text":"Bounded screen-space Gaussian density below connections and points."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapHeat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapHeatInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatInput","title":"GeoMapHeatInput","description":"Type definition"}]}]},{"id":"property-mapLayers","title":"mapLayers","blocks":[{"kind":"paragraph","text":"Layer presentation masks; assign an object property. Hidden sources retain selection and pinned-card identity."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapLayers`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapLayersInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayersInput","title":"GeoMapLayersInput","description":"Type definition"}]}]},{"id":"property-mapLegend","title":"mapLegend","blocks":[{"kind":"paragraph","text":"Native buttons for point, polygon, connection and heat visibility."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapLegend`"],["HTML attribute","`map-legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-mapLegendLayers","title":"mapLegendLayers","blocks":[{"kind":"paragraph","text":"Optional ordered legend subset for geographic specializations; source layers stay intact."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapLegendLayers`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<GeoMapLayer>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":"Type definition"}]}]},{"id":"property-mapLayerNames","title":"mapLayerNames","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Partial<Record<GeoMapLayer,string>>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapLayerNames`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Partial<Record<GeoMapLayer,string>>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"Padding around the coordinate frame in CSS pixels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`16`"]]}]},{"id":"property-projection","title":"projection","blocks":[{"kind":"paragraph","text":"How geographic coordinates project onto the screen."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`projection`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapProjection`"],["Default","`'identity'`"],["Literals in the type","`identity`, `mercator`, `equirectangular`, `albers`, `orthographic`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","description":"Type definition"}]}]},{"id":"property-mapRegion","title":"mapRegion","blocks":[{"kind":"paragraph","text":"The region shown initially."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapRegion`"],["HTML attribute","`map-region`"],["Type","`GeoMapRegion`"],["Default","`'world'`"],["Allowed values","`world`, `africa`, `asia`, `europe`, `north-america`, `south-america`, `oceania`, `antarctica`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapRegion","title":"GeoMapRegion","description":"Type definition"}]}]},{"id":"property-mapBackground","title":"mapBackground","blocks":[{"kind":"paragraph","text":"Bundled public-domain land/coastline data; no runtime map download or API key."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapBackground`"],["HTML attribute","`map-background`"],["Type","`GeoMapBackground`"],["Default","`'natural-earth'`"],["Allowed values","`none`, `natural-earth`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapBackground","title":"GeoMapBackground","description":"Type definition"}]}]},{"id":"property-mapFixed","title":"mapFixed","blocks":[{"kind":"paragraph","text":"Lock geographic dragging: flat maps wrap longitude inside a fixed frame; Albers/Orthographic rotate. Zoom is separate."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapFixed`"],["HTML attribute","`map-fixed`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Geographic crosshair. Bare attribute or {} uses defaults; an object prop or JSON attribute overrides options. Omit/remove the attribute to disable."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-crosshairSnapDistance","title":"crosshairSnapDistance","blocks":[{"kind":"paragraph","text":"Point-center capture distance in CSS pixels when crosshair.snap is enabled; direct marker hits also snap."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairSnapDistance`"],["HTML attribute","`crosshair-snap-distance`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-nodeRadius","title":"nodeRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeRadius`"],["HTML attribute","`node-radius`"],["Type","`number`"],["Default","`5`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-inactiveOtherPoints","title":"inactiveOtherPoints","blocks":[{"kind":"paragraph","text":"Dim other point/feature glyphs around the focused, hovered or selected source identity. Heat stays unchanged."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherPoints`"],["HTML attribute","`inactive-other-points`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactivePointOpacity","title":"inactivePointOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactivePointOpacity`"],["HTML attribute","`inactive-point-opacity`"],["Type","`number`"],["Default","`.2`"]]}]},{"id":"property-nodeLabels","title":"nodeLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabels`"],["HTML attribute","`node-labels`"],["Type","`GeoMapLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":"Type definition"}]}]},{"id":"property-featureLabels","title":"featureLabels","blocks":[{"kind":"paragraph","text":"Optional region and connection names, sharing point-label collision avoidance."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`featureLabels`"],["HTML attribute","`feature-labels`"],["Type","`GeoMapLabelMode`"],["Default","`'hide'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":"Type definition"}]}]},{"id":"property-featureLabelValue","title":"featureLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`featureLabelValue`"],["HTML attribute","`feature-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-nodeLabelValue","title":"nodeLabelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`nodeLabelValue`"],["HTML attribute","`node-label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: GeoMapHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: GeoMapHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":"Type definition"}]}]},{"id":"property-featureTooltipFormat","title":"featureTooltipFormat","blocks":[{"kind":"paragraph","text":"Formats owned polygon/connection metadata; point tooltipFormat remains independent."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`featureTooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail:GeoMapFeatureHitDetail)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`GeoMapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapEasing","title":"GeoMapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`GeoMapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapAnimationType","title":"GeoMapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapStreamSource","title":"GeoMapStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`GeoMapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapEngineMode","title":"GeoMapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`GeoMapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapUnavailableBehaviour","title":"GeoMapUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapRenderResult & { tier: GeoMapEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // GeoMapRenderResult & { tier: GeoMapEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapRenderResult","title":"GeoMapRenderResult","description":"Type definition"},{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","description":"Type definition"}]}]},{"id":"event-nodeClick","title":"nodeClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapHitDetail>`."},{"kind":"code","source":"chart.addEventListener('nodeClick', event => {\n  console.log(event.detail); // GeoMapHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":"Type definition"}]}]},{"id":"event-nodeHover","title":"nodeHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `nodeHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('nodeHover', event => {\n  console.log(event.detail); // GeoMapHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":"Type definition"}]}]},{"id":"event-featureClick","title":"featureClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapFeatureHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `featureClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureHitDetail>`."},{"kind":"code","source":"chart.addEventListener('featureClick', event => {\n  console.log(event.detail); // GeoMapFeatureHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"event-featureHover","title":"featureHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapFeatureHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `featureHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('featureHover', event => {\n  console.log(event.detail); // GeoMapFeatureHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"event-featureSelectionChange","title":"featureSelectionChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapFeatureSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `featureSelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapFeatureSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('featureSelectionChange', event => {\n  console.log(event.detail); // GeoMapFeatureSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureSelectionChangeEventDetail","title":"GeoMapFeatureSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // GeoMapSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapSelectionChangeEventDetail","title":"GeoMapSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<GeoMapPickDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<GeoMapPickDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<GeoMapPickDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/GeoMapPickDetail","title":"GeoMapPickDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-mapViewChange","title":"mapViewChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapViewChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `mapViewChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapViewChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('mapViewChange', event => {\n  console.log(event.detail); // GeoMapViewChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapViewChangeEventDetail","title":"GeoMapViewChangeEventDetail","description":"Type definition"}]}]},{"id":"event-mapLayerChange","title":"mapLayerChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `mapLayerChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapLayerChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('mapLayerChange', event => {\n  console.log(event.detail); // GeoMapLayerChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerChangeEventDetail","title":"GeoMapLayerChangeEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getMapLayers","title":"getMapLayers","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getMapLayers(): Promise<GeoMapLayerDetail[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLayerDetail[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","description":"Type definition"}]}]},{"id":"method-setMapLayerVisible","title":"setMapLayerVisible","blocks":[{"kind":"paragraph","text":"Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null."},{"kind":"code","source":"setMapLayerVisible(layer: GeoMapLayer, visible: boolean): Promise<GeoMapLayerDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`layer`","`GeoMapLayer`","Required"],["`visible`","`boolean`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLayerDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","description":"Type definition"},{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<GeoMapRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapRenderResult","title":"GeoMapRenderResult","description":"Type definition"}]}]},{"id":"method-recycleGpu","title":"recycleGpu","blocks":[{"kind":"paragraph","text":"Release and reacquire the shared GPU surface without resetting data, pins or geographic view. Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"kind":"code","source":"recycleGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getConnections","title":"getConnections","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getConnections(): Promise<GeoMapConnectionView[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapConnectionView[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapConnectionView","title":"GeoMapConnectionView","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<GeoMapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getMapAvailability","title":"getMapAvailability","blocks":[{"kind":"paragraph","text":"Owned current engine status. A Pro decision can be pending before asynchronous device initialization finishes."},{"kind":"code","source":"getMapAvailability(): Promise<GeoMapAvailabilityDetail>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapAvailabilityDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapAvailabilityDetail","title":"GeoMapAvailabilityDetail","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: GeoMapData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`GeoMapData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapData","title":"GeoMapData","description":"Type definition"}]}]},{"id":"method-setFeatures","title":"setFeatures","blocks":[{"kind":"paragraph","text":"Validate atomically; invalid input rejects and leaves the previous layer intact."},{"kind":"code","source":"setFeatures(features?: GeoMapFeatureCollection): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`features`","`GeoMapFeatureCollection`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"method-getFeatures","title":"getFeatures","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getFeatures(): Promise<GeoMapFeatureCollection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureCollection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"method-getMapColorAxis","title":"getMapColorAxis","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getMapColorAxis(): Promise<GeoMapColorAxisDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapColorAxisDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapColorAxisDetail","title":"GeoMapColorAxisDetail","description":"Type definition"}]}]},{"id":"method-getFeatureSelection","title":"getFeatureSelection","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getFeatureSelection(): Promise<GeoMapFeatureSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureSelection","title":"GeoMapFeatureSelection","description":"Type definition"}]}]},{"id":"method-selectFeatureAt","title":"selectFeatureAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectFeatureAt(index: number): Promise<GeoMapFeatureHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtFeature","title":"showTooltipAtFeature","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showTooltipAtFeature(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-parseTopoJSON","title":"parseTopoJSON","blocks":[{"kind":"paragraph","text":"Decode a Topology (object or JSON text) into owned GeoJSON; does not change chart data."},{"kind":"code","source":"parseTopoJSON(input: unknown, objectName?: string): Promise<GeoMapFeatureCollection>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`unknown`","Required"],["`objectName`","`string`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureCollection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"method-parseGeoJSON","title":"parseGeoJSON","blocks":[{"kind":"paragraph","text":"Decode RFC 7946 Geometry, Feature or FeatureCollection into owned features without changing chart data."},{"kind":"code","source":"parseGeoJSON(input: unknown): Promise<GeoMapFeatureCollection>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`unknown`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFeatureCollection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":"Type definition"}]}]},{"id":"method-getNodes","title":"getNodes","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodes(): Promise<GeoMapPoint[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapPoint[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapPoint","title":"GeoMapPoint","description":"Type definition"}]}]},{"id":"method-getNode","title":"getNode","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNode(index: number): Promise<GeoMapPoint | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapPoint | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapPoint","title":"GeoMapPoint","description":"Type definition"}]}]},{"id":"method-getNodeById","title":"getNodeById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeById(id: string): Promise<GeoMapPoint | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapPoint | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapPoint","title":"GeoMapPoint","description":"Type definition"}]}]},{"id":"method-getNodeCount","title":"getNodeCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getNodeCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<GeoMapExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapExtent","title":"GeoMapExtent","description":"Type definition"}]}]},{"id":"method-getMapDiagnostics","title":"getMapDiagnostics","blocks":[{"kind":"paragraph","text":"Current base input and active normalized stream window; not lifetime ingestion counters. Returns an owned snapshot."},{"kind":"code","source":"getMapDiagnostics(): Promise<GeoMapDiagnostics>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapDiagnostics>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapDiagnostics","title":"GeoMapDiagnostics","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<GeoMapLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayoutResult","title":"GeoMapLayoutResult","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(node: GeoMapPointInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`node`","`GeoMapPointInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(nodes: ReadonlyArray<GeoMapPointInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<GeoMapPointInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(nodes: ReadonlyArray<GeoMapPointInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`nodes`","`ReadonlyArray<GeoMapPointInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<GeoMapStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapStreamSource","title":"GeoMapStreamSource","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { enabled?: boolean; duration?: number; easing?: GeoMapEasing; type?: GeoMapAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ enabled?: boolean; duration?: number; easing?: GeoMapEasing; type?: GeoMapAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapEasing","title":"GeoMapEasing","description":"Type definition"},{"path":"/docs/types/GeoMapAnimationType","title":"GeoMapAnimationType","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<GeoMapPickDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapPickDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapPickDetail","title":"GeoMapPickDetail","description":"Type definition"}]}]},{"id":"method-selectNodeAt","title":"selectNodeAt","blocks":[{"kind":"paragraph","text":"Select (pin) a node: its neighbourhood stays highlighted after the pointer leaves; a negative or unknown index releases the selection. Emits selectionChanged when it changes."},{"kind":"code","source":"selectNodeAt(index: number): Promise<GeoMapHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<GeoMapSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapSelection","title":"GeoMapSelection","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows over the unit extents: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by unit-extent units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetMapView","title":"resetMapView","blocks":[{"kind":"paragraph","text":"Restore the configured projection/region and clear map movement and zoom."},{"kind":"code","source":"resetMapView(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getMapView","title":"getMapView","blocks":[{"kind":"paragraph","text":"Owned geographic camera, effective region and viewport state."},{"kind":"code","source":"getMapView(): Promise<GeoMapViewDetail>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapViewDetail>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapViewDetail","title":"GeoMapViewDetail","description":"Type definition"}]}]},{"id":"method-fitMap","title":"fitMap","blocks":[{"kind":"paragraph","text":"Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged."},{"kind":"code","source":"fitMap(options?: GeoMapFitOptions): Promise<GeoMapFitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`GeoMapFitOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFitDetail","title":"GeoMapFitDetail","description":"Type definition"},{"path":"/docs/types/GeoMapFitOptions","title":"GeoMapFitOptions","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (0 … 1) and key of the diagram's orientations (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"kind":"code","source":"getLabels(): Promise<GeoMapLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabel","title":"GeoMapLabel","description":"Type definition"}]}]},{"id":"method-getMapLabels","title":"getMapLabels","blocks":[{"kind":"paragraph","text":"Full source text and current screen placement for both point and feature names."},{"kind":"code","source":"getMapLabels(): Promise<GeoMapLabelView>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLabelView>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelView","title":"GeoMapLabelView","description":"Type definition"}]}]},{"id":"method-getMapHeat","title":"getMapHeat","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getMapHeat(): Promise<GeoMapHeatDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapHeatDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatDetail","title":"GeoMapHeatDetail","description":"Type definition"}]}]},{"id":"method-getMapHeatAt","title":"getMapHeatAt","blocks":[{"kind":"paragraph","text":"Read aggregate density at a host-relative point; original point/feature selection remains separate."},{"kind":"code","source":"getMapHeatAt(cssX: number, cssY: number): Promise<GeoMapHeatPointDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapHeatPointDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatPointDetail","title":"GeoMapHeatPointDetail","description":"Type definition"}]}]},{"id":"method-getMapHeatAtCoordinate","title":"getMapHeatAtCoordinate","blocks":[{"kind":"paragraph","text":"Read the current visible density at geography without requiring a source point or marker. Returns null for invalid, projection-clipped, offscreen or rear-hemisphere coordinates and hidden heat."},{"kind":"code","source":"getMapHeatAtCoordinate(longitude: number, latitude: number): Promise<GeoMapHeatPointDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`longitude`","`number`","Required"],["`latitude`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapHeatPointDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatPointDetail","title":"GeoMapHeatPointDetail","description":"Type definition"}]}]},{"id":"method-getMapBubbleScale","title":"getMapBubbleScale","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getMapBubbleScale(): Promise<GeoMapBubbleScaleDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapBubbleScaleDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapBubbleScaleDetail","title":"GeoMapBubbleScaleDetail","description":"Type definition"}]}]},{"id":"method-showCrosshairAtData","title":"showCrosshairAtData","blocks":[{"kind":"paragraph","text":"Quiet geographic synchronization; invalid, hidden or clipped coordinates leave no guide."},{"kind":"code","source":"showCrosshairAtData(request: {dataX:number;dataY:number}): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`{dataX:number;dataY:number}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/flow-lines","title":"Flow Lines","summary":"Connect movement between locations on a map.","kind":"component","tag":"sy-flow-lines","componentId":"flow-lines","api":{"props":[{"name":"data","attribute":"data","type":"FlowLinesData","kind":"property","values":[],"default":"undefined","description":"flows references locations IDs through from and to."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"460","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"16","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"projection","attribute":"projection","type":"GeoMapProjection","kind":"property","values":["identity","mercator","equirectangular","albers","orthographic"],"default":"'equirectangular'","description":"Allowed values: identity, mercator, equirectangular, albers, orthographic. Default: 'equirectangular'."},{"name":"mapRegion","attribute":"map-region","type":"GeoMapRegion","kind":"string","values":["world","africa","asia","europe","north-america","south-america","oceania","antarctica"],"default":"'world'","description":"Allowed values: world, africa, asia, europe, north-america, south-america, oceania, antarctica. Default: 'world'."},{"name":"mapBackground","attribute":"map-background","type":"GeoMapBackground","kind":"string","values":["none","natural-earth"],"default":"'natural-earth'","description":"Allowed values: none, natural-earth. Default: 'natural-earth'."},{"name":"mapFixed","attribute":"map-fixed","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"routePath","attribute":"route-path","type":"GeoMapConnectionPath","kind":"string","values":["great-circle","straight"],"default":"'great-circle'","description":"great-circle or straight."},{"name":"styleOptions","attribute":"style-options","type":"FlowLinesStyle","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: FlowLinesStyle."},{"name":"locationLabels","attribute":"location-labels","type":"GeoMapLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"name":"flowLabels","attribute":"flow-labels","type":"GeoMapLabelMode","kind":"string","values":["auto","show","hide"],"default":"'hide'","description":"Allowed values: auto, show, hide. Default: 'hide'."},{"name":"labelValue","attribute":"label-value","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"mapLayers","attribute":"map-layers","type":"GeoMapLayersInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GeoMapLayersInput."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to show a legend for series or items."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"inactiveOtherPoints","attribute":"inactive-other-points","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"inactivePointOpacity","attribute":"inactive-point-opacity","type":"number","kind":"number","values":[],"default":".2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"locale","attribute":"locale","type":"string","kind":"string","values":[],"default":"'en-US'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail:FlowLinesHitDetail)=>string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail:FlowLinesHitDetail)=>string."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"crosshairSnapDistance","attribute":"crosshair-snap-distance","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"GeoMapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"GeoMapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"FlowLinesStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"engine","attribute":"engine","type":"GeoMapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"GeoMapUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."},{"name":"showEmpty","attribute":"show-empty","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."}],"methods":[{"name":"setData","parameters":[{"name":"data","type":"FlowLinesData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getData","parameters":[],"returns":"Promise<FlowLinesData>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDiagnostics","parameters":[],"returns":"Promise<FlowLinesDiagnostics>","description":"Normalization diagnostics for the effective base and stream source."},{"name":"getLayout","parameters":[],"returns":"Promise<FlowLinesLayout>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"appendPoint","parameters":[{"name":"flow","type":"FlowLinesRouteInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"flows","type":"ReadonlyArray<FlowLinesRouteInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"replace","parameters":[{"name":"flows","type":"ReadonlyArray<FlowLinesRouteInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<FlowLinesStreamSource|undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"clearStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<FlowLinesHitDetail|null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectFlowAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<FlowLinesHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"selectLocationAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<FlowLinesHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"selectById","parameters":[{"name":"id","type":"FlowLinesId","optional":false},{"name":"kind","type":"'flow'|'location'","optional":true}],"returns":"Promise<FlowLinesHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getSelection","parameters":[],"returns":"Promise<FlowLinesSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"showTooltipAtFlow","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showTooltipAtLocation","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"showCrosshairAtData","parameters":[{"name":"request","type":"{dataX:number;dataY:number}","optional":false}],"returns":"Promise<boolean>","description":"Quiet source-category synchronization. Categories retain their original string or number type."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail|null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail|null>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{x?:number;y?:number}","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail|null>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail|null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"resetMapView","parameters":[],"returns":"Promise<void>","description":"Restore the configured projection/region and clear map movement and zoom."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState|null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail|null>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"getMapView","parameters":[],"returns":"Promise<GeoMapViewDetail|null>","description":"Owned geographic camera, effective region and viewport state."},{"name":"fitMap","parameters":[{"name":"options","type":"GeoMapFitOptions","optional":true}],"returns":"Promise<GeoMapFitDetail|null>","description":"Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged."},{"name":"getMapLayers","parameters":[],"returns":"Promise<GeoMapLayerDetail[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setMapLayerVisible","parameters":[{"name":"layer","type":"GeoMapLayer","optional":false},{"name":"visible","type":"boolean","optional":false}],"returns":"Promise<GeoMapLayerDetail|null>","description":"Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null."},{"name":"setAnimation","parameters":[{"name":"options","type":"{enabled?:boolean;duration?:number;easing?:GeoMapEasing;type?:GeoMapAnimationType}","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"recycleGpu","parameters":[],"returns":"Promise<void>","description":"Without this element's grant (or while it is frozen) nothing is recycled: the refusal is reported here and no GPU work starts."},{"name":"redraw","parameters":[],"returns":"Promise<FlowLinesRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"The inner map's status while the proxy runs; otherwise the proxy's own license outcome (`engine` is forwarded unchanged)."},{"name":"getActiveTier","parameters":[],"returns":"Promise<GeoMapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string|undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."}],"events":[{"name":"pointClick","type":"FlowLinesHitDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"FlowLinesHitDetail|null","description":"CustomEvent.detail type: FlowLinesHitDetail|null. Event names are case-sensitive."},{"name":"selectionChanged","type":"FlowLinesSelectionChangeEventDetail","description":"CustomEvent.detail type: FlowLinesSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<FlowLinesHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<FlowLinesHitDetail>. Event names are case-sensitive."},{"name":"rendered","type":"FlowLinesRenderResult&{tier:GeoMapEngineTier}","description":"Emits rendering results in detail when chart drawing completes."},{"name":"appended","type":"{count:number;replaced:number}","description":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"name":"windowSlid","type":"{dropped:number}","description":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"name":"dataValidationError","type":"{message:string;source:'data'|'stream'}","description":"CustomEvent.detail type: {message:string;source:'data'|'stream'}. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail|null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail|null. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"mapViewChange","type":"GeoMapViewChangeEventDetail","description":"CustomEvent.detail type: GeoMapViewChangeEventDetail. Event names are case-sensitive."},{"name":"mapLayerChange","type":"GeoMapLayerChangeEventDetail","description":"CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-flow-lines","blocks":[{"kind":"paragraph","text":"Explore logistics, routes, and movement volumes between regions."},{"kind":"paragraph","text":"Great-circle routes differ from straight lines on a projected map. Distinguish connection volume from the actual travel path."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","flows references locations IDs through from and to."],["`routePath`","great-circle or straight."]]},{"kind":"links","items":[{"path":"/charts/flow-lines","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-flow-lines.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-flow-lines\",\n      \"props\": {\n        \"data\": {\n          \"locations\": [\n            {\n              \"id\": \"seoul\",\n              \"label\": \"Seoul\",\n              \"longitude\": 126.98,\n              \"latitude\": 37.57\n            },\n            {\n              \"id\": \"tokyo\",\n              \"label\": \"Tokyo\",\n              \"longitude\": 139.69,\n              \"latitude\": 35.68\n            },\n            {\n              \"id\": \"taipei\",\n              \"label\": \"Taipei\",\n              \"longitude\": 121.56,\n              \"latitude\": 25.03\n            },\n            {\n              \"id\": \"singapore\",\n              \"label\": \"Singapore\",\n              \"longitude\": 103.82,\n              \"latitude\": 1.35\n            }\n          ],\n          \"flows\": [\n            {\n              \"id\": \"s-t\",\n              \"from\": \"seoul\",\n              \"to\": \"tokyo\",\n              \"value\": 80\n            },\n            {\n              \"id\": \"s-p\",\n              \"from\": \"seoul\",\n              \"to\": \"taipei\",\n              \"value\": 45\n            },\n            {\n              \"id\": \"p-s\",\n              \"from\": \"taipei\",\n              \"to\": \"singapore\",\n              \"value\": 30\n            }\n          ]\n        },\n        \"mapRegion\": \"asia\",\n        \"mapBackground\": \"natural-earth\",\n        \"routePath\": \"great-circle\",\n        \"locationLabels\": \"show\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'flow-lines example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"flows references locations IDs through from and to."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FlowLinesData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`460`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`16`"]]}]},{"id":"property-projection","title":"projection","blocks":[{"kind":"paragraph","text":"Allowed values: identity, mercator, equirectangular, albers, orthographic. Default: 'equirectangular'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`projection`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapProjection`"],["Default","`'equirectangular'`"],["Literals in the type","`identity`, `mercator`, `equirectangular`, `albers`, `orthographic`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","description":"Type definition"}]}]},{"id":"property-mapRegion","title":"mapRegion","blocks":[{"kind":"paragraph","text":"Allowed values: world, africa, asia, europe, north-america, south-america, oceania, antarctica. Default: 'world'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapRegion`"],["HTML attribute","`map-region`"],["Type","`GeoMapRegion`"],["Default","`'world'`"],["Allowed values","`world`, `africa`, `asia`, `europe`, `north-america`, `south-america`, `oceania`, `antarctica`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapRegion","title":"GeoMapRegion","description":"Type definition"}]}]},{"id":"property-mapBackground","title":"mapBackground","blocks":[{"kind":"paragraph","text":"Allowed values: none, natural-earth. Default: 'natural-earth'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapBackground`"],["HTML attribute","`map-background`"],["Type","`GeoMapBackground`"],["Default","`'natural-earth'`"],["Allowed values","`none`, `natural-earth`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapBackground","title":"GeoMapBackground","description":"Type definition"}]}]},{"id":"property-mapFixed","title":"mapFixed","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapFixed`"],["HTML attribute","`map-fixed`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-routePath","title":"routePath","blocks":[{"kind":"paragraph","text":"great-circle or straight."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`routePath`"],["HTML attribute","`route-path`"],["Type","`GeoMapConnectionPath`"],["Default","`'great-circle'`"],["Allowed values","`great-circle`, `straight`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapConnectionPath","title":"GeoMapConnectionPath","description":"Type definition"}]}]},{"id":"property-styleOptions","title":"styleOptions","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: FlowLinesStyle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`styleOptions`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FlowLinesStyle`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesStyle","title":"FlowLinesStyle","description":"Type definition"}]}]},{"id":"property-locationLabels","title":"locationLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locationLabels`"],["HTML attribute","`location-labels`"],["Type","`GeoMapLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":"Type definition"}]}]},{"id":"property-flowLabels","title":"flowLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'hide'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flowLabels`"],["HTML attribute","`flow-labels`"],["Type","`GeoMapLabelMode`"],["Default","`'hide'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":"Type definition"}]}]},{"id":"property-labelValue","title":"labelValue","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelValue`"],["HTML attribute","`label-value`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-mapLayers","title":"mapLayers","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: GeoMapLayersInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mapLayers`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GeoMapLayersInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayersInput","title":"GeoMapLayersInput","description":"Type definition"}]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-inactiveOtherPoints","title":"inactiveOtherPoints","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactiveOtherPoints`"],["HTML attribute","`inactive-other-points`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-inactivePointOpacity","title":"inactivePointOpacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`inactivePointOpacity`"],["HTML attribute","`inactive-point-opacity`"],["Type","`number`"],["Default","`.2`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-locale","title":"locale","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locale`"],["HTML attribute","`locale`"],["Type","`string`"],["Default","`'en-US'`"]]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail:FlowLinesHitDetail)=>string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail:FlowLinesHitDetail)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-crosshairSnapDistance","title":"crosshairSnapDistance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairSnapDistance`"],["HTML attribute","`crosshair-snap-distance`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`GeoMapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapEasing","title":"GeoMapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`GeoMapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GeoMapAnimationType","title":"GeoMapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`FlowLinesStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesStreamSource","title":"FlowLinesStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`GeoMapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapEngineMode","title":"GeoMapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`GeoMapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/GeoMapUnavailableBehaviour","title":"GeoMapUnavailableBehaviour","description":"Type definition"}]}]},{"id":"property-showEmpty","title":"showEmpty","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showEmpty`"],["HTML attribute","`show-empty`"],["Type","`boolean`"],["Default","`true`"]]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FlowLinesHitDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // FlowLinesHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FlowLinesHitDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FlowLinesHitDetail|null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // FlowLinesHitDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: FlowLinesSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FlowLinesSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // FlowLinesSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FlowLinesSelectionChangeEventDetail","title":"FlowLinesSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<FlowLinesHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<FlowLinesHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<FlowLinesHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"}]}]},{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<FlowLinesRenderResult&{tier:GeoMapEngineTier}>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // FlowLinesRenderResult&{tier:GeoMapEngineTier}\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/FlowLinesRenderResult","title":"FlowLinesRenderResult","description":"Type definition"},{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{count:number;replaced:number}>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // {count:number;replaced:number}\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{dropped:number}>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // {dropped:number}\n});","language":"javascript"}]},{"id":"event-dataValidationError","title":"dataValidationError","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {message:string;source:'data'|'stream'}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{message:string;source:'data'|'stream'}>`."},{"kind":"code","source":"chart.addEventListener('dataValidationError', event => {\n  console.log(event.detail); // {message:string;source:'data'|'stream'}\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail|null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-mapViewChange","title":"mapViewChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapViewChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `mapViewChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapViewChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('mapViewChange', event => {\n  console.log(event.detail); // GeoMapViewChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapViewChangeEventDetail","title":"GeoMapViewChangeEventDetail","description":"Type definition"}]}]},{"id":"event-mapLayerChange","title":"mapLayerChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GeoMapLayerChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `mapLayerChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GeoMapLayerChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('mapLayerChange', event => {\n  console.log(event.detail); // GeoMapLayerChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerChangeEventDetail","title":"GeoMapLayerChangeEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: FlowLinesData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`FlowLinesData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","description":"Type definition"}]}]},{"id":"method-getData","title":"getData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getData(): Promise<FlowLinesData>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesData>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","description":"Type definition"}]}]},{"id":"method-getDiagnostics","title":"getDiagnostics","blocks":[{"kind":"paragraph","text":"Normalization diagnostics for the effective base and stream source."},{"kind":"code","source":"getDiagnostics(): Promise<FlowLinesDiagnostics>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesDiagnostics>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesDiagnostics","title":"FlowLinesDiagnostics","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<FlowLinesLayout>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesLayout>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesLayout","title":"FlowLinesLayout","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(flow: FlowLinesRouteInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`flow`","`FlowLinesRouteInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(flows: ReadonlyArray<FlowLinesRouteInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`flows`","`ReadonlyArray<FlowLinesRouteInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":"Type definition"}]}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(flows: ReadonlyArray<FlowLinesRouteInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`flows`","`ReadonlyArray<FlowLinesRouteInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<FlowLinesStreamSource|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesStreamSource|undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesStreamSource","title":"FlowLinesStreamSource","description":"Type definition"}]}]},{"id":"method-clearStream","title":"clearStream","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"clearStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<FlowLinesHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"}]}]},{"id":"method-selectFlowAt","title":"selectFlowAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectFlowAt(index: number): Promise<FlowLinesHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"}]}]},{"id":"method-selectLocationAt","title":"selectLocationAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectLocationAt(index: number): Promise<FlowLinesHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"}]}]},{"id":"method-selectById","title":"selectById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectById(id: FlowLinesId, kind?: 'flow'|'location'): Promise<FlowLinesHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`FlowLinesId`","Required"],["`kind`","`'flow'|'location'`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":"Type definition"},{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","description":"Type definition"}]}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<FlowLinesSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesSelection","title":"FlowLinesSelection","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showTooltipAtFlow","title":"showTooltipAtFlow","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showTooltipAtFlow(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtLocation","title":"showTooltipAtLocation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showTooltipAtLocation(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAtData","title":"showCrosshairAtData","blocks":[{"kind":"paragraph","text":"Quiet source-category synchronization. Categories retain their original string or number type."},{"kind":"code","source":"showCrosshairAtData(request: {dataX:number;dataY:number}): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`{dataX:number;dataY:number}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: {x?:number;y?:number}): Promise<CartesianZoomChangeEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{x?:number;y?:number}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetMapView","title":"resetMapView","blocks":[{"kind":"paragraph","text":"Restore the configured projection/region and clear map movement and zoom."},{"kind":"code","source":"resetMapView(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getMapView","title":"getMapView","blocks":[{"kind":"paragraph","text":"Owned geographic camera, effective region and viewport state."},{"kind":"code","source":"getMapView(): Promise<GeoMapViewDetail|null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapViewDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapViewDetail","title":"GeoMapViewDetail","description":"Type definition"}]}]},{"id":"method-fitMap","title":"fitMap","blocks":[{"kind":"paragraph","text":"Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged."},{"kind":"code","source":"fitMap(options?: GeoMapFitOptions): Promise<GeoMapFitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`GeoMapFitOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapFitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapFitDetail","title":"GeoMapFitDetail","description":"Type definition"},{"path":"/docs/types/GeoMapFitOptions","title":"GeoMapFitOptions","description":"Type definition"}]}]},{"id":"method-getMapLayers","title":"getMapLayers","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getMapLayers(): Promise<GeoMapLayerDetail[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLayerDetail[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","description":"Type definition"}]}]},{"id":"method-setMapLayerVisible","title":"setMapLayerVisible","blocks":[{"kind":"paragraph","text":"Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null."},{"kind":"code","source":"setMapLayerVisible(layer: GeoMapLayer, visible: boolean): Promise<GeoMapLayerDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`layer`","`GeoMapLayer`","Required"],["`visible`","`boolean`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GeoMapLayerDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","description":"Type definition"},{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: {enabled?:boolean;duration?:number;easing?:GeoMapEasing;type?:GeoMapAnimationType}): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{enabled?:boolean;duration?:number;easing?:GeoMapEasing;type?:GeoMapAnimationType}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapEasing","title":"GeoMapEasing","description":"Type definition"},{"path":"/docs/types/GeoMapAnimationType","title":"GeoMapAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-recycleGpu","title":"recycleGpu","blocks":[{"kind":"paragraph","text":"Without this element's grant (or while it is frozen) nothing is recycled: the refusal is reported here and no GPU work starts."},{"kind":"code","source":"recycleGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<FlowLinesRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<FlowLinesRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/FlowLinesRenderResult","title":"FlowLinesRenderResult","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"The inner map's status while the proxy runs; otherwise the proxy's own license outcome (`engine` is forwarded unchanged)."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<GeoMapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GeoMapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string|undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/candlestick","title":"Candlestick","summary":"Show four prices per period in a candlestick.","kind":"component","tag":"sy-candlestick-chart","componentId":"candlestick","api":{"props":[{"name":"data","attribute":"data","type":"CandlestickData","kind":"property","values":[],"default":"undefined","description":"An array of { time, open, high, low, close, volume? }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes — x narrows the bar window (slots under the ordinal scale, wall time under linear), y the price; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"name":"xMin","attribute":"x-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Explicit domain ends (an omitted end follows the bars; `x-axis` / `y-axis` `min` / `max` also set them)."},{"name":"xMax","attribute":"x-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMin","attribute":"y-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMax","attribute":"y-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"0.05","description":"The price padding above and below the bars (a fraction of the span; default 0.05)."},{"name":"upColor","attribute":"up-color","type":"string","kind":"string","values":[],"default":"DEFAULT_UP_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"downColor","attribute":"down-color","type":"string","kind":"string","values":[],"default":"DEFAULT_DOWN_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"flatColor","attribute":"flat-color","type":"string","kind":"string","values":[],"default":"DEFAULT_FLAT_COLOR","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"candleWidth","attribute":"candle-width","type":"number","kind":"number","values":[],"default":"CANDLE_DEFAULT_WIDTH_RATIO","description":"The body's share of the bar pitch (0 … 1; default 0.7)."},{"name":"candleMinPx","attribute":"candle-min-px","type":"number","kind":"number","values":[],"default":"CANDLE_DEFAULT_MIN_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"candleMaxPx","attribute":"candle-max-px","type":"number","kind":"number","values":[],"default":"CANDLE_DEFAULT_MAX_PX","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"wickWidth","attribute":"wick-width","type":"number","kind":"number","values":[],"default":"1","description":"The wick width in CSS px."},{"name":"bodyMinPx","attribute":"body-min-px","type":"number","kind":"number","values":[],"default":"1","description":"The minimum body height in CSS px (a doji stays visible)."},{"name":"barStyle","attribute":"bar-style","type":"CandlestickBarStyle","kind":"string","values":["candle","ohlc","hlc","hilo"],"default":"'candle'","description":"`candle` (default) or `ohlc` (a high–low spine, an open tick left, a close tick right); `hlc` (no open tick). `<sy-ohlc-chart>` takes `ohlc` / `hlc`."},{"name":"tickLength","attribute":"tick-length","type":"number","kind":"number","values":[],"default":"undefined","description":"(carry-over D5) — the OHLC / HLC tick length in CSS px (default: the body half-width)."},{"name":"fillAlpha","attribute":"fill-alpha","type":"number","kind":"number","values":[],"default":"undefined","description":"(carry-over D5) — the band fill alpha 0 … 1 (default 0.12)."},{"name":"bodyStyle","attribute":"body-style","type":"CandlestickBodyStyle","kind":"string","values":["solid","hollow","hollow-up"],"default":"'solid'","description":"`solid` (default), `hollow`, or `hollow-up` (rising bars hollow, falling filled)."},{"name":"bodyBorderPx","attribute":"body-border-px","type":"number","kind":"number","values":[],"default":"1","description":"the hollow ring's border in CSS px."},{"name":"wickColor","attribute":"wick-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"the wick colour; `auto` follows the body colour."},{"name":"antialias","attribute":"antialias","type":"CandlestickAntialias","kind":"string","values":["auto","off","on"],"default":"'auto'","description":"the edge coverage: `auto` (on while the pitch is at least two device px), `on`, `off`."},{"name":"pixelSnap","attribute":"pixel-snap","type":"boolean","kind":"boolean","values":[],"default":"true","description":"snap the body and the wick to integer device-px widths (crisp, uniform candles)."},{"name":"timeScale","attribute":"time-scale","type":"CandlestickTimeScale","kind":"string","values":["linear","ordinal"],"default":"'ordinal'","description":"ordinal reflects trading order; linear reflects elapsed time."},{"name":"session","attribute":"session","type":"CandlestickSessionInput | string","kind":"property","values":[],"default":"'24x7'","description":"the exchange session the labels read: `24x7`, `us-equity`, or an object / JSON string `{ timezone, sessions, holidays, closedWeekdays }`."},{"name":"labelLocale","attribute":"label-locale","type":"string","kind":"string","values":[],"default":"'en-US'","description":"the BCP-47 locale of the month labels."},{"name":"volume","attribute":"volume","type":"CandlestickVolumeMode","kind":"string","values":["off","pane"],"default":"'off'","description":"Select pane to display volume alongside prices."},{"name":"volumeHeight","attribute":"volume-height","type":"number","kind":"number","values":[],"default":"0.25","description":"the volume pane's share of the plot height (0.05 … 0.8)."},{"name":"volumeUpColor","attribute":"volume-up-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"the volume bar colours; `auto` follows up-color / down-color."},{"name":"volumeDownColor","attribute":"volume-down-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"volumeAlpha","attribute":"volume-alpha","type":"number","kind":"number","values":[],"default":"0.45","description":"the volume bars' alpha."},{"name":"overlays","attribute":"overlays","type":"CandlestickOverlayInput | string","kind":"property","values":[],"default":"undefined","description":"moving-average overlays over the closes: spec objects `{ kind, period?, color?, width?, label? }`, a JSON string of them, or the compact `\"sma:20 ema:50\"`; the kinds are the stock chart's (sma, ema, wma, dema, tema, vwma, hma, linreg). A legend at the top of the price pane names each line and reads its value under the pointer."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"the bar tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: CandlestickPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"CandlestickEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"CandlestickAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"CandlestickStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source of bars (§3.6); without one `appendPoint` creates an internal source."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The bars the internal stream source tracks at most."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed bars the chart renders (the whole buffer when unset)."},{"name":"engine","attribute":"engine","type":"CandlestickEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"CandlestickUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<CandlestickRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<CandlestickEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"CandlestickData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"bar","type":"CandlestickBarInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"bars","type":"ReadonlyArray<CandlestickBarInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed bars (the `data` bars are not the stream)."},{"name":"replace","parameters":[{"name":"bars","type":"ReadonlyArray<CandlestickBarInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<CandlestickStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<CandlestickPointEventDetail | null>","description":"The bar under a host-local point (the nearest bar within half a pitch, anywhere inside the plot's height)."},{"name":"getBar","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CandlestickBar | null>","description":"The normalised bar at an index (null outside)."},{"name":"getBarAt","parameters":[{"name":"time","type":"number","optional":false}],"returns":"Promise<(CandlestickBar & { index: number }) | null>","description":"The bar nearest to a time (null for an empty series)."},{"name":"getBarCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<CandlestickExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDomain","parameters":[],"returns":"Promise<CandlestickDomain>","description":"The data domain the grid spans."},{"name":"getVisibleRange","parameters":[],"returns":"Promise<CandlestickVisibleRange>","description":"The bars the plot shows: the `x-axis` window, narrowed by the zoom when one is in place."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a bar by index (null when the tooltip is off or the bar is outside the visible window)."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusBarAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CandlestickPointEventDetail | null>","description":"move the keyboard focus ring to a bar (null outside the visible window); emits pointHover like the walk."},{"name":"getOverlays","parameters":[],"returns":"Promise<CandlestickOverlayState[]>","description":"the overlays: each settled spec with where its PRIMARY line exists and what is visible (the outputs and the band ride on the spec)."},{"name":"getOverlayValues","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<Record<string, number | null>>","description":"the overlay values at a bar index: the primary output under the overlay id, the others under `id.key` (null through a warm-up)."},{"name":"getPanes","parameters":[],"returns":"Promise<CandlestickPaneRects>","description":"the panes: the price pane, the volume pane when it exists, the separator, and why there is none."},{"name":"getTimeScale","parameters":[],"returns":"Promise<CandlestickTimeScaleState>","description":"the time scale of the visible range: the kind, the slots, the spacing and the ordinal ticks."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation; x in slots under the ordinal scale — bar i sits at i — or epoch ms under linear, y in price); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by data units (`{ x?, y? }` — x in slots or ms, y in price); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent (and key) of the primary — or the named — master axes (x: the visible slot range −0.5 … n − 0.5 under ordinal, the ms window under linear; y: the fitted price domain)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."}],"events":[{"name":"rendered","type":"CandlestickRenderResult & { tier: CandlestickEngineTier; engine?: ChartEngineStatus }","description":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"name":"pointClick","type":"CandlestickPointEventDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"CandlestickPointEventDetail | null","description":"CustomEvent.detail type: CandlestickPointEventDetail | null. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<CandlestickPointEventDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CandlestickPointEventDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"the tooltip events of the shared contract."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-candlestick-chart","blocks":[{"kind":"paragraph","text":"Explore changes in opening, high, low, and closing prices."},{"kind":"paragraph","text":"The example uses fictional prices. Match time zones, trading sessions, and adjusted-price conventions to your actual data."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { time, open, high, low, close, volume? }."],["`timeScale`","ordinal reflects trading order; linear reflects elapsed time."],["`volume`","Select pane to display volume alongside prices."]]},{"kind":"links","items":[{"path":"/charts/candlestick","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-candlestick-chart.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-candlestick-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"time\": 1767225600000,\n            \"open\": 100,\n            \"close\": 95,\n            \"high\": 103,\n            \"low\": 92,\n            \"volume\": 1200\n          },\n          {\n            \"time\": 1767312000000,\n            \"open\": 104,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 101,\n            \"volume\": 1337\n          },\n          {\n            \"time\": 1767398400000,\n            \"open\": 107,\n            \"close\": 105,\n            \"high\": 110,\n            \"low\": 102,\n            \"volume\": 1474\n          },\n          {\n            \"time\": 1767484800000,\n            \"open\": 109,\n            \"close\": 114,\n            \"high\": 117,\n            \"low\": 106,\n            \"volume\": 1611\n          },\n          {\n            \"time\": 1767571200000,\n            \"open\": 108,\n            \"close\": 109,\n            \"high\": 112,\n            \"low\": 105,\n            \"volume\": 1748\n          },\n          {\n            \"time\": 1767657600000,\n            \"open\": 106,\n            \"close\": 103,\n            \"high\": 109,\n            \"low\": 100,\n            \"volume\": 1885\n          },\n          {\n            \"time\": 1767744000000,\n            \"open\": 102,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 99,\n            \"volume\": 2022\n          },\n          {\n            \"time\": 1767830400000,\n            \"open\": 100,\n            \"close\": 100,\n            \"high\": 103,\n            \"low\": 97,\n            \"volume\": 2159\n          },\n          {\n            \"time\": 1767916800000,\n            \"open\": 98,\n            \"close\": 94,\n            \"high\": 101,\n            \"low\": 91,\n            \"volume\": 2296\n          },\n          {\n            \"time\": 1768003200000,\n            \"open\": 99,\n            \"close\": 102,\n            \"high\": 105,\n            \"low\": 96,\n            \"volume\": 2433\n          },\n          {\n            \"time\": 1768089600000,\n            \"open\": 101,\n            \"close\": 100,\n            \"high\": 104,\n            \"low\": 97,\n            \"volume\": 2570\n          },\n          {\n            \"time\": 1768176000000,\n            \"open\": 105,\n            \"close\": 100,\n            \"high\": 108,\n            \"low\": 97,\n            \"volume\": 2707\n          },\n          {\n            \"time\": 1768262400000,\n            \"open\": 109,\n            \"close\": 111,\n            \"high\": 114,\n            \"low\": 106,\n            \"volume\": 2844\n          },\n          {\n            \"time\": 1768348800000,\n            \"open\": 113,\n            \"close\": 111,\n            \"high\": 116,\n            \"low\": 108,\n            \"volume\": 2981\n          },\n          {\n            \"time\": 1768435200000,\n            \"open\": 115,\n            \"close\": 120,\n            \"high\": 123,\n            \"low\": 112,\n            \"volume\": 1318\n          },\n          {\n            \"time\": 1768521600000,\n            \"open\": 115,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 112,\n            \"volume\": 1455\n          },\n          {\n            \"time\": 1768608000000,\n            \"open\": 114,\n            \"close\": 111,\n            \"high\": 117,\n            \"low\": 108,\n            \"volume\": 1592\n          },\n          {\n            \"time\": 1768694400000,\n            \"open\": 111,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 108,\n            \"volume\": 1729\n          },\n          {\n            \"time\": 1768780800000,\n            \"open\": 108,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 105,\n            \"volume\": 1866\n          },\n          {\n            \"time\": 1768867200000,\n            \"open\": 105,\n            \"close\": 101,\n            \"high\": 108,\n            \"low\": 98,\n            \"volume\": 2003\n          },\n          {\n            \"time\": 1768953600000,\n            \"open\": 105,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 102,\n            \"volume\": 2140\n          },\n          {\n            \"time\": 1769040000000,\n            \"open\": 107,\n            \"close\": 106,\n            \"high\": 110,\n            \"low\": 103,\n            \"volume\": 2277\n          },\n          {\n            \"time\": 1769126400000,\n            \"open\": 110,\n            \"close\": 105,\n            \"high\": 113,\n            \"low\": 102,\n            \"volume\": 2414\n          },\n          {\n            \"time\": 1769212800000,\n            \"open\": 114,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 111,\n            \"volume\": 2551\n          },\n          {\n            \"time\": 1769299200000,\n            \"open\": 119,\n            \"close\": 117,\n            \"high\": 122,\n            \"low\": 114,\n            \"volume\": 2688\n          },\n          {\n            \"time\": 1769385600000,\n            \"open\": 121,\n            \"close\": 126,\n            \"high\": 129,\n            \"low\": 118,\n            \"volume\": 2825\n          },\n          {\n            \"time\": 1769472000000,\n            \"open\": 123,\n            \"close\": 124,\n            \"high\": 127,\n            \"low\": 120,\n            \"volume\": 2962\n          },\n          {\n            \"time\": 1769558400000,\n            \"open\": 121,\n            \"close\": 118,\n            \"high\": 124,\n            \"low\": 115,\n            \"volume\": 1299\n          },\n          {\n            \"time\": 1769644800000,\n            \"open\": 119,\n            \"close\": 123,\n            \"high\": 126,\n            \"low\": 116,\n            \"volume\": 1436\n          },\n          {\n            \"time\": 1769731200000,\n            \"open\": 116,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 113,\n            \"volume\": 1573\n          },\n          {\n            \"time\": 1769817600000,\n            \"open\": 113,\n            \"close\": 109,\n            \"high\": 116,\n            \"low\": 106,\n            \"volume\": 1710\n          },\n          {\n            \"time\": 1769904000000,\n            \"open\": 112,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 109,\n            \"volume\": 1847\n          }\n        ],\n        \"timeScale\": \"ordinal\",\n        \"volume\": \"off\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'candlestick example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { time, open, high, low, close, volume? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickData","title":"CandlestickData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (Storybook parity, 2026-09-10): `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, the Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) on the primary axes — x narrows the bar window (slots under the ordinal scale, wall time under linear), y the price; an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default; the methods (`zoomTo` / `zoomBy` / `panBy` / `resetZoom`) work regardless of the gesture switches."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-xMin","title":"xMin","blocks":[{"kind":"paragraph","text":"Explicit domain ends (an omitted end follows the bars; `x-axis` / `y-axis` `min` / `max` also set them)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xMin`"],["HTML attribute","`x-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xMax","title":"xMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xMax`"],["HTML attribute","`x-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMin","title":"yMin","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMin`"],["HTML attribute","`y-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMax","title":"yMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMax`"],["HTML attribute","`y-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"The price padding above and below the bars (a fraction of the span; default 0.05)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`0.05`"]]}]},{"id":"property-upColor","title":"upColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`upColor`"],["HTML attribute","`up-color`"],["Type","`string`"],["Default","`DEFAULT_UP_COLOR`"]]}]},{"id":"property-downColor","title":"downColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`downColor`"],["HTML attribute","`down-color`"],["Type","`string`"],["Default","`DEFAULT_DOWN_COLOR`"]]}]},{"id":"property-flatColor","title":"flatColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flatColor`"],["HTML attribute","`flat-color`"],["Type","`string`"],["Default","`DEFAULT_FLAT_COLOR`"]]}]},{"id":"property-candleWidth","title":"candleWidth","blocks":[{"kind":"paragraph","text":"The body's share of the bar pitch (0 … 1; default 0.7)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`candleWidth`"],["HTML attribute","`candle-width`"],["Type","`number`"],["Default","`CANDLE_DEFAULT_WIDTH_RATIO`"]]}]},{"id":"property-candleMinPx","title":"candleMinPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`candleMinPx`"],["HTML attribute","`candle-min-px`"],["Type","`number`"],["Default","`CANDLE_DEFAULT_MIN_PX`"]]}]},{"id":"property-candleMaxPx","title":"candleMaxPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`candleMaxPx`"],["HTML attribute","`candle-max-px`"],["Type","`number`"],["Default","`CANDLE_DEFAULT_MAX_PX`"]]}]},{"id":"property-wickWidth","title":"wickWidth","blocks":[{"kind":"paragraph","text":"The wick width in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wickWidth`"],["HTML attribute","`wick-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-bodyMinPx","title":"bodyMinPx","blocks":[{"kind":"paragraph","text":"The minimum body height in CSS px (a doji stays visible)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bodyMinPx`"],["HTML attribute","`body-min-px`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-barStyle","title":"barStyle","blocks":[{"kind":"paragraph","text":"`candle` (default) or `ohlc` (a high–low spine, an open tick left, a close tick right); `hlc` (no open tick). `<sy-ohlc-chart>` takes `ohlc` / `hlc`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barStyle`"],["HTML attribute","`bar-style`"],["Type","`CandlestickBarStyle`"],["Default","`'candle'`"],["Allowed values","`candle`, `ohlc`, `hlc`, `hilo`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickBarStyle","title":"CandlestickBarStyle","description":"Type definition"}]}]},{"id":"property-tickLength","title":"tickLength","blocks":[{"kind":"paragraph","text":"(carry-over D5) — the OHLC / HLC tick length in CSS px (default: the body half-width)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLength`"],["HTML attribute","`tick-length`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-fillAlpha","title":"fillAlpha","blocks":[{"kind":"paragraph","text":"(carry-over D5) — the band fill alpha 0 … 1 (default 0.12)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillAlpha`"],["HTML attribute","`fill-alpha`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-bodyStyle","title":"bodyStyle","blocks":[{"kind":"paragraph","text":"`solid` (default), `hollow`, or `hollow-up` (rising bars hollow, falling filled)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bodyStyle`"],["HTML attribute","`body-style`"],["Type","`CandlestickBodyStyle`"],["Default","`'solid'`"],["Allowed values","`solid`, `hollow`, `hollow-up`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickBodyStyle","title":"CandlestickBodyStyle","description":"Type definition"}]}]},{"id":"property-bodyBorderPx","title":"bodyBorderPx","blocks":[{"kind":"paragraph","text":"the hollow ring's border in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bodyBorderPx`"],["HTML attribute","`body-border-px`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-wickColor","title":"wickColor","blocks":[{"kind":"paragraph","text":"the wick colour; `auto` follows the body colour."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wickColor`"],["HTML attribute","`wick-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-antialias","title":"antialias","blocks":[{"kind":"paragraph","text":"the edge coverage: `auto` (on while the pitch is at least two device px), `on`, `off`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`antialias`"],["HTML attribute","`antialias`"],["Type","`CandlestickAntialias`"],["Default","`'auto'`"],["Allowed values","`auto`, `off`, `on`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickAntialias","title":"CandlestickAntialias","description":"Type definition"}]}]},{"id":"property-pixelSnap","title":"pixelSnap","blocks":[{"kind":"paragraph","text":"snap the body and the wick to integer device-px widths (crisp, uniform candles)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`pixelSnap`"],["HTML attribute","`pixel-snap`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-timeScale","title":"timeScale","blocks":[{"kind":"paragraph","text":"ordinal reflects trading order; linear reflects elapsed time."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`timeScale`"],["HTML attribute","`time-scale`"],["Type","`CandlestickTimeScale`"],["Default","`'ordinal'`"],["Allowed values","`linear`, `ordinal`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickTimeScale","title":"CandlestickTimeScale","description":"Type definition"}]}]},{"id":"property-session","title":"session","blocks":[{"kind":"paragraph","text":"the exchange session the labels read: `24x7`, `us-equity`, or an object / JSON string `{ timezone, sessions, holidays, closedWeekdays }`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`session`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickSessionInput | string`"],["Default","`'24x7'`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickSessionInput","title":"CandlestickSessionInput","description":"Type definition"}]}]},{"id":"property-labelLocale","title":"labelLocale","blocks":[{"kind":"paragraph","text":"the BCP-47 locale of the month labels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelLocale`"],["HTML attribute","`label-locale`"],["Type","`string`"],["Default","`'en-US'`"]]}]},{"id":"property-volume","title":"volume","blocks":[{"kind":"paragraph","text":"Select pane to display volume alongside prices."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volume`"],["HTML attribute","`volume`"],["Type","`CandlestickVolumeMode`"],["Default","`'off'`"],["Allowed values","`off`, `pane`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickVolumeMode","title":"CandlestickVolumeMode","description":"Type definition"}]}]},{"id":"property-volumeHeight","title":"volumeHeight","blocks":[{"kind":"paragraph","text":"the volume pane's share of the plot height (0.05 … 0.8)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeHeight`"],["HTML attribute","`volume-height`"],["Type","`number`"],["Default","`0.25`"]]}]},{"id":"property-volumeUpColor","title":"volumeUpColor","blocks":[{"kind":"paragraph","text":"the volume bar colours; `auto` follows up-color / down-color."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeUpColor`"],["HTML attribute","`volume-up-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-volumeDownColor","title":"volumeDownColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeDownColor`"],["HTML attribute","`volume-down-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-volumeAlpha","title":"volumeAlpha","blocks":[{"kind":"paragraph","text":"the volume bars' alpha."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeAlpha`"],["HTML attribute","`volume-alpha`"],["Type","`number`"],["Default","`0.45`"]]}]},{"id":"property-overlays","title":"overlays","blocks":[{"kind":"paragraph","text":"moving-average overlays over the closes: spec objects `{ kind, period?, color?, width?, label? }`, a JSON string of them, or the compact `\"sma:20 ema:50\"`; the kinds are the stock chart's (sma, ema, wma, dema, tema, vwma, hma, linreg). A legend at the top of the price pane names each line and reads its value under the pointer."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`overlays`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickOverlayInput | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlayInput","title":"CandlestickOverlayInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"the bar tooltip (the shared cartesian tooltip input: show / trigger / format / html / connector / draggable …)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"a plain-text formatter of the default tooltip (`tooltip.format` wins)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: CandlestickPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`CandlestickEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickEasing","title":"CandlestickEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`CandlestickAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickAnimationType","title":"CandlestickAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source of bars (§3.6); without one `appendPoint` creates an internal source."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickStreamSource","title":"CandlestickStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The bars the internal stream source tracks at most."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed bars the chart renders (the whole buffer when unset)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`CandlestickEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickEngineMode","title":"CandlestickEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`CandlestickUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickUnavailableBehaviour","title":"CandlestickUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Every drawn frame; `engine` is the engine status (requested / effective / code / the governing license feature)."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CandlestickRenderResult & { tier: CandlestickEngineTier; engine?: ChartEngineStatus }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // CandlestickRenderResult & { tier: CandlestickEngineTier; engine?: ChartEngineStatus }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CandlestickRenderResult","title":"CandlestickRenderResult","description":"Type definition"},{"path":"/docs/types/CandlestickEngineTier","title":"CandlestickEngineTier","description":"Type definition"},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CandlestickPointEventDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // CandlestickPointEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CandlestickPointEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CandlestickPointEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // CandlestickPointEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<CandlestickPointEventDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<CandlestickPointEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<CandlestickPointEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"the tooltip events of the shared contract."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<CandlestickRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickRenderResult","title":"CandlestickRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<CandlestickEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickEngineTier","title":"CandlestickEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: CandlestickData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`CandlestickData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickData","title":"CandlestickData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(bar: CandlestickBarInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`bar`","`CandlestickBarInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`bars`","`ReadonlyArray<CandlestickBarInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed bars (the `data` bars are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`bars`","`ReadonlyArray<CandlestickBarInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<CandlestickStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickStreamSource","title":"CandlestickStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickEasing","title":"CandlestickEasing","description":"Type definition"},{"path":"/docs/types/CandlestickAnimationType","title":"CandlestickAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The bar under a host-local point (the nearest bar within half a pitch, anywhere inside the plot's height)."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<CandlestickPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CandlestickPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"method-getBar","title":"getBar","blocks":[{"kind":"paragraph","text":"The normalised bar at an index (null outside)."},{"kind":"code","source":"getBar(index: number): Promise<CandlestickBar | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CandlestickBar | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","description":"Type definition"}]}]},{"id":"method-getBarAt","title":"getBarAt","blocks":[{"kind":"paragraph","text":"The bar nearest to a time (null for an empty series)."},{"kind":"code","source":"getBarAt(time: number): Promise<(CandlestickBar & { index: number }) | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`time`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<(CandlestickBar & { index: number }) | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","description":"Type definition"}]}]},{"id":"method-getBarCount","title":"getBarCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBarCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<CandlestickExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickExtent","title":"CandlestickExtent","description":"Type definition"}]}]},{"id":"method-getDomain","title":"getDomain","blocks":[{"kind":"paragraph","text":"The data domain the grid spans."},{"kind":"code","source":"getDomain(): Promise<CandlestickDomain>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickDomain>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickDomain","title":"CandlestickDomain","description":"Type definition"}]}]},{"id":"method-getVisibleRange","title":"getVisibleRange","blocks":[{"kind":"paragraph","text":"The bars the plot shows: the `x-axis` window, narrowed by the zoom when one is in place."},{"kind":"code","source":"getVisibleRange(): Promise<CandlestickVisibleRange>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickVisibleRange>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickVisibleRange","title":"CandlestickVisibleRange","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a bar by index (null when the tooltip is off or the bar is outside the visible window)."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusBarAt","title":"focusBarAt","blocks":[{"kind":"paragraph","text":"move the keyboard focus ring to a bar (null outside the visible window); emits pointHover like the walk."},{"kind":"code","source":"focusBarAt(index: number): Promise<CandlestickPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CandlestickPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"method-getOverlays","title":"getOverlays","blocks":[{"kind":"paragraph","text":"the overlays: each settled spec with where its PRIMARY line exists and what is visible (the outputs and the band ride on the spec)."},{"kind":"code","source":"getOverlays(): Promise<CandlestickOverlayState[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickOverlayState[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlayState","title":"CandlestickOverlayState","description":"Type definition"}]}]},{"id":"method-getOverlayValues","title":"getOverlayValues","blocks":[{"kind":"paragraph","text":"the overlay values at a bar index: the primary output under the overlay id, the others under `id.key` (null through a warm-up)."},{"kind":"code","source":"getOverlayValues(index: number): Promise<Record<string, number | null>>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Record<string, number | null>>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getPanes","title":"getPanes","blocks":[{"kind":"paragraph","text":"the panes: the price pane, the volume pane when it exists, the separator, and why there is none."},{"kind":"code","source":"getPanes(): Promise<CandlestickPaneRects>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickPaneRects>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPaneRects","title":"CandlestickPaneRects","description":"Type definition"}]}]},{"id":"method-getTimeScale","title":"getTimeScale","blocks":[{"kind":"paragraph","text":"the time scale of the visible range: the kind, the slots, the spacing and the ordinal ticks."},{"kind":"code","source":"getTimeScale(): Promise<CandlestickTimeScaleState>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickTimeScaleState>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickTimeScaleState","title":"CandlestickTimeScaleState","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows: `x` / `y` as `{ min, max }` or `[min, max]` (`null` clears that orientation; x in slots under the ordinal scale — bar i sits at i — or epoch ms under linear, y in price); `xAxis` / `yAxis` name the axis by id or slot index (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by data units (`{ x?, y? }` — x in slots or ms, y in price); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent (and key) of the primary — or the named — master axes (x: the visible slot range −0.5 … n − 0.5 under ordinal, the ms window under linear; y: the fitted price domain)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the decision for the current inputs, read without side effects (ProChartLicense.engineStatus); a renderer that failed at run time reports engine-unsupported."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/ohlc","title":"Ohlc","summary":"Read four prices from a high-low line and open-close ticks.","kind":"component","tag":"sy-ohlc-chart","componentId":"ohlc","api":{"props":[{"name":"barStyle","attribute":"bar-style","type":"'ohlc' | 'hlc' | 'hilo'","kind":"string","values":["ohlc","hlc","hilo"],"default":"'ohlc'","description":"The tick style: ohlc, hlc, or hilo."},{"name":"data","attribute":"data","type":"CandlestickData","kind":"property","values":[],"default":"undefined","description":"A price array with time, open, high, low, and close."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"360","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"xAxis","attribute":"x-axis","type":"CartesianAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"name":"yAxis","attribute":"y-axis","type":"YAxisInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"name":"gridLines","attribute":"grid-lines","type":"CartesianGridLinesInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Allowed values: auto, off. Default: undefined."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Crosshair that follows the cursor across the plot (forwarded; the inner `crosshairMove` bubbles through the host)."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Zoom (Storybook parity 2026-09-10) — the candlestick's shared cartesian zoom, forwarded; the inner `zoomChange` bubbles through the host."},{"name":"xMin","attribute":"x-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"xMax","attribute":"x-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMin","attribute":"y-min","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"yMax","attribute":"y-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"padding","attribute":"padding","type":"number","kind":"number","values":[],"default":"0.05","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"upColor","attribute":"up-color","type":"string","kind":"string","values":[],"default":"'#26a69a'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"downColor","attribute":"down-color","type":"string","kind":"string","values":[],"default":"'#ef5350'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"flatColor","attribute":"flat-color","type":"string","kind":"string","values":[],"default":"'#9ca3af'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"candleWidth","attribute":"candle-width","type":"number","kind":"number","values":[],"default":"0.7","description":"The tick length's share of the bar pitch (the candle body ratio; 0.7 by default)."},{"name":"candleMinPx","attribute":"candle-min-px","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"candleMaxPx","attribute":"candle-max-px","type":"number","kind":"number","values":[],"default":"40","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"wickWidth","attribute":"wick-width","type":"number","kind":"number","values":[],"default":"1","description":"The spine and tick thickness in CSS px."},{"name":"tickLength","attribute":"tick-length","type":"number","kind":"number","values":[],"default":"undefined","description":"(carry-over D5) — the open / close tick length in CSS px (default: the body half-width)."},{"name":"fillAlpha","attribute":"fill-alpha","type":"number","kind":"number","values":[],"default":"undefined","description":"(carry-over D5) — the band fill alpha 0 … 1 (default 0.12)."},{"name":"bodyMinPx","attribute":"body-min-px","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"bodyStyle","attribute":"body-style","type":"CandlestickBodyStyle","kind":"string","values":["solid","hollow","hollow-up"],"default":"'solid'","description":"Candle-only lanes, forwarded for parity (an OHLC bar has no body to hollow)."},{"name":"bodyBorderPx","attribute":"body-border-px","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"wickColor","attribute":"wick-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"antialias","attribute":"antialias","type":"CandlestickAntialias","kind":"string","values":["auto","off","on"],"default":"'auto'","description":"Allowed values: auto, off, on. Default: 'auto'."},{"name":"pixelSnap","attribute":"pixel-snap","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"timeScale","attribute":"time-scale","type":"CandlestickTimeScale","kind":"string","values":["linear","ordinal"],"default":"'ordinal'","description":"Allowed values: linear, ordinal. Default: 'ordinal'."},{"name":"session","attribute":"session","type":"CandlestickSessionInput | string","kind":"property","values":[],"default":"'24x7'","description":"Pass as a JavaScript property. type: CandlestickSessionInput | string."},{"name":"labelLocale","attribute":"label-locale","type":"string","kind":"string","values":[],"default":"'en-US'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"volume","attribute":"volume","type":"CandlestickVolumeMode","kind":"string","values":["off","pane"],"default":"'off'","description":"Allowed values: off, pane. Default: 'off'."},{"name":"volumeHeight","attribute":"volume-height","type":"number","kind":"number","values":[],"default":"0.25","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"volumeUpColor","attribute":"volume-up-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"volumeDownColor","attribute":"volume-down-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"volumeAlpha","attribute":"volume-alpha","type":"number","kind":"number","values":[],"default":"0.45","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"overlays","attribute":"overlays","type":"CandlestickOverlayInput | string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CandlestickOverlayInput | string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: CandlestickPointEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: CandlestickPointEventDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"CandlestickEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"CandlestickAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"CandlestickStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed bars the chart renders (the whole buffer when unset)."},{"name":"engine","attribute":"engine","type":"CandlestickEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"CandlestickUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"redraw","parameters":[],"returns":"Promise<CandlestickRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<CandlestickEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"CandlestickData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendPoint","parameters":[{"name":"bar","type":"CandlestickBarInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"bars","type":"ReadonlyArray<CandlestickBarInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"bars","type":"ReadonlyArray<CandlestickBarInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<CandlestickStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<CandlestickPointEventDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"getBar","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CandlestickBar | null>","description":"The normalised bar at an index (null outside)."},{"name":"getBarAt","parameters":[{"name":"time","type":"number","optional":false}],"returns":"Promise<(CandlestickBar & { index: number }) | null>","description":"The bar nearest to a time (null for an empty series)."},{"name":"getBarCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<CandlestickExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDomain","parameters":[],"returns":"Promise<CandlestickDomain>","description":"The data domain the grid spans."},{"name":"getVisibleRange","parameters":[],"returns":"Promise<CandlestickVisibleRange>","description":"The bars the plot shows: the `x-axis` window, narrowed by the zoom when one is in place."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"focusBarAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CandlestickPointEventDetail | null>","description":"move the keyboard focus ring to a bar (null outside the visible window); emits pointHover like the walk."},{"name":"getOverlays","parameters":[],"returns":"Promise<CandlestickOverlayState[]>","description":"the overlays: each settled spec with where its PRIMARY line exists and what is visible (the outputs and the band ride on the spec)."},{"name":"getOverlayValues","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<Record<string, number | null>>","description":"the overlay values at a bar index: the primary output under the overlay id, the others under `id.key` (null through a warm-up)."},{"name":"getPanes","parameters":[],"returns":"Promise<CandlestickPaneRects>","description":"the panes: the price pane, the volume pane when it exists, the separator, and why there is none."},{"name":"getTimeScale","parameters":[],"returns":"Promise<CandlestickTimeScaleState>","description":"the time scale of the visible range: the kind, the slots, the spacing and the ordinal ticks."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"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 (default: the primary axis)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08): the inner candlestick's own status once it is mounted (it gates chart.type.ohlc and chart.type.candlestick); before that, this proxy's chart.type.ohlc decision, read without side effects."}],"events":[]},"sections":[{"id":"overview","title":"sy-ohlc-chart","blocks":[{"kind":"paragraph","text":"Use to display many price bars compactly."},{"kind":"paragraph","text":"Uses the same data format as Candlestick. Keep time zones and intervals consistent."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","A price array with time, open, high, low, and close."],["`barStyle`","The tick style: ohlc, hlc, or hilo."]]},{"kind":"links","items":[{"path":"/charts/ohlc","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-ohlc-chart.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-ohlc-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"time\": 1767225600000,\n            \"open\": 100,\n            \"close\": 95,\n            \"high\": 103,\n            \"low\": 92,\n            \"volume\": 1200\n          },\n          {\n            \"time\": 1767312000000,\n            \"open\": 104,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 101,\n            \"volume\": 1337\n          },\n          {\n            \"time\": 1767398400000,\n            \"open\": 107,\n            \"close\": 105,\n            \"high\": 110,\n            \"low\": 102,\n            \"volume\": 1474\n          },\n          {\n            \"time\": 1767484800000,\n            \"open\": 109,\n            \"close\": 114,\n            \"high\": 117,\n            \"low\": 106,\n            \"volume\": 1611\n          },\n          {\n            \"time\": 1767571200000,\n            \"open\": 108,\n            \"close\": 109,\n            \"high\": 112,\n            \"low\": 105,\n            \"volume\": 1748\n          },\n          {\n            \"time\": 1767657600000,\n            \"open\": 106,\n            \"close\": 103,\n            \"high\": 109,\n            \"low\": 100,\n            \"volume\": 1885\n          },\n          {\n            \"time\": 1767744000000,\n            \"open\": 102,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 99,\n            \"volume\": 2022\n          },\n          {\n            \"time\": 1767830400000,\n            \"open\": 100,\n            \"close\": 100,\n            \"high\": 103,\n            \"low\": 97,\n            \"volume\": 2159\n          },\n          {\n            \"time\": 1767916800000,\n            \"open\": 98,\n            \"close\": 94,\n            \"high\": 101,\n            \"low\": 91,\n            \"volume\": 2296\n          },\n          {\n            \"time\": 1768003200000,\n            \"open\": 99,\n            \"close\": 102,\n            \"high\": 105,\n            \"low\": 96,\n            \"volume\": 2433\n          },\n          {\n            \"time\": 1768089600000,\n            \"open\": 101,\n            \"close\": 100,\n            \"high\": 104,\n            \"low\": 97,\n            \"volume\": 2570\n          },\n          {\n            \"time\": 1768176000000,\n            \"open\": 105,\n            \"close\": 100,\n            \"high\": 108,\n            \"low\": 97,\n            \"volume\": 2707\n          },\n          {\n            \"time\": 1768262400000,\n            \"open\": 109,\n            \"close\": 111,\n            \"high\": 114,\n            \"low\": 106,\n            \"volume\": 2844\n          },\n          {\n            \"time\": 1768348800000,\n            \"open\": 113,\n            \"close\": 111,\n            \"high\": 116,\n            \"low\": 108,\n            \"volume\": 2981\n          },\n          {\n            \"time\": 1768435200000,\n            \"open\": 115,\n            \"close\": 120,\n            \"high\": 123,\n            \"low\": 112,\n            \"volume\": 1318\n          },\n          {\n            \"time\": 1768521600000,\n            \"open\": 115,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 112,\n            \"volume\": 1455\n          },\n          {\n            \"time\": 1768608000000,\n            \"open\": 114,\n            \"close\": 111,\n            \"high\": 117,\n            \"low\": 108,\n            \"volume\": 1592\n          },\n          {\n            \"time\": 1768694400000,\n            \"open\": 111,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 108,\n            \"volume\": 1729\n          },\n          {\n            \"time\": 1768780800000,\n            \"open\": 108,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 105,\n            \"volume\": 1866\n          },\n          {\n            \"time\": 1768867200000,\n            \"open\": 105,\n            \"close\": 101,\n            \"high\": 108,\n            \"low\": 98,\n            \"volume\": 2003\n          },\n          {\n            \"time\": 1768953600000,\n            \"open\": 105,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 102,\n            \"volume\": 2140\n          },\n          {\n            \"time\": 1769040000000,\n            \"open\": 107,\n            \"close\": 106,\n            \"high\": 110,\n            \"low\": 103,\n            \"volume\": 2277\n          },\n          {\n            \"time\": 1769126400000,\n            \"open\": 110,\n            \"close\": 105,\n            \"high\": 113,\n            \"low\": 102,\n            \"volume\": 2414\n          },\n          {\n            \"time\": 1769212800000,\n            \"open\": 114,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 111,\n            \"volume\": 2551\n          },\n          {\n            \"time\": 1769299200000,\n            \"open\": 119,\n            \"close\": 117,\n            \"high\": 122,\n            \"low\": 114,\n            \"volume\": 2688\n          },\n          {\n            \"time\": 1769385600000,\n            \"open\": 121,\n            \"close\": 126,\n            \"high\": 129,\n            \"low\": 118,\n            \"volume\": 2825\n          },\n          {\n            \"time\": 1769472000000,\n            \"open\": 123,\n            \"close\": 124,\n            \"high\": 127,\n            \"low\": 120,\n            \"volume\": 2962\n          },\n          {\n            \"time\": 1769558400000,\n            \"open\": 121,\n            \"close\": 118,\n            \"high\": 124,\n            \"low\": 115,\n            \"volume\": 1299\n          },\n          {\n            \"time\": 1769644800000,\n            \"open\": 119,\n            \"close\": 123,\n            \"high\": 126,\n            \"low\": 116,\n            \"volume\": 1436\n          },\n          {\n            \"time\": 1769731200000,\n            \"open\": 116,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 113,\n            \"volume\": 1573\n          },\n          {\n            \"time\": 1769817600000,\n            \"open\": 113,\n            \"close\": 109,\n            \"high\": 116,\n            \"low\": 106,\n            \"volume\": 1710\n          },\n          {\n            \"time\": 1769904000000,\n            \"open\": 112,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 109,\n            \"volume\": 1847\n          }\n        ],\n        \"barStyle\": \"ohlc\",\n        \"timeScale\": \"ordinal\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'ohlc example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-barStyle","title":"barStyle","blocks":[{"kind":"paragraph","text":"The tick style: ohlc, hlc, or hilo."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barStyle`"],["HTML attribute","`bar-style`"],["Type","`'ohlc' | 'hlc' | 'hilo'`"],["Default","`'ohlc'`"],["Allowed values","`ohlc`, `hlc`, `hilo`"]]}]},{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"A price array with time, open, high, low, and close."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickData","title":"CandlestickData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`360`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-xAxis","title":"xAxis","blocks":[{"kind":"paragraph","text":"Configure the horizontal axis type, categories, range, and formatting. For a category axis, match the categories order to the value array indices. Charts supporting multiple axes can accept an axis array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":"Type definition"}]}]},{"id":"property-yAxis","title":"yAxis","blocks":[{"kind":"paragraph","text":"Configure the vertical axis range, ticks, labels, and direction. Use consistent units for comparisons, and consider a zero baseline when comparing bar lengths."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`YAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":"Type definition"}]}]},{"id":"property-gridLines","title":"gridLines","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`gridLines`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianGridLinesInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair that follows the cursor across the plot (forwarded; the inner `crosshairMove` bubbles through the host)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Zoom (Storybook parity 2026-09-10) — the candlestick's shared cartesian zoom, forwarded; the inner `zoomChange` bubbles through the host."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-xMin","title":"xMin","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xMin`"],["HTML attribute","`x-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-xMax","title":"xMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xMax`"],["HTML attribute","`x-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMin","title":"yMin","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMin`"],["HTML attribute","`y-min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-yMax","title":"yMax","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yMax`"],["HTML attribute","`y-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-padding","title":"padding","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`padding`"],["HTML attribute","`padding`"],["Type","`number`"],["Default","`0.05`"]]}]},{"id":"property-upColor","title":"upColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`upColor`"],["HTML attribute","`up-color`"],["Type","`string`"],["Default","`'#26a69a'`"]]}]},{"id":"property-downColor","title":"downColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`downColor`"],["HTML attribute","`down-color`"],["Type","`string`"],["Default","`'#ef5350'`"]]}]},{"id":"property-flatColor","title":"flatColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flatColor`"],["HTML attribute","`flat-color`"],["Type","`string`"],["Default","`'#9ca3af'`"]]}]},{"id":"property-candleWidth","title":"candleWidth","blocks":[{"kind":"paragraph","text":"The tick length's share of the bar pitch (the candle body ratio; 0.7 by default)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`candleWidth`"],["HTML attribute","`candle-width`"],["Type","`number`"],["Default","`0.7`"]]}]},{"id":"property-candleMinPx","title":"candleMinPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`candleMinPx`"],["HTML attribute","`candle-min-px`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-candleMaxPx","title":"candleMaxPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`candleMaxPx`"],["HTML attribute","`candle-max-px`"],["Type","`number`"],["Default","`40`"]]}]},{"id":"property-wickWidth","title":"wickWidth","blocks":[{"kind":"paragraph","text":"The spine and tick thickness in CSS px."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wickWidth`"],["HTML attribute","`wick-width`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-tickLength","title":"tickLength","blocks":[{"kind":"paragraph","text":"(carry-over D5) — the open / close tick length in CSS px (default: the body half-width)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tickLength`"],["HTML attribute","`tick-length`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-fillAlpha","title":"fillAlpha","blocks":[{"kind":"paragraph","text":"(carry-over D5) — the band fill alpha 0 … 1 (default 0.12)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`fillAlpha`"],["HTML attribute","`fill-alpha`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-bodyMinPx","title":"bodyMinPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bodyMinPx`"],["HTML attribute","`body-min-px`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-bodyStyle","title":"bodyStyle","blocks":[{"kind":"paragraph","text":"Candle-only lanes, forwarded for parity (an OHLC bar has no body to hollow)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bodyStyle`"],["HTML attribute","`body-style`"],["Type","`CandlestickBodyStyle`"],["Default","`'solid'`"],["Allowed values","`solid`, `hollow`, `hollow-up`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickBodyStyle","title":"CandlestickBodyStyle","description":"Type definition"}]}]},{"id":"property-bodyBorderPx","title":"bodyBorderPx","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bodyBorderPx`"],["HTML attribute","`body-border-px`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-wickColor","title":"wickColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wickColor`"],["HTML attribute","`wick-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-antialias","title":"antialias","blocks":[{"kind":"paragraph","text":"Allowed values: auto, off, on. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`antialias`"],["HTML attribute","`antialias`"],["Type","`CandlestickAntialias`"],["Default","`'auto'`"],["Allowed values","`auto`, `off`, `on`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickAntialias","title":"CandlestickAntialias","description":"Type definition"}]}]},{"id":"property-pixelSnap","title":"pixelSnap","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`pixelSnap`"],["HTML attribute","`pixel-snap`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-timeScale","title":"timeScale","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ordinal. Default: 'ordinal'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`timeScale`"],["HTML attribute","`time-scale`"],["Type","`CandlestickTimeScale`"],["Default","`'ordinal'`"],["Allowed values","`linear`, `ordinal`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickTimeScale","title":"CandlestickTimeScale","description":"Type definition"}]}]},{"id":"property-session","title":"session","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CandlestickSessionInput | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`session`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickSessionInput | string`"],["Default","`'24x7'`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickSessionInput","title":"CandlestickSessionInput","description":"Type definition"}]}]},{"id":"property-labelLocale","title":"labelLocale","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelLocale`"],["HTML attribute","`label-locale`"],["Type","`string`"],["Default","`'en-US'`"]]}]},{"id":"property-volume","title":"volume","blocks":[{"kind":"paragraph","text":"Allowed values: off, pane. Default: 'off'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volume`"],["HTML attribute","`volume`"],["Type","`CandlestickVolumeMode`"],["Default","`'off'`"],["Allowed values","`off`, `pane`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickVolumeMode","title":"CandlestickVolumeMode","description":"Type definition"}]}]},{"id":"property-volumeHeight","title":"volumeHeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeHeight`"],["HTML attribute","`volume-height`"],["Type","`number`"],["Default","`0.25`"]]}]},{"id":"property-volumeUpColor","title":"volumeUpColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeUpColor`"],["HTML attribute","`volume-up-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-volumeDownColor","title":"volumeDownColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeDownColor`"],["HTML attribute","`volume-down-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-volumeAlpha","title":"volumeAlpha","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`volumeAlpha`"],["HTML attribute","`volume-alpha`"],["Type","`number`"],["Default","`0.45`"]]}]},{"id":"property-overlays","title":"overlays","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CandlestickOverlayInput | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`overlays`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickOverlayInput | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlayInput","title":"CandlestickOverlayInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: CandlestickPointEventDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: CandlestickPointEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`CandlestickEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickEasing","title":"CandlestickEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`CandlestickAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickAnimationType","title":"CandlestickAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CandlestickStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CandlestickStreamSource","title":"CandlestickStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed bars the chart renders (the whole buffer when unset)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`CandlestickEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickEngineMode","title":"CandlestickEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`CandlestickUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/CandlestickUnavailableBehaviour","title":"CandlestickUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<CandlestickRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickRenderResult","title":"CandlestickRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<CandlestickEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickEngineTier","title":"CandlestickEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: CandlestickData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`CandlestickData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickData","title":"CandlestickData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(bar: CandlestickBarInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`bar`","`CandlestickBarInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`bars`","`ReadonlyArray<CandlestickBarInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(bars: ReadonlyArray<CandlestickBarInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`bars`","`ReadonlyArray<CandlestickBarInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<CandlestickStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickStreamSource","title":"CandlestickStreamSource","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: CandlestickEasing; enabled?: boolean; type?: CandlestickAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickEasing","title":"CandlestickEasing","description":"Type definition"},{"path":"/docs/types/CandlestickAnimationType","title":"CandlestickAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<CandlestickPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CandlestickPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"method-getBar","title":"getBar","blocks":[{"kind":"paragraph","text":"The normalised bar at an index (null outside)."},{"kind":"code","source":"getBar(index: number): Promise<CandlestickBar | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CandlestickBar | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","description":"Type definition"}]}]},{"id":"method-getBarAt","title":"getBarAt","blocks":[{"kind":"paragraph","text":"The bar nearest to a time (null for an empty series)."},{"kind":"code","source":"getBarAt(time: number): Promise<(CandlestickBar & { index: number }) | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`time`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<(CandlestickBar & { index: number }) | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","description":"Type definition"}]}]},{"id":"method-getBarCount","title":"getBarCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getBarCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<CandlestickExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickExtent","title":"CandlestickExtent","description":"Type definition"}]}]},{"id":"method-getDomain","title":"getDomain","blocks":[{"kind":"paragraph","text":"The data domain the grid spans."},{"kind":"code","source":"getDomain(): Promise<CandlestickDomain>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickDomain>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickDomain","title":"CandlestickDomain","description":"Type definition"}]}]},{"id":"method-getVisibleRange","title":"getVisibleRange","blocks":[{"kind":"paragraph","text":"The bars the plot shows: the `x-axis` window, narrowed by the zoom when one is in place."},{"kind":"code","source":"getVisibleRange(): Promise<CandlestickVisibleRange>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickVisibleRange>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickVisibleRange","title":"CandlestickVisibleRange","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-focusBarAt","title":"focusBarAt","blocks":[{"kind":"paragraph","text":"move the keyboard focus ring to a bar (null outside the visible window); emits pointHover like the walk."},{"kind":"code","source":"focusBarAt(index: number): Promise<CandlestickPointEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CandlestickPointEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":"Type definition"}]}]},{"id":"method-getOverlays","title":"getOverlays","blocks":[{"kind":"paragraph","text":"the overlays: each settled spec with where its PRIMARY line exists and what is visible (the outputs and the band ride on the spec)."},{"kind":"code","source":"getOverlays(): Promise<CandlestickOverlayState[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickOverlayState[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlayState","title":"CandlestickOverlayState","description":"Type definition"}]}]},{"id":"method-getOverlayValues","title":"getOverlayValues","blocks":[{"kind":"paragraph","text":"the overlay values at a bar index: the primary output under the overlay id, the others under `id.key` (null through a warm-up)."},{"kind":"code","source":"getOverlayValues(index: number): Promise<Record<string, number | null>>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Record<string, number | null>>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getPanes","title":"getPanes","blocks":[{"kind":"paragraph","text":"the panes: the price pane, the volume pane when it exists, the separator, and why there is none."},{"kind":"code","source":"getPanes(): Promise<CandlestickPaneRects>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickPaneRects>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickPaneRects","title":"CandlestickPaneRects","description":"Type definition"}]}]},{"id":"method-getTimeScale","title":"getTimeScale","blocks":[{"kind":"paragraph","text":"the time scale of the visible range: the kind, the slots, the spacing and the ordinal ticks."},{"kind":"code","source":"getTimeScale(): Promise<CandlestickTimeScaleState>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CandlestickTimeScaleState>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CandlestickTimeScaleState","title":"CandlestickTimeScaleState","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"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 (default: the primary axis)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"the full extent (and key) of the primary — or the named — master axes (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08): the inner candlestick's own status once it is mounted (it gates chart.type.ohlc and chart.type.candlestick); before that, this proxy's chart.type.ohlc decision, read without side effects."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/stock-chart","title":"Stock Chart","summary":"Combine price history with financial exploration controls.","kind":"component","tag":"sy-stock-chart","componentId":"stock-chart","api":{"props":[{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"760","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"420","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"data","attribute":"data","type":"StockDataInput","kind":"property","values":[],"default":"undefined","description":"Chronological OHLCV records."},{"name":"session","attribute":"session","type":"'24x7' | 'us-equity' | StockSessionInput","kind":"property","values":["24x7","us-equity"],"default":"'24x7'","description":"24x7 or a trading session."},{"name":"visibleFrom","attribute":"visible-from","type":"number","kind":"number","values":[],"default":"undefined","description":"Visible bar range (indices; defaults to everything)."},{"name":"visibleTo","attribute":"visible-to","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"showNavigator","attribute":"show-navigator","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Show the full-tape navigator + scrollbar under the time axis ()."},{"name":"showRangeSelector","attribute":"show-range-selector","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Show the 1M/3M/6M/YTD/1Y/All + resolution button rows ()."},{"name":"resolution","attribute":"resolution","type":"StockResolution","kind":"string","values":["1d","1w","1M"],"default":"'1d'","description":"Tape resolution: `1d` raw / `1w` / `1M` calendar roll-ups."},{"name":"dataGrouping","attribute":"data-grouping","type":"string","kind":"string","values":[],"default":"'auto'","description":"View-density grouping: `auto` (default) / `off` / a forced factor."},{"name":"historyLoader","attribute":"history-loader","type":"(oldestTime: number, count: number) => Promise<ReadonlyArray<StockBarInput>> | ReadonlyArray<StockBarInput>","kind":"property","values":[],"default":"undefined","description":"Older-history provider (): `(oldestTime, count) => bars`. Called automatically when the window nears the tape head; an empty return marks the history exhausted."},{"name":"historyThreshold","attribute":"history-threshold","type":"number","kind":"number","values":[],"default":"30","description":"Bars from the head that trigger a history load (default 30)."},{"name":"panes","attribute":"panes","type":"ReadonlyArray<PaneSpecInput>","kind":"property","values":[],"default":"undefined","description":"Pane stack (): `[{id, weight, label?}]`, price first by convention. Weights are proportions; separators drag live."},{"name":"seriesStyle","attribute":"series-style","type":"StockSeriesStyle | DerivedStockStyle","kind":"string","values":["area","ohlc","hlc","hilo","hollow","line","candlestick","column-range","baseline","hlc-area","volume-candle","heikin-ashi","renko","kagi","point-figure","line-break"],"default":"'candlestick'","description":"How prices are drawn."},{"name":"brickSize","attribute":"brick-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Renko brick size in price units (default auto — close range/50, nice)."},{"name":"reversalPct","attribute":"reversal-pct","type":"number","kind":"number","values":[],"default":"4","description":"Kagi reversal, percent (default 4)."},{"name":"boxSize","attribute":"box-size","type":"number","kind":"number","values":[],"default":"undefined","description":"Point & Figure box size (default auto) and reversal boxes (default 3)."},{"name":"reversalBoxes","attribute":"reversal-boxes","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"lineBreakCount","attribute":"line-break-count","type":"number","kind":"number","values":[],"default":"3","description":"Line Break lookback (default 3-line break)."},{"name":"upColor","attribute":"up-color","type":"string","kind":"string","values":[],"default":"'#16a34a'","description":"Up/down candle colours (close ≥ open → up)."},{"name":"downColor","attribute":"down-color","type":"string","kind":"string","values":[],"default":"'#dc2626'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"baselineValue","attribute":"baseline-value","type":"number","kind":"number","values":[],"default":"undefined","description":"Baseline anchor for `series-style=\"baseline\"` (default first visible close)."},{"name":"lineColor","attribute":"line-color","type":"string","kind":"string","values":[],"default":"'#2563eb'","description":"Line/area/hilo ink."},{"name":"priceScaleMode","attribute":"price-scale","type":"string","kind":"string","values":[],"default":"'linear'","description":"Right-scale space: `linear` (default) / `log` / `percent` / `indexed`."},{"name":"referenceLines","attribute":"reference-lines","type":"string","kind":"string","values":[],"default":"undefined","description":"Reference lines, comma list: `current,previous-close,high,low,bid,ask`."},{"name":"bid","attribute":"bid","type":"number","kind":"number","values":[],"default":"undefined","description":"Quotes for the `bid`/`ask` reference lines."},{"name":"ask","attribute":"ask","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"crosshair","attribute":"crosshair","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Crosshair + OHLC legend on hover ()."},{"name":"showLegend","attribute":"show-legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"compareSymbols","attribute":"compare-symbols","type":"ReadonlyArray<CompareSymbolInput>","kind":"property","values":[],"default":"undefined","description":"Compare overlays (): `[{id, name?, color?, data}]`. Any active compare FORCES the percent scale — every series reads vs its own first visible close."},{"name":"flags","attribute":"flags","type":"ReadonlyArray<StockFlagInput>","kind":"property","values":[],"default":"undefined","description":"Events with time, text, and title."},{"name":"indicators","attribute":"indicators","type":"ReadonlyArray<StockIndicatorInput>","kind":"property","values":[],"default":"undefined","description":"Indicator instances (): `[{kind, params?, color?, linkedTo?, pane?}]` against the registry (`registerIndicator`). Overlay kinds paint into the price pane; pane kinds own a synthesized pane."},{"name":"drawings","attribute":"drawings","type":"ReadonlyArray<StockDrawingInput>","kind":"property","values":[],"default":"undefined","description":"Drawing seed (): `[{tool, anchors: [{time, price}], style?}]` — DATA-coordinate anchors survive pan/zoom/grouping/resolution. Assigning the prop resets the document (and its undo history); the method surface mutates it with full undo/redo."},{"name":"showToolbar","attribute":"show-toolbar","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Show the left drawing-tools toolbar ()."},{"name":"exportScale","attribute":"export-scale","type":"number","kind":"number","values":[],"default":"2","description":"PNG export pixel scale ()."},{"name":"locale","attribute":"locale","type":"string","kind":"string","values":[],"default":"'en-US'","description":"BCP-47 locale (): month labels + price/P&L number formats."},{"name":"trades","attribute":"trades","type":"ReadonlyArray<StockTradeInput>","kind":"property","values":[],"default":"undefined","description":"Executed trades (): `[{time, side: buy|sell, price, quantity?}]`."},{"name":"positions","attribute":"positions","type":"ReadonlyArray<StockPositionInput>","kind":"property","values":[],"default":"undefined","description":"Open positions (): `[{side: long|short, entryPrice, quantity}]` — live P&L badges."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."}],"methods":[{"name":"addCompare","parameters":[{"name":"symbol","type":"CompareSymbolInput","optional":false}],"returns":"Promise<void>","description":"Add a compare overlay (duplicate ids replace)."},{"name":"removeCompare","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<void>","description":"Remove a compare overlay by id."},{"name":"addIndicator","parameters":[{"name":"spec","type":"StockIndicatorInput","optional":false}],"returns":"Promise<StockIndicatorInput>","description":"Add an indicator instance (an explicit duplicate id replaces). A missing id is minted HERE and persisted into the spec, so later removals never re-number method-added instances."},{"name":"removeIndicator","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<void>","description":"Remove an indicator by resolved id (its synthesized pane goes with it)."},{"name":"updateIndicator","parameters":[{"name":"id","type":"string","optional":false},{"name":"params","type":"Record<string, number | string>","optional":false}],"returns":"Promise<void>","description":"Merge params into an instance (by resolved id)."},{"name":"getIndicators","parameters":[],"returns":"Promise<Array<{\n    id: string; kind: string; params: Record<string, number>; linkedTo: string; paneId: string | null; label: string;\n  }>>","description":"Resolved indicator list (serialisable — no definition objects)."},{"name":"defineIndicator","parameters":[{"name":"definition","type":"IndicatorDefinition","optional":false}],"returns":"Promise<{ ok: boolean; errors: string[] }>","description":"Register a CUSTOM indicator definition at runtime () — the component-level gate over the `sy/stock` `registerIndicator` core: strictly validated, re-register replaces, existing instances of the kind re-compute on the forced re-render. Definitions live in the page-global registry (every chart on the page sees them)."},{"name":"undefineIndicator","parameters":[{"name":"kind","type":"string","optional":false}],"returns":"Promise<{ removed: boolean }>","description":"Remove a definition; live instances of the kind resolve away."},{"name":"getIndicatorKinds","parameters":[],"returns":"Promise<string[]>","description":"Registered indicator kinds (built-ins + custom), sorted."},{"name":"getIndicatorValues","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<Record<string, Array<number | null>> | null>","description":"Computed columns for one instance over the current render tape."},{"name":"addDrawing","parameters":[{"name":"input","type":"StockDrawingInput","optional":false}],"returns":"Promise<StockDrawing | null>","description":"Add a drawing (data-coordinate anchors); returns it with the minted id."},{"name":"updateDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"patch","type":"Partial<Omit<StockDrawing, 'id'>>","optional":false}],"returns":"Promise<void>","description":"Merge a patch (anchors/style/meta/visible/locked) into a drawing."},{"name":"moveDrawing","parameters":[{"name":"id","type":"string","optional":false},{"name":"deltaTime","type":"number","optional":false},{"name":"deltaPrice","type":"number","optional":false}],"returns":"Promise<void>","description":"Translate a drawing by data-space deltas (locked drawings hold)."},{"name":"removeDrawing","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<void>","description":"remove one drawing."},{"name":"clearDrawings","parameters":[],"returns":"Promise<void>","description":"clear the document (undoable)."},{"name":"undoDrawings","parameters":[],"returns":"Promise<{ count: number; canUndo: boolean; canRedo: boolean }>","description":"An asynchronous method. Check the argument and return types below."},{"name":"redoDrawings","parameters":[],"returns":"Promise<{ count: number; canUndo: boolean; canRedo: boolean }>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDrawings","parameters":[],"returns":"Promise<StockDrawing[]>","description":"The current document (deep-copied, serialisable)."},{"name":"exportDrawings","parameters":[],"returns":"Promise<string>","description":"Versioned JSON export of the document."},{"name":"loadDrawings","parameters":[{"name":"json","type":"string","optional":false}],"returns":"Promise<number>","description":"Restore a serialized document (undoable — it goes through the history)."},{"name":"getDrawingPoints","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<Array<{ x: number; y: number }> | null>","description":"Projected css-px points for one drawing on the CURRENT render tape."},{"name":"setActiveTool","parameters":[{"name":"tool","type":"string | null","optional":false}],"returns":"Promise<void>","description":"Activate a placement tool (`null` = the select cursor)."},{"name":"getActiveTool","parameters":[],"returns":"Promise<string | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"zoomBy","parameters":[{"name":"scale","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<{ from: number; to: number }>","description":"Zoom programmatically around an anchor fraction (default centre)."},{"name":"panByBars","parameters":[{"name":"bars","type":"number","optional":false}],"returns":"Promise<{ from: number; to: number }>","description":"Pan programmatically by (ungrouped) bars."},{"name":"setData","parameters":[{"name":"data","type":"StockDataInput","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"appendTick","parameters":[{"name":"tick","type":"StockTickInput","optional":false}],"returns":"Promise<{ appended: boolean; time: number } | null>","description":"Live tick streaming (): roll a feed update into the tape — inside the last bar's interval it UPDATES the live candle (close replaces, extremes widen, volume accumulates); past it a new bar opens. A tail-pinned window auto-follows the new bar; stale out-of-order ticks drop (returns null)."},{"name":"appendTicks","parameters":[{"name":"ticks","type":"ReadonlyArray<StockTickInput>","optional":false}],"returns":"Promise<{ appended: boolean; time: number } | null>","description":"Batch ticks in ONE repaint (returns the last applied result)."},{"name":"exportTemplate","parameters":[],"returns":"Promise<string>","description":"Export the chart CONFIGURATION as a versioned JSON template () — style/params, scale, panes, indicators, drawings, compares, flags, window/resolution/grouping. The data tape stays out (templates travel between symbols)."},{"name":"importTemplate","parameters":[{"name":"json","type":"string","optional":false}],"returns":"Promise<{ ok: boolean; applied: string[] }>","description":"Apply a template (per-field whitelist; drawings land undoably)."},{"name":"getSnapshotSVG","parameters":[],"returns":"Promise<string | null>","description":"The composed standalone SVG snapshot (canvas raster + SVG chrome + the brand)."},{"name":"getCSV","parameters":[],"returns":"Promise<string>","description":"The tape as a CSV table (ISO time, OHLC, volume)."},{"name":"exportPNG","parameters":[],"returns":"Promise<void>","description":"Download the composed snapshot as a PNG at `export-scale`. The grant is confirmed again after the rasterisation await: one lost (or changed) meanwhile rejects with the §4.1 `stale` refusal — no download, no `exported`."},{"name":"exportSVG","parameters":[],"returns":"Promise<void>","description":"Download the composed snapshot as an SVG file (composed and saved in one turn, under a confirmed grant)."},{"name":"exportCSV","parameters":[],"returns":"Promise<void>","description":"Download the tape as a CSV file (under a confirmed grant; getCSV stays the ungated read)."},{"name":"print","parameters":[],"returns":"Promise<void>","description":"Print view with the inlined snapshot (the facade `print` mirror), opened under a confirmed grant."},{"name":"getBarCounts","parameters":[],"returns":"Promise<{ bars: number; from: number; to: number }>","description":"Normalised bar count + visible range (diagnostics/tooling)."},{"name":"getPaneLayout","parameters":[],"returns":"Promise<{ panes: Array<{ id: string; top: number; height: number }> }>","description":"Current pane rects (layout-local px)."},{"name":"addPane","parameters":[{"name":"pane","type":"PaneSpecInput","optional":false},{"name":"at","type":"number","optional":true}],"returns":"Promise<void>","description":"Append a pane (default at the bottom)."},{"name":"removePane","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<void>","description":"Remove a pane by id (the last pane stays)."},{"name":"reorderPane","parameters":[{"name":"id","type":"string","optional":false},{"name":"to","type":"number","optional":false}],"returns":"Promise<void>","description":"Move a pane to a new stack position."},{"name":"setPaneWeight","parameters":[{"name":"id","type":"string","optional":false},{"name":"weight","type":"number","optional":false}],"returns":"Promise<void>","description":"Set a pane's weight directly."},{"name":"loadOlderHistory","parameters":[{"name":"count","type":"number","optional":true}],"returns":"Promise<number>","description":"Pull older bars through `historyLoader` and keep the view anchored. chart.stock: when the grant ends (or changes) while the loader runs, nothing merges into the frozen tape and the call rejects with the §4.1 `stale` refusal. The licenseFeatureRefused event (code `stale`, method `loadOlderHistory`) is dispatched FIRST; the request then still ends with `historyLoaded { added: 0, exhausted: false }` so a loading state the app shows for historyRequested clears."},{"name":"applyRange","parameters":[{"name":"range","type":"StockRangeKey","optional":false}],"returns":"Promise<{ from: number; to: number }>","description":"Apply a range button: window the CURRENT tape by calendar maths."},{"name":"setResolution","parameters":[{"name":"resolution","type":"StockResolution","optional":false}],"returns":"Promise<void>","description":"Switch the tape resolution (resets the window — indices change)."}],"events":[{"name":"rendered","type":"{ bars: number; visibleBars: number; renderMs: number }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"paneLayoutChanged","type":"{ panes: Array<{ id: string; weight: number }> }","description":"The pane stack changed (drag, add/remove/reorder, weight set)."},{"name":"visibleRangeChanged","type":"{ from: number; to: number }","description":"The visible window changed (navigator/scrollbar; fires on release)."},{"name":"rangeSelected","type":"{ range: StockRangeKey; from: number; to: number }","description":"A range button was applied."},{"name":"resolutionChanged","type":"{ resolution: StockResolution }","description":"The resolution changed."},{"name":"historyRequested","type":"{ oldestTime: number; count: number }","description":"A history load started / finished."},{"name":"historyLoaded","type":"{ added: number; exhausted: boolean }","description":"CustomEvent.detail type: { added: number; exhausted: boolean }. Event names are case-sensitive."},{"name":"crosshairMoved","type":"{ index: number; time: number; price: number } | null","description":"The crosshair moved to a bar (`null` on leave)."},{"name":"compareChanged","type":"{ ids: string[] }","description":"The compare set changed."},{"name":"flagClick","type":"{ id: string; time: number; text: string; title?: string }","description":"A flag was clicked / hovered (`null` on hover leave)."},{"name":"flagHover","type":"{ id: string; time: number; text: string; title?: string } | null","description":"CustomEvent.detail type: { id: string; time: number; text: string; title?: string } | null. Event names are case-sensitive."},{"name":"indicatorsChanged","type":"{ ids: string[] }","description":"The indicator set changed (add/remove/update)."},{"name":"drawingsChanged","type":"{ count: number; canUndo: boolean; canRedo: boolean }","description":"The drawing document changed (add/update/move/remove/undo/redo/load)."},{"name":"drawingSelect","type":"{ id: string } | null","description":"A drawing was selected (`null` on deselect)."},{"name":"toolChanged","type":"{ tool: string | null }","description":"The active placement tool changed (`null` = the cursor)."},{"name":"tickApplied","type":"{ appended: boolean; time: number; close: number; bars: number }","description":"A live tick was applied (`appended` = a new bar opened)."},{"name":"tradeClick","type":"{ id: string; time: number; side: 'buy' | 'sell'; price: number; quantity?: number }","description":"A trade marker was clicked."},{"name":"templateApplied","type":"{ applied: string[] }","description":"A template was imported (`applied` names the fields that landed)."},{"name":"exported","type":"{ format: string; filename: string }","description":"An export finished (`png` | `svg` | `csv`)."}]},"sections":[{"id":"overview","title":"sy-stock-chart","blocks":[{"kind":"paragraph","text":"Build financial interfaces with range selection, Navigator, and flags."},{"kind":"paragraph","text":"Align date time zones and trading sessions. The example uses fictional data to demonstrate display features."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","Chronological OHLCV records."],["`session`","24x7 or a trading session."],["`flags`","Events with time, text, and title."],["`seriesStyle`","How prices are drawn."]]},{"kind":"links","items":[{"path":"/charts/stock-chart","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-stock-chart.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-stock-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"time\": 1767225600000,\n            \"open\": 100,\n            \"close\": 95,\n            \"high\": 103,\n            \"low\": 92,\n            \"volume\": 1200\n          },\n          {\n            \"time\": 1767312000000,\n            \"open\": 104,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 101,\n            \"volume\": 1337\n          },\n          {\n            \"time\": 1767398400000,\n            \"open\": 107,\n            \"close\": 105,\n            \"high\": 110,\n            \"low\": 102,\n            \"volume\": 1474\n          },\n          {\n            \"time\": 1767484800000,\n            \"open\": 109,\n            \"close\": 114,\n            \"high\": 117,\n            \"low\": 106,\n            \"volume\": 1611\n          },\n          {\n            \"time\": 1767571200000,\n            \"open\": 108,\n            \"close\": 109,\n            \"high\": 112,\n            \"low\": 105,\n            \"volume\": 1748\n          },\n          {\n            \"time\": 1767657600000,\n            \"open\": 106,\n            \"close\": 103,\n            \"high\": 109,\n            \"low\": 100,\n            \"volume\": 1885\n          },\n          {\n            \"time\": 1767744000000,\n            \"open\": 102,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 99,\n            \"volume\": 2022\n          },\n          {\n            \"time\": 1767830400000,\n            \"open\": 100,\n            \"close\": 100,\n            \"high\": 103,\n            \"low\": 97,\n            \"volume\": 2159\n          },\n          {\n            \"time\": 1767916800000,\n            \"open\": 98,\n            \"close\": 94,\n            \"high\": 101,\n            \"low\": 91,\n            \"volume\": 2296\n          },\n          {\n            \"time\": 1768003200000,\n            \"open\": 99,\n            \"close\": 102,\n            \"high\": 105,\n            \"low\": 96,\n            \"volume\": 2433\n          },\n          {\n            \"time\": 1768089600000,\n            \"open\": 101,\n            \"close\": 100,\n            \"high\": 104,\n            \"low\": 97,\n            \"volume\": 2570\n          },\n          {\n            \"time\": 1768176000000,\n            \"open\": 105,\n            \"close\": 100,\n            \"high\": 108,\n            \"low\": 97,\n            \"volume\": 2707\n          },\n          {\n            \"time\": 1768262400000,\n            \"open\": 109,\n            \"close\": 111,\n            \"high\": 114,\n            \"low\": 106,\n            \"volume\": 2844\n          },\n          {\n            \"time\": 1768348800000,\n            \"open\": 113,\n            \"close\": 111,\n            \"high\": 116,\n            \"low\": 108,\n            \"volume\": 2981\n          },\n          {\n            \"time\": 1768435200000,\n            \"open\": 115,\n            \"close\": 120,\n            \"high\": 123,\n            \"low\": 112,\n            \"volume\": 1318\n          },\n          {\n            \"time\": 1768521600000,\n            \"open\": 115,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 112,\n            \"volume\": 1455\n          },\n          {\n            \"time\": 1768608000000,\n            \"open\": 114,\n            \"close\": 111,\n            \"high\": 117,\n            \"low\": 108,\n            \"volume\": 1592\n          },\n          {\n            \"time\": 1768694400000,\n            \"open\": 111,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 108,\n            \"volume\": 1729\n          },\n          {\n            \"time\": 1768780800000,\n            \"open\": 108,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 105,\n            \"volume\": 1866\n          },\n          {\n            \"time\": 1768867200000,\n            \"open\": 105,\n            \"close\": 101,\n            \"high\": 108,\n            \"low\": 98,\n            \"volume\": 2003\n          },\n          {\n            \"time\": 1768953600000,\n            \"open\": 105,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 102,\n            \"volume\": 2140\n          },\n          {\n            \"time\": 1769040000000,\n            \"open\": 107,\n            \"close\": 106,\n            \"high\": 110,\n            \"low\": 103,\n            \"volume\": 2277\n          },\n          {\n            \"time\": 1769126400000,\n            \"open\": 110,\n            \"close\": 105,\n            \"high\": 113,\n            \"low\": 102,\n            \"volume\": 2414\n          },\n          {\n            \"time\": 1769212800000,\n            \"open\": 114,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 111,\n            \"volume\": 2551\n          },\n          {\n            \"time\": 1769299200000,\n            \"open\": 119,\n            \"close\": 117,\n            \"high\": 122,\n            \"low\": 114,\n            \"volume\": 2688\n          },\n          {\n            \"time\": 1769385600000,\n            \"open\": 121,\n            \"close\": 126,\n            \"high\": 129,\n            \"low\": 118,\n            \"volume\": 2825\n          },\n          {\n            \"time\": 1769472000000,\n            \"open\": 123,\n            \"close\": 124,\n            \"high\": 127,\n            \"low\": 120,\n            \"volume\": 2962\n          },\n          {\n            \"time\": 1769558400000,\n            \"open\": 121,\n            \"close\": 118,\n            \"high\": 124,\n            \"low\": 115,\n            \"volume\": 1299\n          },\n          {\n            \"time\": 1769644800000,\n            \"open\": 119,\n            \"close\": 123,\n            \"high\": 126,\n            \"low\": 116,\n            \"volume\": 1436\n          },\n          {\n            \"time\": 1769731200000,\n            \"open\": 116,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 113,\n            \"volume\": 1573\n          },\n          {\n            \"time\": 1769817600000,\n            \"open\": 113,\n            \"close\": 109,\n            \"high\": 116,\n            \"low\": 106,\n            \"volume\": 1710\n          },\n          {\n            \"time\": 1769904000000,\n            \"open\": 112,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 109,\n            \"volume\": 1847\n          }\n        ],\n        \"session\": \"24x7\",\n        \"seriesStyle\": \"candlestick\",\n        \"showNavigator\": true,\n        \"showRangeSelector\": true,\n        \"width\": 640,\n        \"height\": 440,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'stock-chart example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('flagClick', event.detail);\n  };\n  chart.addEventListener('flagClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('flagClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`760`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`420`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"Chronological OHLCV records."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`StockDataInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-session","title":"session","blocks":[{"kind":"paragraph","text":"24x7 or a trading session."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`session`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`'24x7' | 'us-equity' | StockSessionInput`"],["Default","`'24x7'`"],["Literals in the type","`24x7`, `us-equity`"]]},{"kind":"links","items":[{"path":"/docs/types/StockSessionInput","title":"StockSessionInput","description":"Type definition"}]}]},{"id":"property-visibleFrom","title":"visibleFrom","blocks":[{"kind":"paragraph","text":"Visible bar range (indices; defaults to everything)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visibleFrom`"],["HTML attribute","`visible-from`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-visibleTo","title":"visibleTo","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visibleTo`"],["HTML attribute","`visible-to`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-showNavigator","title":"showNavigator","blocks":[{"kind":"paragraph","text":"Show the full-tape navigator + scrollbar under the time axis ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showNavigator`"],["HTML attribute","`show-navigator`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-showRangeSelector","title":"showRangeSelector","blocks":[{"kind":"paragraph","text":"Show the 1M/3M/6M/YTD/1Y/All + resolution button rows ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showRangeSelector`"],["HTML attribute","`show-range-selector`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-resolution","title":"resolution","blocks":[{"kind":"paragraph","text":"Tape resolution: `1d` raw / `1w` / `1M` calendar roll-ups."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`resolution`"],["HTML attribute","`resolution`"],["Type","`StockResolution`"],["Default","`'1d'`"],["Allowed values","`1d`, `1w`, `1M`"]]},{"kind":"links","items":[{"path":"/docs/types/StockResolution","title":"StockResolution","description":"Type definition"}]}]},{"id":"property-dataGrouping","title":"dataGrouping","blocks":[{"kind":"paragraph","text":"View-density grouping: `auto` (default) / `off` / a forced factor."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dataGrouping`"],["HTML attribute","`data-grouping`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-historyLoader","title":"historyLoader","blocks":[{"kind":"paragraph","text":"Older-history provider (): `(oldestTime, count) => bars`. Called automatically when the window nears the tape head; an empty return marks the history exhausted."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`historyLoader`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(oldestTime: number, count: number) => Promise<ReadonlyArray<StockBarInput>> | ReadonlyArray<StockBarInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-historyThreshold","title":"historyThreshold","blocks":[{"kind":"paragraph","text":"Bars from the head that trigger a history load (default 30)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`historyThreshold`"],["HTML attribute","`history-threshold`"],["Type","`number`"],["Default","`30`"]]}]},{"id":"property-panes","title":"panes","blocks":[{"kind":"paragraph","text":"Pane stack (): `[{id, weight, label?}]`, price first by convention. Weights are proportions; separators drag live."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`panes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<PaneSpecInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/PaneSpecInput","title":"PaneSpecInput","description":"Type definition"}]}]},{"id":"property-seriesStyle","title":"seriesStyle","blocks":[{"kind":"paragraph","text":"How prices are drawn."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`seriesStyle`"],["HTML attribute","`series-style`"],["Type","`StockSeriesStyle | DerivedStockStyle`"],["Default","`'candlestick'`"],["Allowed values","`area`, `ohlc`, `hlc`, `hilo`, `hollow`, `line`, `candlestick`, `column-range`, `baseline`, `hlc-area`, `volume-candle`, `heikin-ashi`, `renko`, `kagi`, `point-figure`, `line-break`"]]},{"kind":"links","items":[{"path":"/docs/types/StockSeriesStyle","title":"StockSeriesStyle","description":"Type definition"},{"path":"/docs/types/DerivedStockStyle","title":"DerivedStockStyle","description":"Type definition"}]}]},{"id":"property-brickSize","title":"brickSize","blocks":[{"kind":"paragraph","text":"Renko brick size in price units (default auto — close range/50, nice)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brickSize`"],["HTML attribute","`brick-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-reversalPct","title":"reversalPct","blocks":[{"kind":"paragraph","text":"Kagi reversal, percent (default 4)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`reversalPct`"],["HTML attribute","`reversal-pct`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"property-boxSize","title":"boxSize","blocks":[{"kind":"paragraph","text":"Point & Figure box size (default auto) and reversal boxes (default 3)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`boxSize`"],["HTML attribute","`box-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-reversalBoxes","title":"reversalBoxes","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`reversalBoxes`"],["HTML attribute","`reversal-boxes`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-lineBreakCount","title":"lineBreakCount","blocks":[{"kind":"paragraph","text":"Line Break lookback (default 3-line break)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineBreakCount`"],["HTML attribute","`line-break-count`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-upColor","title":"upColor","blocks":[{"kind":"paragraph","text":"Up/down candle colours (close ≥ open → up)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`upColor`"],["HTML attribute","`up-color`"],["Type","`string`"],["Default","`'#16a34a'`"]]}]},{"id":"property-downColor","title":"downColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`downColor`"],["HTML attribute","`down-color`"],["Type","`string`"],["Default","`'#dc2626'`"]]}]},{"id":"property-baselineValue","title":"baselineValue","blocks":[{"kind":"paragraph","text":"Baseline anchor for `series-style=\"baseline\"` (default first visible close)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baselineValue`"],["HTML attribute","`baseline-value`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-lineColor","title":"lineColor","blocks":[{"kind":"paragraph","text":"Line/area/hilo ink."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lineColor`"],["HTML attribute","`line-color`"],["Type","`string`"],["Default","`'#2563eb'`"]]}]},{"id":"property-priceScaleMode","title":"priceScaleMode","blocks":[{"kind":"paragraph","text":"Right-scale space: `linear` (default) / `log` / `percent` / `indexed`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`priceScaleMode`"],["HTML attribute","`price-scale`"],["Type","`string`"],["Default","`'linear'`"]]}]},{"id":"property-referenceLines","title":"referenceLines","blocks":[{"kind":"paragraph","text":"Reference lines, comma list: `current,previous-close,high,low,bid,ask`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`referenceLines`"],["HTML attribute","`reference-lines`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-bid","title":"bid","blocks":[{"kind":"paragraph","text":"Quotes for the `bid`/`ask` reference lines."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`bid`"],["HTML attribute","`bid`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-ask","title":"ask","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`ask`"],["HTML attribute","`ask`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Crosshair + OHLC legend on hover ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","`crosshair`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-showLegend","title":"showLegend","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showLegend`"],["HTML attribute","`show-legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-compareSymbols","title":"compareSymbols","blocks":[{"kind":"paragraph","text":"Compare overlays (): `[{id, name?, color?, data}]`. Any active compare FORCES the percent scale — every series reads vs its own first visible close."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`compareSymbols`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<CompareSymbolInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CompareSymbolInput","title":"CompareSymbolInput","description":"Type definition"}]}]},{"id":"property-flags","title":"flags","blocks":[{"kind":"paragraph","text":"Events with time, text, and title."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flags`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<StockFlagInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StockFlagInput","title":"StockFlagInput","description":"Type definition"}]}]},{"id":"property-indicators","title":"indicators","blocks":[{"kind":"paragraph","text":"Indicator instances (): `[{kind, params?, color?, linkedTo?, pane?}]` against the registry (`registerIndicator`). Overlay kinds paint into the price pane; pane kinds own a synthesized pane."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`indicators`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<StockIndicatorInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StockIndicatorInput","title":"StockIndicatorInput","description":"Type definition"}]}]},{"id":"property-drawings","title":"drawings","blocks":[{"kind":"paragraph","text":"Drawing seed (): `[{tool, anchors: [{time, price}], style?}]` — DATA-coordinate anchors survive pan/zoom/grouping/resolution. Assigning the prop resets the document (and its undo history); the method surface mutates it with full undo/redo."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`drawings`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<StockDrawingInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StockDrawingInput","title":"StockDrawingInput","description":"Type definition"}]}]},{"id":"property-showToolbar","title":"showToolbar","blocks":[{"kind":"paragraph","text":"Show the left drawing-tools toolbar ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showToolbar`"],["HTML attribute","`show-toolbar`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-exportScale","title":"exportScale","blocks":[{"kind":"paragraph","text":"PNG export pixel scale ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`exportScale`"],["HTML attribute","`export-scale`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-locale","title":"locale","blocks":[{"kind":"paragraph","text":"BCP-47 locale (): month labels + price/P&L number formats."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locale`"],["HTML attribute","`locale`"],["Type","`string`"],["Default","`'en-US'`"]]}]},{"id":"property-trades","title":"trades","blocks":[{"kind":"paragraph","text":"Executed trades (): `[{time, side: buy|sell, price, quantity?}]`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`trades`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<StockTradeInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StockTradeInput","title":"StockTradeInput","description":"Type definition"}]}]},{"id":"property-positions","title":"positions","blocks":[{"kind":"paragraph","text":"Open positions (): `[{side: long|short, entryPrice, quantity}]` — live P&L badges."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`positions`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<StockPositionInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StockPositionInput","title":"StockPositionInput","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ bars: number; visibleBars: number; renderMs: number }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // { bars: number; visibleBars: number; renderMs: number }\n});","language":"javascript"}]},{"id":"event-paneLayoutChanged","title":"paneLayoutChanged","blocks":[{"kind":"paragraph","text":"The pane stack changed (drag, add/remove/reorder, weight set)."},{"kind":"paragraph","text":"Event name: `paneLayoutChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ panes: Array<{ id: string; weight: number }> }>`."},{"kind":"code","source":"chart.addEventListener('paneLayoutChanged', event => {\n  console.log(event.detail); // { panes: Array<{ id: string; weight: number }> }\n});","language":"javascript"}]},{"id":"event-visibleRangeChanged","title":"visibleRangeChanged","blocks":[{"kind":"paragraph","text":"The visible window changed (navigator/scrollbar; fires on release)."},{"kind":"paragraph","text":"Event name: `visibleRangeChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ from: number; to: number }>`."},{"kind":"code","source":"chart.addEventListener('visibleRangeChanged', event => {\n  console.log(event.detail); // { from: number; to: number }\n});","language":"javascript"}]},{"id":"event-rangeSelected","title":"rangeSelected","blocks":[{"kind":"paragraph","text":"A range button was applied."},{"kind":"paragraph","text":"Event name: `rangeSelected`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ range: StockRangeKey; from: number; to: number }>`."},{"kind":"code","source":"chart.addEventListener('rangeSelected', event => {\n  console.log(event.detail); // { range: StockRangeKey; from: number; to: number }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/StockRangeKey","title":"StockRangeKey","description":"Type definition"}]}]},{"id":"event-resolutionChanged","title":"resolutionChanged","blocks":[{"kind":"paragraph","text":"The resolution changed."},{"kind":"paragraph","text":"Event name: `resolutionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ resolution: StockResolution }>`."},{"kind":"code","source":"chart.addEventListener('resolutionChanged', event => {\n  console.log(event.detail); // { resolution: StockResolution }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/StockResolution","title":"StockResolution","description":"Type definition"}]}]},{"id":"event-historyRequested","title":"historyRequested","blocks":[{"kind":"paragraph","text":"A history load started / finished."},{"kind":"paragraph","text":"Event name: `historyRequested`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ oldestTime: number; count: number }>`."},{"kind":"code","source":"chart.addEventListener('historyRequested', event => {\n  console.log(event.detail); // { oldestTime: number; count: number }\n});","language":"javascript"}]},{"id":"event-historyLoaded","title":"historyLoaded","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { added: number; exhausted: boolean }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `historyLoaded`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ added: number; exhausted: boolean }>`."},{"kind":"code","source":"chart.addEventListener('historyLoaded', event => {\n  console.log(event.detail); // { added: number; exhausted: boolean }\n});","language":"javascript"}]},{"id":"event-crosshairMoved","title":"crosshairMoved","blocks":[{"kind":"paragraph","text":"The crosshair moved to a bar (`null` on leave)."},{"kind":"paragraph","text":"Event name: `crosshairMoved`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ index: number; time: number; price: number } | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMoved', event => {\n  console.log(event.detail); // { index: number; time: number; price: number } | null\n});","language":"javascript"}]},{"id":"event-compareChanged","title":"compareChanged","blocks":[{"kind":"paragraph","text":"The compare set changed."},{"kind":"paragraph","text":"Event name: `compareChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ ids: string[] }>`."},{"kind":"code","source":"chart.addEventListener('compareChanged', event => {\n  console.log(event.detail); // { ids: string[] }\n});","language":"javascript"}]},{"id":"event-flagClick","title":"flagClick","blocks":[{"kind":"paragraph","text":"A flag was clicked / hovered (`null` on hover leave)."},{"kind":"paragraph","text":"Event name: `flagClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ id: string; time: number; text: string; title?: string }>`."},{"kind":"code","source":"chart.addEventListener('flagClick', event => {\n  console.log(event.detail); // { id: string; time: number; text: string; title?: string }\n});","language":"javascript"}]},{"id":"event-flagHover","title":"flagHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { id: string; time: number; text: string; title?: string } | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `flagHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ id: string; time: number; text: string; title?: string } | null>`."},{"kind":"code","source":"chart.addEventListener('flagHover', event => {\n  console.log(event.detail); // { id: string; time: number; text: string; title?: string } | null\n});","language":"javascript"}]},{"id":"event-indicatorsChanged","title":"indicatorsChanged","blocks":[{"kind":"paragraph","text":"The indicator set changed (add/remove/update)."},{"kind":"paragraph","text":"Event name: `indicatorsChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ ids: string[] }>`."},{"kind":"code","source":"chart.addEventListener('indicatorsChanged', event => {\n  console.log(event.detail); // { ids: string[] }\n});","language":"javascript"}]},{"id":"event-drawingsChanged","title":"drawingsChanged","blocks":[{"kind":"paragraph","text":"The drawing document changed (add/update/move/remove/undo/redo/load)."},{"kind":"paragraph","text":"Event name: `drawingsChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; canUndo: boolean; canRedo: boolean }>`."},{"kind":"code","source":"chart.addEventListener('drawingsChanged', event => {\n  console.log(event.detail); // { count: number; canUndo: boolean; canRedo: boolean }\n});","language":"javascript"}]},{"id":"event-drawingSelect","title":"drawingSelect","blocks":[{"kind":"paragraph","text":"A drawing was selected (`null` on deselect)."},{"kind":"paragraph","text":"Event name: `drawingSelect`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ id: string } | null>`."},{"kind":"code","source":"chart.addEventListener('drawingSelect', event => {\n  console.log(event.detail); // { id: string } | null\n});","language":"javascript"}]},{"id":"event-toolChanged","title":"toolChanged","blocks":[{"kind":"paragraph","text":"The active placement tool changed (`null` = the cursor)."},{"kind":"paragraph","text":"Event name: `toolChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ tool: string | null }>`."},{"kind":"code","source":"chart.addEventListener('toolChanged', event => {\n  console.log(event.detail); // { tool: string | null }\n});","language":"javascript"}]},{"id":"event-tickApplied","title":"tickApplied","blocks":[{"kind":"paragraph","text":"A live tick was applied (`appended` = a new bar opened)."},{"kind":"paragraph","text":"Event name: `tickApplied`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ appended: boolean; time: number; close: number; bars: number }>`."},{"kind":"code","source":"chart.addEventListener('tickApplied', event => {\n  console.log(event.detail); // { appended: boolean; time: number; close: number; bars: number }\n});","language":"javascript"}]},{"id":"event-tradeClick","title":"tradeClick","blocks":[{"kind":"paragraph","text":"A trade marker was clicked."},{"kind":"paragraph","text":"Event name: `tradeClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ id: string; time: number; side: 'buy' | 'sell'; price: number; quantity?: number }>`."},{"kind":"code","source":"chart.addEventListener('tradeClick', event => {\n  console.log(event.detail); // { id: string; time: number; side: 'buy' | 'sell'; price: number; quantity?: number }\n});","language":"javascript"}]},{"id":"event-templateApplied","title":"templateApplied","blocks":[{"kind":"paragraph","text":"A template was imported (`applied` names the fields that landed)."},{"kind":"paragraph","text":"Event name: `templateApplied`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ applied: string[] }>`."},{"kind":"code","source":"chart.addEventListener('templateApplied', event => {\n  console.log(event.detail); // { applied: string[] }\n});","language":"javascript"}]},{"id":"event-exported","title":"exported","blocks":[{"kind":"paragraph","text":"An export finished (`png` | `svg` | `csv`)."},{"kind":"paragraph","text":"Event name: `exported`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ format: string; filename: string }>`."},{"kind":"code","source":"chart.addEventListener('exported', event => {\n  console.log(event.detail); // { format: string; filename: string }\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-addCompare","title":"addCompare","blocks":[{"kind":"paragraph","text":"Add a compare overlay (duplicate ids replace)."},{"kind":"code","source":"addCompare(symbol: CompareSymbolInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`symbol`","`CompareSymbolInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CompareSymbolInput","title":"CompareSymbolInput","description":"Type definition"}]}]},{"id":"method-removeCompare","title":"removeCompare","blocks":[{"kind":"paragraph","text":"Remove a compare overlay by id."},{"kind":"code","source":"removeCompare(id: string): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-addIndicator","title":"addIndicator","blocks":[{"kind":"paragraph","text":"Add an indicator instance (an explicit duplicate id replaces). A missing id is minted HERE and persisted into the spec, so later removals never re-number method-added instances."},{"kind":"code","source":"addIndicator(spec: StockIndicatorInput): Promise<StockIndicatorInput>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`spec`","`StockIndicatorInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<StockIndicatorInput>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockIndicatorInput","title":"StockIndicatorInput","description":"Type definition"}]}]},{"id":"method-removeIndicator","title":"removeIndicator","blocks":[{"kind":"paragraph","text":"Remove an indicator by resolved id (its synthesized pane goes with it)."},{"kind":"code","source":"removeIndicator(id: string): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-updateIndicator","title":"updateIndicator","blocks":[{"kind":"paragraph","text":"Merge params into an instance (by resolved id)."},{"kind":"code","source":"updateIndicator(id: string, params: Record<string, number | string>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`params`","`Record<string, number | string>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getIndicators","title":"getIndicators","blocks":[{"kind":"paragraph","text":"Resolved indicator list (serialisable — no definition objects)."},{"kind":"code","source":"getIndicators(): Promise<Array<{\n    id: string; kind: string; params: Record<string, number>; linkedTo: string; paneId: string | null; label: string;\n  }>>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Array<{\n    id: string; kind: string; params: Record<string, number>; linkedTo: string; paneId: string | null; label: string;\n  }>>`. Call the method after element registration and await its Promise result."}]},{"id":"method-defineIndicator","title":"defineIndicator","blocks":[{"kind":"paragraph","text":"Register a CUSTOM indicator definition at runtime () — the component-level gate over the `sy/stock` `registerIndicator` core: strictly validated, re-register replaces, existing instances of the kind re-compute on the forced re-render. Definitions live in the page-global registry (every chart on the page sees them)."},{"kind":"code","source":"defineIndicator(definition: IndicatorDefinition): Promise<{ ok: boolean; errors: string[] }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`definition`","`IndicatorDefinition`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ ok: boolean; errors: string[] }>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/IndicatorDefinition","title":"IndicatorDefinition","description":"Type definition"}]}]},{"id":"method-undefineIndicator","title":"undefineIndicator","blocks":[{"kind":"paragraph","text":"Remove a definition; live instances of the kind resolve away."},{"kind":"code","source":"undefineIndicator(kind: string): Promise<{ removed: boolean }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`kind`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ removed: boolean }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getIndicatorKinds","title":"getIndicatorKinds","blocks":[{"kind":"paragraph","text":"Registered indicator kinds (built-ins + custom), sorted."},{"kind":"code","source":"getIndicatorKinds(): Promise<string[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string[]>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getIndicatorValues","title":"getIndicatorValues","blocks":[{"kind":"paragraph","text":"Computed columns for one instance over the current render tape."},{"kind":"code","source":"getIndicatorValues(id: string): Promise<Record<string, Array<number | null>> | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Record<string, Array<number | null>> | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-addDrawing","title":"addDrawing","blocks":[{"kind":"paragraph","text":"Add a drawing (data-coordinate anchors); returns it with the minted id."},{"kind":"code","source":"addDrawing(input: StockDrawingInput): Promise<StockDrawing | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`input`","`StockDrawingInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<StockDrawing | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockDrawing","title":"StockDrawing","description":"Type definition"},{"path":"/docs/types/StockDrawingInput","title":"StockDrawingInput","description":"Type definition"}]}]},{"id":"method-updateDrawing","title":"updateDrawing","blocks":[{"kind":"paragraph","text":"Merge a patch (anchors/style/meta/visible/locked) into a drawing."},{"kind":"code","source":"updateDrawing(id: string, patch: Partial<Omit<StockDrawing, 'id'>>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`patch`","`Partial<Omit<StockDrawing, 'id'>>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockDrawing","title":"StockDrawing","description":"Type definition"}]}]},{"id":"method-moveDrawing","title":"moveDrawing","blocks":[{"kind":"paragraph","text":"Translate a drawing by data-space deltas (locked drawings hold)."},{"kind":"code","source":"moveDrawing(id: string, deltaTime: number, deltaPrice: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`deltaTime`","`number`","Required"],["`deltaPrice`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-removeDrawing","title":"removeDrawing","blocks":[{"kind":"paragraph","text":"remove one drawing."},{"kind":"code","source":"removeDrawing(id: string): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-clearDrawings","title":"clearDrawings","blocks":[{"kind":"paragraph","text":"clear the document (undoable)."},{"kind":"code","source":"clearDrawings(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-undoDrawings","title":"undoDrawings","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"undoDrawings(): Promise<{ count: number; canUndo: boolean; canRedo: boolean }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ count: number; canUndo: boolean; canRedo: boolean }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-redoDrawings","title":"redoDrawings","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"redoDrawings(): Promise<{ count: number; canUndo: boolean; canRedo: boolean }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ count: number; canUndo: boolean; canRedo: boolean }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDrawings","title":"getDrawings","blocks":[{"kind":"paragraph","text":"The current document (deep-copied, serialisable)."},{"kind":"code","source":"getDrawings(): Promise<StockDrawing[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<StockDrawing[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockDrawing","title":"StockDrawing","description":"Type definition"}]}]},{"id":"method-exportDrawings","title":"exportDrawings","blocks":[{"kind":"paragraph","text":"Versioned JSON export of the document."},{"kind":"code","source":"exportDrawings(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-loadDrawings","title":"loadDrawings","blocks":[{"kind":"paragraph","text":"Restore a serialized document (undoable — it goes through the history)."},{"kind":"code","source":"loadDrawings(json: string): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`json`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDrawingPoints","title":"getDrawingPoints","blocks":[{"kind":"paragraph","text":"Projected css-px points for one drawing on the CURRENT render tape."},{"kind":"code","source":"getDrawingPoints(id: string): Promise<Array<{ x: number; y: number }> | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Array<{ x: number; y: number }> | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setActiveTool","title":"setActiveTool","blocks":[{"kind":"paragraph","text":"Activate a placement tool (`null` = the select cursor)."},{"kind":"code","source":"setActiveTool(tool: string | null): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`tool`","`string | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getActiveTool","title":"getActiveTool","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTool(): Promise<string | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Zoom programmatically around an anchor fraction (default centre)."},{"kind":"code","source":"zoomBy(scale: number, anchorFraction?: number): Promise<{ from: number; to: number }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`scale`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<{ from: number; to: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-panByBars","title":"panByBars","blocks":[{"kind":"paragraph","text":"Pan programmatically by (ungrouped) bars."},{"kind":"code","source":"panByBars(bars: number): Promise<{ from: number; to: number }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`bars`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ from: number; to: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: StockDataInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`StockDataInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-appendTick","title":"appendTick","blocks":[{"kind":"paragraph","text":"Live tick streaming (): roll a feed update into the tape — inside the last bar's interval it UPDATES the live candle (close replaces, extremes widen, volume accumulates); past it a new bar opens. A tail-pinned window auto-follows the new bar; stale out-of-order ticks drop (returns null)."},{"kind":"code","source":"appendTick(tick: StockTickInput): Promise<{ appended: boolean; time: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`tick`","`StockTickInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ appended: boolean; time: number } | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockTickInput","title":"StockTickInput","description":"Type definition"}]}]},{"id":"method-appendTicks","title":"appendTicks","blocks":[{"kind":"paragraph","text":"Batch ticks in ONE repaint (returns the last applied result)."},{"kind":"code","source":"appendTicks(ticks: ReadonlyArray<StockTickInput>): Promise<{ appended: boolean; time: number } | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ticks`","`ReadonlyArray<StockTickInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ appended: boolean; time: number } | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockTickInput","title":"StockTickInput","description":"Type definition"}]}]},{"id":"method-exportTemplate","title":"exportTemplate","blocks":[{"kind":"paragraph","text":"Export the chart CONFIGURATION as a versioned JSON template () — style/params, scale, panes, indicators, drawings, compares, flags, window/resolution/grouping. The data tape stays out (templates travel between symbols)."},{"kind":"code","source":"exportTemplate(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-importTemplate","title":"importTemplate","blocks":[{"kind":"paragraph","text":"Apply a template (per-field whitelist; drawings land undoably)."},{"kind":"code","source":"importTemplate(json: string): Promise<{ ok: boolean; applied: string[] }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`json`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ ok: boolean; applied: string[] }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSnapshotSVG","title":"getSnapshotSVG","blocks":[{"kind":"paragraph","text":"The composed standalone SVG snapshot (canvas raster + SVG chrome + the brand)."},{"kind":"code","source":"getSnapshotSVG(): Promise<string | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getCSV","title":"getCSV","blocks":[{"kind":"paragraph","text":"The tape as a CSV table (ISO time, OHLC, volume)."},{"kind":"code","source":"getCSV(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]},{"id":"method-exportPNG","title":"exportPNG","blocks":[{"kind":"paragraph","text":"Download the composed snapshot as a PNG at `export-scale`. The grant is confirmed again after the rasterisation await: one lost (or changed) meanwhile rejects with the §4.1 `stale` refusal — no download, no `exported`."},{"kind":"code","source":"exportPNG(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-exportSVG","title":"exportSVG","blocks":[{"kind":"paragraph","text":"Download the composed snapshot as an SVG file (composed and saved in one turn, under a confirmed grant)."},{"kind":"code","source":"exportSVG(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-exportCSV","title":"exportCSV","blocks":[{"kind":"paragraph","text":"Download the tape as a CSV file (under a confirmed grant; getCSV stays the ungated read)."},{"kind":"code","source":"exportCSV(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-print","title":"print","blocks":[{"kind":"paragraph","text":"Print view with the inlined snapshot (the facade `print` mirror), opened under a confirmed grant."},{"kind":"code","source":"print(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getBarCounts","title":"getBarCounts","blocks":[{"kind":"paragraph","text":"Normalised bar count + visible range (diagnostics/tooling)."},{"kind":"code","source":"getBarCounts(): Promise<{ bars: number; from: number; to: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ bars: number; from: number; to: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getPaneLayout","title":"getPaneLayout","blocks":[{"kind":"paragraph","text":"Current pane rects (layout-local px)."},{"kind":"code","source":"getPaneLayout(): Promise<{ panes: Array<{ id: string; top: number; height: number }> }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ panes: Array<{ id: string; top: number; height: number }> }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-addPane","title":"addPane","blocks":[{"kind":"paragraph","text":"Append a pane (default at the bottom)."},{"kind":"code","source":"addPane(pane: PaneSpecInput, at?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`pane`","`PaneSpecInput`","Required"],["`at`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/PaneSpecInput","title":"PaneSpecInput","description":"Type definition"}]}]},{"id":"method-removePane","title":"removePane","blocks":[{"kind":"paragraph","text":"Remove a pane by id (the last pane stays)."},{"kind":"code","source":"removePane(id: string): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-reorderPane","title":"reorderPane","blocks":[{"kind":"paragraph","text":"Move a pane to a new stack position."},{"kind":"code","source":"reorderPane(id: string, to: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`to`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setPaneWeight","title":"setPaneWeight","blocks":[{"kind":"paragraph","text":"Set a pane's weight directly."},{"kind":"code","source":"setPaneWeight(id: string, weight: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"],["`weight`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-loadOlderHistory","title":"loadOlderHistory","blocks":[{"kind":"paragraph","text":"Pull older bars through `historyLoader` and keep the view anchored. chart.stock: when the grant ends (or changes) while the loader runs, nothing merges into the frozen tape and the call rejects with the §4.1 `stale` refusal. The licenseFeatureRefused event (code `stale`, method `loadOlderHistory`) is dispatched FIRST; the request then still ends with `historyLoaded { added: 0, exhausted: false }` so a loading state the app shows for historyRequested clears."},{"kind":"code","source":"loadOlderHistory(count?: number): Promise<number>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-applyRange","title":"applyRange","blocks":[{"kind":"paragraph","text":"Apply a range button: window the CURRENT tape by calendar maths."},{"kind":"code","source":"applyRange(range: StockRangeKey): Promise<{ from: number; to: number }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`range`","`StockRangeKey`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ from: number; to: number }>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockRangeKey","title":"StockRangeKey","description":"Type definition"}]}]},{"id":"method-setResolution","title":"setResolution","blocks":[{"kind":"paragraph","text":"Switch the tape resolution (resets the window — indices change)."},{"kind":"code","source":"setResolution(resolution: StockResolution): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`resolution`","`StockResolution`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/StockResolution","title":"StockResolution","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/stock-volume","title":"Stock Volume","summary":"Show volume on the same time axis as prices.","kind":"component","tag":"sy-stock-volume","componentId":"stock-volume","api":{"props":[{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"760","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"160","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"data","attribute":"data","type":"StockDataInput","kind":"property","values":[],"default":"undefined","description":"The same OHLCV array as the price chart. volume is trading volume."},{"name":"session","attribute":"session","type":"'24x7' | 'us-equity' | StockSessionInput","kind":"property","values":["24x7","us-equity"],"default":"'24x7'","description":"Allowed values: 24x7, us-equity. Default: '24x7'."},{"name":"visibleFrom","attribute":"visible-from","type":"number","kind":"number","values":[],"default":"undefined","description":"The beginning of the visible time range."},{"name":"visibleTo","attribute":"visible-to","type":"number","kind":"number","values":[],"default":"undefined","description":"The end of the visible time range."},{"name":"upColor","attribute":"up-color","type":"string","kind":"string","values":[],"default":"'rgba(22, 163, 74, 0.55)'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"downColor","attribute":"down-color","type":"string","kind":"string","values":[],"default":"'rgba(220, 38, 38, 0.55)'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."}],"methods":[{"name":"setData","parameters":[{"name":"data","type":"StockDataInput","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."}],"events":[{"name":"rendered","type":"{ bars: number; maxVolume: number }","description":"Emits rendering results in detail when chart drawing completes."}]},"sections":[{"id":"overview","title":"sy-stock-volume","blocks":[{"kind":"paragraph","text":"Compare trading activity beneath the price panel."},{"kind":"paragraph","text":"Update price and volume data, sessions, and visibleFrom/visibleTo together to keep time axes aligned."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","The same OHLCV array as the price chart. volume is trading volume."],["`visibleFrom`","The beginning of the visible time range."],["`visibleTo`","The end of the visible time range."]]},{"kind":"links","items":[{"path":"/charts/stock-volume","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-stock-chart.js';\n  import { defineCustomElement as define1 } from '@syidax/advanced-pro/components/sy-stock-volume.js';\n  define0();\n  define1();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"tag\": \"sy-stock-chart\",\n      \"id\": \"price-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"time\": 1767225600000,\n            \"open\": 100,\n            \"close\": 95,\n            \"high\": 103,\n            \"low\": 92,\n            \"volume\": 1200\n          },\n          {\n            \"time\": 1767312000000,\n            \"open\": 104,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 101,\n            \"volume\": 1337\n          },\n          {\n            \"time\": 1767398400000,\n            \"open\": 107,\n            \"close\": 105,\n            \"high\": 110,\n            \"low\": 102,\n            \"volume\": 1474\n          },\n          {\n            \"time\": 1767484800000,\n            \"open\": 109,\n            \"close\": 114,\n            \"high\": 117,\n            \"low\": 106,\n            \"volume\": 1611\n          },\n          {\n            \"time\": 1767571200000,\n            \"open\": 108,\n            \"close\": 109,\n            \"high\": 112,\n            \"low\": 105,\n            \"volume\": 1748\n          },\n          {\n            \"time\": 1767657600000,\n            \"open\": 106,\n            \"close\": 103,\n            \"high\": 109,\n            \"low\": 100,\n            \"volume\": 1885\n          },\n          {\n            \"time\": 1767744000000,\n            \"open\": 102,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 99,\n            \"volume\": 2022\n          },\n          {\n            \"time\": 1767830400000,\n            \"open\": 100,\n            \"close\": 100,\n            \"high\": 103,\n            \"low\": 97,\n            \"volume\": 2159\n          },\n          {\n            \"time\": 1767916800000,\n            \"open\": 98,\n            \"close\": 94,\n            \"high\": 101,\n            \"low\": 91,\n            \"volume\": 2296\n          },\n          {\n            \"time\": 1768003200000,\n            \"open\": 99,\n            \"close\": 102,\n            \"high\": 105,\n            \"low\": 96,\n            \"volume\": 2433\n          },\n          {\n            \"time\": 1768089600000,\n            \"open\": 101,\n            \"close\": 100,\n            \"high\": 104,\n            \"low\": 97,\n            \"volume\": 2570\n          },\n          {\n            \"time\": 1768176000000,\n            \"open\": 105,\n            \"close\": 100,\n            \"high\": 108,\n            \"low\": 97,\n            \"volume\": 2707\n          },\n          {\n            \"time\": 1768262400000,\n            \"open\": 109,\n            \"close\": 111,\n            \"high\": 114,\n            \"low\": 106,\n            \"volume\": 2844\n          },\n          {\n            \"time\": 1768348800000,\n            \"open\": 113,\n            \"close\": 111,\n            \"high\": 116,\n            \"low\": 108,\n            \"volume\": 2981\n          },\n          {\n            \"time\": 1768435200000,\n            \"open\": 115,\n            \"close\": 120,\n            \"high\": 123,\n            \"low\": 112,\n            \"volume\": 1318\n          },\n          {\n            \"time\": 1768521600000,\n            \"open\": 115,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 112,\n            \"volume\": 1455\n          },\n          {\n            \"time\": 1768608000000,\n            \"open\": 114,\n            \"close\": 111,\n            \"high\": 117,\n            \"low\": 108,\n            \"volume\": 1592\n          },\n          {\n            \"time\": 1768694400000,\n            \"open\": 111,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 108,\n            \"volume\": 1729\n          },\n          {\n            \"time\": 1768780800000,\n            \"open\": 108,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 105,\n            \"volume\": 1866\n          },\n          {\n            \"time\": 1768867200000,\n            \"open\": 105,\n            \"close\": 101,\n            \"high\": 108,\n            \"low\": 98,\n            \"volume\": 2003\n          },\n          {\n            \"time\": 1768953600000,\n            \"open\": 105,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 102,\n            \"volume\": 2140\n          },\n          {\n            \"time\": 1769040000000,\n            \"open\": 107,\n            \"close\": 106,\n            \"high\": 110,\n            \"low\": 103,\n            \"volume\": 2277\n          },\n          {\n            \"time\": 1769126400000,\n            \"open\": 110,\n            \"close\": 105,\n            \"high\": 113,\n            \"low\": 102,\n            \"volume\": 2414\n          },\n          {\n            \"time\": 1769212800000,\n            \"open\": 114,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 111,\n            \"volume\": 2551\n          },\n          {\n            \"time\": 1769299200000,\n            \"open\": 119,\n            \"close\": 117,\n            \"high\": 122,\n            \"low\": 114,\n            \"volume\": 2688\n          },\n          {\n            \"time\": 1769385600000,\n            \"open\": 121,\n            \"close\": 126,\n            \"high\": 129,\n            \"low\": 118,\n            \"volume\": 2825\n          },\n          {\n            \"time\": 1769472000000,\n            \"open\": 123,\n            \"close\": 124,\n            \"high\": 127,\n            \"low\": 120,\n            \"volume\": 2962\n          },\n          {\n            \"time\": 1769558400000,\n            \"open\": 121,\n            \"close\": 118,\n            \"high\": 124,\n            \"low\": 115,\n            \"volume\": 1299\n          },\n          {\n            \"time\": 1769644800000,\n            \"open\": 119,\n            \"close\": 123,\n            \"high\": 126,\n            \"low\": 116,\n            \"volume\": 1436\n          },\n          {\n            \"time\": 1769731200000,\n            \"open\": 116,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 113,\n            \"volume\": 1573\n          },\n          {\n            \"time\": 1769817600000,\n            \"open\": 113,\n            \"close\": 109,\n            \"high\": 116,\n            \"low\": 106,\n            \"volume\": 1710\n          },\n          {\n            \"time\": 1769904000000,\n            \"open\": 112,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 109,\n            \"volume\": 1847\n          }\n        ],\n        \"session\": \"24x7\",\n        \"showNavigator\": false,\n        \"showRangeSelector\": false,\n        \"height\": 250,\n        \"width\": 640\n      }\n    },\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-stock-volume\",\n      \"props\": {\n        \"data\": [\n          {\n            \"time\": 1767225600000,\n            \"open\": 100,\n            \"close\": 95,\n            \"high\": 103,\n            \"low\": 92,\n            \"volume\": 1200\n          },\n          {\n            \"time\": 1767312000000,\n            \"open\": 104,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 101,\n            \"volume\": 1337\n          },\n          {\n            \"time\": 1767398400000,\n            \"open\": 107,\n            \"close\": 105,\n            \"high\": 110,\n            \"low\": 102,\n            \"volume\": 1474\n          },\n          {\n            \"time\": 1767484800000,\n            \"open\": 109,\n            \"close\": 114,\n            \"high\": 117,\n            \"low\": 106,\n            \"volume\": 1611\n          },\n          {\n            \"time\": 1767571200000,\n            \"open\": 108,\n            \"close\": 109,\n            \"high\": 112,\n            \"low\": 105,\n            \"volume\": 1748\n          },\n          {\n            \"time\": 1767657600000,\n            \"open\": 106,\n            \"close\": 103,\n            \"high\": 109,\n            \"low\": 100,\n            \"volume\": 1885\n          },\n          {\n            \"time\": 1767744000000,\n            \"open\": 102,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 99,\n            \"volume\": 2022\n          },\n          {\n            \"time\": 1767830400000,\n            \"open\": 100,\n            \"close\": 100,\n            \"high\": 103,\n            \"low\": 97,\n            \"volume\": 2159\n          },\n          {\n            \"time\": 1767916800000,\n            \"open\": 98,\n            \"close\": 94,\n            \"high\": 101,\n            \"low\": 91,\n            \"volume\": 2296\n          },\n          {\n            \"time\": 1768003200000,\n            \"open\": 99,\n            \"close\": 102,\n            \"high\": 105,\n            \"low\": 96,\n            \"volume\": 2433\n          },\n          {\n            \"time\": 1768089600000,\n            \"open\": 101,\n            \"close\": 100,\n            \"high\": 104,\n            \"low\": 97,\n            \"volume\": 2570\n          },\n          {\n            \"time\": 1768176000000,\n            \"open\": 105,\n            \"close\": 100,\n            \"high\": 108,\n            \"low\": 97,\n            \"volume\": 2707\n          },\n          {\n            \"time\": 1768262400000,\n            \"open\": 109,\n            \"close\": 111,\n            \"high\": 114,\n            \"low\": 106,\n            \"volume\": 2844\n          },\n          {\n            \"time\": 1768348800000,\n            \"open\": 113,\n            \"close\": 111,\n            \"high\": 116,\n            \"low\": 108,\n            \"volume\": 2981\n          },\n          {\n            \"time\": 1768435200000,\n            \"open\": 115,\n            \"close\": 120,\n            \"high\": 123,\n            \"low\": 112,\n            \"volume\": 1318\n          },\n          {\n            \"time\": 1768521600000,\n            \"open\": 115,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 112,\n            \"volume\": 1455\n          },\n          {\n            \"time\": 1768608000000,\n            \"open\": 114,\n            \"close\": 111,\n            \"high\": 117,\n            \"low\": 108,\n            \"volume\": 1592\n          },\n          {\n            \"time\": 1768694400000,\n            \"open\": 111,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 108,\n            \"volume\": 1729\n          },\n          {\n            \"time\": 1768780800000,\n            \"open\": 108,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 105,\n            \"volume\": 1866\n          },\n          {\n            \"time\": 1768867200000,\n            \"open\": 105,\n            \"close\": 101,\n            \"high\": 108,\n            \"low\": 98,\n            \"volume\": 2003\n          },\n          {\n            \"time\": 1768953600000,\n            \"open\": 105,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 102,\n            \"volume\": 2140\n          },\n          {\n            \"time\": 1769040000000,\n            \"open\": 107,\n            \"close\": 106,\n            \"high\": 110,\n            \"low\": 103,\n            \"volume\": 2277\n          },\n          {\n            \"time\": 1769126400000,\n            \"open\": 110,\n            \"close\": 105,\n            \"high\": 113,\n            \"low\": 102,\n            \"volume\": 2414\n          },\n          {\n            \"time\": 1769212800000,\n            \"open\": 114,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 111,\n            \"volume\": 2551\n          },\n          {\n            \"time\": 1769299200000,\n            \"open\": 119,\n            \"close\": 117,\n            \"high\": 122,\n            \"low\": 114,\n            \"volume\": 2688\n          },\n          {\n            \"time\": 1769385600000,\n            \"open\": 121,\n            \"close\": 126,\n            \"high\": 129,\n            \"low\": 118,\n            \"volume\": 2825\n          },\n          {\n            \"time\": 1769472000000,\n            \"open\": 123,\n            \"close\": 124,\n            \"high\": 127,\n            \"low\": 120,\n            \"volume\": 2962\n          },\n          {\n            \"time\": 1769558400000,\n            \"open\": 121,\n            \"close\": 118,\n            \"high\": 124,\n            \"low\": 115,\n            \"volume\": 1299\n          },\n          {\n            \"time\": 1769644800000,\n            \"open\": 119,\n            \"close\": 123,\n            \"high\": 126,\n            \"low\": 116,\n            \"volume\": 1436\n          },\n          {\n            \"time\": 1769731200000,\n            \"open\": 116,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 113,\n            \"volume\": 1573\n          },\n          {\n            \"time\": 1769817600000,\n            \"open\": 113,\n            \"close\": 109,\n            \"high\": 116,\n            \"low\": 106,\n            \"volume\": 1710\n          },\n          {\n            \"time\": 1769904000000,\n            \"open\": 112,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 109,\n            \"volume\": 1847\n          }\n        ],\n        \"session\": \"24x7\",\n        \"width\": 640,\n        \"height\": 160,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'stock-volume example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('rendered', event.detail);\n  };\n  chart.addEventListener('rendered', onEvent);\n  const onRange = event => {\n    chart.visibleFrom = event.detail.from;\n    chart.visibleTo = event.detail.to;\n  };\n  elements[0].addEventListener('visibleRangeChanged', onRange);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('rendered', onEvent);\n    elements[0].removeEventListener('visibleRangeChanged', onRange);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`760`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`160`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"The same OHLCV array as the price chart. volume is trading volume."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`StockDataInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-session","title":"session","blocks":[{"kind":"paragraph","text":"Allowed values: 24x7, us-equity. Default: '24x7'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`session`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`'24x7' | 'us-equity' | StockSessionInput`"],["Default","`'24x7'`"],["Literals in the type","`24x7`, `us-equity`"]]},{"kind":"links","items":[{"path":"/docs/types/StockSessionInput","title":"StockSessionInput","description":"Type definition"}]}]},{"id":"property-visibleFrom","title":"visibleFrom","blocks":[{"kind":"paragraph","text":"The beginning of the visible time range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visibleFrom`"],["HTML attribute","`visible-from`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-visibleTo","title":"visibleTo","blocks":[{"kind":"paragraph","text":"The end of the visible time range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visibleTo`"],["HTML attribute","`visible-to`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-upColor","title":"upColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`upColor`"],["HTML attribute","`up-color`"],["Type","`string`"],["Default","`'rgba(22, 163, 74, 0.55)'`"]]}]},{"id":"property-downColor","title":"downColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`downColor`"],["HTML attribute","`down-color`"],["Type","`string`"],["Default","`'rgba(220, 38, 38, 0.55)'`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ bars: number; maxVolume: number }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // { bars: number; maxVolume: number }\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: StockDataInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`StockDataInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/stock-flags","title":"Stock Flags","summary":"Attach events at time positions in price data.","kind":"component","tag":"sy-stock-flags","componentId":"stock-flags","api":{"props":[{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"760","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"84","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"data","attribute":"data","type":"StockDataInput","kind":"property","values":[],"default":"undefined","description":"The price array used to locate flags in time."},{"name":"flags","attribute":"flags","type":"ReadonlyArray<StockFlagInput>","kind":"property","values":[],"default":"undefined","description":"An array of events as { id?, time, text, title? }."},{"name":"session","attribute":"session","type":"'24x7' | 'us-equity' | StockSessionInput","kind":"property","values":["24x7","us-equity"],"default":"'24x7'","description":"Allowed values: 24x7, us-equity. Default: '24x7'."},{"name":"visibleFrom","attribute":"visible-from","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"visibleTo","attribute":"visible-to","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."}],"methods":[],"events":[{"name":"flagClick","type":"{ id: string; time: number; text: string; title?: string }","description":"CustomEvent.detail type: { id: string; time: number; text: string; title?: string }. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-stock-flags","blocks":[{"kind":"paragraph","text":"Mark earnings announcements, dividends, and company events."},{"kind":"paragraph","text":"Flags outside the visible time range are hidden. Keep range and session settings aligned with the price panel."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","The price array used to locate flags in time."],["`flags`","An array of events as { id?, time, text, title? }."]]},{"kind":"links","items":[{"path":"/charts/stock-flags","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-stock-chart.js';\n  import { defineCustomElement as define1 } from '@syidax/advanced-pro/components/sy-stock-flags.js';\n  define0();\n  define1();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"tag\": \"sy-stock-chart\",\n      \"id\": \"price-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"time\": 1767225600000,\n            \"open\": 100,\n            \"close\": 95,\n            \"high\": 103,\n            \"low\": 92,\n            \"volume\": 1200\n          },\n          {\n            \"time\": 1767312000000,\n            \"open\": 104,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 101,\n            \"volume\": 1337\n          },\n          {\n            \"time\": 1767398400000,\n            \"open\": 107,\n            \"close\": 105,\n            \"high\": 110,\n            \"low\": 102,\n            \"volume\": 1474\n          },\n          {\n            \"time\": 1767484800000,\n            \"open\": 109,\n            \"close\": 114,\n            \"high\": 117,\n            \"low\": 106,\n            \"volume\": 1611\n          },\n          {\n            \"time\": 1767571200000,\n            \"open\": 108,\n            \"close\": 109,\n            \"high\": 112,\n            \"low\": 105,\n            \"volume\": 1748\n          },\n          {\n            \"time\": 1767657600000,\n            \"open\": 106,\n            \"close\": 103,\n            \"high\": 109,\n            \"low\": 100,\n            \"volume\": 1885\n          },\n          {\n            \"time\": 1767744000000,\n            \"open\": 102,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 99,\n            \"volume\": 2022\n          },\n          {\n            \"time\": 1767830400000,\n            \"open\": 100,\n            \"close\": 100,\n            \"high\": 103,\n            \"low\": 97,\n            \"volume\": 2159\n          },\n          {\n            \"time\": 1767916800000,\n            \"open\": 98,\n            \"close\": 94,\n            \"high\": 101,\n            \"low\": 91,\n            \"volume\": 2296\n          },\n          {\n            \"time\": 1768003200000,\n            \"open\": 99,\n            \"close\": 102,\n            \"high\": 105,\n            \"low\": 96,\n            \"volume\": 2433\n          },\n          {\n            \"time\": 1768089600000,\n            \"open\": 101,\n            \"close\": 100,\n            \"high\": 104,\n            \"low\": 97,\n            \"volume\": 2570\n          },\n          {\n            \"time\": 1768176000000,\n            \"open\": 105,\n            \"close\": 100,\n            \"high\": 108,\n            \"low\": 97,\n            \"volume\": 2707\n          },\n          {\n            \"time\": 1768262400000,\n            \"open\": 109,\n            \"close\": 111,\n            \"high\": 114,\n            \"low\": 106,\n            \"volume\": 2844\n          },\n          {\n            \"time\": 1768348800000,\n            \"open\": 113,\n            \"close\": 111,\n            \"high\": 116,\n            \"low\": 108,\n            \"volume\": 2981\n          },\n          {\n            \"time\": 1768435200000,\n            \"open\": 115,\n            \"close\": 120,\n            \"high\": 123,\n            \"low\": 112,\n            \"volume\": 1318\n          },\n          {\n            \"time\": 1768521600000,\n            \"open\": 115,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 112,\n            \"volume\": 1455\n          },\n          {\n            \"time\": 1768608000000,\n            \"open\": 114,\n            \"close\": 111,\n            \"high\": 117,\n            \"low\": 108,\n            \"volume\": 1592\n          },\n          {\n            \"time\": 1768694400000,\n            \"open\": 111,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 108,\n            \"volume\": 1729\n          },\n          {\n            \"time\": 1768780800000,\n            \"open\": 108,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 105,\n            \"volume\": 1866\n          },\n          {\n            \"time\": 1768867200000,\n            \"open\": 105,\n            \"close\": 101,\n            \"high\": 108,\n            \"low\": 98,\n            \"volume\": 2003\n          },\n          {\n            \"time\": 1768953600000,\n            \"open\": 105,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 102,\n            \"volume\": 2140\n          },\n          {\n            \"time\": 1769040000000,\n            \"open\": 107,\n            \"close\": 106,\n            \"high\": 110,\n            \"low\": 103,\n            \"volume\": 2277\n          },\n          {\n            \"time\": 1769126400000,\n            \"open\": 110,\n            \"close\": 105,\n            \"high\": 113,\n            \"low\": 102,\n            \"volume\": 2414\n          },\n          {\n            \"time\": 1769212800000,\n            \"open\": 114,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 111,\n            \"volume\": 2551\n          },\n          {\n            \"time\": 1769299200000,\n            \"open\": 119,\n            \"close\": 117,\n            \"high\": 122,\n            \"low\": 114,\n            \"volume\": 2688\n          },\n          {\n            \"time\": 1769385600000,\n            \"open\": 121,\n            \"close\": 126,\n            \"high\": 129,\n            \"low\": 118,\n            \"volume\": 2825\n          },\n          {\n            \"time\": 1769472000000,\n            \"open\": 123,\n            \"close\": 124,\n            \"high\": 127,\n            \"low\": 120,\n            \"volume\": 2962\n          },\n          {\n            \"time\": 1769558400000,\n            \"open\": 121,\n            \"close\": 118,\n            \"high\": 124,\n            \"low\": 115,\n            \"volume\": 1299\n          },\n          {\n            \"time\": 1769644800000,\n            \"open\": 119,\n            \"close\": 123,\n            \"high\": 126,\n            \"low\": 116,\n            \"volume\": 1436\n          },\n          {\n            \"time\": 1769731200000,\n            \"open\": 116,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 113,\n            \"volume\": 1573\n          },\n          {\n            \"time\": 1769817600000,\n            \"open\": 113,\n            \"close\": 109,\n            \"high\": 116,\n            \"low\": 106,\n            \"volume\": 1710\n          },\n          {\n            \"time\": 1769904000000,\n            \"open\": 112,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 109,\n            \"volume\": 1847\n          }\n        ],\n        \"session\": \"24x7\",\n        \"showNavigator\": false,\n        \"showRangeSelector\": false,\n        \"height\": 250,\n        \"width\": 640\n      }\n    },\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-stock-flags\",\n      \"props\": {\n        \"data\": [\n          {\n            \"time\": 1767225600000,\n            \"open\": 100,\n            \"close\": 95,\n            \"high\": 103,\n            \"low\": 92,\n            \"volume\": 1200\n          },\n          {\n            \"time\": 1767312000000,\n            \"open\": 104,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 101,\n            \"volume\": 1337\n          },\n          {\n            \"time\": 1767398400000,\n            \"open\": 107,\n            \"close\": 105,\n            \"high\": 110,\n            \"low\": 102,\n            \"volume\": 1474\n          },\n          {\n            \"time\": 1767484800000,\n            \"open\": 109,\n            \"close\": 114,\n            \"high\": 117,\n            \"low\": 106,\n            \"volume\": 1611\n          },\n          {\n            \"time\": 1767571200000,\n            \"open\": 108,\n            \"close\": 109,\n            \"high\": 112,\n            \"low\": 105,\n            \"volume\": 1748\n          },\n          {\n            \"time\": 1767657600000,\n            \"open\": 106,\n            \"close\": 103,\n            \"high\": 109,\n            \"low\": 100,\n            \"volume\": 1885\n          },\n          {\n            \"time\": 1767744000000,\n            \"open\": 102,\n            \"close\": 106,\n            \"high\": 109,\n            \"low\": 99,\n            \"volume\": 2022\n          },\n          {\n            \"time\": 1767830400000,\n            \"open\": 100,\n            \"close\": 100,\n            \"high\": 103,\n            \"low\": 97,\n            \"volume\": 2159\n          },\n          {\n            \"time\": 1767916800000,\n            \"open\": 98,\n            \"close\": 94,\n            \"high\": 101,\n            \"low\": 91,\n            \"volume\": 2296\n          },\n          {\n            \"time\": 1768003200000,\n            \"open\": 99,\n            \"close\": 102,\n            \"high\": 105,\n            \"low\": 96,\n            \"volume\": 2433\n          },\n          {\n            \"time\": 1768089600000,\n            \"open\": 101,\n            \"close\": 100,\n            \"high\": 104,\n            \"low\": 97,\n            \"volume\": 2570\n          },\n          {\n            \"time\": 1768176000000,\n            \"open\": 105,\n            \"close\": 100,\n            \"high\": 108,\n            \"low\": 97,\n            \"volume\": 2707\n          },\n          {\n            \"time\": 1768262400000,\n            \"open\": 109,\n            \"close\": 111,\n            \"high\": 114,\n            \"low\": 106,\n            \"volume\": 2844\n          },\n          {\n            \"time\": 1768348800000,\n            \"open\": 113,\n            \"close\": 111,\n            \"high\": 116,\n            \"low\": 108,\n            \"volume\": 2981\n          },\n          {\n            \"time\": 1768435200000,\n            \"open\": 115,\n            \"close\": 120,\n            \"high\": 123,\n            \"low\": 112,\n            \"volume\": 1318\n          },\n          {\n            \"time\": 1768521600000,\n            \"open\": 115,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 112,\n            \"volume\": 1455\n          },\n          {\n            \"time\": 1768608000000,\n            \"open\": 114,\n            \"close\": 111,\n            \"high\": 117,\n            \"low\": 108,\n            \"volume\": 1592\n          },\n          {\n            \"time\": 1768694400000,\n            \"open\": 111,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 108,\n            \"volume\": 1729\n          },\n          {\n            \"time\": 1768780800000,\n            \"open\": 108,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 105,\n            \"volume\": 1866\n          },\n          {\n            \"time\": 1768867200000,\n            \"open\": 105,\n            \"close\": 101,\n            \"high\": 108,\n            \"low\": 98,\n            \"volume\": 2003\n          },\n          {\n            \"time\": 1768953600000,\n            \"open\": 105,\n            \"close\": 108,\n            \"high\": 111,\n            \"low\": 102,\n            \"volume\": 2140\n          },\n          {\n            \"time\": 1769040000000,\n            \"open\": 107,\n            \"close\": 106,\n            \"high\": 110,\n            \"low\": 103,\n            \"volume\": 2277\n          },\n          {\n            \"time\": 1769126400000,\n            \"open\": 110,\n            \"close\": 105,\n            \"high\": 113,\n            \"low\": 102,\n            \"volume\": 2414\n          },\n          {\n            \"time\": 1769212800000,\n            \"open\": 114,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 111,\n            \"volume\": 2551\n          },\n          {\n            \"time\": 1769299200000,\n            \"open\": 119,\n            \"close\": 117,\n            \"high\": 122,\n            \"low\": 114,\n            \"volume\": 2688\n          },\n          {\n            \"time\": 1769385600000,\n            \"open\": 121,\n            \"close\": 126,\n            \"high\": 129,\n            \"low\": 118,\n            \"volume\": 2825\n          },\n          {\n            \"time\": 1769472000000,\n            \"open\": 123,\n            \"close\": 124,\n            \"high\": 127,\n            \"low\": 120,\n            \"volume\": 2962\n          },\n          {\n            \"time\": 1769558400000,\n            \"open\": 121,\n            \"close\": 118,\n            \"high\": 124,\n            \"low\": 115,\n            \"volume\": 1299\n          },\n          {\n            \"time\": 1769644800000,\n            \"open\": 119,\n            \"close\": 123,\n            \"high\": 126,\n            \"low\": 116,\n            \"volume\": 1436\n          },\n          {\n            \"time\": 1769731200000,\n            \"open\": 116,\n            \"close\": 116,\n            \"high\": 119,\n            \"low\": 113,\n            \"volume\": 1573\n          },\n          {\n            \"time\": 1769817600000,\n            \"open\": 113,\n            \"close\": 109,\n            \"high\": 116,\n            \"low\": 106,\n            \"volume\": 1710\n          },\n          {\n            \"time\": 1769904000000,\n            \"open\": 112,\n            \"close\": 115,\n            \"high\": 118,\n            \"low\": 109,\n            \"volume\": 1847\n          }\n        ],\n        \"flags\": [\n          {\n            \"id\": \"earnings\",\n            \"time\": 1767916800000,\n            \"text\": \"E\",\n            \"title\": \"Earnings announcement (example)\"\n          },\n          {\n            \"id\": \"dividend\",\n            \"time\": 1769126400000,\n            \"text\": \"D\",\n            \"title\": \"Dividend record date (example)\"\n          }\n        ],\n        \"session\": \"24x7\",\n        \"width\": 640,\n        \"height\": 84,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'stock-flags example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('flagClick', event.detail);\n  };\n  chart.addEventListener('flagClick', onEvent);\n  const onRange = event => {\n    chart.visibleFrom = event.detail.from;\n    chart.visibleTo = event.detail.to;\n  };\n  elements[0].addEventListener('visibleRangeChanged', onRange);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('flagClick', onEvent);\n    elements[0].removeEventListener('visibleRangeChanged', onRange);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`760`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`84`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"The price array used to locate flags in time."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`StockDataInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-flags","title":"flags","blocks":[{"kind":"paragraph","text":"An array of events as { id?, time, text, title? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flags`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<StockFlagInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/StockFlagInput","title":"StockFlagInput","description":"Type definition"}]}]},{"id":"property-session","title":"session","blocks":[{"kind":"paragraph","text":"Allowed values: 24x7, us-equity. Default: '24x7'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`session`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`'24x7' | 'us-equity' | StockSessionInput`"],["Default","`'24x7'`"],["Literals in the type","`24x7`, `us-equity`"]]},{"kind":"links","items":[{"path":"/docs/types/StockSessionInput","title":"StockSessionInput","description":"Type definition"}]}]},{"id":"property-visibleFrom","title":"visibleFrom","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visibleFrom`"],["HTML attribute","`visible-from`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-visibleTo","title":"visibleTo","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`visibleTo`"],["HTML attribute","`visible-to`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-flagClick","title":"flagClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { id: string; time: number; text: string; title?: string }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `flagClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ id: string; time: number; text: string; title?: string }>`."},{"kind":"code","source":"chart.addEventListener('flagClick', event => {\n  console.log(event.detail); // { id: string; time: number; text: string; title?: string }\n});","language":"javascript"}]}]}]}]},{"path":"/docs/components/surface-3d","title":"Surface 3d","summary":"Show gridded measurements as a continuous 3D surface.","kind":"component","tag":"sy-surface-3d","componentId":"surface-3d","api":{"props":[{"name":"data","attribute":"data","type":"Surface3DData","kind":"property","values":[],"default":"undefined","description":"A grid as { x, y, z }. z[row][column] is the height at x[column], y[row]. null creates a gap."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"800","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"480","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"colors","attribute":"colors","type":"HeatmapColorInput","kind":"property","values":[],"default":"'viridis'","description":"Pass as a JavaScript property. type: HeatmapColorInput."},{"name":"colorDomain","attribute":"color-domain","type":"Surface3DDomain","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Surface3DDomain."},{"name":"missingColor","attribute":"missing-color","type":"string","kind":"string","values":[],"default":"'#94a3b8'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"surfaceSize","attribute":"surface-size","type":"Scene3DVector","kind":"property","values":[],"default":"[2,2,2]","description":"Pass as a JavaScript property. type: Scene3DVector."},{"name":"opacity","attribute":"opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"locale","attribute":"locale","type":"string","kind":"string","values":[],"default":"'en-US'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"axes","attribute":"axes","type":"Surface3DAxesOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string."},{"name":"wireframe","attribute":"wireframe","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"wireWidth","attribute":"wire-width","type":"number","kind":"number","values":[],"default":".8","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"wireColor","attribute":"wire-color","type":"string","kind":"string","values":[],"default":"'#475569'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"material","attribute":"material","type":"Scene3DMaterialOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},{"name":"lighting","attribute":"lighting","type":"Scene3DLightingOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DLightingOptions."},{"name":"camera","attribute":"camera","type":"Scene3DCameraOptions|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DCameraOptions|string."},{"name":"orbit","attribute":"orbit","type":"Orbit3DOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."},{"name":"showEmpty","attribute":"show-empty","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether the component shows its own empty-geometry notice."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail:Surface3DHitDetail)=>string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail:Surface3DHitDetail)=>string."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"crosshairSnapDistance","attribute":"crosshair-snap-distance","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"Surface3DEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"HeatmapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"Surface3DStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"Surface3DEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"Surface3DUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"appendPoint","parameters":[{"name":"row","type":"Surface3DRowInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendPoints","parameters":[{"name":"rows","type":"ReadonlyArray<Surface3DRowInput>","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendBatch","parameters":[{"name":"rows","type":"ReadonlyArray<Surface3DRowInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shiftPoints","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"clearStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"replace","parameters":[{"name":"rows","type":"ReadonlyArray<Surface3DRowInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<Surface3DStreamSource|undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setData","parameters":[{"name":"data","type":"Surface3DData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getData","parameters":[],"returns":"Promise<Surface3DGrid>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDiagnostics","parameters":[],"returns":"Promise<{ missingHeights: number; invalidHeights: number; missingValues: number; invalidValues: number; }>","description":"Normalization diagnostics for the effective base and stream source."},{"name":"getLayout","parameters":[],"returns":"Promise<Surface3DGeometry>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"setAnimation","parameters":[{"name":"options","type":"{enabled?:boolean;duration?:number;easing?:Surface3DEasing;type?:HeatmapAnimationType}","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"getCamera","parameters":[],"returns":"Promise<Scene3DCameraOptions>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setCamera","parameters":[{"name":"options","type":"Scene3DCameraOptions","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setProjection","parameters":[{"name":"projection","type":"Scene3DProjection","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"resetCamera","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"saveCamera","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"fitSurface","parameters":[{"name":"padding","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false}],"returns":"Promise<void>","description":"A factor below one moves closer. Perspective changes distance; orthographic changes zoom."},{"name":"rotateBy","parameters":[{"name":"azimuth","type":"number","optional":false},{"name":"polar","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"panBy","parameters":[{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<void>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<void>","description":"Reset the zoomed or panned range to the original data range."},{"name":"redraw","parameters":[],"returns":"Promise<Surface3DRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<Surface3DEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string|undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"name":"recycleGpu","parameters":[],"returns":"Promise<void>","description":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<Surface3DHitDetail|null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectPointAt","parameters":[{"name":"row","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<Surface3DHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<Surface3DSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"showTooltipAtPoint","parameters":[{"name":"row","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"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."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"showCrosshairAt","parameters":[{"name":"row","type":"number","optional":false},{"name":"column","type":"number","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"showCrosshairAtData","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"Quiet cross-chart synchronization in data units, including positions between grid samples."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getCSV","parameters":[{"name":"options","type":"CsvOptions","optional":true}],"returns":"Promise<string>","description":"The tape as a CSV table (ISO time, OHLC, volume)."},{"name":"getTable","parameters":[],"returns":"Promise<string>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rendered","type":"Surface3DRenderResult&{tier:Surface3DEngineTier}","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"Surface3DHitDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"Surface3DHitDetail|null","description":"CustomEvent.detail type: Surface3DHitDetail|null. Event names are case-sensitive."},{"name":"selectionChanged","type":"Surface3DSelectionChangeEventDetail","description":"CustomEvent.detail type: Surface3DSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<Surface3DHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<Surface3DHitDetail>. Event names are case-sensitive."},{"name":"cameraChange","type":"Surface3DCameraChangeEventDetail","description":"CustomEvent.detail type: Surface3DCameraChangeEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"Surface3DCrosshairDetail|null","description":"CustomEvent.detail type: Surface3DCrosshairDetail|null. Event names are case-sensitive."},{"name":"appended","type":"{count:number;replaced:number}","description":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"name":"windowSlid","type":"{dropped:number}","description":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"dataValidationError","type":"{message:string}","description":"CustomEvent.detail type: {message:string}. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-surface-3d","blocks":[{"kind":"paragraph","text":"Explore a value across two coordinates, such as temperature, elevation, or a response surface."},{"kind":"paragraph","text":"Watch for perspective and occlusion. Change the camera angle and supplement precise values with data."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","A grid as { x, y, z }. z[row][column] is the height at x[column], y[row]. null creates a gap."]]},{"kind":"links","items":[{"path":"/charts/surface-3d","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-surface-3d.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-surface-3d\",\n      \"props\": {\n        \"data\": {\n          \"x\": [-2, -1, 0, 1, 2],\n          \"y\": [-2, -1, 0, 1, 2],\n          \"z\": [\n            [0, 3, 4, 3, 0],\n            [3, 6, 7, 6, 3],\n            [4, 7, 8, 7, 4],\n            [3, 6, 7, 6, 3],\n            [0, 3, 4, 3, 0]\n          ]\n        },\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'surface-3d example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"A grid as { x, y, z }. z[row][column] is the height at x[column], y[row]. null creates a gap."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Surface3DData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Surface3DData","title":"Surface3DData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`800`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`480`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: HeatmapColorInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapColorInput`"],["Default","`'viridis'`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":"Type definition"}]}]},{"id":"property-colorDomain","title":"colorDomain","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Surface3DDomain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Surface3DDomain`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Surface3DDomain","title":"Surface3DDomain","description":"Type definition"}]}]},{"id":"property-missingColor","title":"missingColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`missingColor`"],["HTML attribute","`missing-color`"],["Type","`string`"],["Default","`'#94a3b8'`"]]}]},{"id":"property-surfaceSize","title":"surfaceSize","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DVector."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`surfaceSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DVector`"],["Default","`[2,2,2]`"]]},{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":"Type definition"}]}]},{"id":"property-opacity","title":"opacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`opacity`"],["HTML attribute","`opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-locale","title":"locale","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locale`"],["HTML attribute","`locale`"],["Type","`string`"],["Default","`'en-US'`"]]}]},{"id":"property-axes","title":"axes","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Surface3DAxesOptions|boolean|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Surface3DAxesOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Surface3DAxesOptions","title":"Surface3DAxesOptions","description":"Type definition"}]}]},{"id":"property-wireframe","title":"wireframe","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wireframe`"],["HTML attribute","`wireframe`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-wireWidth","title":"wireWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wireWidth`"],["HTML attribute","`wire-width`"],["Type","`number`"],["Default","`.8`"]]}]},{"id":"property-wireColor","title":"wireColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wireColor`"],["HTML attribute","`wire-color`"],["Type","`string`"],["Default","`'#475569'`"]]}]},{"id":"property-material","title":"material","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`material`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DMaterialOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DMaterialOptions","title":"Scene3DMaterialOptions","description":"Type definition"}]}]},{"id":"property-lighting","title":"lighting","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DLightingOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lighting`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DLightingOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DLightingOptions","title":"Scene3DLightingOptions","description":"Type definition"}]}]},{"id":"property-camera","title":"camera","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DCameraOptions|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`camera`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DCameraOptions|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"property-orbit","title":"orbit","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orbit`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Orbit3DOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Orbit3DOptions","title":"Orbit3DOptions","description":"Type definition"}]}]},{"id":"property-showEmpty","title":"showEmpty","blocks":[{"kind":"paragraph","text":"Whether the component shows its own empty-geometry notice."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showEmpty`"],["HTML attribute","`show-empty`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail:Surface3DHitDetail)=>string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail:Surface3DHitDetail)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-crosshairSnapDistance","title":"crosshairSnapDistance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairSnapDistance`"],["HTML attribute","`crosshair-snap-distance`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`Surface3DEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/Surface3DEasing","title":"Surface3DEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`HeatmapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Surface3DStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Surface3DStreamSource","title":"Surface3DStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`Surface3DEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/Surface3DEngineMode","title":"Surface3DEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`Surface3DUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/Surface3DUnavailableBehaviour","title":"Surface3DUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Surface3DRenderResult&{tier:Surface3DEngineTier}>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // Surface3DRenderResult&{tier:Surface3DEngineTier}\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Surface3DRenderResult","title":"Surface3DRenderResult","description":"Type definition"},{"path":"/docs/types/Surface3DEngineTier","title":"Surface3DEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Surface3DHitDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // Surface3DHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Surface3DHitDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Surface3DHitDetail|null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // Surface3DHitDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Surface3DSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Surface3DSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // Surface3DSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Surface3DSelectionChangeEventDetail","title":"Surface3DSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<Surface3DHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<Surface3DHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<Surface3DHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"}]}]},{"id":"event-cameraChange","title":"cameraChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Surface3DCameraChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `cameraChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Surface3DCameraChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('cameraChange', event => {\n  console.log(event.detail); // Surface3DCameraChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Surface3DCameraChangeEventDetail","title":"Surface3DCameraChangeEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Surface3DCrosshairDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Surface3DCrosshairDetail|null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // Surface3DCrosshairDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Surface3DCrosshairDetail","title":"Surface3DCrosshairDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{count:number;replaced:number}>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // {count:number;replaced:number}\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{dropped:number}>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // {dropped:number}\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-dataValidationError","title":"dataValidationError","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {message:string}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{message:string}>`."},{"kind":"code","source":"chart.addEventListener('dataValidationError', event => {\n  console.log(event.detail); // {message:string}\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(row: Surface3DRowInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`Surface3DRowInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":"Type definition"}]}]},{"id":"method-appendPoints","title":"appendPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"appendPoints(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rows`","`ReadonlyArray<Surface3DRowInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rows`","`ReadonlyArray<Surface3DRowInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":"Type definition"}]}]},{"id":"method-shiftPoints","title":"shiftPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"shiftPoints(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-clearStream","title":"clearStream","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"clearStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(rows: ReadonlyArray<Surface3DRowInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`rows`","`ReadonlyArray<Surface3DRowInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<Surface3DStreamSource|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DStreamSource|undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DStreamSource","title":"Surface3DStreamSource","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: Surface3DData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`Surface3DData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DData","title":"Surface3DData","description":"Type definition"}]}]},{"id":"method-getData","title":"getData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getData(): Promise<Surface3DGrid>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DGrid>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DGrid","title":"Surface3DGrid","description":"Type definition"}]}]},{"id":"method-getDiagnostics","title":"getDiagnostics","blocks":[{"kind":"paragraph","text":"Normalization diagnostics for the effective base and stream source."},{"kind":"code","source":"getDiagnostics(): Promise<{ missingHeights: number; invalidHeights: number; missingValues: number; invalidValues: number; }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ missingHeights: number; invalidHeights: number; missingValues: number; invalidValues: number; }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<Surface3DGeometry>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DGeometry>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DGeometry","title":"Surface3DGeometry","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: {enabled?:boolean;duration?:number;easing?:Surface3DEasing;type?:HeatmapAnimationType}): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{enabled?:boolean;duration?:number;easing?:Surface3DEasing;type?:HeatmapAnimationType}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DEasing","title":"Surface3DEasing","description":"Type definition"},{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getCamera","title":"getCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getCamera(): Promise<Scene3DCameraOptions>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scene3DCameraOptions>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"method-setCamera","title":"setCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setCamera(options: Scene3DCameraOptions): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`Scene3DCameraOptions`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"method-setProjection","title":"setProjection","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setProjection(projection: Scene3DProjection): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`projection`","`Scene3DProjection`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DProjection","title":"Scene3DProjection","description":"Type definition"}]}]},{"id":"method-resetCamera","title":"resetCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"resetCamera(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-saveCamera","title":"saveCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"saveCamera(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-fitSurface","title":"fitSurface","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"fitSurface(padding?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`padding`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"A factor below one moves closer. Perspective changes distance; orthographic changes zoom."},{"kind":"code","source":"zoomBy(factor: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-rotateBy","title":"rotateBy","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"rotateBy(azimuth: number, polar?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`azimuth`","`number`","Required"],["`polar`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(x: number, y: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<Surface3DRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DRenderResult","title":"Surface3DRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<Surface3DEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DEngineTier","title":"Surface3DEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string|undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-recycleGpu","title":"recycleGpu","blocks":[{"kind":"paragraph","text":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"kind":"code","source":"recycleGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<Surface3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Surface3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"}]}]},{"id":"method-selectPointAt","title":"selectPointAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectPointAt(row: number, column: number): Promise<Surface3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Surface3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<Surface3DSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Surface3DSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Surface3DSelection","title":"Surface3DSelection","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(row: number, column: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(row: number, column: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`row`","`number`","Required"],["`column`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAtData","title":"showCrosshairAtData","blocks":[{"kind":"paragraph","text":"Quiet cross-chart synchronization in data units, including positions between grid samples."},{"kind":"code","source":"showCrosshairAtData(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getCSV","title":"getCSV","blocks":[{"kind":"paragraph","text":"The tape as a CSV table (ISO time, OHLC, volume)."},{"kind":"code","source":"getCSV(options?: CsvOptions): Promise<string>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`CsvOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CsvOptions","title":"CsvOptions","description":"Type definition"}]}]},{"id":"method-getTable","title":"getTable","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTable(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/bar-3d","title":"Bar 3d","summary":"Represent combinations of two categories with bars of varying height.","kind":"component","tag":"sy-bar-3d","componentId":"bar-3d","api":{"props":[{"name":"data","attribute":"data","type":"Bar3DData","kind":"property","values":[],"default":"undefined","description":"An array of { x, y, z, color? }. x and y are categories; z is bar height."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"800","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"480","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"colors","attribute":"colors","type":"HeatmapColorInput","kind":"property","values":[],"default":"'viridis'","description":"Pass as a JavaScript property. type: HeatmapColorInput."},{"name":"colorDomain","attribute":"color-domain","type":"Bar3DDomain","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Bar3DDomain."},{"name":"missingColor","attribute":"missing-color","type":"string","kind":"string","values":[],"default":"'#94a3b8'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"barSize","attribute":"bar-size","type":"Scene3DVector","kind":"property","values":[],"default":"[2,2,2]","description":"Pass as a JavaScript property. type: Scene3DVector."},{"name":"opacity","attribute":"opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"locale","attribute":"locale","type":"string","kind":"string","values":[],"default":"'en-US'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"axes","attribute":"axes","type":"Bar3DAxesOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Bar3DAxesOptions|boolean|string."},{"name":"barWidth","attribute":"bar-width","type":"number","kind":"number","values":[],"default":".72","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"barDepth","attribute":"bar-depth","type":"number","kind":"number","values":[],"default":".72","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"xCategories","attribute":"x-categories","type":"ReadonlyArray<Bar3DCategory>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},{"name":"yCategories","attribute":"y-categories","type":"ReadonlyArray<Bar3DCategory>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},{"name":"material","attribute":"material","type":"Scene3DMaterialOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},{"name":"lighting","attribute":"lighting","type":"Scene3DLightingOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DLightingOptions."},{"name":"camera","attribute":"camera","type":"Scene3DCameraOptions|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DCameraOptions|string."},{"name":"orbit","attribute":"orbit","type":"Orbit3DOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."},{"name":"showEmpty","attribute":"show-empty","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether the component shows its own empty-geometry notice."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail:Bar3DHitDetail)=>string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail:Bar3DHitDetail)=>string."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"crosshairSnapDistance","attribute":"crosshair-snap-distance","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"Bar3DEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"HeatmapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"Bar3DStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"Bar3DEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"Bar3DUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"appendPoint","parameters":[{"name":"point","type":"Bar3DDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendPoints","parameters":[{"name":"points","type":"ReadonlyArray<Bar3DDatum>","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendBatch","parameters":[{"name":"points","type":"ReadonlyArray<Bar3DDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shiftPoints","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"clearStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"replace","parameters":[{"name":"points","type":"ReadonlyArray<Bar3DDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<Bar3DStreamSource|undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setData","parameters":[{"name":"data","type":"Bar3DData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getData","parameters":[],"returns":"Promise<Bar3DDatum[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDiagnostics","parameters":[],"returns":"Promise<{ points: number; validPoints: number; missingCoordinates: number; invalidCoordinates: number; missingValues: number; zeroHeight: number; }>","description":"Normalization diagnostics for the effective base and stream source."},{"name":"getLayout","parameters":[],"returns":"Promise<Bar3DGeometry>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"setAnimation","parameters":[{"name":"options","type":"{enabled?:boolean;duration?:number;easing?:Bar3DEasing;type?:HeatmapAnimationType}","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"getCamera","parameters":[],"returns":"Promise<Scene3DCameraOptions>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setCamera","parameters":[{"name":"options","type":"Scene3DCameraOptions","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setProjection","parameters":[{"name":"projection","type":"Scene3DProjection","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"resetCamera","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"saveCamera","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"fitBars","parameters":[{"name":"padding","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false}],"returns":"Promise<void>","description":"A factor below one moves closer. Perspective changes distance; orthographic changes zoom."},{"name":"rotateBy","parameters":[{"name":"azimuth","type":"number","optional":false},{"name":"polar","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"panBy","parameters":[{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<void>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<void>","description":"Reset the zoomed or panned range to the original data range."},{"name":"redraw","parameters":[],"returns":"Promise<Bar3DRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<Bar3DEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string|undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"name":"recycleGpu","parameters":[],"returns":"Promise<void>","description":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<Bar3DHitDetail|null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectPointAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<Bar3DHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<Bar3DSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"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."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"showCrosshairAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"showCrosshairAtData","parameters":[{"name":"request","type":"Bar3DCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"Quiet source-category synchronization. Categories retain their original string or number type."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getCSV","parameters":[{"name":"options","type":"CsvOptions","optional":true}],"returns":"Promise<string>","description":"The tape as a CSV table (ISO time, OHLC, volume)."},{"name":"getTable","parameters":[],"returns":"Promise<string>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rendered","type":"Bar3DRenderResult&{tier:Bar3DEngineTier}","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"Bar3DHitDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"Bar3DHitDetail|null","description":"CustomEvent.detail type: Bar3DHitDetail|null. Event names are case-sensitive."},{"name":"selectionChanged","type":"Bar3DSelectionChangeEventDetail","description":"CustomEvent.detail type: Bar3DSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<Bar3DHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<Bar3DHitDetail>. Event names are case-sensitive."},{"name":"cameraChange","type":"Bar3DCameraChangeEventDetail","description":"CustomEvent.detail type: Bar3DCameraChangeEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"Bar3DCrosshairDetail|null","description":"CustomEvent.detail type: Bar3DCrosshairDetail|null. Event names are case-sensitive."},{"name":"appended","type":"{count:number;replaced:number}","description":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"name":"windowSlid","type":"{dropped:number}","description":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"dataValidationError","type":"{message:string}","description":"CustomEvent.detail type: {message:string}. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-bar-3d","blocks":[{"kind":"paragraph","text":"Arrange magnitudes across intersecting categories, such as products and quarters, in space."},{"kind":"paragraph","text":"Bars at the back may be hidden. Provide a 2D Heatmap or table as well."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { x, y, z, color? }. x and y are categories; z is bar height."]]},{"kind":"links","items":[{"path":"/charts/bar-3d","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-bar-3d.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-bar-3d\",\n      \"props\": {\n        \"data\": [\n          {\n            \"x\": \"Q1\",\n            \"y\": \"A\",\n            \"z\": 12\n          },\n          {\n            \"x\": \"Q2\",\n            \"y\": \"A\",\n            \"z\": 19\n          },\n          {\n            \"x\": \"Q3\",\n            \"y\": \"A\",\n            \"z\": 26\n          },\n          {\n            \"x\": \"Q4\",\n            \"y\": \"A\",\n            \"z\": 33\n          },\n          {\n            \"x\": \"Q1\",\n            \"y\": \"B\",\n            \"z\": 40\n          },\n          {\n            \"x\": \"Q2\",\n            \"y\": \"B\",\n            \"z\": 17\n          },\n          {\n            \"x\": \"Q3\",\n            \"y\": \"B\",\n            \"z\": 24\n          },\n          {\n            \"x\": \"Q4\",\n            \"y\": \"B\",\n            \"z\": 31\n          },\n          {\n            \"x\": \"Q1\",\n            \"y\": \"C\",\n            \"z\": 38\n          },\n          {\n            \"x\": \"Q2\",\n            \"y\": \"C\",\n            \"z\": 15\n          },\n          {\n            \"x\": \"Q3\",\n            \"y\": \"C\",\n            \"z\": 22\n          },\n          {\n            \"x\": \"Q4\",\n            \"y\": \"C\",\n            \"z\": 29\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'bar-3d example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { x, y, z, color? }. x and y are categories; z is bar height."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Bar3DData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DData","title":"Bar3DData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`800`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`480`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: HeatmapColorInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapColorInput`"],["Default","`'viridis'`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":"Type definition"}]}]},{"id":"property-colorDomain","title":"colorDomain","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Bar3DDomain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Bar3DDomain`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDomain","title":"Bar3DDomain","description":"Type definition"}]}]},{"id":"property-missingColor","title":"missingColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`missingColor`"],["HTML attribute","`missing-color`"],["Type","`string`"],["Default","`'#94a3b8'`"]]}]},{"id":"property-barSize","title":"barSize","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DVector."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DVector`"],["Default","`[2,2,2]`"]]},{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":"Type definition"}]}]},{"id":"property-opacity","title":"opacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`opacity`"],["HTML attribute","`opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-locale","title":"locale","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locale`"],["HTML attribute","`locale`"],["Type","`string`"],["Default","`'en-US'`"]]}]},{"id":"property-axes","title":"axes","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Bar3DAxesOptions|boolean|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Bar3DAxesOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DAxesOptions","title":"Bar3DAxesOptions","description":"Type definition"}]}]},{"id":"property-barWidth","title":"barWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barWidth`"],["HTML attribute","`bar-width`"],["Type","`number`"],["Default","`.72`"]]}]},{"id":"property-barDepth","title":"barDepth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barDepth`"],["HTML attribute","`bar-depth`"],["Type","`number`"],["Default","`.72`"]]}]},{"id":"property-xCategories","title":"xCategories","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`xCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<Bar3DCategory>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":"Type definition"}]}]},{"id":"property-yCategories","title":"yCategories","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<Bar3DCategory>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`yCategories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<Bar3DCategory>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":"Type definition"}]}]},{"id":"property-material","title":"material","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`material`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DMaterialOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DMaterialOptions","title":"Scene3DMaterialOptions","description":"Type definition"}]}]},{"id":"property-lighting","title":"lighting","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DLightingOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lighting`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DLightingOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DLightingOptions","title":"Scene3DLightingOptions","description":"Type definition"}]}]},{"id":"property-camera","title":"camera","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DCameraOptions|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`camera`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DCameraOptions|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"property-orbit","title":"orbit","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orbit`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Orbit3DOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Orbit3DOptions","title":"Orbit3DOptions","description":"Type definition"}]}]},{"id":"property-showEmpty","title":"showEmpty","blocks":[{"kind":"paragraph","text":"Whether the component shows its own empty-geometry notice."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showEmpty`"],["HTML attribute","`show-empty`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail:Bar3DHitDetail)=>string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail:Bar3DHitDetail)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-crosshairSnapDistance","title":"crosshairSnapDistance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairSnapDistance`"],["HTML attribute","`crosshair-snap-distance`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`Bar3DEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/Bar3DEasing","title":"Bar3DEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`HeatmapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Bar3DStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Bar3DStreamSource","title":"Bar3DStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`Bar3DEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/Bar3DEngineMode","title":"Bar3DEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`Bar3DUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/Bar3DUnavailableBehaviour","title":"Bar3DUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Bar3DRenderResult&{tier:Bar3DEngineTier}>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // Bar3DRenderResult&{tier:Bar3DEngineTier}\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Bar3DRenderResult","title":"Bar3DRenderResult","description":"Type definition"},{"path":"/docs/types/Bar3DEngineTier","title":"Bar3DEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Bar3DHitDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // Bar3DHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Bar3DHitDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Bar3DHitDetail|null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // Bar3DHitDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Bar3DSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Bar3DSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // Bar3DSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Bar3DSelectionChangeEventDetail","title":"Bar3DSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<Bar3DHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<Bar3DHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<Bar3DHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"event-cameraChange","title":"cameraChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Bar3DCameraChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `cameraChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Bar3DCameraChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('cameraChange', event => {\n  console.log(event.detail); // Bar3DCameraChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Bar3DCameraChangeEventDetail","title":"Bar3DCameraChangeEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Bar3DCrosshairDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Bar3DCrosshairDetail|null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // Bar3DCrosshairDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Bar3DCrosshairDetail","title":"Bar3DCrosshairDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{count:number;replaced:number}>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // {count:number;replaced:number}\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{dropped:number}>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // {dropped:number}\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-dataValidationError","title":"dataValidationError","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {message:string}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{message:string}>`."},{"kind":"code","source":"chart.addEventListener('dataValidationError', event => {\n  console.log(event.detail); // {message:string}\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(point: Bar3DDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`point`","`Bar3DDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"method-appendPoints","title":"appendPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"appendPoints(points: ReadonlyArray<Bar3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<Bar3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(points: ReadonlyArray<Bar3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<Bar3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"method-shiftPoints","title":"shiftPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"shiftPoints(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-clearStream","title":"clearStream","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"clearStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(points: ReadonlyArray<Bar3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<Bar3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<Bar3DStreamSource|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DStreamSource|undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DStreamSource","title":"Bar3DStreamSource","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: Bar3DData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`Bar3DData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DData","title":"Bar3DData","description":"Type definition"}]}]},{"id":"method-getData","title":"getData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getData(): Promise<Bar3DDatum[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DDatum[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":"Type definition"}]}]},{"id":"method-getDiagnostics","title":"getDiagnostics","blocks":[{"kind":"paragraph","text":"Normalization diagnostics for the effective base and stream source."},{"kind":"code","source":"getDiagnostics(): Promise<{ points: number; validPoints: number; missingCoordinates: number; invalidCoordinates: number; missingValues: number; zeroHeight: number; }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ points: number; validPoints: number; missingCoordinates: number; invalidCoordinates: number; missingValues: number; zeroHeight: number; }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<Bar3DGeometry>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DGeometry>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DGeometry","title":"Bar3DGeometry","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: {enabled?:boolean;duration?:number;easing?:Bar3DEasing;type?:HeatmapAnimationType}): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{enabled?:boolean;duration?:number;easing?:Bar3DEasing;type?:HeatmapAnimationType}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DEasing","title":"Bar3DEasing","description":"Type definition"},{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getCamera","title":"getCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getCamera(): Promise<Scene3DCameraOptions>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scene3DCameraOptions>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"method-setCamera","title":"setCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setCamera(options: Scene3DCameraOptions): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`Scene3DCameraOptions`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"method-setProjection","title":"setProjection","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setProjection(projection: Scene3DProjection): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`projection`","`Scene3DProjection`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DProjection","title":"Scene3DProjection","description":"Type definition"}]}]},{"id":"method-resetCamera","title":"resetCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"resetCamera(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-saveCamera","title":"saveCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"saveCamera(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-fitBars","title":"fitBars","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"fitBars(padding?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`padding`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"A factor below one moves closer. Perspective changes distance; orthographic changes zoom."},{"kind":"code","source":"zoomBy(factor: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-rotateBy","title":"rotateBy","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"rotateBy(azimuth: number, polar?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`azimuth`","`number`","Required"],["`polar`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(x: number, y: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<Bar3DRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DRenderResult","title":"Bar3DRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<Bar3DEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DEngineTier","title":"Bar3DEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string|undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-recycleGpu","title":"recycleGpu","blocks":[{"kind":"paragraph","text":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"kind":"code","source":"recycleGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<Bar3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Bar3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"method-selectPointAt","title":"selectPointAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectPointAt(index: number): Promise<Bar3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Bar3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<Bar3DSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Bar3DSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DSelection","title":"Bar3DSelection","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(index: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAtData","title":"showCrosshairAtData","blocks":[{"kind":"paragraph","text":"Quiet source-category synchronization. Categories retain their original string or number type."},{"kind":"code","source":"showCrosshairAtData(request: Bar3DCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`Bar3DCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Bar3DCrosshairShowRequest","title":"Bar3DCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getCSV","title":"getCSV","blocks":[{"kind":"paragraph","text":"The tape as a CSV table (ISO time, OHLC, volume)."},{"kind":"code","source":"getCSV(options?: CsvOptions): Promise<string>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`CsvOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CsvOptions","title":"CsvOptions","description":"Type definition"}]}]},{"id":"method-getTable","title":"getTable","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTable(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/scatter-3d","title":"Scatter 3d","summary":"Show three continuous measurements as points in space.","kind":"component","tag":"sy-scatter-3d","componentId":"scatter-3d","api":{"props":[{"name":"data","attribute":"data","type":"Scatter3DData","kind":"property","values":[],"default":"undefined","description":"An array of { x, y, z, value?, label? }."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"800","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"480","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"colors","attribute":"colors","type":"HeatmapColorInput","kind":"property","values":[],"default":"'viridis'","description":"Pass as a JavaScript property. type: HeatmapColorInput."},{"name":"colorDomain","attribute":"color-domain","type":"Scatter3DDomain","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scatter3DDomain."},{"name":"missingColor","attribute":"missing-color","type":"string","kind":"string","values":[],"default":"'#94a3b8'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"scatterSize","attribute":"scatter-size","type":"Scene3DVector","kind":"property","values":[],"default":"[2,2,2]","description":"Pass as a JavaScript property. type: Scene3DVector."},{"name":"opacity","attribute":"opacity","type":"number","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"legend","attribute":"legend","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to show a legend for series or items."},{"name":"locale","attribute":"locale","type":"string","kind":"string","values":[],"default":"'en-US'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"axes","attribute":"axes","type":"Scatter3DAxesOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scatter3DAxesOptions|boolean|string."},{"name":"marker","attribute":"marker","type":"'sphere'|'cube'","kind":"string","values":["sphere","cube"],"default":"'sphere'","description":"sphere or cube."},{"name":"markerRadius","attribute":"marker-radius","type":"number","kind":"number","values":[],"default":".06","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"markerDetail","attribute":"marker-detail","type":"0|1|2","kind":"number","values":[],"default":"1","description":"Set as an HTML attribute or JavaScript property. type: 0|1|2."},{"name":"material","attribute":"material","type":"Scene3DMaterialOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},{"name":"lighting","attribute":"lighting","type":"Scene3DLightingOptions","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DLightingOptions."},{"name":"camera","attribute":"camera","type":"Scene3DCameraOptions|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Scene3DCameraOptions|string."},{"name":"orbit","attribute":"orbit","type":"Orbit3DOptions|boolean|string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."},{"name":"showEmpty","attribute":"show-empty","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether the component shows its own empty-geometry notice."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail:Scatter3DHitDetail)=>string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail:Scatter3DHitDetail)=>string."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"crosshairSnapDistance","attribute":"crosshair-snap-distance","type":"number","kind":"number","values":[],"default":"12","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"Scatter3DEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"HeatmapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"Scatter3DStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"engine","attribute":"engine","type":"Scatter3DEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"Scatter3DUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"appendPoint","parameters":[{"name":"point","type":"Scatter3DDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendPoints","parameters":[{"name":"points","type":"ReadonlyArray<Scatter3DDatum>","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"appendBatch","parameters":[{"name":"points","type":"ReadonlyArray<Scatter3DDatum>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shiftPoints","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"clearStream","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"replace","parameters":[{"name":"points","type":"ReadonlyArray<Scatter3DDatum>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<Scatter3DStreamSource|undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"setData","parameters":[{"name":"data","type":"Scatter3DData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getData","parameters":[],"returns":"Promise<Scatter3DDatum[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDiagnostics","parameters":[],"returns":"Promise<{ points: number; validPoints: number; missingCoordinates: number; invalidCoordinates: number; missingValues: number; }>","description":"Normalization diagnostics for the effective base and stream source."},{"name":"getLayout","parameters":[],"returns":"Promise<Scatter3DGeometry>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"setAnimation","parameters":[{"name":"options","type":"{enabled?:boolean;duration?:number;easing?:Scatter3DEasing;type?:HeatmapAnimationType}","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"getCamera","parameters":[],"returns":"Promise<Scene3DCameraOptions>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setCamera","parameters":[{"name":"options","type":"Scene3DCameraOptions","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"setProjection","parameters":[{"name":"projection","type":"Scene3DProjection","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"resetCamera","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"saveCamera","parameters":[],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"fitPoints","parameters":[{"name":"padding","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false}],"returns":"Promise<void>","description":"A factor below one moves closer. Perspective changes distance; orthographic changes zoom."},{"name":"rotateBy","parameters":[{"name":"azimuth","type":"number","optional":false},{"name":"polar","type":"number","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"panBy","parameters":[{"name":"x","type":"number","optional":false},{"name":"y","type":"number","optional":false}],"returns":"Promise<void>","description":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<void>","description":"Reset the zoomed or panned range to the original data range."},{"name":"redraw","parameters":[],"returns":"Promise<Scatter3DRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getActiveTier","parameters":[],"returns":"Promise<Scatter3DEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string|undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"name":"recycleGpu","parameters":[],"returns":"Promise<void>","description":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<Scatter3DHitDetail|null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectPointAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<Scatter3DHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<Scatter3DSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"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."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"showCrosshairAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<boolean>","description":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"name":"showCrosshairAtData","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest&{dataZ?:number}","optional":false}],"returns":"Promise<boolean>","description":"Quiet source-coordinate synchronization. A cloud has no interpolated surface between its points."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getCSV","parameters":[{"name":"options","type":"CsvOptions","optional":true}],"returns":"Promise<string>","description":"The tape as a CSV table (ISO time, OHLC, volume)."},{"name":"getTable","parameters":[],"returns":"Promise<string>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rendered","type":"Scatter3DRenderResult&{tier:Scatter3DEngineTier}","description":"Emits rendering results in detail when chart drawing completes."},{"name":"pointClick","type":"Scatter3DHitDetail","description":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"name":"pointHover","type":"Scatter3DHitDetail|null","description":"CustomEvent.detail type: Scatter3DHitDetail|null. Event names are case-sensitive."},{"name":"selectionChanged","type":"Scatter3DSelectionChangeEventDetail","description":"CustomEvent.detail type: Scatter3DSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<Scatter3DHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<Scatter3DHitDetail>. Event names are case-sensitive."},{"name":"cameraChange","type":"Scatter3DCameraChangeEventDetail","description":"CustomEvent.detail type: Scatter3DCameraChangeEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"Scatter3DCrosshairDetail|null","description":"CustomEvent.detail type: Scatter3DCrosshairDetail|null. Event names are case-sensitive."},{"name":"appended","type":"{count:number;replaced:number}","description":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"name":"windowSlid","type":"{dropped:number}","description":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"dataValidationError","type":"{message:string}","description":"CustomEvent.detail type: {message:string}. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-scatter-3d","blocks":[{"kind":"paragraph","text":"Explore clusters and outliers in multivariate observations."},{"kind":"paragraph","text":"Rotate the view to inspect points that overlap in a 2D projection. State the unit for each axis."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of { x, y, z, value?, label? }."],["`marker`","sphere or cube."]]},{"kind":"links","items":[{"path":"/charts/scatter-3d","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-scatter-3d.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-scatter-3d\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"p0\",\n            \"label\": \"Measurement 1\",\n            \"x\": 0,\n            \"y\": 0,\n            \"z\": 1,\n            \"value\": 0,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p1\",\n            \"label\": \"Measurement 2\",\n            \"x\": 1,\n            \"y\": 0,\n            \"z\": 8,\n            \"value\": 1,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p2\",\n            \"label\": \"Measurement 3\",\n            \"x\": 2,\n            \"y\": 0,\n            \"z\": 6,\n            \"value\": 2,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p3\",\n            \"label\": \"Measurement 4\",\n            \"x\": 3,\n            \"y\": 0,\n            \"z\": 4,\n            \"value\": 3,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p4\",\n            \"label\": \"Measurement 5\",\n            \"x\": 4,\n            \"y\": 0,\n            \"z\": 2,\n            \"value\": 4,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p5\",\n            \"label\": \"Measurement 6\",\n            \"x\": 5,\n            \"y\": 0,\n            \"z\": 9,\n            \"value\": 5,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p6\",\n            \"label\": \"Measurement 7\",\n            \"x\": 0,\n            \"y\": 1,\n            \"z\": 7,\n            \"value\": 6,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p7\",\n            \"label\": \"Measurement 8\",\n            \"x\": 1,\n            \"y\": 1,\n            \"z\": 5,\n            \"value\": 7,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"p8\",\n            \"label\": \"Measurement 9\",\n            \"x\": 2,\n            \"y\": 1,\n            \"z\": 3,\n            \"value\": 8,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p9\",\n            \"label\": \"Measurement 10\",\n            \"x\": 3,\n            \"y\": 1,\n            \"z\": 1,\n            \"value\": 9,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p10\",\n            \"label\": \"Measurement 11\",\n            \"x\": 4,\n            \"y\": 1,\n            \"z\": 8,\n            \"value\": 10,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p11\",\n            \"label\": \"Measurement 12\",\n            \"x\": 5,\n            \"y\": 1,\n            \"z\": 6,\n            \"value\": 11,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p12\",\n            \"label\": \"Measurement 13\",\n            \"x\": 0,\n            \"y\": 2,\n            \"z\": 4,\n            \"value\": 12,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p13\",\n            \"label\": \"Measurement 14\",\n            \"x\": 1,\n            \"y\": 2,\n            \"z\": 2,\n            \"value\": 13,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p14\",\n            \"label\": \"Measurement 15\",\n            \"x\": 2,\n            \"y\": 2,\n            \"z\": 9,\n            \"value\": 14,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p15\",\n            \"label\": \"Measurement 16\",\n            \"x\": 3,\n            \"y\": 2,\n            \"z\": 7,\n            \"value\": 15,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"p16\",\n            \"label\": \"Measurement 17\",\n            \"x\": 4,\n            \"y\": 2,\n            \"z\": 5,\n            \"value\": 16,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"p17\",\n            \"label\": \"Measurement 18\",\n            \"x\": 5,\n            \"y\": 2,\n            \"z\": 3,\n            \"value\": 17,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"p18\",\n            \"label\": \"Measurement 19\",\n            \"x\": 0,\n            \"y\": 3,\n            \"z\": 1,\n            \"value\": 18,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"p19\",\n            \"label\": \"Measurement 20\",\n            \"x\": 1,\n            \"y\": 3,\n            \"z\": 8,\n            \"value\": 19,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"p20\",\n            \"label\": \"Measurement 21\",\n            \"x\": 2,\n            \"y\": 3,\n            \"z\": 6,\n            \"value\": 20,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"p21\",\n            \"label\": \"Measurement 22\",\n            \"x\": 3,\n            \"y\": 3,\n            \"z\": 4,\n            \"value\": 21,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"p22\",\n            \"label\": \"Measurement 23\",\n            \"x\": 4,\n            \"y\": 3,\n            \"z\": 2,\n            \"value\": 22,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"p23\",\n            \"label\": \"Measurement 24\",\n            \"x\": 5,\n            \"y\": 3,\n            \"z\": 9,\n            \"value\": 23,\n            \"color\": \"#e99954\"\n          }\n        ],\n        \"marker\": \"sphere\",\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'scatter-3d example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('pointClick', event.detail);\n  };\n  chart.addEventListener('pointClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('pointClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of { x, y, z, value?, label? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scatter3DData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DData","title":"Scatter3DData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`800`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`480`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-colors","title":"colors","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: HeatmapColorInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`HeatmapColorInput`"],["Default","`'viridis'`"]]},{"kind":"links","items":[{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":"Type definition"}]}]},{"id":"property-colorDomain","title":"colorDomain","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scatter3DDomain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scatter3DDomain`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDomain","title":"Scatter3DDomain","description":"Type definition"}]}]},{"id":"property-missingColor","title":"missingColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`missingColor`"],["HTML attribute","`missing-color`"],["Type","`string`"],["Default","`'#94a3b8'`"]]}]},{"id":"property-scatterSize","title":"scatterSize","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DVector."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scatterSize`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DVector`"],["Default","`[2,2,2]`"]]},{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":"Type definition"}]}]},{"id":"property-opacity","title":"opacity","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`opacity`"],["HTML attribute","`opacity`"],["Type","`number`"],["Default","`1`"]]}]},{"id":"property-legend","title":"legend","blocks":[{"kind":"paragraph","text":"Whether to show a legend for series or items."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legend`"],["HTML attribute","`legend`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-locale","title":"locale","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`locale`"],["HTML attribute","`locale`"],["Type","`string`"],["Default","`'en-US'`"]]}]},{"id":"property-axes","title":"axes","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scatter3DAxesOptions|boolean|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axes`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scatter3DAxesOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DAxesOptions","title":"Scatter3DAxesOptions","description":"Type definition"}]}]},{"id":"property-marker","title":"marker","blocks":[{"kind":"paragraph","text":"sphere or cube."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`marker`"],["HTML attribute","`marker`"],["Type","`'sphere'|'cube'`"],["Default","`'sphere'`"],["Allowed values","`sphere`, `cube`"]]}]},{"id":"property-markerRadius","title":"markerRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerRadius`"],["HTML attribute","`marker-radius`"],["Type","`number`"],["Default","`.06`"]]}]},{"id":"property-markerDetail","title":"markerDetail","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: 0|1|2."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`markerDetail`"],["HTML attribute","`marker-detail`"],["Type","`0|1|2`"],["Default","`1`"]]}]},{"id":"property-material","title":"material","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DMaterialOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`material`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DMaterialOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DMaterialOptions","title":"Scene3DMaterialOptions","description":"Type definition"}]}]},{"id":"property-lighting","title":"lighting","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DLightingOptions."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`lighting`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DLightingOptions`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DLightingOptions","title":"Scene3DLightingOptions","description":"Type definition"}]}]},{"id":"property-camera","title":"camera","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Scene3DCameraOptions|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`camera`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scene3DCameraOptions|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"property-orbit","title":"orbit","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: Orbit3DOptions|boolean|string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orbit`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Orbit3DOptions|boolean|string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Orbit3DOptions","title":"Orbit3DOptions","description":"Type definition"}]}]},{"id":"property-showEmpty","title":"showEmpty","blocks":[{"kind":"paragraph","text":"Whether the component shows its own empty-geometry notice."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showEmpty`"],["HTML attribute","`show-empty`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail:Scatter3DHitDetail)=>string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail:Scatter3DHitDetail)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-crosshairSnapDistance","title":"crosshairSnapDistance","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairSnapDistance`"],["HTML attribute","`crosshair-snap-distance`"],["Type","`number`"],["Default","`12`"]]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`Scatter3DEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/Scatter3DEasing","title":"Scatter3DEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`HeatmapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Scatter3DStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DStreamSource","title":"Scatter3DStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`Scatter3DEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/Scatter3DEngineMode","title":"Scatter3DEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`Scatter3DUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/Scatter3DUnavailableBehaviour","title":"Scatter3DUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Scatter3DRenderResult&{tier:Scatter3DEngineTier}>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // Scatter3DRenderResult&{tier:Scatter3DEngineTier}\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Scatter3DRenderResult","title":"Scatter3DRenderResult","description":"Type definition"},{"path":"/docs/types/Scatter3DEngineTier","title":"Scatter3DEngineTier","description":"Type definition"}]}]},{"id":"event-pointClick","title":"pointClick","blocks":[{"kind":"paragraph","text":"A point selection event. Read the selected data and index from CustomEvent.detail."},{"kind":"paragraph","text":"Event name: `pointClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Scatter3DHitDetail>`."},{"kind":"code","source":"chart.addEventListener('pointClick', event => {\n  console.log(event.detail); // Scatter3DHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"}]}]},{"id":"event-pointHover","title":"pointHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Scatter3DHitDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Scatter3DHitDetail|null>`."},{"kind":"code","source":"chart.addEventListener('pointHover', event => {\n  console.log(event.detail); // Scatter3DHitDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Scatter3DSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Scatter3DSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // Scatter3DSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Scatter3DSelectionChangeEventDetail","title":"Scatter3DSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<Scatter3DHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<Scatter3DHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<Scatter3DHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"}]}]},{"id":"event-cameraChange","title":"cameraChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Scatter3DCameraChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `cameraChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Scatter3DCameraChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('cameraChange', event => {\n  console.log(event.detail); // Scatter3DCameraChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Scatter3DCameraChangeEventDetail","title":"Scatter3DCameraChangeEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: Scatter3DCrosshairDetail|null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<Scatter3DCrosshairDetail|null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // Scatter3DCrosshairDetail|null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/Scatter3DCrosshairDetail","title":"Scatter3DCrosshairDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {count:number;replaced:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{count:number;replaced:number}>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // {count:number;replaced:number}\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {dropped:number}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{dropped:number}>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // {dropped:number}\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-dataValidationError","title":"dataValidationError","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: {message:string}. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dataValidationError`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{message:string}>`."},{"kind":"code","source":"chart.addEventListener('dataValidationError', event => {\n  console.log(event.detail); // {message:string}\n});","language":"javascript"}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(point: Scatter3DDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`point`","`Scatter3DDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"}]}]},{"id":"method-appendPoints","title":"appendPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"appendPoints(points: ReadonlyArray<Scatter3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<Scatter3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(points: ReadonlyArray<Scatter3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<Scatter3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"}]}]},{"id":"method-shiftPoints","title":"shiftPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"shiftPoints(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-clearStream","title":"clearStream","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"clearStream(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(points: ReadonlyArray<Scatter3DDatum>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`points`","`ReadonlyArray<Scatter3DDatum>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<Scatter3DStreamSource|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DStreamSource|undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DStreamSource","title":"Scatter3DStreamSource","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: Scatter3DData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`Scatter3DData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DData","title":"Scatter3DData","description":"Type definition"}]}]},{"id":"method-getData","title":"getData","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getData(): Promise<Scatter3DDatum[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DDatum[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":"Type definition"}]}]},{"id":"method-getDiagnostics","title":"getDiagnostics","blocks":[{"kind":"paragraph","text":"Normalization diagnostics for the effective base and stream source."},{"kind":"code","source":"getDiagnostics(): Promise<{ points: number; validPoints: number; missingCoordinates: number; invalidCoordinates: number; missingValues: number; }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ points: number; validPoints: number; missingCoordinates: number; invalidCoordinates: number; missingValues: number; }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<Scatter3DGeometry>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DGeometry>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DGeometry","title":"Scatter3DGeometry","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: {enabled?:boolean;duration?:number;easing?:Scatter3DEasing;type?:HeatmapAnimationType}): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{enabled?:boolean;duration?:number;easing?:Scatter3DEasing;type?:HeatmapAnimationType}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DEasing","title":"Scatter3DEasing","description":"Type definition"},{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":"Type definition"}]}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getCamera","title":"getCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getCamera(): Promise<Scene3DCameraOptions>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scene3DCameraOptions>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"method-setCamera","title":"setCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setCamera(options: Scene3DCameraOptions): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`Scene3DCameraOptions`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":"Type definition"}]}]},{"id":"method-setProjection","title":"setProjection","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setProjection(projection: Scene3DProjection): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`projection`","`Scene3DProjection`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scene3DProjection","title":"Scene3DProjection","description":"Type definition"}]}]},{"id":"method-resetCamera","title":"resetCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"resetCamera(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-saveCamera","title":"saveCamera","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"saveCamera(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-fitPoints","title":"fitPoints","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"fitPoints(padding?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`padding`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"A factor below one moves closer. Perspective changes distance; orthographic changes zoom."},{"kind":"code","source":"zoomBy(factor: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-rotateBy","title":"rotateBy","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"rotateBy(azimuth: number, polar?: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`azimuth`","`number`","Required"],["`polar`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"slide the zoomed windows by data units (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(x: number, y: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`x`","`number`","Required"],["`y`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<Scatter3DRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DRenderResult","title":"Scatter3DRenderResult","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<Scatter3DEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DEngineTier","title":"Scatter3DEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string|undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string|undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-recycleGpu","title":"recycleGpu","blocks":[{"kind":"paragraph","text":"Without the grant (or while frozen) nothing is recycled: no GPU work starts."},{"kind":"code","source":"recycleGpu(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<Scatter3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"}]}]},{"id":"method-selectPointAt","title":"selectPointAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectPointAt(index: number): Promise<Scatter3DHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<Scatter3DSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Scatter3DSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/Scatter3DSelection","title":"Scatter3DSelection","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"show the crosshair at a data position (a linked chart's cursor) without emitting `crosshairMove`; false when it falls outside the plot."},{"kind":"code","source":"showCrosshairAt(index: number): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-showCrosshairAtData","title":"showCrosshairAtData","blocks":[{"kind":"paragraph","text":"Quiet source-coordinate synchronization. A cloud has no interpolated surface between its points."},{"kind":"code","source":"showCrosshairAtData(request: CartesianCrosshairShowRequest&{dataZ?:number}): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest&{dataZ?:number}`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getCSV","title":"getCSV","blocks":[{"kind":"paragraph","text":"The tape as a CSV table (ISO time, OHLC, volume)."},{"kind":"code","source":"getCSV(options?: CsvOptions): Promise<string>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`CsvOptions`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CsvOptions","title":"CsvOptions","description":"Type definition"}]}]},{"id":"method-getTable","title":"getTable","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTable(): Promise<string>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/gantt","title":"Gantt","summary":"Arrange task durations and progress on a timeline.","kind":"component","tag":"sy-gantt-chart","componentId":"gantt","api":{"props":[{"name":"data","attribute":"data","type":"GanttData","kind":"property","values":[],"default":"undefined","description":"An array of tasks as { id, label, start, end?, progress?, milestone?, baseline? }. progress ranges from 0 to 1."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"900","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"400","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"barHeight","attribute":"bar-height","type":"number","kind":"number","values":[],"default":"24","description":"Maximum task bar height and gap in CSS pixels."},{"name":"rowGap","attribute":"row-gap","type":"number","kind":"number","values":[],"default":"4","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"barRadius","attribute":"bar-radius","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"progressShow","attribute":"progress-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"progressColor","attribute":"progress-color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"taskLabelFormat","attribute":"task-label-format","type":"(task:GanttTask)=>string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (task:GanttTask)=>string."},{"name":"timeDomain","attribute":"time-domain","type":"readonly [number, number]","kind":"property","values":[],"default":"undefined","description":"Optional full timeline extent in epoch milliseconds."},{"name":"criticalPath","attribute":"critical-path","type":"GanttCriticalPathInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GanttCriticalPathInput."},{"name":"taskEditing","attribute":"task-editing","type":"GanttTaskEditingInput","kind":"property","values":[],"default":"undefined","description":"Opt-in task move/resize. Committed local edits are queried through getTasks/getTaskEdits; source updates supersede them."},{"name":"baseline","attribute":"baseline","type":"GanttBaselineStyleInput","kind":"property","values":[],"default":"undefined","description":"Reference-date strips, visible by default when tasks include baseline dates."},{"name":"dependencies","attribute":"dependencies","type":"ReadonlyArray<GanttDependencyInput>","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>."},{"name":"dependencyStyle","attribute":"dependency-style","type":"GanttDependencyStyleInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GanttDependencyStyleInput."},{"name":"timeAxis","attribute":"time-axis","type":"GanttTimeAxisInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: GanttTimeAxisInput."},{"name":"crosshair","attribute":"crosshair","type":"CartesianCrosshairInput","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"name":"crosshairTimeUnit","attribute":"crosshair-time-unit","type":"GanttCrosshairTimeUnit","kind":"string","values":["year","month","week","day","hour","minute","second"],"default":"'hour'","description":"Crosshair time badge precision; hour by default. Uses timeAxis.utc without changing event timestamps."},{"name":"color","attribute":"color","type":"string","kind":"string","values":[],"default":"'auto'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"activeColor","attribute":"active-color","type":"string","kind":"string","values":[],"default":"'#f59e0b'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"taskLabels","attribute":"task-labels","type":"GanttLabelMode","kind":"string","values":["auto","show","hide"],"default":"'auto'","description":"Allowed values: auto, show, hide. Default: 'auto'."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"enableMouseTracking","attribute":"enable-mouse-tracking","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltip","attribute":"tooltip","type":"CartesianTooltipInput","kind":"property","values":["auto","off"],"default":"undefined","description":"Tooltip settings for pointer-driven values, position, and content."},{"name":"tooltipEnabled","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: GanttHitDetail) => string","kind":"property","values":[],"default":"undefined","description":"Pass as a JavaScript property. type: (detail: GanttHitDetail) => string."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Whether to animate initial display and data changes."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"GanttEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"GanttAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"Allowed values: initial, update. Default: undefined."},{"name":"streamSource","attribute":"stream-source","type":"GanttStreamSource","kind":"property","values":[],"default":"undefined","description":"A stream source for live data. Check the contract for the specific type."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"The maximum number of streaming data points to retain."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The streaming data range to keep visible."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Settings for zooming and the visible range."},{"name":"engine","attribute":"engine","type":"GanttEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"GanttUnavailableBehaviour","kind":"string","values":["fallback","error"],"default":"'fallback'","description":"Allowed values: fallback, error. Default: 'fallback'."}],"methods":[{"name":"getCriticalPath","parameters":[],"returns":"Promise<GanttCriticalPathResult>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDependencies","parameters":[],"returns":"Promise<GanttDependencyDataset>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDependencyPaths","parameters":[],"returns":"Promise<GanttDependencyPath[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTestDependency","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<GanttDependencyHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDependencySelection","parameters":[],"returns":"Promise<GanttDependencySelection>","description":"An asynchronous method. Check the argument and return types below."},{"name":"selectDependencyAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GanttDependencyHitDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showDependencyTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail|null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"redraw","parameters":[],"returns":"Promise<GanttRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"name":"getActiveTier","parameters":[],"returns":"Promise<GanttEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getUnavailableReason","parameters":[],"returns":"Promise<string | undefined>","description":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"name":"setData","parameters":[{"name":"data","type":"GanttData","optional":false}],"returns":"Promise<void>","description":"Replace the bar set."},{"name":"getTasks","parameters":[],"returns":"Promise<GanttTask[]>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getTask","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GanttTask | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getTaskById","parameters":[{"name":"id","type":"string","optional":false}],"returns":"Promise<GanttTask | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getDiagnostics","parameters":[],"returns":"Promise<GanttDiagnostics>","description":"Normalization diagnostics for the effective base and stream source."},{"name":"getTaskCount","parameters":[],"returns":"Promise<number>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<GanttExtent>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getLayout","parameters":[],"returns":"Promise<GanttLayoutResult>","description":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"name":"getBaselines","parameters":[],"returns":"Promise<GanttBaselineComparison[]>","description":"Reference comparisons for every accepted task, including hidden/offscreen baselines. Positive variance means later or longer."},{"name":"appendPoint","parameters":[{"name":"task","type":"GanttTaskInput","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendBatch","parameters":[{"name":"tasks","type":"ReadonlyArray<GanttTaskInput>","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"name":"replace","parameters":[{"name":"tasks","type":"ReadonlyArray<GanttTaskInput>","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<GanttStreamSource | undefined>","description":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ enabled?: boolean; duration?: number; easing?: GanttEasing; type?: GanttAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"hitTest","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<GanttHitDetail | null>","description":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"name":"selectTaskAt","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<GanttHitDetail | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"clearSelection","parameters":[],"returns":"Promise<void>","description":"Release the selection (emits selectionChanged when there was one)."},{"name":"getSelection","parameters":[],"returns":"Promise<GanttSelection>","description":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"name":"showTooltipAtIndex","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"name":"showTooltipAtPoint","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<CartesianTooltipEventDetail | null>","description":"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."},{"name":"hideTooltip","parameters":[],"returns":"Promise<void>","description":"Close the currently visible tooltip."},{"name":"getTaskEdits","parameters":[],"returns":"Promise<GanttTaskEdit[]>","description":"Committed local dates, completion and displaced rows; never mutates caller data."},{"name":"resetTaskEdits","parameters":[{"name":"id","type":"string","optional":true}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"cancelTaskEdit","parameters":[],"returns":"Promise<boolean>","description":"An asynchronous method. Check the argument and return types below."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to an explicit millisecond x window. Task rows do not accept y zoom requests."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by milliseconds (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full timestamp extent and axis key (`null` before the first layout)."},{"name":"getDataTable","parameters":[],"returns":"Promise<ChartDataTable>","description":"Current normalized table, including the retained stream; independent of GPU availability."},{"name":"getLabels","parameters":[],"returns":"Promise<GanttLabel[]>","description":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"name":"getTimeAxis","parameters":[],"returns":"Promise<GanttTimeAxisModel>","description":"An asynchronous method. Check the argument and return types below."},{"name":"showCrosshairAt","parameters":[{"name":"request","type":"CartesianCrosshairShowRequest","optional":false}],"returns":"Promise<boolean>","description":"Quiet sync API: epoch milliseconds and a zero-based task row; no crosshairMove feedback loop."},{"name":"hideCrosshair","parameters":[],"returns":"Promise<void>","description":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."}],"events":[{"name":"rendered","type":"GanttRenderResult & { tier: GanttEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"dependencyClick","type":"GanttDependencyHitDetail","description":"CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive."},{"name":"dependencyHover","type":"GanttDependencyHitDetail | null","description":"CustomEvent.detail type: GanttDependencyHitDetail | null. Event names are case-sensitive."},{"name":"dependencySelectionChange","type":"GanttDependencySelectionChange","description":"CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive."},{"name":"taskClick","type":"GanttHitDetail","description":"CustomEvent.detail type: GanttHitDetail. Event names are case-sensitive."},{"name":"taskHover","type":"GanttHitDetail | null","description":"CustomEvent.detail type: GanttHitDetail | null. Event names are case-sensitive."},{"name":"taskEditStart","type":"GanttTaskEditEventDetail","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"name":"taskEditMove","type":"GanttTaskEditEventDetail","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"name":"taskEditEnd","type":"GanttTaskEditEventDetail","description":"Cancelable before local dates, completion and row order commit. preventDefault restores the prior state."},{"name":"taskEditCancel","type":"GanttTaskEditEventDetail","description":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"name":"selectionChanged","type":"GanttSelectionChangeEventDetail","description":"CustomEvent.detail type: GanttSelectionChangeEventDetail. Event names are case-sensitive."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<GanttHitDetail>","description":"CustomEvent.detail type: ChartPointContextMenuEventDetail<GanttHitDetail>. Event names are case-sensitive."},{"name":"appended","type":"{ count: number; replaced: number }","description":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"name":"windowSlid","type":"{ dropped: number }","description":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"name":"tooltipShow","type":"CartesianTooltipEventDetail","description":"Whether to display the built-in tooltip."},{"name":"tooltipHide","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"tooltipAction","type":"CartesianTooltipActionEventDetail","description":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"name":"crosshairMove","type":"CartesianCrosshairEventDetail | null","description":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."}]},"sections":[{"id":"overview","title":"sy-gantt-chart","blocks":[{"kind":"paragraph","text":"Manage project schedules, milestones, and baselines together."},{"kind":"paragraph","text":"This display example does not save tasks. Connect application persistence to editing events to save changes."},{"kind":"paragraph","text":"Base chart tier: Pro. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`data`","An array of tasks as { id, label, start, end?, progress?, milestone?, baseline? }. progress ranges from 0 to 1."]]},{"kind":"links","items":[{"path":"/charts/gantt","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-gantt-chart.js';\n  define0();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-gantt-chart\",\n      \"props\": {\n        \"data\": [\n          {\n            \"id\": \"research\",\n            \"label\": \"Research\",\n            \"start\": \"2026-01-05\",\n            \"end\": \"2026-01-09\",\n            \"progress\": 1,\n            \"color\": \"#8263d9\"\n          },\n          {\n            \"id\": \"design\",\n            \"label\": \"Design\",\n            \"start\": \"2026-01-08\",\n            \"end\": \"2026-01-16\",\n            \"progress\": 0.65,\n            \"color\": \"#239c91\"\n          },\n          {\n            \"id\": \"build\",\n            \"label\": \"Implementation\",\n            \"start\": \"2026-01-14\",\n            \"end\": \"2026-01-26\",\n            \"progress\": 0.3,\n            \"color\": \"#e99954\"\n          },\n          {\n            \"id\": \"launch\",\n            \"label\": \"Release\",\n            \"start\": \"2026-01-28\",\n            \"milestone\": true\n          }\n        ],\n        \"width\": 640,\n        \"height\": 360,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'gantt example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('taskClick', event.detail);\n  };\n  chart.addEventListener('taskClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('taskClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-data","title":"data","blocks":[{"kind":"paragraph","text":"An array of tasks as { id, label, start, end?, progress?, milestone?, baseline? }. progress ranges from 0 to 1."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`data`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttData","title":"GanttData","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`900`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`400`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-barHeight","title":"barHeight","blocks":[{"kind":"paragraph","text":"Maximum task bar height and gap in CSS pixels."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barHeight`"],["HTML attribute","`bar-height`"],["Type","`number`"],["Default","`24`"]]}]},{"id":"property-rowGap","title":"rowGap","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`rowGap`"],["HTML attribute","`row-gap`"],["Type","`number`"],["Default","`4`"]]}]},{"id":"property-barRadius","title":"barRadius","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`barRadius`"],["HTML attribute","`bar-radius`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-progressShow","title":"progressShow","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`progressShow`"],["HTML attribute","`progress-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-progressColor","title":"progressColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`progressColor`"],["HTML attribute","`progress-color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-taskLabelFormat","title":"taskLabelFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (task:GanttTask)=>string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`taskLabelFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(task:GanttTask)=>string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"property-timeDomain","title":"timeDomain","blocks":[{"kind":"paragraph","text":"Optional full timeline extent in epoch milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`timeDomain`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`readonly [number, number]`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-criticalPath","title":"criticalPath","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: GanttCriticalPathInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`criticalPath`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttCriticalPathInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttCriticalPathInput","title":"GanttCriticalPathInput","description":"Type definition"}]}]},{"id":"property-taskEditing","title":"taskEditing","blocks":[{"kind":"paragraph","text":"Opt-in task move/resize. Committed local edits are queried through getTasks/getTaskEdits; source updates supersede them."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`taskEditing`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttTaskEditingInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditingInput","title":"GanttTaskEditingInput","description":"Type definition"}]}]},{"id":"property-baseline","title":"baseline","blocks":[{"kind":"paragraph","text":"Reference-date strips, visible by default when tasks include baseline dates."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`baseline`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttBaselineStyleInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttBaselineStyleInput","title":"GanttBaselineStyleInput","description":"Type definition"}]}]},{"id":"property-dependencies","title":"dependencies","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: ReadonlyArray<GanttDependencyInput>."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dependencies`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<GanttDependencyInput>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyInput","title":"GanttDependencyInput","description":"Type definition"}]}]},{"id":"property-dependencyStyle","title":"dependencyStyle","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: GanttDependencyStyleInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dependencyStyle`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttDependencyStyleInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyStyleInput","title":"GanttDependencyStyleInput","description":"Type definition"}]}]},{"id":"property-timeAxis","title":"timeAxis","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: GanttTimeAxisInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`timeAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttTimeAxisInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttTimeAxisInput","title":"GanttTimeAxisInput","description":"Type definition"}]}]},{"id":"property-crosshair","title":"crosshair","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: CartesianCrosshairInput."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshair`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianCrosshairInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":"Type definition"}]}]},{"id":"property-crosshairTimeUnit","title":"crosshairTimeUnit","blocks":[{"kind":"paragraph","text":"Crosshair time badge precision; hour by default. Uses timeAxis.utc without changing event timestamps."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`crosshairTimeUnit`"],["HTML attribute","`crosshair-time-unit`"],["Type","`GanttCrosshairTimeUnit`"],["Default","`'hour'`"],["Allowed values","`year`, `month`, `week`, `day`, `hour`, `minute`, `second`"]]},{"kind":"links","items":[{"path":"/docs/types/GanttCrosshairTimeUnit","title":"GanttCrosshairTimeUnit","description":"Type definition"}]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","`color`"],["Type","`string`"],["Default","`'auto'`"]]}]},{"id":"property-activeColor","title":"activeColor","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`activeColor`"],["HTML attribute","`active-color`"],["Type","`string`"],["Default","`'#f59e0b'`"]]}]},{"id":"property-taskLabels","title":"taskLabels","blocks":[{"kind":"paragraph","text":"Allowed values: auto, show, hide. Default: 'auto'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`taskLabels`"],["HTML attribute","`task-labels`"],["Type","`GanttLabelMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `show`, `hide`"]]},{"kind":"links","items":[{"path":"/docs/types/GanttLabelMode","title":"GanttLabelMode","description":"Type definition"}]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-enableMouseTracking","title":"enableMouseTracking","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`enableMouseTracking`"],["HTML attribute","`enable-mouse-tracking`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltip","title":"tooltip","blocks":[{"kind":"paragraph","text":"Tooltip settings for pointer-driven values, position, and content."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltip`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianTooltipInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":"Type definition"}]}]},{"id":"property-tooltipEnabled","title":"tooltipEnabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipEnabled`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: (detail: GanttHitDetail) => string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: GanttHitDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"}]}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Whether to animate initial display and data changes."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`GanttEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/GanttEasing","title":"GanttEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"Allowed values: initial, update. Default: undefined."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`GanttAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttAnimationType","title":"GanttAnimationType","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A stream source for live data. Check the contract for the specific type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`GanttStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/GanttStreamSource","title":"GanttStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"The maximum number of streaming data points to retain."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The streaming data range to keep visible."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Settings for zooming and the visible range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`GanttEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/GanttEngineMode","title":"GanttEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`GanttUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`"]]},{"kind":"links","items":[{"path":"/docs/types/GanttUnavailableBehaviour","title":"GanttUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttRenderResult & { tier: GanttEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // GanttRenderResult & { tier: GanttEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttRenderResult","title":"GanttRenderResult","description":"Type definition"},{"path":"/docs/types/GanttEngineTier","title":"GanttEngineTier","description":"Type definition"}]}]},{"id":"event-dependencyClick","title":"dependencyClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttDependencyHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dependencyClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencyHitDetail>`."},{"kind":"code","source":"chart.addEventListener('dependencyClick', event => {\n  console.log(event.detail); // GanttDependencyHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"event-dependencyHover","title":"dependencyHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttDependencyHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dependencyHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencyHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('dependencyHover', event => {\n  console.log(event.detail); // GanttDependencyHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"event-dependencySelectionChange","title":"dependencySelectionChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttDependencySelectionChange. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `dependencySelectionChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttDependencySelectionChange>`."},{"kind":"code","source":"chart.addEventListener('dependencySelectionChange', event => {\n  console.log(event.detail); // GanttDependencySelectionChange\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttDependencySelectionChange","title":"GanttDependencySelectionChange","description":"Type definition"}]}]},{"id":"event-taskClick","title":"taskClick","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttHitDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `taskClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttHitDetail>`."},{"kind":"code","source":"chart.addEventListener('taskClick', event => {\n  console.log(event.detail); // GanttHitDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"}]}]},{"id":"event-taskHover","title":"taskHover","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttHitDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `taskHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttHitDetail | null>`."},{"kind":"code","source":"chart.addEventListener('taskHover', event => {\n  console.log(event.detail); // GanttHitDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"}]}]},{"id":"event-taskEditStart","title":"taskEditStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `taskEditStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditStart', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"event-taskEditMove","title":"taskEditMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `taskEditMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditMove', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"event-taskEditEnd","title":"taskEditEnd","blocks":[{"kind":"paragraph","text":"Cancelable before local dates, completion and row order commit. preventDefault restores the prior state."},{"kind":"paragraph","text":"Event name: `taskEditEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditEnd', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"event-taskEditCancel","title":"taskEditCancel","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttTaskEditEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `taskEditCancel`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttTaskEditEventDetail>`."},{"kind":"code","source":"chart.addEventListener('taskEditCancel', event => {\n  console.log(event.detail); // GanttTaskEditEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: GanttSelectionChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<GanttSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // GanttSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/GanttSelectionChangeEventDetail","title":"GanttSelectionChangeEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: ChartPointContextMenuEventDetail<GanttHitDetail>. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<GanttHitDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<GanttHitDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { count: number; replaced: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number; replaced: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number; replaced: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: { dropped: number }. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Whether to display the built-in tooltip."},{"kind":"paragraph","text":"Event name: `tooltipShow`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipShow', event => {\n  console.log(event.detail); // CartesianTooltipEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"event-tooltipHide","title":"tooltipHide","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipHide`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('tooltipHide', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-tooltipAction","title":"tooltipAction","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianTooltipActionEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `tooltipAction`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianTooltipActionEventDetail>`."},{"kind":"code","source":"chart.addEventListener('tooltipAction', event => {\n  console.log(event.detail); // CartesianTooltipActionEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":"Type definition"}]}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianZoomChangeEventDetail. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"event-crosshairMove","title":"crosshairMove","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: CartesianCrosshairEventDetail | null. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `crosshairMove`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianCrosshairEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('crosshairMove', event => {\n  console.log(event.detail); // CartesianCrosshairEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getCriticalPath","title":"getCriticalPath","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getCriticalPath(): Promise<GanttCriticalPathResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttCriticalPathResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttCriticalPathResult","title":"GanttCriticalPathResult","description":"Type definition"}]}]},{"id":"method-getDependencies","title":"getDependencies","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getDependencies(): Promise<GanttDependencyDataset>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyDataset>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyDataset","title":"GanttDependencyDataset","description":"Type definition"}]}]},{"id":"method-getDependencyPaths","title":"getDependencyPaths","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getDependencyPaths(): Promise<GanttDependencyPath[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyPath[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyPath","title":"GanttDependencyPath","description":"Type definition"}]}]},{"id":"method-hitTestDependency","title":"hitTestDependency","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"hitTestDependency(cssX: number, cssY: number): Promise<GanttDependencyHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"method-getDependencySelection","title":"getDependencySelection","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getDependencySelection(): Promise<GanttDependencySelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencySelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencySelection","title":"GanttDependencySelection","description":"Type definition"}]}]},{"id":"method-selectDependencyAt","title":"selectDependencyAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectDependencyAt(index: number): Promise<GanttDependencyHitDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttDependencyHitDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":"Type definition"}]}]},{"id":"method-showDependencyTooltipAtIndex","title":"showDependencyTooltipAtIndex","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"showDependencyTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail|null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail|null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<GanttRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttRenderResult","title":"GanttRenderResult","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"Requested engine vs what runs, and why (CHART-ADD-08); a frozen or unlicensed chart reports the license outcome."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<GanttEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttEngineTier","title":"GanttEngineTier","description":"Type definition"}]}]},{"id":"method-getUnavailableReason","title":"getUnavailableReason","blocks":[{"kind":"paragraph","text":"Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back."},{"kind":"code","source":"getUnavailableReason(): Promise<string | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<string | undefined>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the bar set."},{"kind":"code","source":"setData(data: GanttData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`GanttData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttData","title":"GanttData","description":"Type definition"}]}]},{"id":"method-getTasks","title":"getTasks","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTasks(): Promise<GanttTask[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttTask[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"method-getTask","title":"getTask","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTask(index: number): Promise<GanttTask | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttTask | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"method-getTaskById","title":"getTaskById","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTaskById(id: string): Promise<GanttTask | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttTask | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":"Type definition"}]}]},{"id":"method-getDiagnostics","title":"getDiagnostics","blocks":[{"kind":"paragraph","text":"Normalization diagnostics for the effective base and stream source."},{"kind":"code","source":"getDiagnostics(): Promise<GanttDiagnostics>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttDiagnostics>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttDiagnostics","title":"GanttDiagnostics","description":"Type definition"}]}]},{"id":"method-getTaskCount","title":"getTaskCount","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTaskCount(): Promise<number>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<number>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<GanttExtent>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttExtent>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttExtent","title":"GanttExtent","description":"Type definition"}]}]},{"id":"method-getLayout","title":"getLayout","blocks":[{"kind":"paragraph","text":"Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom."},{"kind":"code","source":"getLayout(): Promise<GanttLayoutResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttLayoutResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttLayoutResult","title":"GanttLayoutResult","description":"Type definition"}]}]},{"id":"method-getBaselines","title":"getBaselines","blocks":[{"kind":"paragraph","text":"Reference comparisons for every accepted task, including hidden/offscreen baselines. Positive variance means later or longer."},{"kind":"code","source":"getBaselines(): Promise<GanttBaselineComparison[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttBaselineComparison[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttBaselineComparison","title":"GanttBaselineComparison","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(task: GanttTaskInput): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`task`","`GanttTaskInput`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(tasks: ReadonlyArray<GanttTaskInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`tasks`","`ReadonlyArray<GanttTaskInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the oldest streamed categories (the `data` boxes are not the stream)."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(tasks: ReadonlyArray<GanttTaskInput>): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`tasks`","`ReadonlyArray<GanttTaskInput>`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed."},{"kind":"code","source":"getStreamSource(): Promise<GanttStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttStreamSource","title":"GanttStreamSource","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Replay the initial sweep from min → value(s). No-op when animation is off / reduced."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { enabled?: boolean; duration?: number; easing?: GanttEasing; type?: GanttAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ enabled?: boolean; duration?: number; easing?: GanttEasing; type?: GanttAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttEasing","title":"GanttEasing","description":"Type definition"},{"path":"/docs/types/GanttAnimationType","title":"GanttAnimationType","description":"Type definition"}]}]},{"id":"method-hitTest","title":"hitTest","blocks":[{"kind":"paragraph","text":"The box under a host-local CSS point (the nearest slot, within half a pitch), or null."},{"kind":"code","source":"hitTest(cssX: number, cssY: number): Promise<GanttHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"}]}]},{"id":"method-selectTaskAt","title":"selectTaskAt","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"selectTaskAt(index: number): Promise<GanttHitDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<GanttHitDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":"Type definition"}]}]},{"id":"method-clearSelection","title":"clearSelection","blocks":[{"kind":"paragraph","text":"Release the selection (emits selectionChanged when there was one)."},{"kind":"code","source":"clearSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelection","title":"getSelection","blocks":[{"kind":"paragraph","text":"The selection: the selected node's / link's detail (`null` = none); its anchors are Pro-derived, refused without a valid license."},{"kind":"code","source":"getSelection(): Promise<GanttSelection>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttSelection>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttSelection","title":"GanttSelection","description":"Type definition"}]}]},{"id":"method-showTooltipAtIndex","title":"showTooltipAtIndex","blocks":[{"kind":"paragraph","text":"open the tooltip on a box (the facade's `showTooltipAtPoint` routes here); null off the boxes or with the tooltip off."},{"kind":"code","source":"showTooltipAtIndex(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-showTooltipAtPoint","title":"showTooltipAtPoint","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"showTooltipAtPoint(index: number): Promise<CartesianTooltipEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianTooltipEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":"Type definition"}]}]},{"id":"method-hideTooltip","title":"hideTooltip","blocks":[{"kind":"paragraph","text":"Close the currently visible tooltip."},{"kind":"code","source":"hideTooltip(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getTaskEdits","title":"getTaskEdits","blocks":[{"kind":"paragraph","text":"Committed local dates, completion and displaced rows; never mutates caller data."},{"kind":"code","source":"getTaskEdits(): Promise<GanttTaskEdit[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttTaskEdit[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTaskEdit","title":"GanttTaskEdit","description":"Type definition"}]}]},{"id":"method-resetTaskEdits","title":"resetTaskEdits","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"resetTaskEdits(id?: string): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`id`","`string`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-cancelTaskEdit","title":"cancelTaskEdit","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"cancelTaskEdit(): Promise<boolean>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to an explicit millisecond x window. Task rows do not accept y zoom requests."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by milliseconds (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full timestamp extent and axis key (`null` before the first layout)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-getDataTable","title":"getDataTable","blocks":[{"kind":"paragraph","text":"Current normalized table, including the retained stream; independent of GPU availability."},{"kind":"code","source":"getDataTable(): Promise<ChartDataTable>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartDataTable>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":"Type definition"}]}]},{"id":"method-getLabels","title":"getLabels","blocks":[{"kind":"paragraph","text":"the placed node labels in HOST-local CSS px as shown (the plot offset added; under a zoom the labels of the nodes outside the window are left out), shown or hidden with the reason."},{"kind":"code","source":"getLabels(): Promise<GanttLabel[]>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttLabel[]>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttLabel","title":"GanttLabel","description":"Type definition"}]}]},{"id":"method-getTimeAxis","title":"getTimeAxis","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getTimeAxis(): Promise<GanttTimeAxisModel>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<GanttTimeAxisModel>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/GanttTimeAxisModel","title":"GanttTimeAxisModel","description":"Type definition"}]}]},{"id":"method-showCrosshairAt","title":"showCrosshairAt","blocks":[{"kind":"paragraph","text":"Quiet sync API: epoch milliseconds and a zero-based task row; no crosshairMove feedback loop."},{"kind":"code","source":"showCrosshairAt(request: CartesianCrosshairShowRequest): Promise<boolean>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianCrosshairShowRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":"Type definition"}]}]},{"id":"method-hideCrosshair","title":"hideCrosshair","blocks":[{"kind":"paragraph","text":"hide the crosshair shown by `showCrosshairAt` (or the pointer's)."},{"kind":"code","source":"hideCrosshair(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/components/wafer-map","title":"Wafer Map","summary":"Show status and measurements at die coordinates on a wafer.","kind":"component","tag":"sy-wafer-map","componentId":"wafer-map","api":{"props":[{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"500","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"diameter","attribute":"diameter","type":"number","kind":"number","values":[],"default":"300","description":"Wafer diameter in mm (default 300)."},{"name":"edgeExclusion","attribute":"edge-exclusion","type":"number","kind":"number","values":[],"default":"3","description":"Unusable edge band in mm (default 3)."},{"name":"indicator","attribute":"indicator","type":"WaferIndicator","kind":"string","values":["none","flat","notch"],"default":"'notch'","description":"Orientation-mark kind: `notch` (300 mm standard) / `flat` (legacy) / `none`."},{"name":"orientation","attribute":"orientation","type":"WaferOrientation","kind":"string","values":["left","right","down","up"],"default":"'down'","description":"Where the mark points (fab standard: `down`)."},{"name":"flatLength","attribute":"flat-length","type":"number","kind":"number","values":[],"default":"undefined","description":"Flat chord length in mm (default diameter × 0.2)."},{"name":"notchDepth","attribute":"notch-depth","type":"number","kind":"number","values":[],"default":"undefined","description":"Notch depth in mm (default 2.5)."},{"name":"dieWidth","attribute":"die-width","type":"number","kind":"number","values":[],"default":"10","description":"Die size in mm (defaults 10 × 10)."},{"name":"dieHeight","attribute":"die-height","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"scribeX","attribute":"scribe-x","type":"number","kind":"number","values":[],"default":"0.2","description":"Scribe-street widths in mm (defaults 0.2)."},{"name":"scribeY","attribute":"scribe-y","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"offsetX","attribute":"offset-x","type":"number","kind":"number","values":[],"default":"0","description":"Grid shift in mm relative to the centred lattice."},{"name":"offsetY","attribute":"offset-y","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"values","attribute":"values","type":"WaferMapData","kind":"property","values":[],"default":"undefined","description":"An array of dies as { col, row, bin?, value? }."},{"name":"mode","attribute":"mode","type":"WaferMapMode","kind":"string","values":["value","grid","bin","binary"],"default":"'grid'","description":"Choose grid, bin, binary, or value."},{"name":"binColors","attribute":"bin-colors","type":"Readonly<Record<string, string>>","kind":"property","values":[],"default":"undefined","description":"Explicit per-bin colours (`{ [bin]: colour }`) — bin mode only."},{"name":"passBin","attribute":"pass-bin","type":"number | string","kind":"property","values":[],"default":"1","description":"The bin interpreted as a pass."},{"name":"passColor","attribute":"pass-color","type":"string","kind":"string","values":[],"default":"'#16a34a'","description":"Pass-bin fill."},{"name":"failColor","attribute":"fail-color","type":"string","kind":"string","values":[],"default":"'#dc2626'","description":"Fail fill (`mode=\"binary\"` — every non-pass bin)."},{"name":"colorAxis","attribute":"color-axis","type":"WaferValueAxisInput","kind":"property","values":["auto"],"default":"'auto'","description":"Value-axis config for `mode=\"value\"`: `auto` (data extent, blues) or `{min, max, scheme, minColor, maxColor, stops, center}` — a diverging scheme name (rdbu, spectral, …) anchors its midpoint on `center`."},{"name":"showStats","attribute":"show-stats","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the min/mean/σ/median statistics line under the value legend."},{"name":"overlay","attribute":"overlay","type":"'none' | 'defect'","kind":"string","values":["none","defect"],"default":"'none'","description":"Overlay layer on top of any mode: `none` / `defect`."},{"name":"grid","attribute":"grid","type":"'die' | 'shot'","kind":"string","values":["die","shot"],"default":"'die'","description":"Grid chrome: `die` (scribe streets only) or `shot` (+ reticle boundaries)."},{"name":"shotCols","attribute":"shot-cols","type":"number","kind":"number","values":[],"default":"3","description":"Dies per exposure shot (defaults 3 × 2)."},{"name":"shotRows","attribute":"shot-rows","type":"number","kind":"number","values":[],"default":"2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"shotOffsetX","attribute":"shot-offset-x","type":"number","kind":"number","values":[],"default":"0","description":"Shot-grid alignment shift in whole dies."},{"name":"shotOffsetY","attribute":"shot-offset-y","type":"number","kind":"number","values":[],"default":"0","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"shotColor","attribute":"shot-color","type":"string","kind":"string","values":[],"default":"'#334155'","description":"Shot boundary stroke."},{"name":"defects","attribute":"defects","type":"WaferDefectData","kind":"property","values":[],"default":"undefined","description":"Inspection defects (`{x, y, class?, size?}`, wafer mm, notch frame)."},{"name":"defectColor","attribute":"defect-color","type":"string","kind":"string","values":[],"default":"'#0f172a'","description":"Dot colour for unclassified defects (classes cycle the palette)."},{"name":"palette","attribute":"palette","type":"keyof typeof categorical","kind":"string","values":["tableau10","tableau20","observable10","paired12","set3_12"],"default":"'tableau10'","description":"Categorical palette cycled over fail bins (sorted order)."},{"name":"binLegend","attribute":"bin-legend","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the bin legend under the wafer (bin mode)."},{"name":"legendPosition","attribute":"legend-position","type":"WaferMapLegendPosition","kind":"string","values":["top","bottom","left","right","float"],"default":"'bottom'","description":"Storybook parity (2026-09-10) — where the bin legend (`mode=\"bin\"`; the pass / fail readout of `mode=\"binary\"` follows it) sits: docked on an edge of the stage (`top` / `bottom` / `left` / `right`; the band is taken off the wafer) or `float` — an overlay box inside the drawing rectangle anchored by `legend-float-align` / `legend-float-vertical-align`. The line chart's legend contract. The parameter map's gradient + statistics panel (`mode=\"value\"`) keeps its footer."},{"name":"legendFloatAlign","attribute":"legend-float-align","type":"'start' | 'center' | 'end'","kind":"string","values":["start","center","end"],"default":"'end'","description":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"name":"legendFloatVerticalAlign","attribute":"legend-float-vertical-align","type":"'top' | 'middle' | 'bottom'","kind":"string","values":["top","bottom","middle"],"default":"'top'","description":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"name":"legendDraggable","attribute":"legend-draggable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"name":"showPartial","attribute":"show-partial","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Draw edge (partial) dies."},{"name":"showExclusion","attribute":"show-exclusion","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Draw the dashed edge-exclusion ring."},{"name":"dieIndexOrigin","attribute":"die-index-origin","type":"DieIndexOrigin","kind":"string","values":["top-left","center"],"default":"'top-left'","description":"Die-index convention (fab map formats): `top-left` counts from the lattice bounding-box corner, `center` keeps signed notch-frame coordinates. Indices are notch-frame-stable — the view `orientation` never renumbers a die."},{"name":"dieIndexBase","attribute":"die-index-base","type":"number","kind":"number","values":[],"default":"0","description":"First index value (0 or 1)."},{"name":"showDieIndex","attribute":"show-die-index","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Print `ix,iy` inside each die (auto-hides when dies get too small)."},{"name":"waferColor","attribute":"wafer-color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#eef2f7'","description":"Substrate disc fill."},{"name":"dieColor","attribute":"die-color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#cbd5e1'","description":"Full (probeable) die fill."},{"name":"partialColor","attribute":"partial-color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#e2e8f0'","description":"Edge (partial) die fill."},{"name":"dataColor","attribute":"data-color","type":"string | ReadonlyArray<string>","kind":"property","values":[],"default":"'#2563eb'","description":"Fill for dies that carry data (until the mode days colour by it)."},{"name":"edgeColor","attribute":"edge-color","type":"string","kind":"string","values":[],"default":"'rgba(255,255,255,0.9)'","description":"Scribe-street stroke between dies."},{"name":"outlineColor","attribute":"outline-color","type":"string","kind":"string","values":[],"default":"'#64748b'","description":"Wafer outline stroke."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."},{"name":"tooltipShow","attribute":"tooltip-show","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Die tooltip on hover ()."},{"name":"tooltipFormat","attribute":"tooltip-format","type":"(detail: WaferDieEventDetail) => string","kind":"property","values":[],"default":"undefined","description":"Custom tooltip text (return a string; default: index · bin/value · shot)."},{"name":"zoom","attribute":"zoom","type":"CartesianZoomInput","kind":"property","values":["auto","off","true","false","x","y","xy","inside"],"default":"undefined","description":"Storybook parity (2026-09-10) — viewport zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) over the wafer's drawing rectangle (the stage minus the title block and the legend band; x 0 → 1 left → right, y 0 → 1 bottom → top, like a cartesian plot); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches. Property-only."},{"name":"streamSource","attribute":"stream-source","type":"WaferMapStreamSource","kind":"property","values":[],"default":"undefined","description":"A bound die ring (script-set): the chart renders ITS tracked dies on top of `values` and follows its events; unset, the chart keeps an internal ring that the stream methods feed."},{"name":"streamMax","attribute":"stream-max","type":"number","kind":"number","values":[],"default":"undefined","description":"Streamed dies tracked at most (the ring's capacity, default 1,000,000): past it the OLDEST streamed dies leave (`windowSlid`) and revert to the base map. A re-sent cell replaces its result and moves to the newest position."},{"name":"streamWindow","attribute":"stream-window","type":"number","kind":"number","values":[],"default":"undefined","description":"The newest N streamed dies the chart renders on top of `values` (every tracked die when unset); older streamed dies revert to the base map — or to \"no data\" where the base has none."},{"name":"animated","attribute":"animate","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Animate: the initial reveal grows the dies into place from the wafer centre outward; a `values` change and every stream event cross-fade each die whose colour changed from the colour it showed to the next one."},{"name":"animationDuration","attribute":"animation-duration","type":"number","kind":"number","values":[],"default":"600","description":"Animation duration in milliseconds."},{"name":"animationEasing","attribute":"animation-easing","type":"WaferMapEasing","kind":"string","values":["linear","ease-out","ease-in","ease-in-out"],"default":"'ease-out'","description":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"name":"animationType","attribute":"animation-type","type":"WaferMapAnimationType","kind":"string","values":["initial","update"],"default":"undefined","description":"`initial` = the reveal only; `update` = the change morph only; unset = both."},{"name":"engine","attribute":"engine","type":"WaferMapEngineMode","kind":"string","values":["auto","standard","pro"],"default":"'auto'","description":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"name":"unavailable","attribute":"unavailable","type":"WaferMapUnavailableBehaviour","kind":"string","values":["fallback","error","throw"],"default":"'fallback'","description":"Allowed values: fallback, error, throw. Default: 'fallback'."}],"methods":[{"name":"getDefectSummary","parameters":[],"returns":"Promise<{ total: number; offWafer: number; byClass: Array<{ key: string; count: number }> }>","description":"Per-class defect counts over the on-wafer points (`overlay=\"defect\"`)."},{"name":"getShotOf","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<{ shotCol: number; shotRow: number }>","description":"Shot (reticle exposure) coordinate of a lattice cell."},{"name":"hitTestDie","parameters":[{"name":"cssX","type":"number","optional":false},{"name":"cssY","type":"number","optional":false}],"returns":"Promise<WaferDieEventDetail | null>","description":"Die under a component-local CSS point, or null (streets, off-wafer)."},{"name":"selectDie","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<WaferDieEventDetail | null>","description":"Select a die programmatically (null-safe no-op off the lattice)."},{"name":"clearDieSelection","parameters":[],"returns":"Promise<void>","description":"Wafer map: clear the die selection."},{"name":"getSelectedDie","parameters":[],"returns":"Promise<WaferDieEventDetail | null>","description":"The current selection (null when none)."},{"name":"zoomTo","parameters":[{"name":"request","type":"CartesianZoomRequest","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` fractions 0 … 1; `null` clears that orientation)."},{"name":"zoomBy","parameters":[{"name":"factor","type":"number","optional":false},{"name":"anchorFraction","type":"number","optional":true}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"name":"panBy","parameters":[{"name":"delta","type":"{ x?: number; y?: number }","optional":false}],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Slide the zoomed windows by fractions of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"name":"resetZoom","parameters":[],"returns":"Promise<CartesianZoomChangeEventDetail | null>","description":"Reset the zoomed or panned range to the original data range."},{"name":"getZoom","parameters":[],"returns":"Promise<CartesianZoomState | null>","description":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"name":"getZoomExtent","parameters":[{"name":"request","type":"CartesianZoomExtentRequest","optional":true}],"returns":"Promise<CartesianZoomExtentDetail | null>","description":"The full extent of the viewport axes (`[0, 1]` each, key `'0'`)."},{"name":"setData","parameters":[{"name":"values","type":"WaferMapData","optional":false}],"returns":"Promise<void>","description":"Replace the die data set (facade `setData` route) — the base map; the streamed dies stay on top of it."},{"name":"appendPoint","parameters":[{"name":"datum","type":"WaferDieDatum","optional":false}],"returns":"Promise<void>","description":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"appendDie","parameters":[{"name":"datum","type":"WaferDieDatum","optional":false}],"returns":"Promise<void>","description":"Stream one probe result in () — the wafer's name for `appendPoint`."},{"name":"appendBatch","parameters":[{"name":"data","type":"WaferMapData","optional":false}],"returns":"Promise<void>","description":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"name":"shift","parameters":[{"name":"count","type":"number","optional":false}],"returns":"Promise<void>","description":"Drop the `count` oldest streamed dies (`windowSlid`); they revert to the base map. Without `chart.streaming` there is no streamed set apart from the base, and the base never leaves: nothing is dropped."},{"name":"replace","parameters":[{"name":"data","type":"WaferMapData","optional":false}],"returns":"Promise<void>","description":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"name":"getStreamSource","parameters":[],"returns":"Promise<WaferMapStreamSource | undefined>","description":"The die ring in use: the bound `stream-source`, else the internal one (undefined before the first push, and without `chart.streaming`)."},{"name":"updateDie","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false},{"name":"patch","type":"{ bin?: number | string; value?: number }","optional":false}],"returns":"Promise<WaferDieEventDetail | null>","description":"Patch an existing die's data (creates the cell when absent — a late probe log is still a probe log): the merged result streams in through the ring. Returns the resulting detail."},{"name":"setAnimation","parameters":[{"name":"options","type":"{ duration?: number; easing?: WaferMapEasing; enabled?: boolean; type?: WaferMapAnimationType }","optional":false}],"returns":"Promise<void>","description":"An asynchronous method. Check the argument and return types below."},{"name":"pauseAnimation","parameters":[],"returns":"Promise<void>","description":"Pause the current animation."},{"name":"resumeAnimation","parameters":[],"returns":"Promise<void>","description":"Resume a paused animation."},{"name":"replayAnimation","parameters":[],"returns":"Promise<void>","description":"Run the reveal again."},{"name":"getDieCounts","parameters":[],"returns":"Promise<{ dies: number; fullDies: number; partialDies: number }>","description":"Layout + grid summary for tooling/specs."},{"name":"getYield","parameters":[],"returns":"Promise<BinarySummary>","description":"Pass/fail/yield summary over the probed dies (any mode)."},{"name":"getValueStats","parameters":[],"returns":"Promise<WaferValueStats>","description":"Descriptive statistics over the measured on-wafer values (any mode)."},{"name":"getDieIndex","parameters":[{"name":"col","type":"number","optional":false},{"name":"row","type":"number","optional":false}],"returns":"Promise<DieIndexEntry | null>","description":"Map index of a notch-frame lattice cell, or null when off the wafer."},{"name":"getDieByIndex","parameters":[{"name":"ix","type":"number","optional":false},{"name":"iy","type":"number","optional":false}],"returns":"Promise<DieIndexEntry | null>","description":"Die entry addressed by its map index, or null."},{"name":"getActiveTier","parameters":[],"returns":"Promise<WaferMapEngineTier>","description":"An asynchronous method. Check the argument and return types below."},{"name":"redraw","parameters":[],"returns":"Promise<WaferMapRenderResult>","description":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"name":"getEngineStatus","parameters":[],"returns":"Promise<ChartEngineStatus>","description":"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."}],"events":[{"name":"rendered","type":"WaferMapRenderResult & { tier: WaferMapEngineTier }","description":"Emits rendering results in detail when chart drawing completes."},{"name":"dieHover","type":"WaferDieEventDetail | null","description":"Pointer entered/left a die (`null` on leave)."},{"name":"dieClick","type":"WaferDieEventDetail","description":"A die was clicked."},{"name":"dieSelect","type":"WaferDieEventDetail | null","description":"Selection changed (click toggles; `null` when cleared)."},{"name":"pointContextMenu","type":"ChartPointContextMenuEventDetail<WaferDieEventDetail>","description":"A die was right-clicked (the shared point context-menu detail: the die + the pointer's local / viewport position)."},{"name":"appended","type":"{ count: number }","description":"Dies streamed in (`appendPoint` / `appendDie` / `appendBatch` / `updateDie`): the dies the ring stored."},{"name":"windowSlid","type":"{ dropped: number }","description":"The oldest streamed dies left the ring (`stream-max`) or were shifted out — they revert to the base map."},{"name":"chartAnimationStart","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationEnd","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"chartAnimationInterrupted","type":"void","description":"CustomEvent.detail type: void. Event names are case-sensitive."},{"name":"binChanged","type":"{\n    col: number; row: number; ix: number; iy: number;\n    previousBin: number | string; bin: number | string;\n  }","description":"An upsert CHANGED an already-probed die's bin (a re-test flipping the verdict) — the signal a live yield display keys on."},{"name":"zoomChange","type":"CartesianZoomChangeEventDetail","description":"Storybook parity (2026-09-10) — fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."}]},"sections":[{"id":"overview","title":"sy-wafer-map","blocks":[{"kind":"paragraph","text":"Inspect spatial patterns in bins, yield, and parameters."},{"kind":"paragraph","text":"Match diameter, dieWidth, dieHeight, and the coordinate origin to the actual measurement system. Do not treat missing dies as passes."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`values`","An array of dies as { col, row, bin?, value? }."],["`mode`","Choose grid, bin, binary, or value."],["`passBin`","The bin interpreted as a pass."]]},{"kind":"links","items":[{"path":"/charts/wafer-map","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-wafer-map.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-wafer-map\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"values\": [\n          {\n            \"col\": -6,\n            \"row\": -6,\n            \"bin\": 2,\n            \"value\": 95\n          },\n          {\n            \"col\": -5,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 96.93\n          },\n          {\n            \"col\": -4,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 97.96\n          },\n          {\n            \"col\": -3,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 97.59\n          },\n          {\n            \"col\": -2,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 96\n          },\n          {\n            \"col\": -1,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 93.95\n          },\n          {\n            \"col\": 0,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 92.39\n          },\n          {\n            \"col\": 1,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 92.05\n          },\n          {\n            \"col\": 2,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 93.11\n          },\n          {\n            \"col\": 3,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 95.05\n          },\n          {\n            \"col\": 4,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 96.97\n          },\n          {\n            \"col\": 5,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 97.96\n          },\n          {\n            \"col\": 6,\n            \"row\": -6,\n            \"bin\": 1,\n            \"value\": 97.56\n          },\n          {\n            \"col\": -6,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 95.96\n          },\n          {\n            \"col\": -5,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 93.9\n          },\n          {\n            \"col\": -4,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 92.36\n          },\n          {\n            \"col\": -3,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 92.06\n          },\n          {\n            \"col\": -2,\n            \"row\": -5,\n            \"bin\": 2,\n            \"value\": 93.15\n          },\n          {\n            \"col\": -1,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 95.1\n          },\n          {\n            \"col\": 0,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 97.01\n          },\n          {\n            \"col\": 1,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 97.97\n          },\n          {\n            \"col\": 2,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 97.54\n          },\n          {\n            \"col\": 3,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 95.91\n          },\n          {\n            \"col\": 4,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 93.85\n          },\n          {\n            \"col\": 5,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 92.34\n          },\n          {\n            \"col\": 6,\n            \"row\": -5,\n            \"bin\": 1,\n            \"value\": 92.07\n          },\n          {\n            \"col\": -6,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 93.19\n          },\n          {\n            \"col\": -5,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 95.15\n          },\n          {\n            \"col\": -4,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 97.05\n          },\n          {\n            \"col\": -3,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 97.98\n          },\n          {\n            \"col\": -2,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 97.51\n          },\n          {\n            \"col\": -1,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 95.86\n          },\n          {\n            \"col\": 0,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 93.81\n          },\n          {\n            \"col\": 1,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 92.31\n          },\n          {\n            \"col\": 2,\n            \"row\": -4,\n            \"bin\": 2,\n            \"value\": 92.08\n          },\n          {\n            \"col\": 3,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 93.23\n          },\n          {\n            \"col\": 4,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 95.2\n          },\n          {\n            \"col\": 5,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 97.08\n          },\n          {\n            \"col\": 6,\n            \"row\": -4,\n            \"bin\": 1,\n            \"value\": 97.98\n          },\n          {\n            \"col\": -6,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 97.48\n          },\n          {\n            \"col\": -5,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 95.81\n          },\n          {\n            \"col\": -4,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 93.76\n          },\n          {\n            \"col\": -3,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 92.29\n          },\n          {\n            \"col\": -2,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 92.1\n          },\n          {\n            \"col\": -1,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 93.27\n          },\n          {\n            \"col\": 0,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 95.25\n          },\n          {\n            \"col\": 1,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 97.12\n          },\n          {\n            \"col\": 2,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 97.99\n          },\n          {\n            \"col\": 3,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 97.45\n          },\n          {\n            \"col\": 4,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 95.76\n          },\n          {\n            \"col\": 5,\n            \"row\": -3,\n            \"bin\": 1,\n            \"value\": 93.72\n          },\n          {\n            \"col\": 6,\n            \"row\": -3,\n            \"bin\": 2,\n            \"value\": 92.27\n          },\n          {\n            \"col\": -6,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 92.11\n          },\n          {\n            \"col\": -5,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 93.31\n          },\n          {\n            \"col\": -4,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 95.3\n          },\n          {\n            \"col\": -3,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 97.15\n          },\n          {\n            \"col\": -2,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 97.99\n          },\n          {\n            \"col\": -1,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 97.42\n          },\n          {\n            \"col\": 0,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 95.72\n          },\n          {\n            \"col\": 1,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 93.67\n          },\n          {\n            \"col\": 2,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 92.25\n          },\n          {\n            \"col\": 3,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 92.12\n          },\n          {\n            \"col\": 4,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 93.35\n          },\n          {\n            \"col\": 5,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 95.35\n          },\n          {\n            \"col\": 6,\n            \"row\": -2,\n            \"bin\": 1,\n            \"value\": 97.19\n          },\n          {\n            \"col\": -6,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 98\n          },\n          {\n            \"col\": -5,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 97.39\n          },\n          {\n            \"col\": -4,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 95.67\n          },\n          {\n            \"col\": -3,\n            \"row\": -1,\n            \"bin\": 2,\n            \"value\": 93.63\n          },\n          {\n            \"col\": -2,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 92.23\n          },\n          {\n            \"col\": -1,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 92.14\n          },\n          {\n            \"col\": 0,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 93.39\n          },\n          {\n            \"col\": 1,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 95.4\n          },\n          {\n            \"col\": 2,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 97.22\n          },\n          {\n            \"col\": 3,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 98\n          },\n          {\n            \"col\": 4,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 97.36\n          },\n          {\n            \"col\": 5,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 95.62\n          },\n          {\n            \"col\": 6,\n            \"row\": -1,\n            \"bin\": 1,\n            \"value\": 93.58\n          },\n          {\n            \"col\": -6,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 92.21\n          },\n          {\n            \"col\": -5,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 92.15\n          },\n          {\n            \"col\": -4,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 93.44\n          },\n          {\n            \"col\": -3,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 95.45\n          },\n          {\n            \"col\": -2,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 97.26\n          },\n          {\n            \"col\": -1,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 98\n          },\n          {\n            \"col\": 0,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 97.33\n          },\n          {\n            \"col\": 1,\n            \"row\": 0,\n            \"bin\": 2,\n            \"value\": 95.57\n          },\n          {\n            \"col\": 2,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 93.54\n          },\n          {\n            \"col\": 3,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 92.19\n          },\n          {\n            \"col\": 4,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 92.17\n          },\n          {\n            \"col\": 5,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 93.48\n          },\n          {\n            \"col\": 6,\n            \"row\": 0,\n            \"bin\": 1,\n            \"value\": 95.5\n          },\n          {\n            \"col\": -6,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 97.29\n          },\n          {\n            \"col\": -5,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 98\n          },\n          {\n            \"col\": -4,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 97.3\n          },\n          {\n            \"col\": -3,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 95.52\n          },\n          {\n            \"col\": -2,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 93.49\n          },\n          {\n            \"col\": -1,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 92.18\n          },\n          {\n            \"col\": 0,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 92.19\n          },\n          {\n            \"col\": 1,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 93.52\n          },\n          {\n            \"col\": 2,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 95.55\n          },\n          {\n            \"col\": 3,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 97.32\n          },\n          {\n            \"col\": 4,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 98\n          },\n          {\n            \"col\": 5,\n            \"row\": 1,\n            \"bin\": 2,\n            \"value\": 97.27\n          },\n          {\n            \"col\": 6,\n            \"row\": 1,\n            \"bin\": 1,\n            \"value\": 95.47\n          },\n          {\n            \"col\": -6,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 93.45\n          },\n          {\n            \"col\": -5,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 92.16\n          },\n          {\n            \"col\": -4,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 92.21\n          },\n          {\n            \"col\": -3,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 93.57\n          },\n          {\n            \"col\": -2,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 95.6\n          },\n          {\n            \"col\": -1,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 97.35\n          },\n          {\n            \"col\": 0,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 98\n          },\n          {\n            \"col\": 1,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 97.23\n          },\n          {\n            \"col\": 2,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 95.42\n          },\n          {\n            \"col\": 3,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 93.41\n          },\n          {\n            \"col\": 4,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 92.14\n          },\n          {\n            \"col\": 5,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 92.22\n          },\n          {\n            \"col\": 6,\n            \"row\": 2,\n            \"bin\": 1,\n            \"value\": 93.61\n          },\n          {\n            \"col\": -6,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 95.65\n          },\n          {\n            \"col\": -5,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 97.38\n          },\n          {\n            \"col\": -4,\n            \"row\": 3,\n            \"bin\": 2,\n            \"value\": 98\n          },\n          {\n            \"col\": -3,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 97.2\n          },\n          {\n            \"col\": -2,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 95.37\n          },\n          {\n            \"col\": -1,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 93.36\n          },\n          {\n            \"col\": 0,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 92.13\n          },\n          {\n            \"col\": 1,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 92.24\n          },\n          {\n            \"col\": 2,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 93.66\n          },\n          {\n            \"col\": 3,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 95.7\n          },\n          {\n            \"col\": 4,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 97.41\n          },\n          {\n            \"col\": 5,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 97.99\n          },\n          {\n            \"col\": 6,\n            \"row\": 3,\n            \"bin\": 1,\n            \"value\": 97.16\n          },\n          {\n            \"col\": -6,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 95.32\n          },\n          {\n            \"col\": -5,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 93.32\n          },\n          {\n            \"col\": -4,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 92.11\n          },\n          {\n            \"col\": -3,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 92.26\n          },\n          {\n            \"col\": -2,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 93.7\n          },\n          {\n            \"col\": -1,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 95.75\n          },\n          {\n            \"col\": 0,\n            \"row\": 4,\n            \"bin\": 2,\n            \"value\": 97.44\n          },\n          {\n            \"col\": 1,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 97.99\n          },\n          {\n            \"col\": 2,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 97.13\n          },\n          {\n            \"col\": 3,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 95.27\n          },\n          {\n            \"col\": 4,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 93.28\n          },\n          {\n            \"col\": 5,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 92.1\n          },\n          {\n            \"col\": 6,\n            \"row\": 4,\n            \"bin\": 1,\n            \"value\": 92.29\n          },\n          {\n            \"col\": -6,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 93.75\n          },\n          {\n            \"col\": -5,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 95.8\n          },\n          {\n            \"col\": -4,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 97.47\n          },\n          {\n            \"col\": -3,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 97.99\n          },\n          {\n            \"col\": -2,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 97.09\n          },\n          {\n            \"col\": -1,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 95.22\n          },\n          {\n            \"col\": 0,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 93.24\n          },\n          {\n            \"col\": 1,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 92.09\n          },\n          {\n            \"col\": 2,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 92.31\n          },\n          {\n            \"col\": 3,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 93.79\n          },\n          {\n            \"col\": 4,\n            \"row\": 5,\n            \"bin\": 2,\n            \"value\": 95.85\n          },\n          {\n            \"col\": 5,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 97.5\n          },\n          {\n            \"col\": 6,\n            \"row\": 5,\n            \"bin\": 1,\n            \"value\": 97.98\n          },\n          {\n            \"col\": -6,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 97.06\n          },\n          {\n            \"col\": -5,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 95.17\n          },\n          {\n            \"col\": -4,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 93.2\n          },\n          {\n            \"col\": -3,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 92.08\n          },\n          {\n            \"col\": -2,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 92.33\n          },\n          {\n            \"col\": -1,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 93.84\n          },\n          {\n            \"col\": 0,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 95.89\n          },\n          {\n            \"col\": 1,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 97.53\n          },\n          {\n            \"col\": 2,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 97.97\n          },\n          {\n            \"col\": 3,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 97.02\n          },\n          {\n            \"col\": 4,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 95.12\n          },\n          {\n            \"col\": 5,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 93.16\n          },\n          {\n            \"col\": 6,\n            \"row\": 6,\n            \"bin\": 1,\n            \"value\": 92.07\n          }\n        ],\n        \"diameter\": 150,\n        \"dieWidth\": 10,\n        \"dieHeight\": 10,\n        \"mode\": \"bin\",\n        \"passBin\": 1,\n        \"width\": 640,\n        \"height\": 420,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'wafer-map example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('dieClick', event.detail);\n  };\n  chart.addEventListener('dieClick', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('dieClick', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`500`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-diameter","title":"diameter","blocks":[{"kind":"paragraph","text":"Wafer diameter in mm (default 300)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`diameter`"],["HTML attribute","`diameter`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-edgeExclusion","title":"edgeExclusion","blocks":[{"kind":"paragraph","text":"Unusable edge band in mm (default 3)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeExclusion`"],["HTML attribute","`edge-exclusion`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-indicator","title":"indicator","blocks":[{"kind":"paragraph","text":"Orientation-mark kind: `notch` (300 mm standard) / `flat` (legacy) / `none`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`indicator`"],["HTML attribute","`indicator`"],["Type","`WaferIndicator`"],["Default","`'notch'`"],["Allowed values","`none`, `flat`, `notch`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferIndicator","title":"WaferIndicator","description":"Type definition"}]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"Where the mark points (fab standard: `down`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`WaferOrientation`"],["Default","`'down'`"],["Allowed values","`left`, `right`, `down`, `up`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferOrientation","title":"WaferOrientation","description":"Type definition"}]}]},{"id":"property-flatLength","title":"flatLength","blocks":[{"kind":"paragraph","text":"Flat chord length in mm (default diameter × 0.2)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`flatLength`"],["HTML attribute","`flat-length`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-notchDepth","title":"notchDepth","blocks":[{"kind":"paragraph","text":"Notch depth in mm (default 2.5)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`notchDepth`"],["HTML attribute","`notch-depth`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-dieWidth","title":"dieWidth","blocks":[{"kind":"paragraph","text":"Die size in mm (defaults 10 × 10)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieWidth`"],["HTML attribute","`die-width`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-dieHeight","title":"dieHeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieHeight`"],["HTML attribute","`die-height`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-scribeX","title":"scribeX","blocks":[{"kind":"paragraph","text":"Scribe-street widths in mm (defaults 0.2)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeX`"],["HTML attribute","`scribe-x`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-scribeY","title":"scribeY","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeY`"],["HTML attribute","`scribe-y`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-offsetX","title":"offsetX","blocks":[{"kind":"paragraph","text":"Grid shift in mm relative to the centred lattice."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`offsetX`"],["HTML attribute","`offset-x`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-offsetY","title":"offsetY","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`offsetY`"],["HTML attribute","`offset-y`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"An array of dies as { col, row, bin?, value? }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaferMapData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":"Type definition"}]}]},{"id":"property-mode","title":"mode","blocks":[{"kind":"paragraph","text":"Choose grid, bin, binary, or value."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`mode`"],["HTML attribute","`mode`"],["Type","`WaferMapMode`"],["Default","`'grid'`"],["Allowed values","`value`, `grid`, `bin`, `binary`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferMapMode","title":"WaferMapMode","description":"Type definition"}]}]},{"id":"property-binColors","title":"binColors","blocks":[{"kind":"paragraph","text":"Explicit per-bin colours (`{ [bin]: colour }`) — bin mode only."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`binColors`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`Readonly<Record<string, string>>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-passBin","title":"passBin","blocks":[{"kind":"paragraph","text":"The bin interpreted as a pass."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`passBin`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`1`"]]}]},{"id":"property-passColor","title":"passColor","blocks":[{"kind":"paragraph","text":"Pass-bin fill."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`passColor`"],["HTML attribute","`pass-color`"],["Type","`string`"],["Default","`'#16a34a'`"]]}]},{"id":"property-failColor","title":"failColor","blocks":[{"kind":"paragraph","text":"Fail fill (`mode=\"binary\"` — every non-pass bin)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`failColor`"],["HTML attribute","`fail-color`"],["Type","`string`"],["Default","`'#dc2626'`"]]}]},{"id":"property-colorAxis","title":"colorAxis","blocks":[{"kind":"paragraph","text":"Value-axis config for `mode=\"value\"`: `auto` (data extent, blues) or `{min, max, scheme, minColor, maxColor, stops, center}` — a diverging scheme name (rdbu, spectral, …) anchors its midpoint on `center`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaferValueAxisInput`"],["Default","`'auto'`"],["Literals in the type","`auto`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferValueAxisInput","title":"WaferValueAxisInput","description":"Type definition"}]}]},{"id":"property-showStats","title":"showStats","blocks":[{"kind":"paragraph","text":"Show the min/mean/σ/median statistics line under the value legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showStats`"],["HTML attribute","`show-stats`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-overlay","title":"overlay","blocks":[{"kind":"paragraph","text":"Overlay layer on top of any mode: `none` / `defect`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`overlay`"],["HTML attribute","`overlay`"],["Type","`'none' | 'defect'`"],["Default","`'none'`"],["Allowed values","`none`, `defect`"]]}]},{"id":"property-grid","title":"grid","blocks":[{"kind":"paragraph","text":"Grid chrome: `die` (scribe streets only) or `shot` (+ reticle boundaries)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`grid`"],["HTML attribute","`grid`"],["Type","`'die' | 'shot'`"],["Default","`'die'`"],["Allowed values","`die`, `shot`"]]}]},{"id":"property-shotCols","title":"shotCols","blocks":[{"kind":"paragraph","text":"Dies per exposure shot (defaults 3 × 2)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotCols`"],["HTML attribute","`shot-cols`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-shotRows","title":"shotRows","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotRows`"],["HTML attribute","`shot-rows`"],["Type","`number`"],["Default","`2`"]]}]},{"id":"property-shotOffsetX","title":"shotOffsetX","blocks":[{"kind":"paragraph","text":"Shot-grid alignment shift in whole dies."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotOffsetX`"],["HTML attribute","`shot-offset-x`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-shotOffsetY","title":"shotOffsetY","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotOffsetY`"],["HTML attribute","`shot-offset-y`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-shotColor","title":"shotColor","blocks":[{"kind":"paragraph","text":"Shot boundary stroke."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`shotColor`"],["HTML attribute","`shot-color`"],["Type","`string`"],["Default","`'#334155'`"]]}]},{"id":"property-defects","title":"defects","blocks":[{"kind":"paragraph","text":"Inspection defects (`{x, y, class?, size?}`, wafer mm, notch frame)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`defects`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaferDefectData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferDefectData","title":"WaferDefectData","description":"Type definition"}]}]},{"id":"property-defectColor","title":"defectColor","blocks":[{"kind":"paragraph","text":"Dot colour for unclassified defects (classes cycle the palette)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`defectColor`"],["HTML attribute","`defect-color`"],["Type","`string`"],["Default","`'#0f172a'`"]]}]},{"id":"property-palette","title":"palette","blocks":[{"kind":"paragraph","text":"Categorical palette cycled over fail bins (sorted order)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`palette`"],["HTML attribute","`palette`"],["Type","`keyof typeof categorical`"],["Default","`'tableau10'`"],["Allowed values","`tableau10`, `tableau20`, `observable10`, `paired12`, `set3_12`"]]}]},{"id":"property-binLegend","title":"binLegend","blocks":[{"kind":"paragraph","text":"Show the bin legend under the wafer (bin mode)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`binLegend`"],["HTML attribute","`bin-legend`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-legendPosition","title":"legendPosition","blocks":[{"kind":"paragraph","text":"Storybook parity (2026-09-10) — where the bin legend (`mode=\"bin\"`; the pass / fail readout of `mode=\"binary\"` follows it) sits: docked on an edge of the stage (`top` / `bottom` / `left` / `right`; the band is taken off the wafer) or `float` — an overlay box inside the drawing rectangle anchored by `legend-float-align` / `legend-float-vertical-align`. The line chart's legend contract. The parameter map's gradient + statistics panel (`mode=\"value\"`) keeps its footer."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendPosition`"],["HTML attribute","`legend-position`"],["Type","`WaferMapLegendPosition`"],["Default","`'bottom'`"],["Allowed values","`top`, `bottom`, `left`, `right`, `float`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferMapLegendPosition","title":"WaferMapLegendPosition","description":"Type definition"}]}]},{"id":"property-legendFloatAlign","title":"legendFloatAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's horizontal anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatAlign`"],["HTML attribute","`legend-float-align`"],["Type","`'start' | 'center' | 'end'`"],["Default","`'end'`"],["Allowed values","`start`, `center`, `end`"]]}]},{"id":"property-legendFloatVerticalAlign","title":"legendFloatVerticalAlign","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the overlay's vertical anchor inside the drawing rectangle."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendFloatVerticalAlign`"],["HTML attribute","`legend-float-vertical-align`"],["Type","`'top' | 'middle' | 'bottom'`"],["Default","`'top'`"],["Allowed values","`top`, `bottom`, `middle`"]]}]},{"id":"property-legendDraggable","title":"legendDraggable","blocks":[{"kind":"paragraph","text":"`legend-position=\"float\"`: the floating legend can be dragged inside the chart bounds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`legendDraggable`"],["HTML attribute","`legend-draggable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-showPartial","title":"showPartial","blocks":[{"kind":"paragraph","text":"Draw edge (partial) dies."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showPartial`"],["HTML attribute","`show-partial`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-showExclusion","title":"showExclusion","blocks":[{"kind":"paragraph","text":"Draw the dashed edge-exclusion ring."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showExclusion`"],["HTML attribute","`show-exclusion`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-dieIndexOrigin","title":"dieIndexOrigin","blocks":[{"kind":"paragraph","text":"Die-index convention (fab map formats): `top-left` counts from the lattice bounding-box corner, `center` keeps signed notch-frame coordinates. Indices are notch-frame-stable — the view `orientation` never renumbers a die."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieIndexOrigin`"],["HTML attribute","`die-index-origin`"],["Type","`DieIndexOrigin`"],["Default","`'top-left'`"],["Allowed values","`top-left`, `center`"]]},{"kind":"links","items":[{"path":"/docs/types/DieIndexOrigin","title":"DieIndexOrigin","description":"Type definition"}]}]},{"id":"property-dieIndexBase","title":"dieIndexBase","blocks":[{"kind":"paragraph","text":"First index value (0 or 1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieIndexBase`"],["HTML attribute","`die-index-base`"],["Type","`number`"],["Default","`0`"]]}]},{"id":"property-showDieIndex","title":"showDieIndex","blocks":[{"kind":"paragraph","text":"Print `ix,iy` inside each die (auto-hides when dies get too small)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showDieIndex`"],["HTML attribute","`show-die-index`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-waferColor","title":"waferColor","blocks":[{"kind":"paragraph","text":"Substrate disc fill."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`waferColor`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#eef2f7'`"]]}]},{"id":"property-dieColor","title":"dieColor","blocks":[{"kind":"paragraph","text":"Full (probeable) die fill."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieColor`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#cbd5e1'`"]]}]},{"id":"property-partialColor","title":"partialColor","blocks":[{"kind":"paragraph","text":"Edge (partial) die fill."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`partialColor`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#e2e8f0'`"]]}]},{"id":"property-dataColor","title":"dataColor","blocks":[{"kind":"paragraph","text":"Fill for dies that carry data (until the mode days colour by it)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dataColor`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`string | ReadonlyArray<string>`"],["Default","`'#2563eb'`"]]}]},{"id":"property-edgeColor","title":"edgeColor","blocks":[{"kind":"paragraph","text":"Scribe-street stroke between dies."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeColor`"],["HTML attribute","`edge-color`"],["Type","`string`"],["Default","`'rgba(255,255,255,0.9)'`"]]}]},{"id":"property-outlineColor","title":"outlineColor","blocks":[{"kind":"paragraph","text":"Wafer outline stroke."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`outlineColor`"],["HTML attribute","`outline-color`"],["Type","`string`"],["Default","`'#64748b'`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-tooltipShow","title":"tooltipShow","blocks":[{"kind":"paragraph","text":"Die tooltip on hover ()."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipShow`"],["HTML attribute","`tooltip-show`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-tooltipFormat","title":"tooltipFormat","blocks":[{"kind":"paragraph","text":"Custom tooltip text (return a string; default: index · bin/value · shot)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`tooltipFormat`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(detail: WaferDieEventDetail) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"property-zoom","title":"zoom","blocks":[{"kind":"paragraph","text":"Storybook parity (2026-09-10) — viewport zoom: `'x'` | `'y'` | `'xy'` | `true` (x) enable the drag rectangle, the pan, Ctrl + wheel, the pinch and the keyboard (`+` / `-` / `Escape`) over the wafer's drawing rectangle (the stage minus the title block and the legend band; x 0 → 1 left → right, y 0 → 1 bottom → top, like a cartesian plot); an object refines `mode` / `drag` / `keyboard` / `minRangePx` / `resetButton` / `pan` / `wheel` / `pinch` / `inside`. Off by default. `zoomTo` / `zoomBy` / `panBy` / `resetZoom` work regardless of the gesture switches. Property-only."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoom`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianZoomInput`"],["Default","`undefined`"],["Literals in the type","`auto`, `off`, `true`, `false`, `x`, `y`, `xy`, `inside`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":"Type definition"}]}]},{"id":"property-streamSource","title":"streamSource","blocks":[{"kind":"paragraph","text":"A bound die ring (script-set): the chart renders ITS tracked dies on top of `values` and follows its events; unset, the chart keeps an internal ring that the stream methods feed."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamSource`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaferMapStreamSource`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferMapStreamSource","title":"WaferMapStreamSource","description":"Type definition"}]}]},{"id":"property-streamMax","title":"streamMax","blocks":[{"kind":"paragraph","text":"Streamed dies tracked at most (the ring's capacity, default 1,000,000): past it the OLDEST streamed dies leave (`windowSlid`) and revert to the base map. A re-sent cell replaces its result and moves to the newest position."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamMax`"],["HTML attribute","`stream-max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-streamWindow","title":"streamWindow","blocks":[{"kind":"paragraph","text":"The newest N streamed dies the chart renders on top of `values` (every tracked die when unset); older streamed dies revert to the base map — or to \"no data\" where the base has none."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`streamWindow`"],["HTML attribute","`stream-window`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-animated","title":"animated","blocks":[{"kind":"paragraph","text":"Animate: the initial reveal grows the dies into place from the wafer centre outward; a `values` change and every stream event cross-fade each die whose colour changed from the colour it showed to the next one."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animated`"],["HTML attribute","`animate`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-animationDuration","title":"animationDuration","blocks":[{"kind":"paragraph","text":"Animation duration in milliseconds."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationDuration`"],["HTML attribute","`animation-duration`"],["Type","`number`"],["Default","`600`"]]}]},{"id":"property-animationEasing","title":"animationEasing","blocks":[{"kind":"paragraph","text":"Allowed values: linear, ease-out, ease-in, ease-in-out. Default: 'ease-out'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationEasing`"],["HTML attribute","`animation-easing`"],["Type","`WaferMapEasing`"],["Default","`'ease-out'`"],["Allowed values","`linear`, `ease-out`, `ease-in`, `ease-in-out`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferMapEasing","title":"WaferMapEasing","description":"Type definition"}]}]},{"id":"property-animationType","title":"animationType","blocks":[{"kind":"paragraph","text":"`initial` = the reveal only; `update` = the change morph only; unset = both."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`animationType`"],["HTML attribute","`animation-type`"],["Type","`WaferMapAnimationType`"],["Default","`undefined`"],["Allowed values","`initial`, `update`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferMapAnimationType","title":"WaferMapAnimationType","description":"Type definition"}]}]},{"id":"property-engine","title":"engine","blocks":[{"kind":"paragraph","text":"Renderer selection: auto, standard, or pro. Engine selection is separate from permission to use a Pro chart type."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`engine`"],["HTML attribute","`engine`"],["Type","`WaferMapEngineMode`"],["Default","`'auto'`"],["Allowed values","`auto`, `standard`, `pro`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferMapEngineMode","title":"WaferMapEngineMode","description":"Type definition"}]}]},{"id":"property-unavailable","title":"unavailable","blocks":[{"kind":"paragraph","text":"Allowed values: fallback, error, throw. Default: 'fallback'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`unavailable`"],["HTML attribute","`unavailable`"],["Type","`WaferMapUnavailableBehaviour`"],["Default","`'fallback'`"],["Allowed values","`fallback`, `error`, `throw`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferMapUnavailableBehaviour","title":"WaferMapUnavailableBehaviour","description":"Type definition"}]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaferMapRenderResult & { tier: WaferMapEngineTier }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // WaferMapRenderResult & { tier: WaferMapEngineTier }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaferMapRenderResult","title":"WaferMapRenderResult","description":"Type definition"},{"path":"/docs/types/WaferMapEngineTier","title":"WaferMapEngineTier","description":"Type definition"}]}]},{"id":"event-dieHover","title":"dieHover","blocks":[{"kind":"paragraph","text":"Pointer entered/left a die (`null` on leave)."},{"kind":"paragraph","text":"Event name: `dieHover`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaferDieEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('dieHover', event => {\n  console.log(event.detail); // WaferDieEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"event-dieClick","title":"dieClick","blocks":[{"kind":"paragraph","text":"A die was clicked."},{"kind":"paragraph","text":"Event name: `dieClick`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaferDieEventDetail>`."},{"kind":"code","source":"chart.addEventListener('dieClick', event => {\n  console.log(event.detail); // WaferDieEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"event-dieSelect","title":"dieSelect","blocks":[{"kind":"paragraph","text":"Selection changed (click toggles; `null` when cleared)."},{"kind":"paragraph","text":"Event name: `dieSelect`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaferDieEventDetail | null>`."},{"kind":"code","source":"chart.addEventListener('dieSelect', event => {\n  console.log(event.detail); // WaferDieEventDetail | null\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"event-pointContextMenu","title":"pointContextMenu","blocks":[{"kind":"paragraph","text":"A die was right-clicked (the shared point context-menu detail: the die + the pointer's local / viewport position)."},{"kind":"paragraph","text":"Event name: `pointContextMenu`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<ChartPointContextMenuEventDetail<WaferDieEventDetail>>`."},{"kind":"code","source":"chart.addEventListener('pointContextMenu', event => {\n  console.log(event.detail); // ChartPointContextMenuEventDetail<WaferDieEventDetail>\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":"Type definition"},{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"event-appended","title":"appended","blocks":[{"kind":"paragraph","text":"Dies streamed in (`appendPoint` / `appendDie` / `appendBatch` / `updateDie`): the dies the ring stored."},{"kind":"paragraph","text":"Event name: `appended`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ count: number }>`."},{"kind":"code","source":"chart.addEventListener('appended', event => {\n  console.log(event.detail); // { count: number }\n});","language":"javascript"}]},{"id":"event-windowSlid","title":"windowSlid","blocks":[{"kind":"paragraph","text":"The oldest streamed dies left the ring (`stream-max`) or were shifted out — they revert to the base map."},{"kind":"paragraph","text":"Event name: `windowSlid`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{ dropped: number }>`."},{"kind":"code","source":"chart.addEventListener('windowSlid', event => {\n  console.log(event.detail); // { dropped: number }\n});","language":"javascript"}]},{"id":"event-chartAnimationStart","title":"chartAnimationStart","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationStart`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationStart', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationEnd","title":"chartAnimationEnd","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationEnd`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationEnd', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-chartAnimationInterrupted","title":"chartAnimationInterrupted","blocks":[{"kind":"paragraph","text":"CustomEvent.detail type: void. Event names are case-sensitive."},{"kind":"paragraph","text":"Event name: `chartAnimationInterrupted`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<void>`."},{"kind":"code","source":"chart.addEventListener('chartAnimationInterrupted', event => {\n  console.log(event.detail); // void\n});","language":"javascript"}]},{"id":"event-binChanged","title":"binChanged","blocks":[{"kind":"paragraph","text":"An upsert CHANGED an already-probed die's bin (a re-test flipping the verdict) — the signal a live yield display keys on."},{"kind":"paragraph","text":"Event name: `binChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<{\n    col: number; row: number; ix: number; iy: number;\n    previousBin: number | string; bin: number | string;\n  }>`."},{"kind":"code","source":"chart.addEventListener('binChanged', event => {\n  console.log(event.detail); // {\n    col: number; row: number; ix: number; iy: number;\n    previousBin: number | string; bin: number | string;\n  }\n});","language":"javascript"}]},{"id":"event-zoomChange","title":"zoomChange","blocks":[{"kind":"paragraph","text":"Storybook parity (2026-09-10) — fired after every zoom change (drag / pan / wheel / pinch / keyboard / api / reset) with the new state."},{"kind":"paragraph","text":"Event name: `zoomChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<CartesianZoomChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('zoomChange', event => {\n  console.log(event.detail); // CartesianZoomChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getDefectSummary","title":"getDefectSummary","blocks":[{"kind":"paragraph","text":"Per-class defect counts over the on-wafer points (`overlay=\"defect\"`)."},{"kind":"code","source":"getDefectSummary(): Promise<{ total: number; offWafer: number; byClass: Array<{ key: string; count: number }> }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ total: number; offWafer: number; byClass: Array<{ key: string; count: number }> }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getShotOf","title":"getShotOf","blocks":[{"kind":"paragraph","text":"Shot (reticle exposure) coordinate of a lattice cell."},{"kind":"code","source":"getShotOf(col: number, row: number): Promise<{ shotCol: number; shotRow: number }>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<{ shotCol: number; shotRow: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-hitTestDie","title":"hitTestDie","blocks":[{"kind":"paragraph","text":"Die under a component-local CSS point, or null (streets, off-wafer)."},{"kind":"code","source":"hitTestDie(cssX: number, cssY: number): Promise<WaferDieEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`cssX`","`number`","Required"],["`cssY`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WaferDieEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"method-selectDie","title":"selectDie","blocks":[{"kind":"paragraph","text":"Select a die programmatically (null-safe no-op off the lattice)."},{"kind":"code","source":"selectDie(col: number, row: number): Promise<WaferDieEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WaferDieEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"method-clearDieSelection","title":"clearDieSelection","blocks":[{"kind":"paragraph","text":"Wafer map: clear the die selection."},{"kind":"code","source":"clearDieSelection(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelectedDie","title":"getSelectedDie","blocks":[{"kind":"paragraph","text":"The current selection (null when none)."},{"kind":"code","source":"getSelectedDie(): Promise<WaferDieEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaferDieEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"method-zoomTo","title":"zoomTo","blocks":[{"kind":"paragraph","text":"Zoom to explicit windows of the drawing (`x` / `y` as `{ min, max }` or `[min, max]` fractions 0 … 1; `null` clears that orientation)."},{"kind":"code","source":"zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomRequest`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":"Type definition"}]}]},{"id":"method-zoomBy","title":"zoomBy","blocks":[{"kind":"paragraph","text":"Scale the current windows by `factor` (< 1 zooms in) around `anchorFraction` (0..1, default centre)."},{"kind":"code","source":"zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`factor`","`number`","Required"],["`anchorFraction`","`number`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-panBy","title":"panBy","blocks":[{"kind":"paragraph","text":"Slide the zoomed windows by fractions of the drawing (`{ x?, y? }`); a no-op at the full extent."},{"kind":"code","source":"panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`delta`","`{ x?: number; y?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-resetZoom","title":"resetZoom","blocks":[{"kind":"paragraph","text":"Reset the zoomed or panned range to the original data range."},{"kind":"code","source":"resetZoom(): Promise<CartesianZoomChangeEventDetail | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomChangeEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":"Type definition"}]}]},{"id":"method-getZoom","title":"getZoom","blocks":[{"kind":"paragraph","text":"Read the current zoom range. Check the return type's nullability and the range for each axis."},{"kind":"code","source":"getZoom(): Promise<CartesianZoomState | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomState | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":"Type definition"}]}]},{"id":"method-getZoomExtent","title":"getZoomExtent","blocks":[{"kind":"paragraph","text":"The full extent of the viewport axes (`[0, 1]` each, key `'0'`)."},{"kind":"code","source":"getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`request`","`CartesianZoomExtentRequest`","Optional"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomExtentDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":"Type definition"},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":"Type definition"}]}]},{"id":"method-setData","title":"setData","blocks":[{"kind":"paragraph","text":"Replace the die data set (facade `setData` route) — the base map; the streamed dies stay on top of it."},{"kind":"code","source":"setData(values: WaferMapData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`values`","`WaferMapData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":"Type definition"}]}]},{"id":"method-appendPoint","title":"appendPoint","blocks":[{"kind":"paragraph","text":"Append one value to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendPoint(datum: WaferDieDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`WaferDieDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":"Type definition"}]}]},{"id":"method-appendDie","title":"appendDie","blocks":[{"kind":"paragraph","text":"Stream one probe result in () — the wafer's name for `appendPoint`."},{"kind":"code","source":"appendDie(datum: WaferDieDatum): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`datum`","`WaferDieDatum`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":"Type definition"}]}]},{"id":"method-appendBatch","title":"appendBatch","blocks":[{"kind":"paragraph","text":"Append multiple values to the stream. Check the argument type and the licensing requirements for streaming."},{"kind":"code","source":"appendBatch(data: WaferMapData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`WaferMapData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":"Type definition"}]}]},{"id":"method-shift","title":"shift","blocks":[{"kind":"paragraph","text":"Drop the `count` oldest streamed dies (`windowSlid`); they revert to the base map. Without `chart.streaming` there is no streamed set apart from the base, and the base never leaves: nothing is dropped."},{"kind":"code","source":"shift(count: number): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`count`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replace","title":"replace","blocks":[{"kind":"paragraph","text":"Swap the streamed set (`replace([])` clears it); the base `values` never leave. Without `chart.streaming` the dies upsert into the base like a batch (quietly: no `appended`, no `binChanged`, as a ring replace)."},{"kind":"code","source":"replace(data: WaferMapData): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`data`","`WaferMapData`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":"Type definition"}]}]},{"id":"method-getStreamSource","title":"getStreamSource","blocks":[{"kind":"paragraph","text":"The die ring in use: the bound `stream-source`, else the internal one (undefined before the first push, and without `chart.streaming`)."},{"kind":"code","source":"getStreamSource(): Promise<WaferMapStreamSource | undefined>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaferMapStreamSource | undefined>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferMapStreamSource","title":"WaferMapStreamSource","description":"Type definition"}]}]},{"id":"method-updateDie","title":"updateDie","blocks":[{"kind":"paragraph","text":"Patch an existing die's data (creates the cell when absent — a late probe log is still a probe log): the merged result streams in through the ring. Returns the resulting detail."},{"kind":"code","source":"updateDie(col: number, row: number, patch: { bin?: number | string; value?: number }): Promise<WaferDieEventDetail | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"],["`patch`","`{ bin?: number | string; value?: number }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<WaferDieEventDetail | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":"Type definition"}]}]},{"id":"method-setAnimation","title":"setAnimation","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"setAnimation(options: { duration?: number; easing?: WaferMapEasing; enabled?: boolean; type?: WaferMapAnimationType }): Promise<void>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`options`","`{ duration?: number; easing?: WaferMapEasing; enabled?: boolean; type?: WaferMapAnimationType }`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferMapEasing","title":"WaferMapEasing","description":"Type definition"},{"path":"/docs/types/WaferMapAnimationType","title":"WaferMapAnimationType","description":"Type definition"}]}]},{"id":"method-pauseAnimation","title":"pauseAnimation","blocks":[{"kind":"paragraph","text":"Pause the current animation."},{"kind":"code","source":"pauseAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-resumeAnimation","title":"resumeAnimation","blocks":[{"kind":"paragraph","text":"Resume a paused animation."},{"kind":"code","source":"resumeAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-replayAnimation","title":"replayAnimation","blocks":[{"kind":"paragraph","text":"Run the reveal again."},{"kind":"code","source":"replayAnimation(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getDieCounts","title":"getDieCounts","blocks":[{"kind":"paragraph","text":"Layout + grid summary for tooling/specs."},{"kind":"code","source":"getDieCounts(): Promise<{ dies: number; fullDies: number; partialDies: number }>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<{ dies: number; fullDies: number; partialDies: number }>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getYield","title":"getYield","blocks":[{"kind":"paragraph","text":"Pass/fail/yield summary over the probed dies (any mode)."},{"kind":"code","source":"getYield(): Promise<BinarySummary>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<BinarySummary>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/BinarySummary","title":"BinarySummary","description":"Type definition"}]}]},{"id":"method-getValueStats","title":"getValueStats","blocks":[{"kind":"paragraph","text":"Descriptive statistics over the measured on-wafer values (any mode)."},{"kind":"code","source":"getValueStats(): Promise<WaferValueStats>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaferValueStats>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferValueStats","title":"WaferValueStats","description":"Type definition"}]}]},{"id":"method-getDieIndex","title":"getDieIndex","blocks":[{"kind":"paragraph","text":"Map index of a notch-frame lattice cell, or null when off the wafer."},{"kind":"code","source":"getDieIndex(col: number, row: number): Promise<DieIndexEntry | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`col`","`number`","Required"],["`row`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DieIndexEntry | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DieIndexEntry","title":"DieIndexEntry","description":"Type definition"}]}]},{"id":"method-getDieByIndex","title":"getDieByIndex","blocks":[{"kind":"paragraph","text":"Die entry addressed by its map index, or null."},{"kind":"code","source":"getDieByIndex(ix: number, iy: number): Promise<DieIndexEntry | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`ix`","`number`","Required"],["`iy`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<DieIndexEntry | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/DieIndexEntry","title":"DieIndexEntry","description":"Type definition"}]}]},{"id":"method-getActiveTier","title":"getActiveTier","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getActiveTier(): Promise<WaferMapEngineTier>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaferMapEngineTier>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferMapEngineTier","title":"WaferMapEngineTier","description":"Type definition"}]}]},{"id":"method-redraw","title":"redraw","blocks":[{"kind":"paragraph","text":"Redraw the chart using its current data and options. Inspect the rendered result after the returned Promise resolves."},{"kind":"code","source":"redraw(): Promise<WaferMapRenderResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<WaferMapRenderResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferMapRenderResult","title":"WaferMapRenderResult","description":"Type definition"}]}]},{"id":"method-getEngineStatus","title":"getEngineStatus","blocks":[{"kind":"paragraph","text":"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."},{"kind":"code","source":"getEngineStatus(): Promise<ChartEngineStatus>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ChartEngineStatus>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/wafer-stack","title":"Wafer Stack","summary":"Aggregate multiple wafers at matching coordinates.","kind":"component","tag":"sy-wafer-stack","componentId":"wafer-stack","api":{"props":[{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"540","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"wafers","attribute":"wafers","type":"ReadonlyArray<WaferStackWafer>","kind":"property","values":[],"default":"undefined","description":"An array of { id?, values: [{ col, row, bin?, value? }] }."},{"name":"metric","attribute":"metric","type":"WaferStackMetric","kind":"string","values":["fail-count","fail-rate","mean-value"],"default":"'fail-count'","description":"The aggregation: fail-count, fail-rate, or mean-value."},{"name":"passBin","attribute":"pass-bin","type":"number | string","kind":"property","values":[],"default":"1","description":"The pass bin code (default 1)."},{"name":"repeatThreshold","attribute":"repeat-threshold","type":"number","kind":"number","values":[],"default":"undefined","description":"Fail-count at/above which a cell is systematic (default ⌈lot/2⌉)."},{"name":"diameter","attribute":"diameter","type":"number","kind":"number","values":[],"default":"300","description":"Wafer geometry — forwarded to the underlying map."},{"name":"edgeExclusion","attribute":"edge-exclusion","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"indicator","attribute":"indicator","type":"WaferIndicator","kind":"string","values":["none","flat","notch"],"default":"'notch'","description":"Allowed values: none, flat, notch. Default: 'notch'."},{"name":"orientation","attribute":"orientation","type":"WaferOrientation","kind":"string","values":["left","right","down","up"],"default":"'down'","description":"Allowed values: left, right, down, up. Default: 'down'."},{"name":"dieWidth","attribute":"die-width","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"dieHeight","attribute":"die-height","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"scribeX","attribute":"scribe-x","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"scribeY","attribute":"scribe-y","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"showPartial","attribute":"show-partial","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"colorAxis","attribute":"color-axis","type":"WaferValueAxisInput","kind":"property","values":["auto"],"default":"undefined","description":"Value-axis override; defaults per metric (reds 0..lot / 0..1 / auto)."},{"name":"showStats","attribute":"show-stats","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."}],"methods":[{"name":"getStackSummary","parameters":[],"returns":"Promise<Omit<WaferStackResult, 'values'>>","description":"Lot aggregation summary (wafer count, max fail, systematic cells)."}],"events":[{"name":"rendered","type":"WaferMapRenderResult & { tier: 'standard' }","description":"Emits rendering results in detail when chart drawing completes."}]},"sections":[{"id":"overview","title":"sy-wafer-stack","blocks":[{"kind":"paragraph","text":"Inspect recurring failure locations and average parameter patterns."},{"kind":"paragraph","text":"Wafers must share a coordinate system, die dimensions, and orientation for comparison."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`wafers`","An array of { id?, values: [{ col, row, bin?, value? }] }."],["`metric`","The aggregation: fail-count, fail-rate, or mean-value."]]},{"kind":"links","items":[{"path":"/charts/wafer-stack","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-wafer-stack.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-wafer-stack\",\n      \"props\": {\n        \"wafers\": [\n          {\n            \"id\": \"W1\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 95\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.93\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.59\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.95\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.39\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.11\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.05\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.56\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.96\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.9\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.36\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 93.15\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.1\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.01\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.54\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.91\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.85\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.34\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.19\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.15\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.05\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.51\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.86\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.81\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 92.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.23\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.2\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.08\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.48\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.81\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.76\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.27\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.25\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.12\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.45\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.76\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.72\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 92.27\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.31\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.3\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.15\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.42\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.72\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.67\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.25\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.35\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.35\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.19\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.39\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.67\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 93.63\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.39\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.4\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.22\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.36\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.62\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.58\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.15\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.44\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.45\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.26\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.33\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 95.57\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.54\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.17\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.48\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.5\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.29\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.3\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.52\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.49\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.18\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.52\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.55\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.32\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 97.27\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.47\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.45\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.57\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.6\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.35\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.23\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.41\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.22\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.65\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.38\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 2,\n                \"value\": 98\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.2\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.37\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.36\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.13\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.24\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.66\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.7\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.41\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.16\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.32\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.32\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.26\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.7\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.75\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 97.44\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.13\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.27\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.28\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.75\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.8\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.47\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.09\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.22\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.24\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.79\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 95.85\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.5\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.06\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.17\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.2\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.08\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.33\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.84\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.89\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.53\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.02\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.07\n              }\n            ]\n          },\n          {\n            \"id\": \"W2\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.52\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.35\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.88\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.93\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.55\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.99\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.07\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.12\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.37\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.93\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.98\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.58\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.95\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.02\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.09\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.4\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.97\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.03\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.6\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.91\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.97\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 93.05\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.42\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.02\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.08\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.63\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.87\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.92\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.01\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.45\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.07\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.12\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.65\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.83\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 94.87\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.48\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.12\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.17\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.67\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.79\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.82\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.93\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.5\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.16\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.22\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.7\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.91\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 96.75\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.77\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.9\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.53\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.21\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.26\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.71\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.72\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.86\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.56\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.26\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.31\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.74\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 97.88\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.67\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.67\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.83\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.59\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.31\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.35\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.76\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.87\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.63\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.62\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.79\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.62\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.36\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.4\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.58\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.57\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.76\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.65\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.41\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.44\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.84\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.54\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.52\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.73\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.46\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 96.49\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.82\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.82\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.5\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.47\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.72\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.51\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.53\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.83\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.45\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.42\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.66\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.75\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 94.56\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.57\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.41\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.37\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.63\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.78\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.61\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.62\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.86\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.77\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.37\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.32\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.6\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 92.82\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.66\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.66\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.88\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.75\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.32\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.27\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.57\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.85\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.71\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.7\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.89\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.27\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.23\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.54\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.89\n              }\n            ]\n          },\n          {\n            \"id\": \"W3\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.73\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.28\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 94.23\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.55\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.88\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 94.75\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.74\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.71\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.24\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 94.18\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.52\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.92\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.8\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.78\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.68\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.19\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.14\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.49\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.96\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.85\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.82\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.66\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 96.14\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.09\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.46\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.99\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.9\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.86\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.64\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.1\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.04\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.43\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.95\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.9\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 97.61\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.05\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.41\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.93\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.59\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.95\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.38\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.11\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.05\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.97\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 2,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.56\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.95\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.9\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.36\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.15\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.1\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.01\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.54\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.91\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.85\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.34\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.19\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.15\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 97.05\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.51\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.86\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.8\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.23\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.2\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.08\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.48\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.81\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.76\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.27\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 95.25\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.12\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.45\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.76\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.71\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.27\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.31\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.3\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.16\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.42\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.71\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.67\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.25\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 93.35\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.35\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.19\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.39\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.66\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.62\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.39\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.4\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.22\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.36\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.61\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.58\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.44\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.26\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.33\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.56\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.53\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.17\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.48\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.5\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.29\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.3\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.52\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.49\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 92.18\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.52\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.55\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.32\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.27\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.47\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.45\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.57\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.6\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.35\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.23\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 93.4\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.65\n              }\n            ]\n          },\n          {\n            \"id\": \"W4\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.41\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.15\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.22\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.65\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.38\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 97.2\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.37\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.37\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.13\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.24\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.65\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.69\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.41\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.17\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.32\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.33\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.26\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.7\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.74\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.44\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.13\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.27\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.28\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.28\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.74\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.79\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.47\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.1\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.22\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.24\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.79\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.84\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 97.5\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.06\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.17\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.2\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.33\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.83\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.89\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.53\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.02\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.35\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.88\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 2,\n                \"value\": 95.94\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.55\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.99\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.12\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.37\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.93\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.98\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.58\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.95\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.02\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.4\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 93.98\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.03\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.6\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.91\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.97\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.05\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.43\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.02\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.08\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.63\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.87\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.92\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.01\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 92.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.07\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.13\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.65\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.83\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.87\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.97\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.48\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.12\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.17\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.68\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.79\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.82\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.93\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.51\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.17\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.22\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.7\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.91\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.75\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.77\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.9\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.53\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.22\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.27\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.71\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.72\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 2,\n                \"value\": 92.86\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.56\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.26\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.31\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.74\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.88\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.67\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.67\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.83\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.59\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.31\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.36\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.76\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.87\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.63\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 94.62\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.79\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.62\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.36\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.4\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.58\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.57\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.76\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.65\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.41\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.84\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 96.54\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.52\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.72\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.46\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.49\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.82\n              }\n            ]\n          }\n        ],\n        \"diameter\": 150,\n        \"dieWidth\": 10,\n        \"dieHeight\": 10,\n        \"metric\": \"fail-count\",\n        \"width\": 640,\n        \"height\": 420,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'wafer-stack example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('rendered', event.detail);\n  };\n  chart.addEventListener('rendered', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('rendered', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`540`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-wafers","title":"wafers","blocks":[{"kind":"paragraph","text":"An array of { id?, values: [{ col, row, bin?, value? }] }."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wafers`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<WaferStackWafer>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferStackWafer","title":"WaferStackWafer","description":"Type definition"}]}]},{"id":"property-metric","title":"metric","blocks":[{"kind":"paragraph","text":"The aggregation: fail-count, fail-rate, or mean-value."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`metric`"],["HTML attribute","`metric`"],["Type","`WaferStackMetric`"],["Default","`'fail-count'`"],["Allowed values","`fail-count`, `fail-rate`, `mean-value`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferStackMetric","title":"WaferStackMetric","description":"Type definition"}]}]},{"id":"property-passBin","title":"passBin","blocks":[{"kind":"paragraph","text":"The pass bin code (default 1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`passBin`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`1`"]]}]},{"id":"property-repeatThreshold","title":"repeatThreshold","blocks":[{"kind":"paragraph","text":"Fail-count at/above which a cell is systematic (default ⌈lot/2⌉)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`repeatThreshold`"],["HTML attribute","`repeat-threshold`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-diameter","title":"diameter","blocks":[{"kind":"paragraph","text":"Wafer geometry — forwarded to the underlying map."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`diameter`"],["HTML attribute","`diameter`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-edgeExclusion","title":"edgeExclusion","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeExclusion`"],["HTML attribute","`edge-exclusion`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-indicator","title":"indicator","blocks":[{"kind":"paragraph","text":"Allowed values: none, flat, notch. Default: 'notch'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`indicator`"],["HTML attribute","`indicator`"],["Type","`WaferIndicator`"],["Default","`'notch'`"],["Allowed values","`none`, `flat`, `notch`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferIndicator","title":"WaferIndicator","description":"Type definition"}]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"Allowed values: left, right, down, up. Default: 'down'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`WaferOrientation`"],["Default","`'down'`"],["Allowed values","`left`, `right`, `down`, `up`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferOrientation","title":"WaferOrientation","description":"Type definition"}]}]},{"id":"property-dieWidth","title":"dieWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieWidth`"],["HTML attribute","`die-width`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-dieHeight","title":"dieHeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieHeight`"],["HTML attribute","`die-height`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-scribeX","title":"scribeX","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeX`"],["HTML attribute","`scribe-x`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-scribeY","title":"scribeY","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeY`"],["HTML attribute","`scribe-y`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-showPartial","title":"showPartial","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showPartial`"],["HTML attribute","`show-partial`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-colorAxis","title":"colorAxis","blocks":[{"kind":"paragraph","text":"Value-axis override; defaults per metric (reds 0..lot / 0..1 / auto)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaferValueAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferValueAxisInput","title":"WaferValueAxisInput","description":"Type definition"}]}]},{"id":"property-showStats","title":"showStats","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showStats`"],["HTML attribute","`show-stats`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaferMapRenderResult & { tier: 'standard' }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // WaferMapRenderResult & { tier: 'standard' }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaferMapRenderResult","title":"WaferMapRenderResult","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getStackSummary","title":"getStackSummary","blocks":[{"kind":"paragraph","text":"Lot aggregation summary (wafer count, max fail, systematic cells)."},{"kind":"code","source":"getStackSummary(): Promise<Omit<WaferStackResult, 'values'>>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Omit<WaferStackResult, 'values'>>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferStackResult","title":"WaferStackResult","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/wafer-correlation","title":"Wafer Correlation","summary":"Compare spatial patterns between two wafer sets.","kind":"component","tag":"sy-wafer-correlation","componentId":"wafer-correlation","api":{"props":[{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"540","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"wafersA","attribute":"wafers-a","type":"ReadonlyArray<WaferStackWafer>","kind":"property","values":[],"default":"undefined","description":"The first wafer set."},{"name":"wafersB","attribute":"wafers-b","type":"ReadonlyArray<WaferStackWafer>","kind":"property","values":[],"default":"undefined","description":"The second wafer set."},{"name":"metric","attribute":"metric","type":"WaferCorrelationMetric","kind":"string","values":["fail-rate","mean-value"],"default":"'fail-rate'","description":"fail-rate or mean-value."},{"name":"passBin","attribute":"pass-bin","type":"number | string","kind":"property","values":[],"default":"1","description":"Pass as a JavaScript property. type: number | string."},{"name":"labelA","attribute":"label-a","type":"string","kind":"string","values":[],"default":"'A'","description":"Labels for the subtitle (default A/B)."},{"name":"labelB","attribute":"label-b","type":"string","kind":"string","values":[],"default":"'B'","description":"Set as an HTML attribute or JavaScript property. type: string."},{"name":"diameter","attribute":"diameter","type":"number","kind":"number","values":[],"default":"300","description":"Wafer geometry — forwarded to the underlying map."},{"name":"edgeExclusion","attribute":"edge-exclusion","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"indicator","attribute":"indicator","type":"WaferIndicator","kind":"string","values":["none","flat","notch"],"default":"'notch'","description":"Allowed values: none, flat, notch. Default: 'notch'."},{"name":"orientation","attribute":"orientation","type":"WaferOrientation","kind":"string","values":["left","right","down","up"],"default":"'down'","description":"Allowed values: left, right, down, up. Default: 'down'."},{"name":"dieWidth","attribute":"die-width","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"dieHeight","attribute":"die-height","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"scribeX","attribute":"scribe-x","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"scribeY","attribute":"scribe-y","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"showPartial","attribute":"show-partial","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"colorAxis","attribute":"color-axis","type":"WaferValueAxisInput","kind":"property","values":["auto"],"default":"undefined","description":"Value-axis override; default symmetric rdbu centred on 0."},{"name":"showStats","attribute":"show-stats","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."}],"methods":[{"name":"getCorrelationSummary","parameters":[],"returns":"Promise<Omit<WaferCorrelationResult, 'values'>>","description":"Delta/correlation summary (r, mean Δ, worse/better cells)."}],"events":[{"name":"rendered","type":"WaferMapRenderResult & { tier: 'standard' }","description":"Emits rendering results in detail when chart drawing completes."}]},"sections":[{"id":"overview","title":"sy-wafer-correlation","blocks":[{"kind":"paragraph","text":"Inspect relationships in failure rates or measurements before and after processing or between two lots."},{"kind":"paragraph","text":"Use matching die coordinates and geometry settings. Do not infer causes from correlation alone."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`wafersA`","The first wafer set."],["`wafersB`","The second wafer set."],["`metric`","fail-rate or mean-value."]]},{"kind":"links","items":[{"path":"/charts/wafer-correlation","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-wafer-correlation.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-wafer-correlation\",\n      \"props\": {\n        \"wafersA\": [\n          {\n            \"id\": \"W1\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 95\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.93\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.59\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.95\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.39\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.11\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.05\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.56\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.96\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.9\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.36\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 93.15\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.1\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.01\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.54\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.91\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.85\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.34\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.19\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.15\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.05\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.51\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.86\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.81\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 92.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.23\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.2\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.08\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.48\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.81\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.76\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.27\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.25\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.12\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.45\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.76\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.72\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 92.27\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.31\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.3\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.15\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.42\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.72\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.67\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.25\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.35\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.35\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.19\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.39\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.67\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 93.63\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.39\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.4\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.22\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.36\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.62\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.58\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.15\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.44\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.45\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.26\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.33\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 95.57\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.54\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.17\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.48\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.5\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.29\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.3\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.52\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.49\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.18\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.52\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.55\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.32\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 97.27\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.47\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.45\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.57\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.6\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.35\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.23\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.41\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.22\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.65\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.38\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 2,\n                \"value\": 98\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.2\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.37\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.36\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.13\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.24\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.66\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.7\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.41\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.16\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.32\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.32\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.26\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.7\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.75\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 97.44\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.13\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.27\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.28\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.75\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.8\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.47\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.09\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.22\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.24\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.79\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 95.85\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.5\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.06\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.17\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.2\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.08\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.33\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.84\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.89\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.53\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.02\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.07\n              }\n            ]\n          },\n          {\n            \"id\": \"W2\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.52\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.35\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.88\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.93\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.55\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.99\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.07\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.12\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.37\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.93\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.98\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.58\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.95\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.02\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.09\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.4\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.97\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.03\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.6\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.91\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.97\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 93.05\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.42\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.02\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.08\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.63\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.87\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.92\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.01\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.45\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.07\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.12\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.65\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.83\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 94.87\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.48\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.12\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.17\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.67\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.79\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.82\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.93\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.5\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.16\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.22\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.7\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.91\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 96.75\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.77\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.9\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.53\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.21\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.26\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.71\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.72\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.86\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.56\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.26\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.31\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.74\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 97.88\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.67\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.67\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.83\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.59\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.31\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.35\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.76\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.87\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.63\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.62\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.79\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.62\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.36\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.4\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.58\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.57\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.76\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.65\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.41\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.44\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.84\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.54\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.52\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.73\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.46\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 96.49\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.82\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.82\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.5\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.47\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.72\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.51\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.53\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.83\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.45\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.42\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.66\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.75\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 94.56\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.57\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.41\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.37\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.63\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.78\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.61\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.62\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.86\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.77\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.37\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.32\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.6\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 92.82\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.66\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.66\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.88\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.75\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.32\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.27\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.57\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.85\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.71\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.7\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.89\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.27\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.23\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.54\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.89\n              }\n            ]\n          }\n        ],\n        \"wafersB\": [\n          {\n            \"id\": \"W3\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.73\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.28\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 94.23\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.55\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.88\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 94.75\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.74\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.71\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.24\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 94.18\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.52\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.92\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.8\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.78\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.68\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.19\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.14\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.49\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.96\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.85\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.82\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.66\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 96.14\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.09\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.46\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.99\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.9\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.86\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.64\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.1\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.04\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.43\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.95\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.9\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 97.61\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.05\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.41\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.93\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.59\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.95\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.38\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.11\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.05\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.97\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 2,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.56\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.95\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.9\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.36\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.15\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.1\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.01\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.54\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.91\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.85\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.34\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.19\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.15\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 97.05\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.51\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.86\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.8\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.23\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.2\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.08\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.48\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.81\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.76\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.27\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 95.25\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.12\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.45\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.76\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.71\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.27\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.31\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.3\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.16\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.42\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.71\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.67\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.25\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 93.35\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.35\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.19\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.39\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.66\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.62\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.39\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.4\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.22\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.36\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.61\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.58\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.44\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.26\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.33\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.56\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.53\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.17\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.48\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.5\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.29\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.3\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.52\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.49\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 92.18\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.52\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.55\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.32\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.27\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.47\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.45\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.57\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.6\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.35\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.23\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 93.4\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.65\n              }\n            ]\n          },\n          {\n            \"id\": \"W4\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.41\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.15\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.22\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.65\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.38\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 97.2\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.37\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.37\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.13\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.24\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.65\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.69\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.41\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.17\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.32\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.33\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.26\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.7\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.74\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.44\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.13\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.27\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.28\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.28\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.74\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.79\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.47\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.1\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.22\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.24\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.79\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.84\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 97.5\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.06\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.17\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.2\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.33\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.83\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.89\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.53\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.02\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.35\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.88\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 2,\n                \"value\": 95.94\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.55\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.99\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.12\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.37\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.93\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.98\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.58\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.95\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.02\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.4\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 93.98\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.03\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.6\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.91\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.97\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.05\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.43\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.02\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.08\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.63\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.87\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.92\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.01\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 92.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.07\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.13\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.65\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.83\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.87\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.97\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.48\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.12\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.17\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.68\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.79\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.82\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.93\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.51\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.17\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.22\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.7\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.91\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.75\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.77\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.9\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.53\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.22\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.27\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.71\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.72\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 2,\n                \"value\": 92.86\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.56\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.26\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.31\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.74\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.88\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.67\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.67\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.83\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.59\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.31\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.36\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.76\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.87\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.63\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 94.62\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.79\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.62\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.36\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.4\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.58\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.57\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.76\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.65\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.41\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.84\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 96.54\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.52\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.72\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.46\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.49\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.82\n              }\n            ]\n          }\n        ],\n        \"diameter\": 150,\n        \"dieWidth\": 10,\n        \"dieHeight\": 10,\n        \"metric\": \"fail-rate\",\n        \"width\": 640,\n        \"height\": 420,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'wafer-correlation example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('rendered', event.detail);\n  };\n  chart.addEventListener('rendered', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('rendered', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`540`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-wafersA","title":"wafersA","blocks":[{"kind":"paragraph","text":"The first wafer set."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wafersA`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<WaferStackWafer>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferStackWafer","title":"WaferStackWafer","description":"Type definition"}]}]},{"id":"property-wafersB","title":"wafersB","blocks":[{"kind":"paragraph","text":"The second wafer set."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wafersB`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<WaferStackWafer>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferStackWafer","title":"WaferStackWafer","description":"Type definition"}]}]},{"id":"property-metric","title":"metric","blocks":[{"kind":"paragraph","text":"fail-rate or mean-value."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`metric`"],["HTML attribute","`metric`"],["Type","`WaferCorrelationMetric`"],["Default","`'fail-rate'`"],["Allowed values","`fail-rate`, `mean-value`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferCorrelationMetric","title":"WaferCorrelationMetric","description":"Type definition"}]}]},{"id":"property-passBin","title":"passBin","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`passBin`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`1`"]]}]},{"id":"property-labelA","title":"labelA","blocks":[{"kind":"paragraph","text":"Labels for the subtitle (default A/B)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelA`"],["HTML attribute","`label-a`"],["Type","`string`"],["Default","`'A'`"]]}]},{"id":"property-labelB","title":"labelB","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`labelB`"],["HTML attribute","`label-b`"],["Type","`string`"],["Default","`'B'`"]]}]},{"id":"property-diameter","title":"diameter","blocks":[{"kind":"paragraph","text":"Wafer geometry — forwarded to the underlying map."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`diameter`"],["HTML attribute","`diameter`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-edgeExclusion","title":"edgeExclusion","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeExclusion`"],["HTML attribute","`edge-exclusion`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-indicator","title":"indicator","blocks":[{"kind":"paragraph","text":"Allowed values: none, flat, notch. Default: 'notch'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`indicator`"],["HTML attribute","`indicator`"],["Type","`WaferIndicator`"],["Default","`'notch'`"],["Allowed values","`none`, `flat`, `notch`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferIndicator","title":"WaferIndicator","description":"Type definition"}]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"Allowed values: left, right, down, up. Default: 'down'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`WaferOrientation`"],["Default","`'down'`"],["Allowed values","`left`, `right`, `down`, `up`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferOrientation","title":"WaferOrientation","description":"Type definition"}]}]},{"id":"property-dieWidth","title":"dieWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieWidth`"],["HTML attribute","`die-width`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-dieHeight","title":"dieHeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieHeight`"],["HTML attribute","`die-height`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-scribeX","title":"scribeX","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeX`"],["HTML attribute","`scribe-x`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-scribeY","title":"scribeY","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeY`"],["HTML attribute","`scribe-y`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-showPartial","title":"showPartial","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showPartial`"],["HTML attribute","`show-partial`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-colorAxis","title":"colorAxis","blocks":[{"kind":"paragraph","text":"Value-axis override; default symmetric rdbu centred on 0."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`colorAxis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaferValueAxisInput`"],["Default","`undefined`"],["Literals in the type","`auto`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferValueAxisInput","title":"WaferValueAxisInput","description":"Type definition"}]}]},{"id":"property-showStats","title":"showStats","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showStats`"],["HTML attribute","`show-stats`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rendered","title":"rendered","blocks":[{"kind":"paragraph","text":"Emits rendering results in detail when chart drawing completes."},{"kind":"paragraph","text":"Event name: `rendered`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<WaferMapRenderResult & { tier: 'standard' }>`."},{"kind":"code","source":"chart.addEventListener('rendered', event => {\n  console.log(event.detail); // WaferMapRenderResult & { tier: 'standard' }\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/WaferMapRenderResult","title":"WaferMapRenderResult","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getCorrelationSummary","title":"getCorrelationSummary","blocks":[{"kind":"paragraph","text":"Delta/correlation summary (r, mean Δ, worse/better cells)."},{"kind":"code","source":"getCorrelationSummary(): Promise<Omit<WaferCorrelationResult, 'values'>>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<Omit<WaferCorrelationResult, 'values'>>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/WaferCorrelationResult","title":"WaferCorrelationResult","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/yield-zone-chart","title":"Yield Zone Chart","summary":"Summarize yield by zones from the center to the edge.","kind":"component","tag":"sy-yield-zone-chart","componentId":"yield-zone-chart","api":{"props":[{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"520","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"520","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"brandLogo","attribute":"brand-logo","type":"string","kind":"string","values":[],"default":"undefined","description":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"name":"brandPosition","attribute":"brand-position","type":"'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'","kind":"string","values":["top-left","top-right","bottom-left","bottom-right"],"default":"'bottom-right'","description":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"name":"wafers","attribute":"wafers","type":"ReadonlyArray<WaferStackWafer>","kind":"property","values":[],"default":"undefined","description":"The wafers to aggregate."},{"name":"values","attribute":"values","type":"WaferMapData","kind":"property","values":[],"default":"undefined","description":"Alternatively, use one wafer's die array."},{"name":"zones","attribute":"zones","type":"number","kind":"number","values":[],"default":"5","description":"The number of radial zones."},{"name":"zoneEdges","attribute":"zone-edges","type":"ReadonlyArray<number>","kind":"property","values":[],"default":"undefined","description":"Explicit ascending ring outer edges in mm (overrides `zones`)."},{"name":"passBin","attribute":"pass-bin","type":"number | string","kind":"property","values":[],"default":"1","description":"Pass as a JavaScript property. type: number | string."},{"name":"diameter","attribute":"diameter","type":"number","kind":"number","values":[],"default":"300","description":"Wafer geometry."},{"name":"edgeExclusion","attribute":"edge-exclusion","type":"number","kind":"number","values":[],"default":"3","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"indicator","attribute":"indicator","type":"WaferIndicator","kind":"string","values":["none","flat","notch"],"default":"'notch'","description":"Allowed values: none, flat, notch. Default: 'notch'."},{"name":"orientation","attribute":"orientation","type":"WaferOrientation","kind":"string","values":["left","right","down","up"],"default":"'down'","description":"Allowed values: left, right, down, up. Default: 'down'."},{"name":"dieWidth","attribute":"die-width","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"dieHeight","attribute":"die-height","type":"number","kind":"number","values":[],"default":"10","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"scribeX","attribute":"scribe-x","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"scribeY","attribute":"scribe-y","type":"number","kind":"number","values":[],"default":"0.2","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"chartTitle","attribute":"chart-title","type":"string","kind":"string","values":[],"default":"undefined","description":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"name":"chartSubtitle","attribute":"chart-subtitle","type":"string","kind":"string","values":[],"default":"undefined","description":"The subtitle inside the chart."}],"methods":[{"name":"getZoneYields","parameters":[],"returns":"Promise<YieldZoneResult>","description":"Per-zone yields + overall (any time)."}],"events":[]},"sections":[{"id":"overview","title":"sy-yield-zone-chart","blocks":[{"kind":"paragraph","text":"Inspect yield differences along the wafer's radius."},{"kind":"paragraph","text":"Sample counts may differ between zones. Check the number of eligible dies alongside yield."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`wafers`","The wafers to aggregate."],["`values`","Alternatively, use one wafer's die array."],["`zones`","The number of radial zones."]]},{"kind":"links","items":[{"path":"/charts/yield-zone-chart","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-yield-zone-chart.js';\n  define0();\n\n  const specs = [\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-yield-zone-chart\",\n      \"props\": {\n        \"wafers\": [\n          {\n            \"id\": \"W1\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 95\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.93\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.59\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.95\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.39\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.11\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.05\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.56\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.96\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.9\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.36\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 93.15\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.1\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.01\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.54\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.91\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.85\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.34\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.19\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.15\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.05\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.51\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.86\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.81\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 92.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.23\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.2\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.08\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.48\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.81\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.76\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.27\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.25\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.12\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.45\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.76\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.72\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 92.27\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.31\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.3\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.15\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.42\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.72\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.67\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.25\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.35\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.35\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.19\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.39\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.67\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 93.63\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.39\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.4\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.22\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.36\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.62\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.58\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.15\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.44\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.45\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.26\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.33\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 95.57\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.54\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.17\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.48\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.5\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.29\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.3\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.52\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.49\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.18\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.52\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.55\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.32\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 97.27\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.47\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.45\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.57\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.6\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.35\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.23\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.41\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.22\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.65\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.38\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 2,\n                \"value\": 98\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.2\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.37\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.36\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.13\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.24\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.66\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.7\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.41\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.16\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.32\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.32\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.26\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.7\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.75\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 97.44\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.13\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.27\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.28\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.75\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.8\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.47\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.09\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.22\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.24\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.79\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 95.85\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.5\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.06\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.17\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.2\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.08\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.33\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.84\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.89\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.53\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.02\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.07\n              }\n            ]\n          },\n          {\n            \"id\": \"W2\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.52\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.35\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.88\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.93\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.55\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.99\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.07\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.12\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.37\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.93\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.98\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.58\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.95\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.02\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.09\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.4\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.97\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.03\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.6\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.91\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.97\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 93.05\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.42\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.02\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.08\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.63\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.87\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.92\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.01\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.45\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.07\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.12\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.65\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.83\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 94.87\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.97\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.48\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.12\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.17\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.67\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.79\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.82\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.93\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.5\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 94.16\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.22\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.7\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.91\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 96.75\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.77\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.9\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.53\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.21\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.26\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.71\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 94.72\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.86\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.56\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.26\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.31\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.74\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 97.88\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.67\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.67\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.83\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.59\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.31\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.35\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.76\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.87\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.63\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.62\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.79\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.62\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.36\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.4\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.58\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.57\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.76\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.65\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.41\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.44\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.84\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.54\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.52\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.73\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.46\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 96.49\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.82\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.82\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.5\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.47\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.72\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.51\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.53\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.83\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.45\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.42\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.66\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.75\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 94.56\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.57\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.41\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.37\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.63\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.78\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.61\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.62\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.86\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.77\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.37\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.32\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.6\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 92.82\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.66\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.66\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.88\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.75\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.32\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.27\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.57\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.85\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.71\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.7\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.89\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.27\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.23\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.54\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.89\n              }\n            ]\n          },\n          {\n            \"id\": \"W3\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.73\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.28\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 94.23\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.55\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.88\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 94.75\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.74\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.71\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 96.24\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 94.18\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.52\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.92\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.8\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.78\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.68\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.19\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.14\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.49\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.96\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 94.85\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 96.82\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.66\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 2,\n                \"value\": 96.14\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.09\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.46\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.99\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.9\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.86\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.64\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 96.1\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 94.04\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.43\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.03\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 94.95\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.9\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 97.61\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 96.05\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.41\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.93\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.59\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.95\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.38\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.11\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.05\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.97\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 2,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.56\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.95\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.9\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.36\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.15\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.1\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.01\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.54\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.91\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.85\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.34\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.19\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.15\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 2,\n                \"value\": 97.05\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.51\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.86\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.8\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.23\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 95.2\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.08\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.48\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.81\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.76\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.29\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.27\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 95.25\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.12\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.45\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 95.76\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.71\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.27\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.11\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.31\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.3\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.16\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.42\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.71\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 93.67\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.25\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 93.35\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 95.35\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.19\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.39\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.66\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.62\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.39\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.4\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.22\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.36\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 95.61\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 93.58\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 2,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.44\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.26\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.33\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.56\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.53\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.17\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 93.48\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 95.5\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.29\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.3\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.52\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.49\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 92.18\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.19\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.52\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.55\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.32\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.27\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 95.47\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 93.45\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.16\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.21\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.57\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.6\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.35\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.23\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 93.4\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.14\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.23\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 95.65\n              }\n            ]\n          },\n          {\n            \"id\": \"W4\",\n            \"values\": [\n              {\n                \"col\": -6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.42\n              },\n              {\n                \"col\": -5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.41\n              },\n              {\n                \"col\": -4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.15\n              },\n              {\n                \"col\": -3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.22\n              },\n              {\n                \"col\": -2,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.61\n              },\n              {\n                \"col\": -1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.65\n              },\n              {\n                \"col\": 0,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 97.38\n              },\n              {\n                \"col\": 1,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 98\n              },\n              {\n                \"col\": 2,\n                \"row\": -6,\n                \"bin\": 2,\n                \"value\": 97.2\n              },\n              {\n                \"col\": 3,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 95.37\n              },\n              {\n                \"col\": 4,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 93.37\n              },\n              {\n                \"col\": 5,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.13\n              },\n              {\n                \"col\": 6,\n                \"row\": -6,\n                \"bin\": 1,\n                \"value\": 92.24\n              },\n              {\n                \"col\": -6,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.65\n              },\n              {\n                \"col\": -5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.69\n              },\n              {\n                \"col\": -4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.41\n              },\n              {\n                \"col\": -3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.17\n              },\n              {\n                \"col\": -1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.32\n              },\n              {\n                \"col\": 0,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.33\n              },\n              {\n                \"col\": 1,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.12\n              },\n              {\n                \"col\": 2,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 92.26\n              },\n              {\n                \"col\": 3,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 93.7\n              },\n              {\n                \"col\": 4,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 95.74\n              },\n              {\n                \"col\": 5,\n                \"row\": -5,\n                \"bin\": 1,\n                \"value\": 97.44\n              },\n              {\n                \"col\": 6,\n                \"row\": -5,\n                \"bin\": 2,\n                \"value\": 97.99\n              },\n              {\n                \"col\": -6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.13\n              },\n              {\n                \"col\": -5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.27\n              },\n              {\n                \"col\": -4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.28\n              },\n              {\n                \"col\": -3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.1\n              },\n              {\n                \"col\": -2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.28\n              },\n              {\n                \"col\": -1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.74\n              },\n              {\n                \"col\": 0,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.79\n              },\n              {\n                \"col\": 1,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.47\n              },\n              {\n                \"col\": 2,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.99\n              },\n              {\n                \"col\": 3,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 97.1\n              },\n              {\n                \"col\": 4,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 95.22\n              },\n              {\n                \"col\": 5,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 93.24\n              },\n              {\n                \"col\": 6,\n                \"row\": -4,\n                \"bin\": 1,\n                \"value\": 92.09\n              },\n              {\n                \"col\": -6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.31\n              },\n              {\n                \"col\": -5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.79\n              },\n              {\n                \"col\": -4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.84\n              },\n              {\n                \"col\": -3,\n                \"row\": -3,\n                \"bin\": 2,\n                \"value\": 97.5\n              },\n              {\n                \"col\": -2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.98\n              },\n              {\n                \"col\": -1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.06\n              },\n              {\n                \"col\": 0,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.17\n              },\n              {\n                \"col\": 1,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.2\n              },\n              {\n                \"col\": 2,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 92.33\n              },\n              {\n                \"col\": 4,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 93.83\n              },\n              {\n                \"col\": 5,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 95.89\n              },\n              {\n                \"col\": 6,\n                \"row\": -3,\n                \"bin\": 1,\n                \"value\": 97.53\n              },\n              {\n                \"col\": -6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": -5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.02\n              },\n              {\n                \"col\": -4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.12\n              },\n              {\n                \"col\": -3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.16\n              },\n              {\n                \"col\": -2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.07\n              },\n              {\n                \"col\": -1,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 92.35\n              },\n              {\n                \"col\": 0,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.88\n              },\n              {\n                \"col\": 1,\n                \"row\": -2,\n                \"bin\": 2,\n                \"value\": 95.94\n              },\n              {\n                \"col\": 2,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.55\n              },\n              {\n                \"col\": 3,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 97.97\n              },\n              {\n                \"col\": 4,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 96.99\n              },\n              {\n                \"col\": 5,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 95.07\n              },\n              {\n                \"col\": 6,\n                \"row\": -2,\n                \"bin\": 1,\n                \"value\": 93.12\n              },\n              {\n                \"col\": -6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.06\n              },\n              {\n                \"col\": -5,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.37\n              },\n              {\n                \"col\": -4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.93\n              },\n              {\n                \"col\": -3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.98\n              },\n              {\n                \"col\": -2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.58\n              },\n              {\n                \"col\": -1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 97.96\n              },\n              {\n                \"col\": 0,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.95\n              },\n              {\n                \"col\": 1,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 95.02\n              },\n              {\n                \"col\": 2,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 93.08\n              },\n              {\n                \"col\": 3,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.05\n              },\n              {\n                \"col\": 4,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 92.4\n              },\n              {\n                \"col\": 5,\n                \"row\": -1,\n                \"bin\": 2,\n                \"value\": 93.98\n              },\n              {\n                \"col\": 6,\n                \"row\": -1,\n                \"bin\": 1,\n                \"value\": 96.03\n              },\n              {\n                \"col\": -6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.6\n              },\n              {\n                \"col\": -5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.95\n              },\n              {\n                \"col\": -4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.91\n              },\n              {\n                \"col\": -3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.97\n              },\n              {\n                \"col\": -2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 93.05\n              },\n              {\n                \"col\": -1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.04\n              },\n              {\n                \"col\": 0,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 92.43\n              },\n              {\n                \"col\": 1,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.02\n              },\n              {\n                \"col\": 2,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.08\n              },\n              {\n                \"col\": 3,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.63\n              },\n              {\n                \"col\": 4,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 97.94\n              },\n              {\n                \"col\": 5,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 96.87\n              },\n              {\n                \"col\": 6,\n                \"row\": 0,\n                \"bin\": 1,\n                \"value\": 94.92\n              },\n              {\n                \"col\": -6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 93.01\n              },\n              {\n                \"col\": -5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.03\n              },\n              {\n                \"col\": -4,\n                \"row\": 1,\n                \"bin\": 2,\n                \"value\": 92.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.07\n              },\n              {\n                \"col\": -2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.13\n              },\n              {\n                \"col\": -1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.65\n              },\n              {\n                \"col\": 0,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 97.93\n              },\n              {\n                \"col\": 1,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 96.83\n              },\n              {\n                \"col\": 2,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.87\n              },\n              {\n                \"col\": 3,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.97\n              },\n              {\n                \"col\": 4,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 5,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 92.48\n              },\n              {\n                \"col\": 6,\n                \"row\": 1,\n                \"bin\": 1,\n                \"value\": 94.12\n              },\n              {\n                \"col\": -6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.17\n              },\n              {\n                \"col\": -5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.68\n              },\n              {\n                \"col\": -4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.92\n              },\n              {\n                \"col\": -3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.79\n              },\n              {\n                \"col\": -2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.82\n              },\n              {\n                \"col\": -1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.93\n              },\n              {\n                \"col\": 0,\n                \"row\": 2,\n                \"bin\": 2,\n                \"value\": 92.02\n              },\n              {\n                \"col\": 1,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 92.51\n              },\n              {\n                \"col\": 2,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 94.17\n              },\n              {\n                \"col\": 3,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.22\n              },\n              {\n                \"col\": 4,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.7\n              },\n              {\n                \"col\": 5,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 97.91\n              },\n              {\n                \"col\": 6,\n                \"row\": 2,\n                \"bin\": 1,\n                \"value\": 96.75\n              },\n              {\n                \"col\": -6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.77\n              },\n              {\n                \"col\": -5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.9\n              },\n              {\n                \"col\": -4,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": -3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.53\n              },\n              {\n                \"col\": -2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.22\n              },\n              {\n                \"col\": -1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.27\n              },\n              {\n                \"col\": 0,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.72\n              },\n              {\n                \"col\": 1,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 97.9\n              },\n              {\n                \"col\": 2,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 96.71\n              },\n              {\n                \"col\": 3,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 94.72\n              },\n              {\n                \"col\": 4,\n                \"row\": 3,\n                \"bin\": 2,\n                \"value\": 92.86\n              },\n              {\n                \"col\": 5,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 6,\n                \"row\": 3,\n                \"bin\": 1,\n                \"value\": 92.56\n              },\n              {\n                \"col\": -6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.26\n              },\n              {\n                \"col\": -5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.31\n              },\n              {\n                \"col\": -4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.74\n              },\n              {\n                \"col\": -3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.88\n              },\n              {\n                \"col\": -2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.67\n              },\n              {\n                \"col\": -1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.67\n              },\n              {\n                \"col\": 0,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.83\n              },\n              {\n                \"col\": 1,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.01\n              },\n              {\n                \"col\": 2,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 92.59\n              },\n              {\n                \"col\": 3,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 94.31\n              },\n              {\n                \"col\": 4,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 96.36\n              },\n              {\n                \"col\": 5,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.76\n              },\n              {\n                \"col\": 6,\n                \"row\": 4,\n                \"bin\": 1,\n                \"value\": 97.87\n              },\n              {\n                \"col\": -6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.63\n              },\n              {\n                \"col\": -5,\n                \"row\": 5,\n                \"bin\": 2,\n                \"value\": 94.62\n              },\n              {\n                \"col\": -4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.79\n              },\n              {\n                \"col\": -3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.62\n              },\n              {\n                \"col\": -1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.36\n              },\n              {\n                \"col\": 0,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.4\n              },\n              {\n                \"col\": 1,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.78\n              },\n              {\n                \"col\": 2,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 97.85\n              },\n              {\n                \"col\": 3,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 96.58\n              },\n              {\n                \"col\": 4,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 94.57\n              },\n              {\n                \"col\": 5,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92.76\n              },\n              {\n                \"col\": 6,\n                \"row\": 5,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": -6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.65\n              },\n              {\n                \"col\": -5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.41\n              },\n              {\n                \"col\": -4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.45\n              },\n              {\n                \"col\": -3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.8\n              },\n              {\n                \"col\": -2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.84\n              },\n              {\n                \"col\": -1,\n                \"row\": 6,\n                \"bin\": 2,\n                \"value\": 96.54\n              },\n              {\n                \"col\": 0,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.52\n              },\n              {\n                \"col\": 1,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.72\n              },\n              {\n                \"col\": 2,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92\n              },\n              {\n                \"col\": 3,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 92.69\n              },\n              {\n                \"col\": 4,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 94.46\n              },\n              {\n                \"col\": 5,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 96.49\n              },\n              {\n                \"col\": 6,\n                \"row\": 6,\n                \"bin\": 1,\n                \"value\": 97.82\n              }\n            ]\n          }\n        ],\n        \"diameter\": 150,\n        \"dieWidth\": 10,\n        \"dieHeight\": 10,\n        \"zones\": 5,\n        \"width\": 640,\n        \"height\": 420,\n        \"brandPosition\": \"bottom-right\",\n        \"brandLogo\": \"\"\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'yield-zone-chart example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`520`"]]}]},{"id":"property-brandLogo","title":"brandLogo","blocks":[{"kind":"paragraph","text":"The default is the Syidax symbol and wordmark. With the Pro chart.branding entitlement, set none to remove it or provide a PNG, JPEG, or WebP data URL to replace it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandLogo`"],["HTML attribute","`brand-logo`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-brandPosition","title":"brandPosition","blocks":[{"kind":"paragraph","text":"The corner where the logo is anchored. Community and Pro both support all four corners, using the same position on screen and in image exports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`brandPosition`"],["HTML attribute","`brand-position`"],["Type","`'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'`"],["Default","`'bottom-right'`"],["Allowed values","`top-left`, `top-right`, `bottom-left`, `bottom-right`"]]}]},{"id":"property-wafers","title":"wafers","blocks":[{"kind":"paragraph","text":"The wafers to aggregate."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`wafers`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<WaferStackWafer>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferStackWafer","title":"WaferStackWafer","description":"Type definition"}]}]},{"id":"property-values","title":"values","blocks":[{"kind":"paragraph","text":"Alternatively, use one wafer's die array."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`values`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`WaferMapData`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":"Type definition"}]}]},{"id":"property-zones","title":"zones","blocks":[{"kind":"paragraph","text":"The number of radial zones."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zones`"],["HTML attribute","`zones`"],["Type","`number`"],["Default","`5`"]]}]},{"id":"property-zoneEdges","title":"zoneEdges","blocks":[{"kind":"paragraph","text":"Explicit ascending ring outer edges in mm (overrides `zones`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`zoneEdges`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<number>`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-passBin","title":"passBin","blocks":[{"kind":"paragraph","text":"Pass as a JavaScript property. type: number | string."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`passBin`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`1`"]]}]},{"id":"property-diameter","title":"diameter","blocks":[{"kind":"paragraph","text":"Wafer geometry."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`diameter`"],["HTML attribute","`diameter`"],["Type","`number`"],["Default","`300`"]]}]},{"id":"property-edgeExclusion","title":"edgeExclusion","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`edgeExclusion`"],["HTML attribute","`edge-exclusion`"],["Type","`number`"],["Default","`3`"]]}]},{"id":"property-indicator","title":"indicator","blocks":[{"kind":"paragraph","text":"Allowed values: none, flat, notch. Default: 'notch'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`indicator`"],["HTML attribute","`indicator`"],["Type","`WaferIndicator`"],["Default","`'notch'`"],["Allowed values","`none`, `flat`, `notch`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferIndicator","title":"WaferIndicator","description":"Type definition"}]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"Allowed values: left, right, down, up. Default: 'down'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`WaferOrientation`"],["Default","`'down'`"],["Allowed values","`left`, `right`, `down`, `up`"]]},{"kind":"links","items":[{"path":"/docs/types/WaferOrientation","title":"WaferOrientation","description":"Type definition"}]}]},{"id":"property-dieWidth","title":"dieWidth","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieWidth`"],["HTML attribute","`die-width`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-dieHeight","title":"dieHeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dieHeight`"],["HTML attribute","`die-height`"],["Type","`number`"],["Default","`10`"]]}]},{"id":"property-scribeX","title":"scribeX","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeX`"],["HTML attribute","`scribe-x`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-scribeY","title":"scribeY","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`scribeY`"],["HTML attribute","`scribe-y`"],["Type","`number`"],["Default","`0.2`"]]}]},{"id":"property-chartTitle","title":"chartTitle","blocks":[{"kind":"paragraph","text":"The title inside the chart. Explain the data's unit and meaning alongside it."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartTitle`"],["HTML attribute","`chart-title`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-chartSubtitle","title":"chartSubtitle","blocks":[{"kind":"paragraph","text":"The subtitle inside the chart."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`chartSubtitle`"],["HTML attribute","`chart-subtitle`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-getZoneYields","title":"getZoneYields","blocks":[{"kind":"paragraph","text":"Per-zone yields + overall (any time)."},{"kind":"code","source":"getZoneYields(): Promise<YieldZoneResult>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<YieldZoneResult>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/YieldZoneResult","title":"YieldZoneResult","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/data-zoom","title":"Data Zoom","summary":"Change a target chart's visible range with a slider.","kind":"component","tag":"sy-data-zoom","componentId":"data-zoom","api":{"props":[{"name":"for","attribute":"for","type":"string","kind":"string","values":[],"default":"undefined","description":"The target chart's ID."},{"name":"target","attribute":"target","type":"DataZoomTargetElement | null","kind":"property","values":[],"default":"undefined","description":"The chart element to drive (the script-set alternative to `for`)."},{"name":"orientation","attribute":"orientation","type":"DataZoomOrientation","kind":"string","values":["vertical","horizontal"],"default":"'horizontal'","description":"'horizontal' drives the x window, 'vertical' the y window."},{"name":"axis","attribute":"axis","type":"CartesianAxisId","kind":"property","values":[],"default":"undefined","description":"The target axis to control."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"28","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"minRangePx","attribute":"min-range-px","type":"number","kind":"number","values":[],"default":"8","description":"The narrowest window, in track pixels (default 8)."},{"name":"stepFraction","attribute":"step-fraction","type":"number","kind":"number","values":[],"default":"0.1","description":"Fraction of the window one arrow key moves (default 0.1)."},{"name":"showLabels","attribute":"show-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Whether to show labels at both ends of the range."},{"name":"format","attribute":"format","type":"(value: number) => string","kind":"property","values":[],"default":"undefined","description":"Label formatter (default: up to two decimals)."},{"name":"disabled","attribute":"disabled","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."}],"methods":[{"name":"refresh","parameters":[],"returns":"Promise<void>","description":"Re-read the target's extent and window (the slider also does this on the target's `rendered` and `zoomChange`)."},{"name":"setWindow","parameters":[{"name":"window","type":"CartesianZoomWindow | readonly [number, number] | null","optional":false}],"returns":"Promise<CartesianZoomWindow | null>","description":"Set the window from script (`null` = the full extent); the chart follows with `zoomChange.source = 'api'`."},{"name":"getWindow","parameters":[],"returns":"Promise<CartesianZoomWindow | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<ZoomExtent | null>","description":"An asynchronous method. Check the argument and return types below."}],"events":[{"name":"rangeChange","type":"DataZoomRangeChangeEventDetail","description":"Every window the slider shows: gestures / keys ('slider'), the chart moving on its own ('chart'), `setWindow` ('api')."}]},"sections":[{"id":"overview","title":"sy-data-zoom","blocks":[{"kind":"paragraph","text":"Let users select a region of interest within a wide data range."},{"kind":"paragraph","text":"This is not a standalone data chart. Place it in the same document as the target and set for to the target's unique ID."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`for`","The target chart's ID."],["`showLabels`","Whether to show labels at both ends of the range."],["`axis`","The target axis to control."]]},{"kind":"links","items":[{"path":"/charts/data-zoom","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-line-chart.js';\n  import { defineCustomElement as define1 } from '@syidax/advanced/components/sy-data-zoom.js';\n  define0();\n  define1();\n\n  const specs = [\n    {\n      \"tag\": \"sy-line-chart\",\n      \"id\": \"chart-target\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"series\": [\n          {\n            \"name\": \"Organic\",\n            \"color\": \"#8263d9\",\n            \"values\": [24, 29, 27, 38, 43, 40, 52, 58, 53, 68, 76, 84]\n          },\n          {\n            \"name\": \"Direct\",\n            \"color\": \"#239c91\",\n            \"values\": [15, 19, 17, 24, 22, 29, 32, 30, 39, 42, 40, 51]\n          },\n          {\n            \"name\": \"Referral\",\n            \"color\": \"#e99954\",\n            \"values\": [8, 11, 9, 15, 13, 19, 17, 23, 22, 28, 25, 33]\n          }\n        ],\n        \"xAxis\": {\n          \"kind\": \"category\",\n          \"categories\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"]\n        },\n        \"yAxis\": {\n          \"kind\": \"linear\",\n          \"min\": 0\n        },\n        \"zoom\": {\n          \"enabled\": true\n        },\n        \"height\": 280,\n        \"width\": 640\n      }\n    },\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-data-zoom\",\n      \"props\": {\n        \"for\": \"chart-target\",\n        \"showLabels\": true,\n        \"width\": 640,\n        \"height\": 36\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'data-zoom example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('rangeChange', event.detail);\n  };\n  chart.addEventListener('rangeChange', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('rangeChange', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-for","title":"for","blocks":[{"kind":"paragraph","text":"The target chart's ID."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`for`"],["HTML attribute","`for`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-target","title":"target","blocks":[{"kind":"paragraph","text":"The chart element to drive (the script-set alternative to `for`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`target`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`DataZoomTargetElement | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/DataZoomTargetElement","title":"DataZoomTargetElement","description":"Type definition"}]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"'horizontal' drives the x window, 'vertical' the y window."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`DataZoomOrientation`"],["Default","`'horizontal'`"],["Allowed values","`vertical`, `horizontal`"]]},{"kind":"links","items":[{"path":"/docs/types/DataZoomOrientation","title":"DataZoomOrientation","description":"Type definition"}]}]},{"id":"property-axis","title":"axis","blocks":[{"kind":"paragraph","text":"The target axis to control."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisId`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`28`"]]}]},{"id":"property-minRangePx","title":"minRangePx","blocks":[{"kind":"paragraph","text":"The narrowest window, in track pixels (default 8)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minRangePx`"],["HTML attribute","`min-range-px`"],["Type","`number`"],["Default","`8`"]]}]},{"id":"property-stepFraction","title":"stepFraction","blocks":[{"kind":"paragraph","text":"Fraction of the window one arrow key moves (default 0.1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stepFraction`"],["HTML attribute","`step-fraction`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-showLabels","title":"showLabels","blocks":[{"kind":"paragraph","text":"Whether to show labels at both ends of the range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showLabels`"],["HTML attribute","`show-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-format","title":"format","blocks":[{"kind":"paragraph","text":"Label formatter (default: up to two decimals)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`format`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(value: number) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-disabled","title":"disabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`disabled`"],["HTML attribute","`disabled`"],["Type","`boolean`"],["Default","`false`"]]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rangeChange","title":"rangeChange","blocks":[{"kind":"paragraph","text":"Every window the slider shows: gestures / keys ('slider'), the chart moving on its own ('chart'), `setWindow` ('api')."},{"kind":"paragraph","text":"Event name: `rangeChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<DataZoomRangeChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('rangeChange', event => {\n  console.log(event.detail); // DataZoomRangeChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/DataZoomRangeChangeEventDetail","title":"DataZoomRangeChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-refresh","title":"refresh","blocks":[{"kind":"paragraph","text":"Re-read the target's extent and window (the slider also does this on the target's `rendered` and `zoomChange`)."},{"kind":"code","source":"refresh(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setWindow","title":"setWindow","blocks":[{"kind":"paragraph","text":"Set the window from script (`null` = the full extent); the chart follows with `zoomChange.source = 'api'`."},{"kind":"code","source":"setWindow(window: CartesianZoomWindow | readonly [number, number] | null): Promise<CartesianZoomWindow | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`window`","`CartesianZoomWindow | readonly [number, number] | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomWindow | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":"Type definition"}]}]},{"id":"method-getWindow","title":"getWindow","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getWindow(): Promise<CartesianZoomWindow | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomWindow | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":"Type definition"}]}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<ZoomExtent | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ZoomExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ZoomExtent","title":"ZoomExtent","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/navigator","title":"Navigator","summary":"Select a range over a condensed view of the full dataset.","kind":"component","tag":"sy-navigator","componentId":"navigator","api":{"props":[{"name":"for","attribute":"for","type":"string","kind":"string","values":[],"default":"undefined","description":"The target chart's ID."},{"name":"target","attribute":"target","type":"NavigatorTargetElement | null","kind":"property","values":[],"default":"undefined","description":"The chart element to drive (the script-set alternative to `for`)."},{"name":"orientation","attribute":"orientation","type":"DataZoomOrientation","kind":"string","values":["vertical","horizontal"],"default":"'horizontal'","description":"'horizontal' drives the x window (preview along x), 'vertical' the y window (preview along y)."},{"name":"axis","attribute":"axis","type":"CartesianAxisId","kind":"property","values":[],"default":"undefined","description":"Which axis of the target (id or slot index); default: the primary axis of the orientation."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"640","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"60","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"minRangePx","attribute":"min-range-px","type":"number","kind":"number","values":[],"default":"8","description":"The narrowest window, in track pixels (default 8)."},{"name":"stepFraction","attribute":"step-fraction","type":"number","kind":"number","values":[],"default":"0.1","description":"Fraction of the window one arrow key moves (default 0.1)."},{"name":"showLabels","attribute":"show-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the window's min / max next to the handles while zoomed."},{"name":"disabled","attribute":"disabled","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."},{"name":"series","attribute":"series","type":"number | string","kind":"property","values":[],"default":"undefined","description":"The series used in the preview."},{"name":"sampling","attribute":"sampling","type":"NavigatorSampling","kind":"string","values":["minmax","lttb"],"default":"'minmax'","description":"Reduce data with minmax or lttb."}],"methods":[{"name":"refresh","parameters":[],"returns":"Promise<void>","description":"Re-read the chart's extent, data and window (also done on the chart's `rendered`)."},{"name":"setWindow","parameters":[{"name":"window","type":"CartesianZoomWindow | readonly [number, number] | null","optional":false}],"returns":"Promise<CartesianZoomWindow | null>","description":"Set the window from script (`null` = the full extent) through the inner slider."},{"name":"getWindow","parameters":[],"returns":"Promise<CartesianZoomWindow | null>","description":"An asynchronous method. Check the argument and return types below."},{"name":"getExtent","parameters":[],"returns":"Promise<ZoomExtent | null>","description":"An asynchronous method. Check the argument and return types below."}],"events":[]},"sections":[{"id":"overview","title":"sy-navigator","blocks":[{"kind":"paragraph","text":"Provide a zoomed view alongside its full context."},{"kind":"paragraph","text":"Navigator's for points to a target chart in the same document. Distinguish sampled previews from raw data."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`for`","The target chart's ID."],["`sampling`","Reduce data with minmax or lttb."],["`series`","The series used in the preview."]]},{"kind":"links","items":[{"path":"/charts/navigator","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced/components/sy-line-chart.js';\n  import { defineCustomElement as define1 } from '@syidax/advanced/components/sy-navigator.js';\n  define0();\n  define1();\n\n  const specs = [\n    {\n      \"tag\": \"sy-line-chart\",\n      \"id\": \"chart-target\",\n      \"props\": {\n        \"engine\": \"standard\",\n        \"series\": [\n          {\n            \"name\": \"Organic\",\n            \"color\": \"#8263d9\",\n            \"values\": [24, 29, 27, 38, 43, 40, 52, 58, 53, 68, 76, 84]\n          },\n          {\n            \"name\": \"Direct\",\n            \"color\": \"#239c91\",\n            \"values\": [15, 19, 17, 24, 22, 29, 32, 30, 39, 42, 40, 51]\n          },\n          {\n            \"name\": \"Referral\",\n            \"color\": \"#e99954\",\n            \"values\": [8, 11, 9, 15, 13, 19, 17, 23, 22, 28, 25, 33]\n          }\n        ],\n        \"xAxis\": {\n          \"kind\": \"category\",\n          \"categories\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"]\n        },\n        \"yAxis\": {\n          \"kind\": \"linear\",\n          \"min\": 0\n        },\n        \"zoom\": {\n          \"enabled\": true\n        },\n        \"height\": 280,\n        \"width\": 640\n      }\n    },\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-navigator\",\n      \"props\": {\n        \"for\": \"chart-target\",\n        \"sampling\": \"minmax\",\n        \"width\": 640,\n        \"height\": 64\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'navigator example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-for","title":"for","blocks":[{"kind":"paragraph","text":"The target chart's ID."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`for`"],["HTML attribute","`for`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-target","title":"target","blocks":[{"kind":"paragraph","text":"The chart element to drive (the script-set alternative to `for`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`target`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`NavigatorTargetElement | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/NavigatorTargetElement","title":"NavigatorTargetElement","description":"Type definition"}]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"'horizontal' drives the x window (preview along x), 'vertical' the y window (preview along y)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`DataZoomOrientation`"],["Default","`'horizontal'`"],["Allowed values","`vertical`, `horizontal`"]]},{"kind":"links","items":[{"path":"/docs/types/DataZoomOrientation","title":"DataZoomOrientation","description":"Type definition"}]}]},{"id":"property-axis","title":"axis","blocks":[{"kind":"paragraph","text":"Which axis of the target (id or slot index); default: the primary axis of the orientation."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`axis`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`CartesianAxisId`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`640`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`60`"]]}]},{"id":"property-minRangePx","title":"minRangePx","blocks":[{"kind":"paragraph","text":"The narrowest window, in track pixels (default 8)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minRangePx`"],["HTML attribute","`min-range-px`"],["Type","`number`"],["Default","`8`"]]}]},{"id":"property-stepFraction","title":"stepFraction","blocks":[{"kind":"paragraph","text":"Fraction of the window one arrow key moves (default 0.1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stepFraction`"],["HTML attribute","`step-fraction`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-showLabels","title":"showLabels","blocks":[{"kind":"paragraph","text":"Show the window's min / max next to the handles while zoomed."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showLabels`"],["HTML attribute","`show-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-disabled","title":"disabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`disabled`"],["HTML attribute","`disabled`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-series","title":"series","blocks":[{"kind":"paragraph","text":"The series used in the preview."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`series`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`number | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-sampling","title":"sampling","blocks":[{"kind":"paragraph","text":"Reduce data with minmax or lttb."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sampling`"],["HTML attribute","`sampling`"],["Type","`NavigatorSampling`"],["Default","`'minmax'`"],["Allowed values","`minmax`, `lttb`"]]},{"kind":"links","items":[{"path":"/docs/types/NavigatorSampling","title":"NavigatorSampling","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-refresh","title":"refresh","blocks":[{"kind":"paragraph","text":"Re-read the chart's extent, data and window (also done on the chart's `rendered`)."},{"kind":"code","source":"refresh(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setWindow","title":"setWindow","blocks":[{"kind":"paragraph","text":"Set the window from script (`null` = the full extent) through the inner slider."},{"kind":"code","source":"setWindow(window: CartesianZoomWindow | readonly [number, number] | null): Promise<CartesianZoomWindow | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`window`","`CartesianZoomWindow | readonly [number, number] | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomWindow | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":"Type definition"}]}]},{"id":"method-getWindow","title":"getWindow","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getWindow(): Promise<CartesianZoomWindow | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<CartesianZoomWindow | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":"Type definition"}]}]},{"id":"method-getExtent","title":"getExtent","blocks":[{"kind":"paragraph","text":"An asynchronous method. Check the argument and return types below."},{"kind":"code","source":"getExtent(): Promise<ZoomExtent | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<ZoomExtent | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/ZoomExtent","title":"ZoomExtent","description":"Type definition"}]}]}]}]}]},{"path":"/docs/components/visual-map","title":"Visual Map","summary":"Control value-based colors, sizes, and the selected range.","kind":"component","tag":"sy-visual-map","componentId":"visual-map","api":{"props":[{"name":"type","attribute":"type","type":"VisualMapType","kind":"string","values":["continuous","piecewise"],"default":"'continuous'","description":"continuous or piecewise."},{"name":"min","attribute":"min","type":"number","kind":"number","values":[],"default":"undefined","description":"Together with max, defines the value range."},{"name":"max","attribute":"max","type":"number","kind":"number","values":[],"default":"undefined","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"for","attribute":"for","type":"string","kind":"string","values":[],"default":"undefined","description":"The target chart's ID."},{"name":"target","attribute":"target","type":"VisualMapTargetElement | null","kind":"property","values":[],"default":"undefined","description":"the chart element to colour (the script-set alternative to `for`)."},{"name":"dimension","attribute":"dimension","type":"VisualMapDimension","kind":"property","values":["x","y","value","z","index"],"default":"undefined","description":"The data dimension to read."},{"name":"sizeRange","attribute":"size-range","type":"readonly [number, number] | string","kind":"property","values":[],"default":"undefined","description":"visualMap → size: the mark radius (px) at the low / high end of the map (`\"4,16\"` as an attribute); the legend shows size ticks."},{"name":"sizeDimension","attribute":"size-dimension","type":"VisualMapDimension","kind":"property","values":["x","y","value","z","index"],"default":"undefined","description":"the dimension the size reads (default: `dimension`)."},{"name":"outOfRangeSize","attribute":"out-of-range-size","type":"number","kind":"number","values":[],"default":"undefined","description":"the radius of out-of-range values (default: the low end of `sizeRange`)."},{"name":"pieces","attribute":"pieces","type":"ReadonlyArray<VisualMapPieceInput> | string","kind":"property","values":[],"default":"undefined","description":"Piecewise: explicit pieces (`[{ min, max, label, color }]` or `[{ value }]`; a JSON string as an attribute). Wins over `categories` / `splitNumber`."},{"name":"splitNumber","attribute":"split-number","type":"number","kind":"number","values":[],"default":"5","description":"Piecewise: equal intervals over `[min, max]` when no pieces / categories are given (default 5)."},{"name":"categories","attribute":"categories","type":"ReadonlyArray<string | number> | string","kind":"property","values":[],"default":"undefined","description":"Piecewise: discrete values, one piece each (a comma list as an attribute)."},{"name":"selectedMode","attribute":"selected-mode","type":"VisualMapSelectedMode","kind":"string","values":["multiple","single"],"default":"'multiple'","description":"Piecewise: 'multiple' toggles pieces independently, 'single' keeps one piece selected."},{"name":"selected","attribute":"selected","type":"ReadonlyArray<boolean> | null","kind":"property","values":[],"default":"undefined","description":"Piecewise: the initial / controlled selection (`null` = every piece); changing it reports `selectionChanged` with source 'api'."},{"name":"itemWidth","attribute":"item-width","type":"number","kind":"number","values":[],"default":"20","description":"Piecewise: the swatch size of a piece (ECharts itemWidth / itemHeight)."},{"name":"itemHeight","attribute":"item-height","type":"number","kind":"number","values":[],"default":"14","description":"Set as an HTML attribute or JavaScript property. type: number."},{"name":"color","attribute":"color","type":"VisualMapColorInput","kind":"property","values":[],"default":"undefined","description":"The ramp: a scheme name (`viridis`, `blues`, `rdbu`, …), a comma list (`#eff6ff,#1d4ed8`), a colour array, or `[t, colour]` stops."},{"name":"outOfRangeColor","attribute":"out-of-range-color","type":"string","kind":"string","values":[],"default":"'#d1d5db'","description":"The colour of values outside the selected range (and of non-finite values)."},{"name":"orientation","attribute":"orientation","type":"DataZoomOrientation","kind":"string","values":["vertical","horizontal"],"default":"'horizontal'","description":"'horizontal' runs min → max left to right, 'vertical' bottom to top."},{"name":"width","attribute":"width","type":"number","kind":"number","values":[],"default":"320","description":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"name":"height","attribute":"height","type":"number","kind":"number","values":[],"default":"28","description":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"name":"calculable","attribute":"calculable","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Show the two range handles: the selected range can be dragged, keyed and set from script."},{"name":"range","attribute":"range","type":"VisualMapRange | readonly [number, number] | null","kind":"property","values":[],"default":"undefined","description":"The selected range (`null` / unset = the whole domain); changing it reports `rangeChange` with source 'api'."},{"name":"precision","attribute":"precision","type":"number","kind":"number","values":[],"default":"undefined","description":"Fixed decimals for the labels (unset = up to two, trimmed)."},{"name":"format","attribute":"format","type":"(value: number) => string","kind":"property","values":[],"default":"undefined","description":"Label formatter (a property — functions cannot be attributes)."},{"name":"text","attribute":"text","type":"string","kind":"string","values":[],"default":"undefined","description":"End captions instead of the numbers: `\"High,Low\"` (max end first — ECharts `text`)."},{"name":"showLabels","attribute":"show-labels","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Show the end labels, and the handle labels while a range is selected."},{"name":"stepFraction","attribute":"step-fraction","type":"number","kind":"number","values":[],"default":"0.1","description":"Fraction of the selected range one arrow key moves (default 0.1)."},{"name":"minRangePx","attribute":"min-range-px","type":"number","kind":"number","values":[],"default":"8","description":"The narrowest selectable range, in track pixels (default 8)."},{"name":"realtime","attribute":"realtime","type":"boolean","kind":"boolean","values":[],"default":"true","description":"Report the frames of a drag (`live: true`); off = only the release reports."},{"name":"disabled","attribute":"disabled","type":"boolean","kind":"boolean","values":[],"default":"false","description":"Set as an HTML attribute or JavaScript property. type: boolean."}],"methods":[{"name":"refresh","parameters":[],"returns":"Promise<void>","description":"Re-read the bound chart's extent (while `min` / `max` are unset) and push the binding; the control also does this on the chart's `rendered`."},{"name":"setRange","parameters":[{"name":"range","type":"VisualMapRange | readonly [number, number] | null","optional":false}],"returns":"Promise<VisualMapRange | null>","description":"Select a range from script (`null` = the whole domain); reports `rangeChange` with source 'api' when it changed."},{"name":"getRange","parameters":[],"returns":"Promise<VisualMapRange | null>","description":"The resolved range."},{"name":"setSelected","parameters":[{"name":"selected","type":"ReadonlyArray<boolean> | null","optional":false}],"returns":"Promise<boolean[] | null>","description":"piecewise: select pieces from script (`null` = every piece); reports `selectionChanged` with source 'api'."},{"name":"getSelected","parameters":[],"returns":"Promise<boolean[] | null>","description":"piecewise: the per-piece selection (`null` = every piece)."},{"name":"togglePiece","parameters":[{"name":"index","type":"number","optional":false}],"returns":"Promise<boolean[] | null>","description":"piecewise: toggle one piece the way a click does (reports source 'api')."},{"name":"getSpec","parameters":[],"returns":"Promise<VisualMapSnapshot>","description":"The resolved spec plus the selection: continuous → domain, stops, space, out-of-range colour, calculable, precision + `range`; piecewise → the pieces + `selected`."},{"name":"colorAt","parameters":[{"name":"value","type":"number | string","optional":false}],"returns":"Promise<string>","description":"The colour of a value on this map: the ramp / piece colour inside the selection, `outOfRangeColor` outside it."}],"events":[{"name":"rangeChange","type":"VisualMapRangeChangeEventDetail","description":"Every range the control shows: a handle drag / key ('control', with `live` frames), `setRange` or the `range` prop ('api')."},{"name":"selectionChanged","type":"VisualMapSelectionChangeEventDetail","description":"a piecewise map's selection changed (a piece toggled: 'control'; `setSelected` / the `selected` prop: 'api')."}]},"sections":[{"id":"overview","title":"sy-visual-map","blocks":[{"kind":"paragraph","text":"Connect a continuous color legend or interval filters to a chart."},{"kind":"paragraph","text":"Choose a dimension supported by the target. This example connects to Heatmap's value."},{"kind":"paragraph","text":"Base chart tier: Community. Features such as additional renderers and custom branding have separate entitlement requirements."},{"kind":"table","headers":["Input","Data description"],"rows":[["`for`","The target chart's ID."],["`dimension`","The data dimension to read."],["`type`","continuous or piecewise."],["`min`","Together with max, defines the value range."]]},{"kind":"links","items":[{"path":"/charts/visual-map","title":"Run in Components","description":"Change options and view framework-specific code"},{"path":"/docs/getting-started","title":"Shared installation and integration","description":""}]}]},{"id":"example","title":"Complete implementation example","blocks":[{"kind":"code","source":"<div id=\"chart-container\" style=\"width: 100%; min-width: 0;\"></div>\n\n<script type=\"module\">\n  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-heatmap.js';\n  import { defineCustomElement as define1 } from '@syidax/advanced-pro/components/sy-visual-map.js';\n  define0();\n  define1();\n\n  // Pro: complete registerLicense at app startup using your issued certificate.\n  // The website preview certificate is not for use in customer apps.\n  const specs = [\n    {\n      \"tag\": \"sy-heatmap\",\n      \"id\": \"chart-target\",\n      \"props\": {\n        \"data\": [\n          {\n            \"x\": 0,\n            \"y\": 0,\n            \"value\": 10\n          },\n          {\n            \"x\": 1,\n            \"y\": 0,\n            \"value\": 27\n          },\n          {\n            \"x\": 2,\n            \"y\": 0,\n            \"value\": 44\n          },\n          {\n            \"x\": 3,\n            \"y\": 0,\n            \"value\": 61\n          },\n          {\n            \"x\": 4,\n            \"y\": 0,\n            \"value\": 78\n          },\n          {\n            \"x\": 5,\n            \"y\": 0,\n            \"value\": 95\n          },\n          {\n            \"x\": 0,\n            \"y\": 1,\n            \"value\": 22\n          },\n          {\n            \"x\": 1,\n            \"y\": 1,\n            \"value\": 39\n          },\n          {\n            \"x\": 2,\n            \"y\": 1,\n            \"value\": 56\n          },\n          {\n            \"x\": 3,\n            \"y\": 1,\n            \"value\": 73\n          },\n          {\n            \"x\": 4,\n            \"y\": 1,\n            \"value\": 90\n          },\n          {\n            \"x\": 5,\n            \"y\": 1,\n            \"value\": 17\n          },\n          {\n            \"x\": 0,\n            \"y\": 2,\n            \"value\": 34\n          },\n          {\n            \"x\": 1,\n            \"y\": 2,\n            \"value\": 51\n          },\n          {\n            \"x\": 2,\n            \"y\": 2,\n            \"value\": 68\n          },\n          {\n            \"x\": 3,\n            \"y\": 2,\n            \"value\": 85\n          },\n          {\n            \"x\": 4,\n            \"y\": 2,\n            \"value\": 12\n          },\n          {\n            \"x\": 5,\n            \"y\": 2,\n            \"value\": 29\n          },\n          {\n            \"x\": 0,\n            \"y\": 3,\n            \"value\": 46\n          },\n          {\n            \"x\": 1,\n            \"y\": 3,\n            \"value\": 63\n          },\n          {\n            \"x\": 2,\n            \"y\": 3,\n            \"value\": 80\n          },\n          {\n            \"x\": 3,\n            \"y\": 3,\n            \"value\": 97\n          },\n          {\n            \"x\": 4,\n            \"y\": 3,\n            \"value\": 24\n          },\n          {\n            \"x\": 5,\n            \"y\": 3,\n            \"value\": 41\n          },\n          {\n            \"x\": 0,\n            \"y\": 4,\n            \"value\": 58\n          },\n          {\n            \"x\": 1,\n            \"y\": 4,\n            \"value\": 75\n          },\n          {\n            \"x\": 2,\n            \"y\": 4,\n            \"value\": 92\n          },\n          {\n            \"x\": 3,\n            \"y\": 4,\n            \"value\": 19\n          },\n          {\n            \"x\": 4,\n            \"y\": 4,\n            \"value\": 36\n          },\n          {\n            \"x\": 5,\n            \"y\": 4,\n            \"value\": 53\n          }\n        ],\n        \"height\": 280,\n        \"width\": 640\n      }\n    },\n    {\n      \"id\": \"example-chart\",\n      \"tag\": \"sy-visual-map\",\n      \"props\": {\n        \"for\": \"chart-target\",\n        \"type\": \"continuous\",\n        \"dimension\": \"value\",\n        \"min\": 0,\n        \"max\": 100,\n        \"calculable\": true,\n        \"color\": [\"#eee6ff\", \"#8263d9\", \"#34265d\"],\n        \"width\": 640,\n        \"height\": 64\n      }\n    }\n  ];\n  const container = document.querySelector('#chart-container');\n  const elements = specs.map(({ tag, id, props }) => {\n    const element = document.createElement(tag);\n    element.id = id;\n    Object.assign(element, props);\n    element.setAttribute('aria-label', 'visual-map example chart');\n    return element;\n  });\n  container.replaceChildren(...elements);\n  const chart = elements.at(-1);\n  const onEvent = event => {\n    console.log('rangeChange', event.detail);\n  };\n  chart.addEventListener('rangeChange', onEvent);\n  const observer = new ResizeObserver(([entry]) => {\n    const width = Math.max(160, Math.floor(entry.contentRect.width));\n    elements.forEach(element => { element.width = width; });\n  });\n  observer.observe(container);\n\n  // In an SPA, call this function when the view is disposed.\n  function disposeChart() {\n    observer.disconnect();\n    chart.removeEventListener('rangeChange', onEvent);\n    container.replaceChildren();\n  }\n</script>","language":"html"}]},{"id":"props","title":"Properties","blocks":[{"kind":"members","items":[{"id":"property-type","title":"type","blocks":[{"kind":"paragraph","text":"continuous or piecewise."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`type`"],["HTML attribute","`type`"],["Type","`VisualMapType`"],["Default","`'continuous'`"],["Allowed values","`continuous`, `piecewise`"]]},{"kind":"links","items":[{"path":"/docs/types/VisualMapType","title":"VisualMapType","description":"Type definition"}]}]},{"id":"property-min","title":"min","blocks":[{"kind":"paragraph","text":"Together with max, defines the value range."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`min`"],["HTML attribute","`min`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-max","title":"max","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`max`"],["HTML attribute","`max`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-for","title":"for","blocks":[{"kind":"paragraph","text":"The target chart's ID."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`for`"],["HTML attribute","`for`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-target","title":"target","blocks":[{"kind":"paragraph","text":"the chart element to colour (the script-set alternative to `for`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`target`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapTargetElement | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapTargetElement","title":"VisualMapTargetElement","description":"Type definition"}]}]},{"id":"property-dimension","title":"dimension","blocks":[{"kind":"paragraph","text":"The data dimension to read."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`dimension`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapDimension`"],["Default","`undefined`"],["Literals in the type","`x`, `y`, `value`, `z`, `index`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapDimension","title":"VisualMapDimension","description":"Type definition"}]}]},{"id":"property-sizeRange","title":"sizeRange","blocks":[{"kind":"paragraph","text":"visualMap → size: the mark radius (px) at the low / high end of the map (`\"4,16\"` as an attribute); the legend shows size ticks."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sizeRange`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`readonly [number, number] | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-sizeDimension","title":"sizeDimension","blocks":[{"kind":"paragraph","text":"the dimension the size reads (default: `dimension`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`sizeDimension`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapDimension`"],["Default","`undefined`"],["Literals in the type","`x`, `y`, `value`, `z`, `index`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapDimension","title":"VisualMapDimension","description":"Type definition"}]}]},{"id":"property-outOfRangeSize","title":"outOfRangeSize","blocks":[{"kind":"paragraph","text":"the radius of out-of-range values (default: the low end of `sizeRange`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`outOfRangeSize`"],["HTML attribute","`out-of-range-size`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-pieces","title":"pieces","blocks":[{"kind":"paragraph","text":"Piecewise: explicit pieces (`[{ min, max, label, color }]` or `[{ value }]`; a JSON string as an attribute). Wins over `categories` / `splitNumber`."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`pieces`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<VisualMapPieceInput> | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapPieceInput","title":"VisualMapPieceInput","description":"Type definition"}]}]},{"id":"property-splitNumber","title":"splitNumber","blocks":[{"kind":"paragraph","text":"Piecewise: equal intervals over `[min, max]` when no pieces / categories are given (default 5)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`splitNumber`"],["HTML attribute","`split-number`"],["Type","`number`"],["Default","`5`"]]}]},{"id":"property-categories","title":"categories","blocks":[{"kind":"paragraph","text":"Piecewise: discrete values, one piece each (a comma list as an attribute)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`categories`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<string | number> | string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-selectedMode","title":"selectedMode","blocks":[{"kind":"paragraph","text":"Piecewise: 'multiple' toggles pieces independently, 'single' keeps one piece selected."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`selectedMode`"],["HTML attribute","`selected-mode`"],["Type","`VisualMapSelectedMode`"],["Default","`'multiple'`"],["Allowed values","`multiple`, `single`"]]},{"kind":"links","items":[{"path":"/docs/types/VisualMapSelectedMode","title":"VisualMapSelectedMode","description":"Type definition"}]}]},{"id":"property-selected","title":"selected","blocks":[{"kind":"paragraph","text":"Piecewise: the initial / controlled selection (`null` = every piece); changing it reports `selectionChanged` with source 'api'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`selected`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`ReadonlyArray<boolean> | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-itemWidth","title":"itemWidth","blocks":[{"kind":"paragraph","text":"Piecewise: the swatch size of a piece (ECharts itemWidth / itemHeight)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`itemWidth`"],["HTML attribute","`item-width`"],["Type","`number`"],["Default","`20`"]]}]},{"id":"property-itemHeight","title":"itemHeight","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: number."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`itemHeight`"],["HTML attribute","`item-height`"],["Type","`number`"],["Default","`14`"]]}]},{"id":"property-color","title":"color","blocks":[{"kind":"paragraph","text":"The ramp: a scheme name (`viridis`, `blues`, `rdbu`, …), a comma list (`#eff6ff,#1d4ed8`), a colour array, or `[t, colour]` stops."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`color`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapColorInput`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapColorInput","title":"VisualMapColorInput","description":"Type definition"}]}]},{"id":"property-outOfRangeColor","title":"outOfRangeColor","blocks":[{"kind":"paragraph","text":"The colour of values outside the selected range (and of non-finite values)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`outOfRangeColor`"],["HTML attribute","`out-of-range-color`"],["Type","`string`"],["Default","`'#d1d5db'`"]]}]},{"id":"property-orientation","title":"orientation","blocks":[{"kind":"paragraph","text":"'horizontal' runs min → max left to right, 'vertical' bottom to top."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`orientation`"],["HTML attribute","`orientation`"],["Type","`DataZoomOrientation`"],["Default","`'horizontal'`"],["Allowed values","`vertical`, `horizontal`"]]},{"kind":"links","items":[{"path":"/docs/types/DataZoomOrientation","title":"DataZoomOrientation","description":"Type definition"}]}]},{"id":"property-width","title":"width","blocks":[{"kind":"paragraph","text":"Chart width in pixels. If the container width changes, update width from a ResizeObserver."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`width`"],["HTML attribute","`width`"],["Type","`number`"],["Default","`320`"]]}]},{"id":"property-height","title":"height","blocks":[{"kind":"paragraph","text":"Chart height in pixels. Allow space for axes, titles, and the legend."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`height`"],["HTML attribute","`height`"],["Type","`number`"],["Default","`28`"]]}]},{"id":"property-calculable","title":"calculable","blocks":[{"kind":"paragraph","text":"Show the two range handles: the selected range can be dragged, keyed and set from script."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`calculable`"],["HTML attribute","`calculable`"],["Type","`boolean`"],["Default","`false`"]]}]},{"id":"property-range","title":"range","blocks":[{"kind":"paragraph","text":"The selected range (`null` / unset = the whole domain); changing it reports `rangeChange` with source 'api'."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`range`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`VisualMapRange | readonly [number, number] | null`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."},{"kind":"links","items":[{"path":"/docs/types/VisualMapRange","title":"VisualMapRange","description":"Type definition"}]}]},{"id":"property-precision","title":"precision","blocks":[{"kind":"paragraph","text":"Fixed decimals for the labels (unset = up to two, trimmed)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`precision`"],["HTML attribute","`precision`"],["Type","`number`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-format","title":"format","blocks":[{"kind":"paragraph","text":"Label formatter (a property — functions cannot be attributes)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`format`"],["HTML attribute","Pass objects, arrays, and callbacks as JavaScript properties"],["Type","`(value: number) => string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-text","title":"text","blocks":[{"kind":"paragraph","text":"End captions instead of the numbers: `\"High,Low\"` (max end first — ECharts `text`)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`text`"],["HTML attribute","`text`"],["Type","`string`"],["Default","`undefined`"]]},{"kind":"paragraph","text":"undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings."}]},{"id":"property-showLabels","title":"showLabels","blocks":[{"kind":"paragraph","text":"Show the end labels, and the handle labels while a range is selected."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`showLabels`"],["HTML attribute","`show-labels`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-stepFraction","title":"stepFraction","blocks":[{"kind":"paragraph","text":"Fraction of the selected range one arrow key moves (default 0.1)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`stepFraction`"],["HTML attribute","`step-fraction`"],["Type","`number`"],["Default","`0.1`"]]}]},{"id":"property-minRangePx","title":"minRangePx","blocks":[{"kind":"paragraph","text":"The narrowest selectable range, in track pixels (default 8)."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`minRangePx`"],["HTML attribute","`min-range-px`"],["Type","`number`"],["Default","`8`"]]}]},{"id":"property-realtime","title":"realtime","blocks":[{"kind":"paragraph","text":"Report the frames of a drag (`live: true`); off = only the release reports."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`realtime`"],["HTML attribute","`realtime`"],["Type","`boolean`"],["Default","`true`"]]}]},{"id":"property-disabled","title":"disabled","blocks":[{"kind":"paragraph","text":"Set as an HTML attribute or JavaScript property. type: boolean."},{"kind":"table","headers":["Item","Value"],"rows":[["JavaScript property","`disabled`"],["HTML attribute","`disabled`"],["Type","`boolean`"],["Default","`false`"]]}]}]}]},{"id":"events","title":"Events","blocks":[{"kind":"members","items":[{"id":"event-rangeChange","title":"rangeChange","blocks":[{"kind":"paragraph","text":"Every range the control shows: a handle drag / key ('control', with `live` frames), `setRange` or the `range` prop ('api')."},{"kind":"paragraph","text":"Event name: `rangeChange`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<VisualMapRangeChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('rangeChange', event => {\n  console.log(event.detail); // VisualMapRangeChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/VisualMapRangeChangeEventDetail","title":"VisualMapRangeChangeEventDetail","description":"Type definition"}]}]},{"id":"event-selectionChanged","title":"selectionChanged","blocks":[{"kind":"paragraph","text":"a piecewise map's selection changed (a piece toggled: 'control'; `setSelected` / the `selected` prop: 'api')."},{"kind":"paragraph","text":"Event name: `selectionChanged`. Names are case-sensitive. Read the payload from `detail` on `CustomEvent<VisualMapSelectionChangeEventDetail>`."},{"kind":"code","source":"chart.addEventListener('selectionChanged', event => {\n  console.log(event.detail); // VisualMapSelectionChangeEventDetail\n});","language":"javascript"},{"kind":"links","items":[{"path":"/docs/types/VisualMapSelectionChangeEventDetail","title":"VisualMapSelectionChangeEventDetail","description":"Type definition"}]}]}]}]},{"id":"methods","title":"Methods","blocks":[{"kind":"members","items":[{"id":"method-refresh","title":"refresh","blocks":[{"kind":"paragraph","text":"Re-read the bound chart's extent (while `min` / `max` are unset) and push the binding; the control also does this on the chart's `rendered`."},{"kind":"code","source":"refresh(): Promise<void>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<void>`. Call the method after element registration and await its Promise result."}]},{"id":"method-setRange","title":"setRange","blocks":[{"kind":"paragraph","text":"Select a range from script (`null` = the whole domain); reports `rangeChange` with source 'api' when it changed."},{"kind":"code","source":"setRange(range: VisualMapRange | readonly [number, number] | null): Promise<VisualMapRange | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`range`","`VisualMapRange | readonly [number, number] | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<VisualMapRange | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapRange","title":"VisualMapRange","description":"Type definition"}]}]},{"id":"method-getRange","title":"getRange","blocks":[{"kind":"paragraph","text":"The resolved range."},{"kind":"code","source":"getRange(): Promise<VisualMapRange | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapRange | null>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapRange","title":"VisualMapRange","description":"Type definition"}]}]},{"id":"method-setSelected","title":"setSelected","blocks":[{"kind":"paragraph","text":"piecewise: select pieces from script (`null` = every piece); reports `selectionChanged` with source 'api'."},{"kind":"code","source":"setSelected(selected: ReadonlyArray<boolean> | null): Promise<boolean[] | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`selected`","`ReadonlyArray<boolean> | null`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean[] | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSelected","title":"getSelected","blocks":[{"kind":"paragraph","text":"piecewise: the per-piece selection (`null` = every piece)."},{"kind":"code","source":"getSelected(): Promise<boolean[] | null>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<boolean[] | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-togglePiece","title":"togglePiece","blocks":[{"kind":"paragraph","text":"piecewise: toggle one piece the way a click does (reports source 'api')."},{"kind":"code","source":"togglePiece(index: number): Promise<boolean[] | null>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`index`","`number`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<boolean[] | null>`. Call the method after element registration and await its Promise result."}]},{"id":"method-getSpec","title":"getSpec","blocks":[{"kind":"paragraph","text":"The resolved spec plus the selection: continuous → domain, stops, space, out-of-range colour, calculable, precision + `range`; piecewise → the pieces + `selected`."},{"kind":"code","source":"getSpec(): Promise<VisualMapSnapshot>","language":"typescript"},{"kind":"paragraph","text":"Return type: `Promise<VisualMapSnapshot>`. Call the method after element registration and await its Promise result."},{"kind":"links","items":[{"path":"/docs/types/VisualMapSnapshot","title":"VisualMapSnapshot","description":"Type definition"}]}]},{"id":"method-colorAt","title":"colorAt","blocks":[{"kind":"paragraph","text":"The colour of a value on this map: the ramp / piece colour inside the selection, `outOfRangeColor` outside it."},{"kind":"code","source":"colorAt(value: number | string): Promise<string>","language":"typescript"},{"kind":"table","headers":["Arguments","Type","Required"],"rows":[["`value`","`number | string`","Required"]]},{"kind":"paragraph","text":"Return type: `Promise<string>`. Call the method after element registration and await its Promise result."}]}]}]}]},{"path":"/docs/types","title":"Types","summary":"Types referenced by public properties, events, and methods, together with their dependencies.","kind":"types","sections":[{"id":"A","title":"A","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartAnimationType","title":"AreaChartAnimationType","description":""},{"path":"/docs/types/AreaChartDatum","title":"AreaChartDatum","description":""},{"path":"/docs/types/AreaChartEasing","title":"AreaChartEasing","description":""},{"path":"/docs/types/AreaChartEngineMode","title":"AreaChartEngineMode","description":""},{"path":"/docs/types/AreaChartEngineTier","title":"AreaChartEngineTier","description":""},{"path":"/docs/types/AreaChartFillGradient","title":"AreaChartFillGradient","description":""},{"path":"/docs/types/AreaChartFillPattern","title":"AreaChartFillPattern","description":""},{"path":"/docs/types/AreaChartFillPatternKind","title":"AreaChartFillPatternKind","description":""},{"path":"/docs/types/AreaChartGradientStop","title":"AreaChartGradientStop","description":""},{"path":"/docs/types/AreaChartLegendItemEventDetail","title":"AreaChartLegendItemEventDetail","description":""},{"path":"/docs/types/AreaChartLegendPosition","title":"AreaChartLegendPosition","description":""},{"path":"/docs/types/AreaChartLinearGradient","title":"AreaChartLinearGradient","description":""},{"path":"/docs/types/AreaChartPatternKind","title":"AreaChartPatternKind","description":""},{"path":"/docs/types/AreaChartRadialGradient","title":"AreaChartRadialGradient","description":""},{"path":"/docs/types/AreaChartRenderResult","title":"AreaChartRenderResult","description":""},{"path":"/docs/types/AreaChartSeries","title":"AreaChartSeries","description":""},{"path":"/docs/types/AreaChartSeriesActiveTrigger","title":"AreaChartSeriesActiveTrigger","description":""},{"path":"/docs/types/AreaChartSeriesStateOptions","title":"AreaChartSeriesStateOptions","description":""},{"path":"/docs/types/AreaChartSeriesStateStyle","title":"AreaChartSeriesStateStyle","description":""},{"path":"/docs/types/AreaChartSeriesToggledEventDetail","title":"AreaChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/AreaChartStreamEvent","title":"AreaChartStreamEvent","description":""},{"path":"/docs/types/AreaChartStreamSource","title":"AreaChartStreamSource","description":""},{"path":"/docs/types/AreaChartUnavailableBehaviour","title":"AreaChartUnavailableBehaviour","description":""},{"path":"/docs/types/AreaChartValues","title":"AreaChartValues","description":""}]}]},{"id":"B","title":"B","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DAxesOptions","title":"Bar3DAxesOptions","description":""},{"path":"/docs/types/Bar3DCameraChangeEventDetail","title":"Bar3DCameraChangeEventDetail","description":""},{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":""},{"path":"/docs/types/Bar3DCrosshairDetail","title":"Bar3DCrosshairDetail","description":""},{"path":"/docs/types/Bar3DCrosshairShowRequest","title":"Bar3DCrosshairShowRequest","description":""},{"path":"/docs/types/Bar3DData","title":"Bar3DData","description":""},{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":""},{"path":"/docs/types/Bar3DDiagnostics","title":"Bar3DDiagnostics","description":""},{"path":"/docs/types/Bar3DDomain","title":"Bar3DDomain","description":""},{"path":"/docs/types/Bar3DEasing","title":"Bar3DEasing","description":""},{"path":"/docs/types/Bar3DEngineMode","title":"Bar3DEngineMode","description":""},{"path":"/docs/types/Bar3DEngineTier","title":"Bar3DEngineTier","description":""},{"path":"/docs/types/Bar3DGeometry","title":"Bar3DGeometry","description":""},{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":""},{"path":"/docs/types/Bar3DPoint","title":"Bar3DPoint","description":""},{"path":"/docs/types/Bar3DRenderResult","title":"Bar3DRenderResult","description":""},{"path":"/docs/types/Bar3DSelection","title":"Bar3DSelection","description":""},{"path":"/docs/types/Bar3DSelectionChangeEventDetail","title":"Bar3DSelectionChangeEventDetail","description":""},{"path":"/docs/types/Bar3DSelectionSource","title":"Bar3DSelectionSource","description":""},{"path":"/docs/types/Bar3DStreamEvent","title":"Bar3DStreamEvent","description":""},{"path":"/docs/types/Bar3DStreamSource","title":"Bar3DStreamSource","description":""},{"path":"/docs/types/Bar3DTuple","title":"Bar3DTuple","description":""},{"path":"/docs/types/Bar3DUnavailableBehaviour","title":"Bar3DUnavailableBehaviour","description":""},{"path":"/docs/types/BarBorderScope","title":"BarBorderScope","description":""},{"path":"/docs/types/BarChartAnimationType","title":"BarChartAnimationType","description":""},{"path":"/docs/types/BarChartDatum","title":"BarChartDatum","description":""},{"path":"/docs/types/BarChartEasing","title":"BarChartEasing","description":""},{"path":"/docs/types/BarChartEngineMode","title":"BarChartEngineMode","description":""},{"path":"/docs/types/BarChartEngineTier","title":"BarChartEngineTier","description":""},{"path":"/docs/types/BarChartLegendItemEventDetail","title":"BarChartLegendItemEventDetail","description":""},{"path":"/docs/types/BarChartLegendPosition","title":"BarChartLegendPosition","description":""},{"path":"/docs/types/BarChartRenderResult","title":"BarChartRenderResult","description":""},{"path":"/docs/types/BarChartSeries","title":"BarChartSeries","description":""},{"path":"/docs/types/BarChartSeriesActiveTrigger","title":"BarChartSeriesActiveTrigger","description":""},{"path":"/docs/types/BarChartSeriesStateOptions","title":"BarChartSeriesStateOptions","description":""},{"path":"/docs/types/BarChartSeriesStateStyle","title":"BarChartSeriesStateStyle","description":""},{"path":"/docs/types/BarChartSeriesToggledEventDetail","title":"BarChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/BarChartStreamEvent","title":"BarChartStreamEvent","description":""},{"path":"/docs/types/BarChartStreamSource","title":"BarChartStreamSource","description":""},{"path":"/docs/types/BarChartUnavailableBehaviour","title":"BarChartUnavailableBehaviour","description":""},{"path":"/docs/types/BarChartValues","title":"BarChartValues","description":""},{"path":"/docs/types/BinarySummary","title":"BinarySummary","description":""},{"path":"/docs/types/BoxPlotAnimationType","title":"BoxPlotAnimationType","description":""},{"path":"/docs/types/BoxPlotBox","title":"BoxPlotBox","description":""},{"path":"/docs/types/BoxPlotData","title":"BoxPlotData","description":""},{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","description":""},{"path":"/docs/types/BoxPlotDomain","title":"BoxPlotDomain","description":""},{"path":"/docs/types/BoxPlotDrawStats","title":"BoxPlotDrawStats","description":""},{"path":"/docs/types/BoxPlotEasing","title":"BoxPlotEasing","description":""},{"path":"/docs/types/BoxPlotEngineMode","title":"BoxPlotEngineMode","description":""},{"path":"/docs/types/BoxPlotEngineTier","title":"BoxPlotEngineTier","description":""},{"path":"/docs/types/BoxPlotExtent","title":"BoxPlotExtent","description":""},{"path":"/docs/types/BoxPlotNotch","title":"BoxPlotNotch","description":""},{"path":"/docs/types/BoxPlotOrientation","title":"BoxPlotOrientation","description":""},{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":""},{"path":"/docs/types/BoxPlotQuantileMethod","title":"BoxPlotQuantileMethod","description":""},{"path":"/docs/types/BoxPlotRenderResult","title":"BoxPlotRenderResult","description":""},{"path":"/docs/types/BoxPlotSamplesInput","title":"BoxPlotSamplesInput","description":""},{"path":"/docs/types/BoxPlotSamplesTupleInput","title":"BoxPlotSamplesTupleInput","description":""},{"path":"/docs/types/BoxPlotStatistics","title":"BoxPlotStatistics","description":""},{"path":"/docs/types/BoxPlotStreamEvent","title":"BoxPlotStreamEvent","description":""},{"path":"/docs/types/BoxPlotStreamSource","title":"BoxPlotStreamSource","description":""},{"path":"/docs/types/BoxPlotSummaryInput","title":"BoxPlotSummaryInput","description":""},{"path":"/docs/types/BoxPlotSummaryTupleInput","title":"BoxPlotSummaryTupleInput","description":""},{"path":"/docs/types/BoxPlotUnavailableBehaviour","title":"BoxPlotUnavailableBehaviour","description":""},{"path":"/docs/types/BoxPlotWhiskerRule","title":"BoxPlotWhiskerRule","description":""},{"path":"/docs/types/BoxplotOptions","title":"BoxplotOptions","description":""},{"path":"/docs/types/BubbleAnimationType","title":"BubbleAnimationType","description":""},{"path":"/docs/types/BubbleData","title":"BubbleData","description":""},{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","description":""},{"path":"/docs/types/BubbleDatumObject","title":"BubbleDatumObject","description":""},{"path":"/docs/types/BubbleDatumTuple","title":"BubbleDatumTuple","description":""},{"path":"/docs/types/BubbleDomain","title":"BubbleDomain","description":""},{"path":"/docs/types/BubbleDrawStats","title":"BubbleDrawStats","description":""},{"path":"/docs/types/BubbleEasing","title":"BubbleEasing","description":""},{"path":"/docs/types/BubbleEngineMode","title":"BubbleEngineMode","description":""},{"path":"/docs/types/BubbleEngineTier","title":"BubbleEngineTier","description":""},{"path":"/docs/types/BubbleExtent","title":"BubbleExtent","description":""},{"path":"/docs/types/BubbleLayoutMode","title":"BubbleLayoutMode","description":""},{"path":"/docs/types/BubblePackCircle","title":"BubblePackCircle","description":""},{"path":"/docs/types/BubblePackFit","title":"BubblePackFit","description":""},{"path":"/docs/types/BubblePackLayout","title":"BubblePackLayout","description":""},{"path":"/docs/types/BubblePoint","title":"BubblePoint","description":""},{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":""},{"path":"/docs/types/BubbleRadiusScale","title":"BubbleRadiusScale","description":""},{"path":"/docs/types/BubbleRenderResult","title":"BubbleRenderResult","description":""},{"path":"/docs/types/BubbleShading","title":"BubbleShading","description":""},{"path":"/docs/types/BubbleSizeScale","title":"BubbleSizeScale","description":""},{"path":"/docs/types/BubbleStreamEvent","title":"BubbleStreamEvent","description":""},{"path":"/docs/types/BubbleStreamSource","title":"BubbleStreamSource","description":""},{"path":"/docs/types/BubbleUnavailableBehaviour","title":"BubbleUnavailableBehaviour","description":""}]}]},{"id":"C","title":"C","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarAggregate","title":"CalendarAggregate","description":""},{"path":"/docs/types/CalendarDateInput","title":"CalendarDateInput","description":""},{"path":"/docs/types/CalendarHeatmapAnimationType","title":"CalendarHeatmapAnimationType","description":""},{"path":"/docs/types/CalendarHeatmapData","title":"CalendarHeatmapData","description":""},{"path":"/docs/types/CalendarHeatmapDatum","title":"CalendarHeatmapDatum","description":""},{"path":"/docs/types/CalendarHeatmapEasing","title":"CalendarHeatmapEasing","description":""},{"path":"/docs/types/CalendarHeatmapEngineMode","title":"CalendarHeatmapEngineMode","description":""},{"path":"/docs/types/CalendarHeatmapEngineTier","title":"CalendarHeatmapEngineTier","description":""},{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","description":""},{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":""},{"path":"/docs/types/CalendarHeatmapRange","title":"CalendarHeatmapRange","description":""},{"path":"/docs/types/CalendarHeatmapRenderPath","title":"CalendarHeatmapRenderPath","description":""},{"path":"/docs/types/CalendarHeatmapRenderResult","title":"CalendarHeatmapRenderResult","description":""},{"path":"/docs/types/CalendarHeatmapStreamEvent","title":"CalendarHeatmapStreamEvent","description":""},{"path":"/docs/types/CalendarHeatmapStreamSource","title":"CalendarHeatmapStreamSource","description":""},{"path":"/docs/types/CalendarHeatmapTuple","title":"CalendarHeatmapTuple","description":""},{"path":"/docs/types/CalendarHeatmapUnavailableBehaviour","title":"CalendarHeatmapUnavailableBehaviour","description":""},{"path":"/docs/types/CalendarHeatmapValueExtent","title":"CalendarHeatmapValueExtent","description":""},{"path":"/docs/types/CalendarMonthMark","title":"CalendarMonthMark","description":""},{"path":"/docs/types/CalendarWeekStart","title":"CalendarWeekStart","description":""},{"path":"/docs/types/CalendarWeekdayLabels","title":"CalendarWeekdayLabels","description":""},{"path":"/docs/types/CandlestickAnimationType","title":"CandlestickAnimationType","description":""},{"path":"/docs/types/CandlestickAntialias","title":"CandlestickAntialias","description":""},{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","description":""},{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":""},{"path":"/docs/types/CandlestickBarObjectInput","title":"CandlestickBarObjectInput","description":""},{"path":"/docs/types/CandlestickBarStyle","title":"CandlestickBarStyle","description":""},{"path":"/docs/types/CandlestickBarTupleInput","title":"CandlestickBarTupleInput","description":""},{"path":"/docs/types/CandlestickBodyStyle","title":"CandlestickBodyStyle","description":""},{"path":"/docs/types/CandlestickData","title":"CandlestickData","description":""},{"path":"/docs/types/CandlestickDirection","title":"CandlestickDirection","description":""},{"path":"/docs/types/CandlestickDomain","title":"CandlestickDomain","description":""},{"path":"/docs/types/CandlestickDrawStats","title":"CandlestickDrawStats","description":""},{"path":"/docs/types/CandlestickEasing","title":"CandlestickEasing","description":""},{"path":"/docs/types/CandlestickEngineMode","title":"CandlestickEngineMode","description":""},{"path":"/docs/types/CandlestickEngineTier","title":"CandlestickEngineTier","description":""},{"path":"/docs/types/CandlestickExtent","title":"CandlestickExtent","description":""},{"path":"/docs/types/CandlestickOverlayBand","title":"CandlestickOverlayBand","description":""},{"path":"/docs/types/CandlestickOverlayInput","title":"CandlestickOverlayInput","description":""},{"path":"/docs/types/CandlestickOverlayKind","title":"CandlestickOverlayKind","description":""},{"path":"/docs/types/CandlestickOverlayOutput","title":"CandlestickOverlayOutput","description":""},{"path":"/docs/types/CandlestickOverlaySpec","title":"CandlestickOverlaySpec","description":""},{"path":"/docs/types/CandlestickOverlaySpecInput","title":"CandlestickOverlaySpecInput","description":""},{"path":"/docs/types/CandlestickOverlayState","title":"CandlestickOverlayState","description":""},{"path":"/docs/types/CandlestickOverlayStats","title":"CandlestickOverlayStats","description":""},{"path":"/docs/types/CandlestickPaneRect","title":"CandlestickPaneRect","description":""},{"path":"/docs/types/CandlestickPaneRects","title":"CandlestickPaneRects","description":""},{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":""},{"path":"/docs/types/CandlestickRenderResult","title":"CandlestickRenderResult","description":""},{"path":"/docs/types/CandlestickSessionInput","title":"CandlestickSessionInput","description":""},{"path":"/docs/types/CandlestickStreamEvent","title":"CandlestickStreamEvent","description":""},{"path":"/docs/types/CandlestickStreamSource","title":"CandlestickStreamSource","description":""},{"path":"/docs/types/CandlestickTimeScale","title":"CandlestickTimeScale","description":""},{"path":"/docs/types/CandlestickTimeScaleState","title":"CandlestickTimeScaleState","description":""},{"path":"/docs/types/CandlestickTimeTick","title":"CandlestickTimeTick","description":""},{"path":"/docs/types/CandlestickUnavailableBehaviour","title":"CandlestickUnavailableBehaviour","description":""},{"path":"/docs/types/CandlestickVisibleRange","title":"CandlestickVisibleRange","description":""},{"path":"/docs/types/CandlestickVolumeMode","title":"CandlestickVolumeMode","description":""},{"path":"/docs/types/CandlestickVolumeStats","title":"CandlestickVolumeStats","description":""},{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","description":""},{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":""},{"path":"/docs/types/CartesianAxisKind","title":"CartesianAxisKind","description":""},{"path":"/docs/types/CartesianAxisPosition","title":"CartesianAxisPosition","description":""},{"path":"/docs/types/CartesianAxisSpec","title":"CartesianAxisSpec","description":""},{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":""},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","description":""},{"path":"/docs/types/CartesianBrushBandArea","title":"CartesianBrushBandArea","description":""},{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":""},{"path":"/docs/types/CartesianBrushCoverage","title":"CartesianBrushCoverage","description":""},{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","description":""},{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","description":""},{"path":"/docs/types/CartesianBrushLassoArea","title":"CartesianBrushLassoArea","description":""},{"path":"/docs/types/CartesianBrushMode","title":"CartesianBrushMode","description":""},{"path":"/docs/types/CartesianBrushModifier","title":"CartesianBrushModifier","description":""},{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","description":""},{"path":"/docs/types/CartesianBrushPoint","title":"CartesianBrushPoint","description":""},{"path":"/docs/types/CartesianBrushRange","title":"CartesianBrushRange","description":""},{"path":"/docs/types/CartesianBrushRectArea","title":"CartesianBrushRectArea","description":""},{"path":"/docs/types/CartesianBrushSelectedPoint","title":"CartesianBrushSelectedPoint","description":""},{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":""},{"path":"/docs/types/CartesianBrushSource","title":"CartesianBrushSource","description":""},{"path":"/docs/types/CartesianBrushSpec","title":"CartesianBrushSpec","description":""},{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","description":""},{"path":"/docs/types/CartesianBrushType","title":"CartesianBrushType","description":""},{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","description":""},{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","description":""},{"path":"/docs/types/CartesianCrosshairMode","title":"CartesianCrosshairMode","description":""},{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","description":""},{"path":"/docs/types/CartesianCrosshairSnap","title":"CartesianCrosshairSnap","description":""},{"path":"/docs/types/CartesianCrosshairSpec","title":"CartesianCrosshairSpec","description":""},{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","description":""},{"path":"/docs/types/CartesianGridLinesSpec","title":"CartesianGridLinesSpec","description":""},{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":""},{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","description":""},{"path":"/docs/types/CartesianSeriesBorderDashStyle","title":"CartesianSeriesBorderDashStyle","description":""},{"path":"/docs/types/CartesianSeriesCornerRadiusInput","title":"CartesianSeriesCornerRadiusInput","description":""},{"path":"/docs/types/CartesianSeriesCornerRadiusTuple","title":"CartesianSeriesCornerRadiusTuple","description":""},{"path":"/docs/types/CartesianSeriesCornerRadiusValue","title":"CartesianSeriesCornerRadiusValue","description":""},{"path":"/docs/types/CartesianSeriesData","title":"CartesianSeriesData","description":""},{"path":"/docs/types/CartesianSeriesDataItem","title":"CartesianSeriesDataItem","description":""},{"path":"/docs/types/CartesianSeriesDataLabelsInput","title":"CartesianSeriesDataLabelsInput","description":""},{"path":"/docs/types/CartesianSeriesDataSortingInput","title":"CartesianSeriesDataSortingInput","description":""},{"path":"/docs/types/CartesianSeriesDataTuple","title":"CartesianSeriesDataTuple","description":""},{"path":"/docs/types/CartesianSeriesEventHandler","title":"CartesianSeriesEventHandler","description":""},{"path":"/docs/types/CartesianSeriesEventName","title":"CartesianSeriesEventName","description":""},{"path":"/docs/types/CartesianSeriesEventsInput","title":"CartesianSeriesEventsInput","description":""},{"path":"/docs/types/CartesianSeriesId","title":"CartesianSeriesId","description":""},{"path":"/docs/types/CartesianSeriesMarkerInput","title":"CartesianSeriesMarkerInput","description":""},{"path":"/docs/types/CartesianSeriesMarkerStateInput","title":"CartesianSeriesMarkerStateInput","description":""},{"path":"/docs/types/CartesianSeriesMarkerSymbol","title":"CartesianSeriesMarkerSymbol","description":""},{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","description":""},{"path":"/docs/types/CartesianSeriesPointDatum","title":"CartesianSeriesPointDatum","description":""},{"path":"/docs/types/CartesianSeriesPointIntervalUnit","title":"CartesianSeriesPointIntervalUnit","description":""},{"path":"/docs/types/CartesianSeriesPointObject","title":"CartesianSeriesPointObject","description":""},{"path":"/docs/types/CartesianSeriesStackingMode","title":"CartesianSeriesStackingMode","description":""},{"path":"/docs/types/CartesianSeriesStateStyle","title":"CartesianSeriesStateStyle","description":""},{"path":"/docs/types/CartesianSeriesStatesInput","title":"CartesianSeriesStatesInput","description":""},{"path":"/docs/types/CartesianSeriesTooltipInput","title":"CartesianSeriesTooltipInput","description":""},{"path":"/docs/types/CartesianSeriesZone","title":"CartesianSeriesZone","description":""},{"path":"/docs/types/CartesianSeriesZoneAxis","title":"CartesianSeriesZoneAxis","description":""},{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":""},{"path":"/docs/types/CartesianTooltipConnectorInput","title":"CartesianTooltipConnectorInput","description":""},{"path":"/docs/types/CartesianTooltipConnectorSpec","title":"CartesianTooltipConnectorSpec","description":""},{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","description":""},{"path":"/docs/types/CartesianTooltipFormatContext","title":"CartesianTooltipFormatContext","description":""},{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","description":""},{"path":"/docs/types/CartesianTooltipMode","title":"CartesianTooltipMode","description":""},{"path":"/docs/types/CartesianTooltipObjectInput","title":"CartesianTooltipObjectInput","description":""},{"path":"/docs/types/CartesianTooltipOpenMode","title":"CartesianTooltipOpenMode","description":""},{"path":"/docs/types/CartesianTooltipSpec","title":"CartesianTooltipSpec","description":""},{"path":"/docs/types/CartesianTooltipStyle","title":"CartesianTooltipStyle","description":""},{"path":"/docs/types/CartesianTooltipStyleValue","title":"CartesianTooltipStyleValue","description":""},{"path":"/docs/types/CartesianTooltipTrigger","title":"CartesianTooltipTrigger","description":""},{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","description":""},{"path":"/docs/types/CartesianZoomAxisExtent","title":"CartesianZoomAxisExtent","description":""},{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":""},{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":""},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":""},{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","description":""},{"path":"/docs/types/CartesianZoomMode","title":"CartesianZoomMode","description":""},{"path":"/docs/types/CartesianZoomPanInput","title":"CartesianZoomPanInput","description":""},{"path":"/docs/types/CartesianZoomPanModifier","title":"CartesianZoomPanModifier","description":""},{"path":"/docs/types/CartesianZoomPanSpec","title":"CartesianZoomPanSpec","description":""},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":""},{"path":"/docs/types/CartesianZoomRequestSource","title":"CartesianZoomRequestSource","description":""},{"path":"/docs/types/CartesianZoomSource","title":"CartesianZoomSource","description":""},{"path":"/docs/types/CartesianZoomSpec","title":"CartesianZoomSpec","description":""},{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":""},{"path":"/docs/types/CartesianZoomWheelInput","title":"CartesianZoomWheelInput","description":""},{"path":"/docs/types/CartesianZoomWheelModifier","title":"CartesianZoomWheelModifier","description":""},{"path":"/docs/types/CartesianZoomWheelSpec","title":"CartesianZoomWheelSpec","description":""},{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":""},{"path":"/docs/types/ChartAction","title":"ChartAction","description":""},{"path":"/docs/types/ChartActionEventDetail","title":"ChartActionEventDetail","description":""},{"path":"/docs/types/ChartActionResult","title":"ChartActionResult","description":""},{"path":"/docs/types/ChartActionType","title":"ChartActionType","description":""},{"path":"/docs/types/ChartAnimationType","title":"ChartAnimationType","description":""},{"path":"/docs/types/ChartAppendedEventDetail","title":"ChartAppendedEventDetail","description":""},{"path":"/docs/types/ChartContextMenuEventDetail","title":"ChartContextMenuEventDetail","description":""},{"path":"/docs/types/ChartContextMenuItemEventDetail","title":"ChartContextMenuItemEventDetail","description":""},{"path":"/docs/types/ChartContextMenuOpenOptions","title":"ChartContextMenuOpenOptions","description":""},{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","description":""},{"path":"/docs/types/ChartDataValidationErrorDetail","title":"ChartDataValidationErrorDetail","description":""},{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":""},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":""},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","description":""},{"path":"/docs/types/ChartEngineCode","title":"ChartEngineCode","description":""},{"path":"/docs/types/ChartEngineEffective","title":"ChartEngineEffective","description":""},{"path":"/docs/types/ChartEngineRequest","title":"ChartEngineRequest","description":""},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","description":""},{"path":"/docs/types/ChartEngineTier","title":"ChartEngineTier","description":""},{"path":"/docs/types/ChartEntitlementState","title":"ChartEntitlementState","description":""},{"path":"/docs/types/ChartLegendItemEventDetail","title":"ChartLegendItemEventDetail","description":""},{"path":"/docs/types/ChartLoadStatus","title":"ChartLoadStatus","description":""},{"path":"/docs/types/ChartLocale","title":"ChartLocale","description":""},{"path":"/docs/types/ChartLocaleName","title":"ChartLocaleName","description":""},{"path":"/docs/types/ChartMenuActionId","title":"ChartMenuActionId","description":""},{"path":"/docs/types/ChartMenuItem","title":"ChartMenuItem","description":""},{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","description":""},{"path":"/docs/types/ChartPointContextMenuSeriesDetail","title":"ChartPointContextMenuSeriesDetail","description":""},{"path":"/docs/types/ChartPointEventDetail","title":"ChartPointEventDetail","description":""},{"path":"/docs/types/ChartRenderResult","title":"ChartRenderResult","description":""},{"path":"/docs/types/ChartSeriesToggledEventDetail","title":"ChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/ChartStreamSource","title":"ChartStreamSource","description":""},{"path":"/docs/types/ChartTheme","title":"ChartTheme","description":""},{"path":"/docs/types/ChartThemeName","title":"ChartThemeName","description":""},{"path":"/docs/types/ChartTooltipActionEventDetail","title":"ChartTooltipActionEventDetail","description":""},{"path":"/docs/types/ChartType","title":"ChartType","description":""},{"path":"/docs/types/ChartTypeLoadDetail","title":"ChartTypeLoadDetail","description":""},{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""},{"path":"/docs/types/ChordAnimationType","title":"ChordAnimationType","description":""},{"path":"/docs/types/ChordArc","title":"ChordArc","description":""},{"path":"/docs/types/ChordData","title":"ChordData","description":""},{"path":"/docs/types/ChordDrawStats","title":"ChordDrawStats","description":""},{"path":"/docs/types/ChordEasing","title":"ChordEasing","description":""},{"path":"/docs/types/ChordEngineMode","title":"ChordEngineMode","description":""},{"path":"/docs/types/ChordEngineTier","title":"ChordEngineTier","description":""},{"path":"/docs/types/ChordExtent","title":"ChordExtent","description":""},{"path":"/docs/types/ChordGraphInput","title":"ChordGraphInput","description":""},{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","description":""},{"path":"/docs/types/ChordLabelMode","title":"ChordLabelMode","description":""},{"path":"/docs/types/ChordLayoutResult","title":"ChordLayoutResult","description":""},{"path":"/docs/types/ChordLink","title":"ChordLink","description":""},{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","description":""},{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":""},{"path":"/docs/types/ChordLinkObject","title":"ChordLinkObject","description":""},{"path":"/docs/types/ChordLinkTuple","title":"ChordLinkTuple","description":""},{"path":"/docs/types/ChordNode","title":"ChordNode","description":""},{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":""},{"path":"/docs/types/ChordNodeInput","title":"ChordNodeInput","description":""},{"path":"/docs/types/ChordNodeLabel","title":"ChordNodeLabel","description":""},{"path":"/docs/types/ChordNodeObject","title":"ChordNodeObject","description":""},{"path":"/docs/types/ChordRenderResult","title":"ChordRenderResult","description":""},{"path":"/docs/types/ChordRibbon","title":"ChordRibbon","description":""},{"path":"/docs/types/ChordSelection","title":"ChordSelection","description":""},{"path":"/docs/types/ChordSelectionChangeEventDetail","title":"ChordSelectionChangeEventDetail","description":""},{"path":"/docs/types/ChordSelectionSource","title":"ChordSelectionSource","description":""},{"path":"/docs/types/ChordStreamEvent","title":"ChordStreamEvent","description":""},{"path":"/docs/types/ChordStreamSource","title":"ChordStreamSource","description":""},{"path":"/docs/types/ChordUnavailableBehaviour","title":"ChordUnavailableBehaviour","description":""},{"path":"/docs/types/ColorSpace","title":"ColorSpace","description":""},{"path":"/docs/types/ColumnBorderScope","title":"ColumnBorderScope","description":""},{"path":"/docs/types/ColumnChartAnimationType","title":"ColumnChartAnimationType","description":""},{"path":"/docs/types/ColumnChartDatum","title":"ColumnChartDatum","description":""},{"path":"/docs/types/ColumnChartEasing","title":"ColumnChartEasing","description":""},{"path":"/docs/types/ColumnChartEngineMode","title":"ColumnChartEngineMode","description":""},{"path":"/docs/types/ColumnChartEngineTier","title":"ColumnChartEngineTier","description":""},{"path":"/docs/types/ColumnChartLegendItemEventDetail","title":"ColumnChartLegendItemEventDetail","description":""},{"path":"/docs/types/ColumnChartLegendPosition","title":"ColumnChartLegendPosition","description":""},{"path":"/docs/types/ColumnChartRenderResult","title":"ColumnChartRenderResult","description":""},{"path":"/docs/types/ColumnChartSeries","title":"ColumnChartSeries","description":""},{"path":"/docs/types/ColumnChartSeriesActiveTrigger","title":"ColumnChartSeriesActiveTrigger","description":""},{"path":"/docs/types/ColumnChartSeriesStateOptions","title":"ColumnChartSeriesStateOptions","description":""},{"path":"/docs/types/ColumnChartSeriesStateStyle","title":"ColumnChartSeriesStateStyle","description":""},{"path":"/docs/types/ColumnChartSeriesToggledEventDetail","title":"ColumnChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/ColumnChartStreamEvent","title":"ColumnChartStreamEvent","description":""},{"path":"/docs/types/ColumnChartStreamSource","title":"ColumnChartStreamSource","description":""},{"path":"/docs/types/ColumnChartUnavailableBehaviour","title":"ColumnChartUnavailableBehaviour","description":""},{"path":"/docs/types/ColumnChartValues","title":"ColumnChartValues","description":""},{"path":"/docs/types/CompareSymbolInput","title":"CompareSymbolInput","description":""},{"path":"/docs/types/ContinuousVisualMapSnapshot","title":"ContinuousVisualMapSnapshot","description":""},{"path":"/docs/types/ContinuousVisualMapSpec","title":"ContinuousVisualMapSpec","description":""},{"path":"/docs/types/CsvOptions","title":"CsvOptions","description":""}]}]},{"id":"D","title":"D","blocks":[{"kind":"links","items":[{"path":"/docs/types/DataZoomOrientation","title":"DataZoomOrientation","description":""},{"path":"/docs/types/DataZoomRangeChangeEventDetail","title":"DataZoomRangeChangeEventDetail","description":""},{"path":"/docs/types/DataZoomRangeChangeSource","title":"DataZoomRangeChangeSource","description":""},{"path":"/docs/types/DataZoomTargetElement","title":"DataZoomTargetElement","description":""},{"path":"/docs/types/Dataset","title":"Dataset","description":""},{"path":"/docs/types/DatasetColumns","title":"DatasetColumns","description":""},{"path":"/docs/types/DatasetCondition","title":"DatasetCondition","description":""},{"path":"/docs/types/DatasetDimension","title":"DatasetDimension","description":""},{"path":"/docs/types/DatasetDimensionInput","title":"DatasetDimensionInput","description":""},{"path":"/docs/types/DatasetDimensionType","title":"DatasetDimensionType","description":""},{"path":"/docs/types/DatasetEncode","title":"DatasetEncode","description":""},{"path":"/docs/types/DatasetFieldCondition","title":"DatasetFieldCondition","description":""},{"path":"/docs/types/DatasetPrimitive","title":"DatasetPrimitive","description":""},{"path":"/docs/types/DatasetRow","title":"DatasetRow","description":""},{"path":"/docs/types/DatasetRowArray","title":"DatasetRowArray","description":""},{"path":"/docs/types/DatasetRowObject","title":"DatasetRowObject","description":""},{"path":"/docs/types/DatasetSortKey","title":"DatasetSortKey","description":""},{"path":"/docs/types/DatasetSourceInput","title":"DatasetSourceInput","description":""},{"path":"/docs/types/DatasetTransform","title":"DatasetTransform","description":""},{"path":"/docs/types/DendrogramAnimationType","title":"DendrogramAnimationType","description":""},{"path":"/docs/types/DendrogramData","title":"DendrogramData","description":""},{"path":"/docs/types/DendrogramDirection","title":"DendrogramDirection","description":""},{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","description":""},{"path":"/docs/types/DendrogramEasing","title":"DendrogramEasing","description":""},{"path":"/docs/types/DendrogramEngineMode","title":"DendrogramEngineMode","description":""},{"path":"/docs/types/DendrogramEngineTier","title":"DendrogramEngineTier","description":""},{"path":"/docs/types/DendrogramExtent","title":"DendrogramExtent","description":""},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":""},{"path":"/docs/types/DendrogramLabel","title":"DendrogramLabel","description":""},{"path":"/docs/types/DendrogramLabelMode","title":"DendrogramLabelMode","description":""},{"path":"/docs/types/DendrogramLayout","title":"DendrogramLayout","description":""},{"path":"/docs/types/DendrogramLayoutResult","title":"DendrogramLayoutResult","description":""},{"path":"/docs/types/DendrogramLink","title":"DendrogramLink","description":""},{"path":"/docs/types/DendrogramLinkPath","title":"DendrogramLinkPath","description":""},{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":""},{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":""},{"path":"/docs/types/DendrogramPoint","title":"DendrogramPoint","description":""},{"path":"/docs/types/DendrogramRect","title":"DendrogramRect","description":""},{"path":"/docs/types/DendrogramRenderResult","title":"DendrogramRenderResult","description":""},{"path":"/docs/types/DendrogramSelection","title":"DendrogramSelection","description":""},{"path":"/docs/types/DendrogramSelectionChangeEventDetail","title":"DendrogramSelectionChangeEventDetail","description":""},{"path":"/docs/types/DendrogramSelectionSource","title":"DendrogramSelectionSource","description":""},{"path":"/docs/types/DendrogramStreamEvent","title":"DendrogramStreamEvent","description":""},{"path":"/docs/types/DendrogramStreamSource","title":"DendrogramStreamSource","description":""},{"path":"/docs/types/DendrogramUnavailableBehaviour","title":"DendrogramUnavailableBehaviour","description":""},{"path":"/docs/types/DensityMapAnimationType","title":"DensityMapAnimationType","description":""},{"path":"/docs/types/DensityMapBandwidth","title":"DensityMapBandwidth","description":""},{"path":"/docs/types/DensityMapBandwidthInput","title":"DensityMapBandwidthInput","description":""},{"path":"/docs/types/DensityMapBandwidthUnit","title":"DensityMapBandwidthUnit","description":""},{"path":"/docs/types/DensityMapColumns","title":"DensityMapColumns","description":""},{"path":"/docs/types/DensityMapComputePath","title":"DensityMapComputePath","description":""},{"path":"/docs/types/DensityMapComputePathInput","title":"DensityMapComputePathInput","description":""},{"path":"/docs/types/DensityMapComputeStats","title":"DensityMapComputeStats","description":""},{"path":"/docs/types/DensityMapData","title":"DensityMapData","description":""},{"path":"/docs/types/DensityMapDomain","title":"DensityMapDomain","description":""},{"path":"/docs/types/DensityMapEasing","title":"DensityMapEasing","description":""},{"path":"/docs/types/DensityMapEngineMode","title":"DensityMapEngineMode","description":""},{"path":"/docs/types/DensityMapEngineTier","title":"DensityMapEngineTier","description":""},{"path":"/docs/types/DensityMapInput","title":"DensityMapInput","description":""},{"path":"/docs/types/DensityMapKernel","title":"DensityMapKernel","description":""},{"path":"/docs/types/DensityMapLodMode","title":"DensityMapLodMode","description":""},{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","description":""},{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":""},{"path":"/docs/types/DensityMapRenderResult","title":"DensityMapRenderResult","description":""},{"path":"/docs/types/DensityMapStreamEvent","title":"DensityMapStreamEvent","description":""},{"path":"/docs/types/DensityMapStreamSource","title":"DensityMapStreamSource","description":""},{"path":"/docs/types/DensityMapTuple","title":"DensityMapTuple","description":""},{"path":"/docs/types/DensityMapUnavailableBehaviour","title":"DensityMapUnavailableBehaviour","description":""},{"path":"/docs/types/DensityMapUnitInput","title":"DensityMapUnitInput","description":""},{"path":"/docs/types/DensityMapValueExtent","title":"DensityMapValueExtent","description":""},{"path":"/docs/types/DerivedStockStyle","title":"DerivedStockStyle","description":""},{"path":"/docs/types/DieIndexEntry","title":"DieIndexEntry","description":""},{"path":"/docs/types/DieIndexOrigin","title":"DieIndexOrigin","description":""},{"path":"/docs/types/DieStatus","title":"DieStatus","description":""},{"path":"/docs/types/DotPlotCategoryDatum","title":"DotPlotCategoryDatum","description":""},{"path":"/docs/types/DotPlotChartAnimationType","title":"DotPlotChartAnimationType","description":""},{"path":"/docs/types/DotPlotChartEasing","title":"DotPlotChartEasing","description":""},{"path":"/docs/types/DotPlotChartEngineMode","title":"DotPlotChartEngineMode","description":""},{"path":"/docs/types/DotPlotChartEngineTier","title":"DotPlotChartEngineTier","description":""},{"path":"/docs/types/DotPlotChartLegendItemEventDetail","title":"DotPlotChartLegendItemEventDetail","description":""},{"path":"/docs/types/DotPlotChartLegendPosition","title":"DotPlotChartLegendPosition","description":""},{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","description":""},{"path":"/docs/types/DotPlotChartRenderResult","title":"DotPlotChartRenderResult","description":""},{"path":"/docs/types/DotPlotChartSeriesToggledEventDetail","title":"DotPlotChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/DotPlotChartStreamEvent","title":"DotPlotChartStreamEvent","description":""},{"path":"/docs/types/DotPlotChartStreamSource","title":"DotPlotChartStreamSource","description":""},{"path":"/docs/types/DotPlotChartUnavailableBehaviour","title":"DotPlotChartUnavailableBehaviour","description":""},{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","description":""},{"path":"/docs/types/DotPlotMarkerSymbol","title":"DotPlotMarkerSymbol","description":""},{"path":"/docs/types/DrawingAction","title":"DrawingAction","description":""},{"path":"/docs/types/DrawingActionType","title":"DrawingActionType","description":""},{"path":"/docs/types/DrawingAnchor","title":"DrawingAnchor","description":""},{"path":"/docs/types/DrawingAnchorInput","title":"DrawingAnchorInput","description":""},{"path":"/docs/types/DrawingDocument","title":"DrawingDocument","description":""},{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","description":""},{"path":"/docs/types/DrawingMeta","title":"DrawingMeta","description":""},{"path":"/docs/types/DrawingMode","title":"DrawingMode","description":""},{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","description":""},{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","description":""},{"path":"/docs/types/DrawingSelectionSource","title":"DrawingSelectionSource","description":""},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":""},{"path":"/docs/types/DrawingStyle","title":"DrawingStyle","description":""},{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","description":""},{"path":"/docs/types/DrawingsChangeSource","title":"DrawingsChangeSource","description":""},{"path":"/docs/types/DumbbellChartAnimationType","title":"DumbbellChartAnimationType","description":""},{"path":"/docs/types/DumbbellChartDatum","title":"DumbbellChartDatum","description":""},{"path":"/docs/types/DumbbellChartEasing","title":"DumbbellChartEasing","description":""},{"path":"/docs/types/DumbbellChartEngineMode","title":"DumbbellChartEngineMode","description":""},{"path":"/docs/types/DumbbellChartEngineTier","title":"DumbbellChartEngineTier","description":""},{"path":"/docs/types/DumbbellChartLegendItemEventDetail","title":"DumbbellChartLegendItemEventDetail","description":""},{"path":"/docs/types/DumbbellChartLegendPosition","title":"DumbbellChartLegendPosition","description":""},{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","description":""},{"path":"/docs/types/DumbbellChartRenderResult","title":"DumbbellChartRenderResult","description":""},{"path":"/docs/types/DumbbellChartSeriesToggledEventDetail","title":"DumbbellChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/DumbbellChartStreamEvent","title":"DumbbellChartStreamEvent","description":""},{"path":"/docs/types/DumbbellChartStreamSource","title":"DumbbellChartStreamSource","description":""},{"path":"/docs/types/DumbbellChartUnavailableBehaviour","title":"DumbbellChartUnavailableBehaviour","description":""},{"path":"/docs/types/DumbbellDatum","title":"DumbbellDatum","description":""},{"path":"/docs/types/DumbbellMarkerSymbol","title":"DumbbellMarkerSymbol","description":""},{"path":"/docs/types/DumbbellPairDatum","title":"DumbbellPairDatum","description":""}]}]},{"id":"E","title":"E","blocks":[{"kind":"links","items":[{"path":"/docs/types/EncodedDataset","title":"EncodedDataset","description":""},{"path":"/docs/types/EncodedSeries","title":"EncodedSeries","description":""},{"path":"/docs/types/ErrorBarAnimationType","title":"ErrorBarAnimationType","description":""},{"path":"/docs/types/ErrorBarData","title":"ErrorBarData","description":""},{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","description":""},{"path":"/docs/types/ErrorBarDatumObject","title":"ErrorBarDatumObject","description":""},{"path":"/docs/types/ErrorBarDatumTuple","title":"ErrorBarDatumTuple","description":""},{"path":"/docs/types/ErrorBarDomain","title":"ErrorBarDomain","description":""},{"path":"/docs/types/ErrorBarDrawStats","title":"ErrorBarDrawStats","description":""},{"path":"/docs/types/ErrorBarEasing","title":"ErrorBarEasing","description":""},{"path":"/docs/types/ErrorBarEngineMode","title":"ErrorBarEngineMode","description":""},{"path":"/docs/types/ErrorBarEngineTier","title":"ErrorBarEngineTier","description":""},{"path":"/docs/types/ErrorBarExtent","title":"ErrorBarExtent","description":""},{"path":"/docs/types/ErrorBarMode","title":"ErrorBarMode","description":""},{"path":"/docs/types/ErrorBarPoint","title":"ErrorBarPoint","description":""},{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":""},{"path":"/docs/types/ErrorBarRenderResult","title":"ErrorBarRenderResult","description":""},{"path":"/docs/types/ErrorBarStreamEvent","title":"ErrorBarStreamEvent","description":""},{"path":"/docs/types/ErrorBarStreamSource","title":"ErrorBarStreamSource","description":""},{"path":"/docs/types/ErrorBarUnavailableBehaviour","title":"ErrorBarUnavailableBehaviour","description":""}]}]},{"id":"F","title":"F","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesCoordinate","title":"FlowLinesCoordinate","description":""},{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","description":""},{"path":"/docs/types/FlowLinesDiagnostics","title":"FlowLinesDiagnostics","description":""},{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":""},{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","description":""},{"path":"/docs/types/FlowLinesLayout","title":"FlowLinesLayout","description":""},{"path":"/docs/types/FlowLinesLocation","title":"FlowLinesLocation","description":""},{"path":"/docs/types/FlowLinesLocationHit","title":"FlowLinesLocationHit","description":""},{"path":"/docs/types/FlowLinesLocationInput","title":"FlowLinesLocationInput","description":""},{"path":"/docs/types/FlowLinesRenderResult","title":"FlowLinesRenderResult","description":""},{"path":"/docs/types/FlowLinesRoute","title":"FlowLinesRoute","description":""},{"path":"/docs/types/FlowLinesRouteHit","title":"FlowLinesRouteHit","description":""},{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":""},{"path":"/docs/types/FlowLinesSelection","title":"FlowLinesSelection","description":""},{"path":"/docs/types/FlowLinesSelectionChangeEventDetail","title":"FlowLinesSelectionChangeEventDetail","description":""},{"path":"/docs/types/FlowLinesStreamEvent","title":"FlowLinesStreamEvent","description":""},{"path":"/docs/types/FlowLinesStreamSource","title":"FlowLinesStreamSource","description":""},{"path":"/docs/types/FlowLinesStyle","title":"FlowLinesStyle","description":""},{"path":"/docs/types/FunnelChartAnimationType","title":"FunnelChartAnimationType","description":""},{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","description":""},{"path":"/docs/types/FunnelChartEasing","title":"FunnelChartEasing","description":""},{"path":"/docs/types/FunnelChartEngineMode","title":"FunnelChartEngineMode","description":""},{"path":"/docs/types/FunnelChartEngineTier","title":"FunnelChartEngineTier","description":""},{"path":"/docs/types/FunnelChartLegendPosition","title":"FunnelChartLegendPosition","description":""},{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":""},{"path":"/docs/types/FunnelChartRenderResult","title":"FunnelChartRenderResult","description":""},{"path":"/docs/types/FunnelChartStreamEvent","title":"FunnelChartStreamEvent","description":""},{"path":"/docs/types/FunnelChartStreamSource","title":"FunnelChartStreamSource","description":""},{"path":"/docs/types/FunnelChartTooltipActionEventDetail","title":"FunnelChartTooltipActionEventDetail","description":""},{"path":"/docs/types/FunnelChartTooltipConnectorInput","title":"FunnelChartTooltipConnectorInput","description":""},{"path":"/docs/types/FunnelChartTooltipConnectorSpec","title":"FunnelChartTooltipConnectorSpec","description":""},{"path":"/docs/types/FunnelChartTooltipFormatContext","title":"FunnelChartTooltipFormatContext","description":""},{"path":"/docs/types/FunnelChartTooltipInput","title":"FunnelChartTooltipInput","description":""},{"path":"/docs/types/FunnelChartTooltipObjectInput","title":"FunnelChartTooltipObjectInput","description":""},{"path":"/docs/types/FunnelChartTooltipOpenMode","title":"FunnelChartTooltipOpenMode","description":""},{"path":"/docs/types/FunnelChartTooltipShowEventDetail","title":"FunnelChartTooltipShowEventDetail","description":""},{"path":"/docs/types/FunnelChartTooltipSide","title":"FunnelChartTooltipSide","description":""},{"path":"/docs/types/FunnelChartTooltipSpec","title":"FunnelChartTooltipSpec","description":""},{"path":"/docs/types/FunnelChartTooltipStyle","title":"FunnelChartTooltipStyle","description":""},{"path":"/docs/types/FunnelChartTooltipStyleValue","title":"FunnelChartTooltipStyleValue","description":""},{"path":"/docs/types/FunnelChartTooltipTrigger","title":"FunnelChartTooltipTrigger","description":""},{"path":"/docs/types/FunnelChartUnavailableBehaviour","title":"FunnelChartUnavailableBehaviour","description":""},{"path":"/docs/types/FunnelLabelPlacement","title":"FunnelLabelPlacement","description":""},{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":""}]}]},{"id":"G","title":"G","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttAnimationType","title":"GanttAnimationType","description":""},{"path":"/docs/types/GanttBaseline","title":"GanttBaseline","description":""},{"path":"/docs/types/GanttBaselineComparison","title":"GanttBaselineComparison","description":""},{"path":"/docs/types/GanttBaselineInput","title":"GanttBaselineInput","description":""},{"path":"/docs/types/GanttBaselineStyle","title":"GanttBaselineStyle","description":""},{"path":"/docs/types/GanttBaselineStyleInput","title":"GanttBaselineStyleInput","description":""},{"path":"/docs/types/GanttCriticalDependency","title":"GanttCriticalDependency","description":""},{"path":"/docs/types/GanttCriticalPathInput","title":"GanttCriticalPathInput","description":""},{"path":"/docs/types/GanttCriticalPathResult","title":"GanttCriticalPathResult","description":""},{"path":"/docs/types/GanttCriticalPathSpec","title":"GanttCriticalPathSpec","description":""},{"path":"/docs/types/GanttCriticalTask","title":"GanttCriticalTask","description":""},{"path":"/docs/types/GanttCrosshairTimeUnit","title":"GanttCrosshairTimeUnit","description":""},{"path":"/docs/types/GanttData","title":"GanttData","description":""},{"path":"/docs/types/GanttDeclaration","title":"GanttDeclaration","description":""},{"path":"/docs/types/GanttDependency","title":"GanttDependency","description":""},{"path":"/docs/types/GanttDependencyDataset","title":"GanttDependencyDataset","description":""},{"path":"/docs/types/GanttDependencyDiagnostics","title":"GanttDependencyDiagnostics","description":""},{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","description":""},{"path":"/docs/types/GanttDependencyInput","title":"GanttDependencyInput","description":""},{"path":"/docs/types/GanttDependencyPath","title":"GanttDependencyPath","description":""},{"path":"/docs/types/GanttDependencyPoint","title":"GanttDependencyPoint","description":""},{"path":"/docs/types/GanttDependencySelection","title":"GanttDependencySelection","description":""},{"path":"/docs/types/GanttDependencySelectionChange","title":"GanttDependencySelectionChange","description":""},{"path":"/docs/types/GanttDependencyStyle","title":"GanttDependencyStyle","description":""},{"path":"/docs/types/GanttDependencyStyleInput","title":"GanttDependencyStyleInput","description":""},{"path":"/docs/types/GanttDependencyType","title":"GanttDependencyType","description":""},{"path":"/docs/types/GanttDiagnostics","title":"GanttDiagnostics","description":""},{"path":"/docs/types/GanttEasing","title":"GanttEasing","description":""},{"path":"/docs/types/GanttEngineMode","title":"GanttEngineMode","description":""},{"path":"/docs/types/GanttEngineTier","title":"GanttEngineTier","description":""},{"path":"/docs/types/GanttExtent","title":"GanttExtent","description":""},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":""},{"path":"/docs/types/GanttLabel","title":"GanttLabel","description":""},{"path":"/docs/types/GanttLabelMode","title":"GanttLabelMode","description":""},{"path":"/docs/types/GanttLayoutResult","title":"GanttLayoutResult","description":""},{"path":"/docs/types/GanttMark","title":"GanttMark","description":""},{"path":"/docs/types/GanttRenderResult","title":"GanttRenderResult","description":""},{"path":"/docs/types/GanttSelection","title":"GanttSelection","description":""},{"path":"/docs/types/GanttSelectionChangeEventDetail","title":"GanttSelectionChangeEventDetail","description":""},{"path":"/docs/types/GanttSelectionSource","title":"GanttSelectionSource","description":""},{"path":"/docs/types/GanttStreamEvent","title":"GanttStreamEvent","description":""},{"path":"/docs/types/GanttStreamSource","title":"GanttStreamSource","description":""},{"path":"/docs/types/GanttTask","title":"GanttTask","description":""},{"path":"/docs/types/GanttTaskEdit","title":"GanttTaskEdit","description":""},{"path":"/docs/types/GanttTaskEditAction","title":"GanttTaskEditAction","description":""},{"path":"/docs/types/GanttTaskEditCancelReason","title":"GanttTaskEditCancelReason","description":""},{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","description":""},{"path":"/docs/types/GanttTaskEditingInput","title":"GanttTaskEditingInput","description":""},{"path":"/docs/types/GanttTaskEditingSpec","title":"GanttTaskEditingSpec","description":""},{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":""},{"path":"/docs/types/GanttTaskSnapInput","title":"GanttTaskSnapInput","description":""},{"path":"/docs/types/GanttTaskSnapUnit","title":"GanttTaskSnapUnit","description":""},{"path":"/docs/types/GanttTaskSnapUnitInput","title":"GanttTaskSnapUnitInput","description":""},{"path":"/docs/types/GanttTime","title":"GanttTime","description":""},{"path":"/docs/types/GanttTimeAxisInput","title":"GanttTimeAxisInput","description":""},{"path":"/docs/types/GanttTimeAxisModel","title":"GanttTimeAxisModel","description":""},{"path":"/docs/types/GanttTimeAxisSpec","title":"GanttTimeAxisSpec","description":""},{"path":"/docs/types/GanttTimeAxisTick","title":"GanttTimeAxisTick","description":""},{"path":"/docs/types/GanttUnavailableBehaviour","title":"GanttUnavailableBehaviour","description":""},{"path":"/docs/types/GaugeActivityRingSpec","title":"GaugeActivityRingSpec","description":""},{"path":"/docs/types/GaugeBandLevel","title":"GaugeBandLevel","description":""},{"path":"/docs/types/GaugeChartAnimationType","title":"GaugeChartAnimationType","description":""},{"path":"/docs/types/GaugeChartEasing","title":"GaugeChartEasing","description":""},{"path":"/docs/types/GaugeChartEngineMode","title":"GaugeChartEngineMode","description":""},{"path":"/docs/types/GaugeChartEngineTier","title":"GaugeChartEngineTier","description":""},{"path":"/docs/types/GaugeChartLegendPosition","title":"GaugeChartLegendPosition","description":""},{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":""},{"path":"/docs/types/GaugeChartRenderResult","title":"GaugeChartRenderResult","description":""},{"path":"/docs/types/GaugeChartStreamEvent","title":"GaugeChartStreamEvent","description":""},{"path":"/docs/types/GaugeChartStreamSource","title":"GaugeChartStreamSource","description":""},{"path":"/docs/types/GaugeChartTooltipActionEventDetail","title":"GaugeChartTooltipActionEventDetail","description":""},{"path":"/docs/types/GaugeChartTooltipConnectorInput","title":"GaugeChartTooltipConnectorInput","description":""},{"path":"/docs/types/GaugeChartTooltipConnectorSpec","title":"GaugeChartTooltipConnectorSpec","description":""},{"path":"/docs/types/GaugeChartTooltipFormatContext","title":"GaugeChartTooltipFormatContext","description":""},{"path":"/docs/types/GaugeChartTooltipInput","title":"GaugeChartTooltipInput","description":""},{"path":"/docs/types/GaugeChartTooltipObjectInput","title":"GaugeChartTooltipObjectInput","description":""},{"path":"/docs/types/GaugeChartTooltipOpenMode","title":"GaugeChartTooltipOpenMode","description":""},{"path":"/docs/types/GaugeChartTooltipShowEventDetail","title":"GaugeChartTooltipShowEventDetail","description":""},{"path":"/docs/types/GaugeChartTooltipSide","title":"GaugeChartTooltipSide","description":""},{"path":"/docs/types/GaugeChartTooltipSpec","title":"GaugeChartTooltipSpec","description":""},{"path":"/docs/types/GaugeChartTooltipStyle","title":"GaugeChartTooltipStyle","description":""},{"path":"/docs/types/GaugeChartTooltipStyleValue","title":"GaugeChartTooltipStyleValue","description":""},{"path":"/docs/types/GaugeChartTooltipTrigger","title":"GaugeChartTooltipTrigger","description":""},{"path":"/docs/types/GaugeChartUnavailableBehaviour","title":"GaugeChartUnavailableBehaviour","description":""},{"path":"/docs/types/GaugeChartVariant","title":"GaugeChartVariant","description":""},{"path":"/docs/types/GaugeColorStop","title":"GaugeColorStop","description":""},{"path":"/docs/types/GaugeNeedleShape","title":"GaugeNeedleShape","description":""},{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","description":""},{"path":"/docs/types/GaugePlotBand","title":"GaugePlotBand","description":""},{"path":"/docs/types/GaugeValueDisplay","title":"GaugeValueDisplay","description":""},{"path":"/docs/types/GeoMapAlbersProjection","title":"GeoMapAlbersProjection","description":""},{"path":"/docs/types/GeoMapAnimationType","title":"GeoMapAnimationType","description":""},{"path":"/docs/types/GeoMapAvailabilityDetail","title":"GeoMapAvailabilityDetail","description":""},{"path":"/docs/types/GeoMapBackground","title":"GeoMapBackground","description":""},{"path":"/docs/types/GeoMapBubbleInput","title":"GeoMapBubbleInput","description":""},{"path":"/docs/types/GeoMapBubbleOptions","title":"GeoMapBubbleOptions","description":""},{"path":"/docs/types/GeoMapBubbleScaleDetail","title":"GeoMapBubbleScaleDetail","description":""},{"path":"/docs/types/GeoMapColorAxis","title":"GeoMapColorAxis","description":""},{"path":"/docs/types/GeoMapColorAxisDetail","title":"GeoMapColorAxisDetail","description":""},{"path":"/docs/types/GeoMapColorAxisInput","title":"GeoMapColorAxisInput","description":""},{"path":"/docs/types/GeoMapConnectionPath","title":"GeoMapConnectionPath","description":""},{"path":"/docs/types/GeoMapConnectionView","title":"GeoMapConnectionView","description":""},{"path":"/docs/types/GeoMapData","title":"GeoMapData","description":""},{"path":"/docs/types/GeoMapDeclaration","title":"GeoMapDeclaration","description":""},{"path":"/docs/types/GeoMapDiagnostics","title":"GeoMapDiagnostics","description":""},{"path":"/docs/types/GeoMapEasing","title":"GeoMapEasing","description":""},{"path":"/docs/types/GeoMapEngineMode","title":"GeoMapEngineMode","description":""},{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","description":""},{"path":"/docs/types/GeoMapEquirectangularProjection","title":"GeoMapEquirectangularProjection","description":""},{"path":"/docs/types/GeoMapExtent","title":"GeoMapExtent","description":""},{"path":"/docs/types/GeoMapFeature","title":"GeoMapFeature","description":""},{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","description":""},{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":""},{"path":"/docs/types/GeoMapFeatureLabel","title":"GeoMapFeatureLabel","description":""},{"path":"/docs/types/GeoMapFeatureSelection","title":"GeoMapFeatureSelection","description":""},{"path":"/docs/types/GeoMapFeatureSelectionChangeEventDetail","title":"GeoMapFeatureSelectionChangeEventDetail","description":""},{"path":"/docs/types/GeoMapFitDetail","title":"GeoMapFitDetail","description":""},{"path":"/docs/types/GeoMapFitOptions","title":"GeoMapFitOptions","description":""},{"path":"/docs/types/GeoMapGeometry","title":"GeoMapGeometry","description":""},{"path":"/docs/types/GeoMapGeometryMetadata","title":"GeoMapGeometryMetadata","description":""},{"path":"/docs/types/GeoMapHeatDetail","title":"GeoMapHeatDetail","description":""},{"path":"/docs/types/GeoMapHeatInput","title":"GeoMapHeatInput","description":""},{"path":"/docs/types/GeoMapHeatOptions","title":"GeoMapHeatOptions","description":""},{"path":"/docs/types/GeoMapHeatPointDetail","title":"GeoMapHeatPointDetail","description":""},{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":""},{"path":"/docs/types/GeoMapIdentityProjection","title":"GeoMapIdentityProjection","description":""},{"path":"/docs/types/GeoMapJsonValue","title":"GeoMapJsonValue","description":""},{"path":"/docs/types/GeoMapLabel","title":"GeoMapLabel","description":""},{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","description":""},{"path":"/docs/types/GeoMapLabelView","title":"GeoMapLabelView","description":""},{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":""},{"path":"/docs/types/GeoMapLayerChangeEventDetail","title":"GeoMapLayerChangeEventDetail","description":""},{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","description":""},{"path":"/docs/types/GeoMapLayerVisibility","title":"GeoMapLayerVisibility","description":""},{"path":"/docs/types/GeoMapLayersInput","title":"GeoMapLayersInput","description":""},{"path":"/docs/types/GeoMapLayoutResult","title":"GeoMapLayoutResult","description":""},{"path":"/docs/types/GeoMapMark","title":"GeoMapMark","description":""},{"path":"/docs/types/GeoMapMercatorProjection","title":"GeoMapMercatorProjection","description":""},{"path":"/docs/types/GeoMapOrthographicProjection","title":"GeoMapOrthographicProjection","description":""},{"path":"/docs/types/GeoMapPickDetail","title":"GeoMapPickDetail","description":""},{"path":"/docs/types/GeoMapPoint","title":"GeoMapPoint","description":""},{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":""},{"path":"/docs/types/GeoMapPointLabel","title":"GeoMapPointLabel","description":""},{"path":"/docs/types/GeoMapPosition","title":"GeoMapPosition","description":""},{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","description":""},{"path":"/docs/types/GeoMapProjectionName","title":"GeoMapProjectionName","description":""},{"path":"/docs/types/GeoMapProperties","title":"GeoMapProperties","description":""},{"path":"/docs/types/GeoMapRegion","title":"GeoMapRegion","description":""},{"path":"/docs/types/GeoMapRenderResult","title":"GeoMapRenderResult","description":""},{"path":"/docs/types/GeoMapSelection","title":"GeoMapSelection","description":""},{"path":"/docs/types/GeoMapSelectionChangeEventDetail","title":"GeoMapSelectionChangeEventDetail","description":""},{"path":"/docs/types/GeoMapSelectionSource","title":"GeoMapSelectionSource","description":""},{"path":"/docs/types/GeoMapStreamEvent","title":"GeoMapStreamEvent","description":""},{"path":"/docs/types/GeoMapStreamSource","title":"GeoMapStreamSource","description":""},{"path":"/docs/types/GeoMapUnavailableBehaviour","title":"GeoMapUnavailableBehaviour","description":""},{"path":"/docs/types/GeoMapViewChangeEventDetail","title":"GeoMapViewChangeEventDetail","description":""},{"path":"/docs/types/GeoMapViewDetail","title":"GeoMapViewDetail","description":""}]}]},{"id":"H","title":"H","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""},{"path":"/docs/types/HeatmapAreaReduce","title":"HeatmapAreaReduce","description":""},{"path":"/docs/types/HeatmapCategoriesInput","title":"HeatmapCategoriesInput","description":""},{"path":"/docs/types/HeatmapCellValue","title":"HeatmapCellValue","description":""},{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","description":""},{"path":"/docs/types/HeatmapData","title":"HeatmapData","description":""},{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","description":""},{"path":"/docs/types/HeatmapDrawLod","title":"HeatmapDrawLod","description":""},{"path":"/docs/types/HeatmapDrawPath","title":"HeatmapDrawPath","description":""},{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""},{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""},{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""},{"path":"/docs/types/HeatmapLodMode","title":"HeatmapLodMode","description":""},{"path":"/docs/types/HeatmapMatrixInput","title":"HeatmapMatrixInput","description":""},{"path":"/docs/types/HeatmapMatrixObject","title":"HeatmapMatrixObject","description":""},{"path":"/docs/types/HeatmapMatrixRows","title":"HeatmapMatrixRows","description":""},{"path":"/docs/types/HeatmapPlaneStats","title":"HeatmapPlaneStats","description":""},{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":""},{"path":"/docs/types/HeatmapRenderPath","title":"HeatmapRenderPath","description":""},{"path":"/docs/types/HeatmapRenderResult","title":"HeatmapRenderResult","description":""},{"path":"/docs/types/HeatmapStreamEvent","title":"HeatmapStreamEvent","description":""},{"path":"/docs/types/HeatmapStreamEventType","title":"HeatmapStreamEventType","description":""},{"path":"/docs/types/HeatmapStreamSource","title":"HeatmapStreamSource","description":""},{"path":"/docs/types/HeatmapTuple","title":"HeatmapTuple","description":""},{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""},{"path":"/docs/types/HeatmapValueExtent","title":"HeatmapValueExtent","description":""},{"path":"/docs/types/HistogramAnimationType","title":"HistogramAnimationType","description":""},{"path":"/docs/types/HistogramBinning","title":"HistogramBinning","description":""},{"path":"/docs/types/HistogramBinsRule","title":"HistogramBinsRule","description":""},{"path":"/docs/types/HistogramEasing","title":"HistogramEasing","description":""},{"path":"/docs/types/HistogramEngineMode","title":"HistogramEngineMode","description":""},{"path":"/docs/types/HistogramEngineTier","title":"HistogramEngineTier","description":""},{"path":"/docs/types/HistogramNormalize","title":"HistogramNormalize","description":""},{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","description":""},{"path":"/docs/types/HistogramProDrawStats","title":"HistogramProDrawStats","description":""},{"path":"/docs/types/HistogramRenderResult","title":"HistogramRenderResult","description":""},{"path":"/docs/types/HistogramStreamDatum","title":"HistogramStreamDatum","description":""},{"path":"/docs/types/HistogramStreamEvent","title":"HistogramStreamEvent","description":""},{"path":"/docs/types/HistogramStreamSource","title":"HistogramStreamSource","description":""},{"path":"/docs/types/HistogramUnavailableBehaviour","title":"HistogramUnavailableBehaviour","description":""},{"path":"/docs/types/HistogramValues","title":"HistogramValues","description":""}]}]},{"id":"I","title":"I","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleAnimationType","title":"IcicleAnimationType","description":""},{"path":"/docs/types/IcicleData","title":"IcicleData","description":""},{"path":"/docs/types/IcicleDirection","title":"IcicleDirection","description":""},{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","description":""},{"path":"/docs/types/IcicleEasing","title":"IcicleEasing","description":""},{"path":"/docs/types/IcicleEngineMode","title":"IcicleEngineMode","description":""},{"path":"/docs/types/IcicleEngineTier","title":"IcicleEngineTier","description":""},{"path":"/docs/types/IcicleExtent","title":"IcicleExtent","description":""},{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":""},{"path":"/docs/types/IcicleLabel","title":"IcicleLabel","description":""},{"path":"/docs/types/IcicleLabelMode","title":"IcicleLabelMode","description":""},{"path":"/docs/types/IcicleLayout","title":"IcicleLayout","description":""},{"path":"/docs/types/IcicleLayoutResult","title":"IcicleLayoutResult","description":""},{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":""},{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":""},{"path":"/docs/types/IcicleRect","title":"IcicleRect","description":""},{"path":"/docs/types/IcicleRenderResult","title":"IcicleRenderResult","description":""},{"path":"/docs/types/IcicleSelection","title":"IcicleSelection","description":""},{"path":"/docs/types/IcicleSelectionChangeEventDetail","title":"IcicleSelectionChangeEventDetail","description":""},{"path":"/docs/types/IcicleSelectionSource","title":"IcicleSelectionSource","description":""},{"path":"/docs/types/IcicleStreamEvent","title":"IcicleStreamEvent","description":""},{"path":"/docs/types/IcicleStreamSource","title":"IcicleStreamSource","description":""},{"path":"/docs/types/IcicleUnavailableBehaviour","title":"IcicleUnavailableBehaviour","description":""},{"path":"/docs/types/IndicatorBandSpec","title":"IndicatorBandSpec","description":""},{"path":"/docs/types/IndicatorColumns","title":"IndicatorColumns","description":""},{"path":"/docs/types/IndicatorDefinition","title":"IndicatorDefinition","description":""},{"path":"/docs/types/IndicatorLevel","title":"IndicatorLevel","description":""},{"path":"/docs/types/IndicatorOutputSpec","title":"IndicatorOutputSpec","description":""},{"path":"/docs/types/IndicatorOutputStyle","title":"IndicatorOutputStyle","description":""},{"path":"/docs/types/IndicatorPlacement","title":"IndicatorPlacement","description":""},{"path":"/docs/types/ItemChartAnimationType","title":"ItemChartAnimationType","description":""},{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":""},{"path":"/docs/types/ItemChartEasing","title":"ItemChartEasing","description":""},{"path":"/docs/types/ItemChartEngineMode","title":"ItemChartEngineMode","description":""},{"path":"/docs/types/ItemChartEngineTier","title":"ItemChartEngineTier","description":""},{"path":"/docs/types/ItemChartLegendPosition","title":"ItemChartLegendPosition","description":""},{"path":"/docs/types/ItemChartPaletteName","title":"ItemChartPaletteName","description":""},{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","description":""},{"path":"/docs/types/ItemChartRenderResult","title":"ItemChartRenderResult","description":""},{"path":"/docs/types/ItemChartResolvedParty","title":"ItemChartResolvedParty","description":""},{"path":"/docs/types/ItemChartStreamEvent","title":"ItemChartStreamEvent","description":""},{"path":"/docs/types/ItemChartStreamSource","title":"ItemChartStreamSource","description":""},{"path":"/docs/types/ItemChartSymbol","title":"ItemChartSymbol","description":""},{"path":"/docs/types/ItemChartTooltipActionEventDetail","title":"ItemChartTooltipActionEventDetail","description":""},{"path":"/docs/types/ItemChartTooltipConnectorInput","title":"ItemChartTooltipConnectorInput","description":""},{"path":"/docs/types/ItemChartTooltipConnectorSpec","title":"ItemChartTooltipConnectorSpec","description":""},{"path":"/docs/types/ItemChartTooltipFormatContext","title":"ItemChartTooltipFormatContext","description":""},{"path":"/docs/types/ItemChartTooltipInput","title":"ItemChartTooltipInput","description":""},{"path":"/docs/types/ItemChartTooltipObjectInput","title":"ItemChartTooltipObjectInput","description":""},{"path":"/docs/types/ItemChartTooltipOpenMode","title":"ItemChartTooltipOpenMode","description":""},{"path":"/docs/types/ItemChartTooltipShowEventDetail","title":"ItemChartTooltipShowEventDetail","description":""},{"path":"/docs/types/ItemChartTooltipSide","title":"ItemChartTooltipSide","description":""},{"path":"/docs/types/ItemChartTooltipSpec","title":"ItemChartTooltipSpec","description":""},{"path":"/docs/types/ItemChartTooltipStyle","title":"ItemChartTooltipStyle","description":""},{"path":"/docs/types/ItemChartTooltipStyleValue","title":"ItemChartTooltipStyleValue","description":""},{"path":"/docs/types/ItemChartTooltipTrigger","title":"ItemChartTooltipTrigger","description":""},{"path":"/docs/types/ItemChartUnavailableBehaviour","title":"ItemChartUnavailableBehaviour","description":""},{"path":"/docs/types/ItemChartValues","title":"ItemChartValues","description":""}]}]},{"id":"L","title":"L","blocks":[{"kind":"links","items":[{"path":"/docs/types/LegendItem","title":"LegendItem","description":""},{"path":"/docs/types/LineChartAnimationType","title":"LineChartAnimationType","description":""},{"path":"/docs/types/LineChartDatum","title":"LineChartDatum","description":""},{"path":"/docs/types/LineChartEasing","title":"LineChartEasing","description":""},{"path":"/docs/types/LineChartEngineMode","title":"LineChartEngineMode","description":""},{"path":"/docs/types/LineChartEngineTier","title":"LineChartEngineTier","description":""},{"path":"/docs/types/LineChartFrameBudgetEventDetail","title":"LineChartFrameBudgetEventDetail","description":""},{"path":"/docs/types/LineChartFrameBudgetInfo","title":"LineChartFrameBudgetInfo","description":""},{"path":"/docs/types/LineChartLegendItemEventDetail","title":"LineChartLegendItemEventDetail","description":""},{"path":"/docs/types/LineChartLegendPosition","title":"LineChartLegendPosition","description":""},{"path":"/docs/types/LineChartMarker","title":"LineChartMarker","description":""},{"path":"/docs/types/LineChartMarkerActiveTrigger","title":"LineChartMarkerActiveTrigger","description":""},{"path":"/docs/types/LineChartMarkerFilter","title":"LineChartMarkerFilter","description":""},{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":""},{"path":"/docs/types/LineChartRenderResult","title":"LineChartRenderResult","description":""},{"path":"/docs/types/LineChartRingRenderStats","title":"LineChartRingRenderStats","description":""},{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","description":""},{"path":"/docs/types/LineChartSeriesStateOptions","title":"LineChartSeriesStateOptions","description":""},{"path":"/docs/types/LineChartSeriesStateStyle","title":"LineChartSeriesStateStyle","description":""},{"path":"/docs/types/LineChartSeriesToggledEventDetail","title":"LineChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/LineChartSmooth","title":"LineChartSmooth","description":""},{"path":"/docs/types/LineChartStep","title":"LineChartStep","description":""},{"path":"/docs/types/LineChartStreamEvent","title":"LineChartStreamEvent","description":""},{"path":"/docs/types/LineChartStreamFrameInfo","title":"LineChartStreamFrameInfo","description":""},{"path":"/docs/types/LineChartStreamSource","title":"LineChartStreamSource","description":""},{"path":"/docs/types/LineChartUnavailableBehaviour","title":"LineChartUnavailableBehaviour","description":""},{"path":"/docs/types/LineChartValues","title":"LineChartValues","description":""},{"path":"/docs/types/LollipopBarDatum","title":"LollipopBarDatum","description":""},{"path":"/docs/types/LollipopChartAnimationType","title":"LollipopChartAnimationType","description":""},{"path":"/docs/types/LollipopChartDatum","title":"LollipopChartDatum","description":""},{"path":"/docs/types/LollipopChartEasing","title":"LollipopChartEasing","description":""},{"path":"/docs/types/LollipopChartEngineMode","title":"LollipopChartEngineMode","description":""},{"path":"/docs/types/LollipopChartEngineTier","title":"LollipopChartEngineTier","description":""},{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","description":""},{"path":"/docs/types/LollipopChartRenderResult","title":"LollipopChartRenderResult","description":""},{"path":"/docs/types/LollipopChartStreamEvent","title":"LollipopChartStreamEvent","description":""},{"path":"/docs/types/LollipopChartStreamSource","title":"LollipopChartStreamSource","description":""},{"path":"/docs/types/LollipopChartUnavailableBehaviour","title":"LollipopChartUnavailableBehaviour","description":""},{"path":"/docs/types/LollipopChartValues","title":"LollipopChartValues","description":""},{"path":"/docs/types/LollipopMarkerSymbol","title":"LollipopMarkerSymbol","description":""},{"path":"/docs/types/LollipopOrientation","title":"LollipopOrientation","description":""}]}]},{"id":"M","title":"M","blocks":[{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartAnimationType","title":"MarimekkoChartAnimationType","description":""},{"path":"/docs/types/MarimekkoChartEasing","title":"MarimekkoChartEasing","description":""},{"path":"/docs/types/MarimekkoChartEngineMode","title":"MarimekkoChartEngineMode","description":""},{"path":"/docs/types/MarimekkoChartEngineTier","title":"MarimekkoChartEngineTier","description":""},{"path":"/docs/types/MarimekkoChartLegendItemEventDetail","title":"MarimekkoChartLegendItemEventDetail","description":""},{"path":"/docs/types/MarimekkoChartLegendPosition","title":"MarimekkoChartLegendPosition","description":""},{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","description":""},{"path":"/docs/types/MarimekkoChartRenderResult","title":"MarimekkoChartRenderResult","description":""},{"path":"/docs/types/MarimekkoChartStreamEvent","title":"MarimekkoChartStreamEvent","description":""},{"path":"/docs/types/MarimekkoChartStreamSource","title":"MarimekkoChartStreamSource","description":""},{"path":"/docs/types/MarimekkoChartUnavailableBehaviour","title":"MarimekkoChartUnavailableBehaviour","description":""},{"path":"/docs/types/MarimekkoColumnDatum","title":"MarimekkoColumnDatum","description":""},{"path":"/docs/types/MarimekkoSeries","title":"MarimekkoSeries","description":""}]}]},{"id":"N","title":"N","blocks":[{"kind":"links","items":[{"path":"/docs/types/NavigatorSampling","title":"NavigatorSampling","description":""},{"path":"/docs/types/NavigatorTargetElement","title":"NavigatorTargetElement","description":""},{"path":"/docs/types/NetworkGraphAnimationType","title":"NetworkGraphAnimationType","description":""},{"path":"/docs/types/NetworkGraphBundling","title":"NetworkGraphBundling","description":""},{"path":"/docs/types/NetworkGraphBundlingStats","title":"NetworkGraphBundlingStats","description":""},{"path":"/docs/types/NetworkGraphCluster","title":"NetworkGraphCluster","description":""},{"path":"/docs/types/NetworkGraphClustering","title":"NetworkGraphClustering","description":""},{"path":"/docs/types/NetworkGraphClusteringResult","title":"NetworkGraphClusteringResult","description":""},{"path":"/docs/types/NetworkGraphClusteringStats","title":"NetworkGraphClusteringStats","description":""},{"path":"/docs/types/NetworkGraphData","title":"NetworkGraphData","description":""},{"path":"/docs/types/NetworkGraphDragSource","title":"NetworkGraphDragSource","description":""},{"path":"/docs/types/NetworkGraphDrawStats","title":"NetworkGraphDrawStats","description":""},{"path":"/docs/types/NetworkGraphEasing","title":"NetworkGraphEasing","description":""},{"path":"/docs/types/NetworkGraphEngineMode","title":"NetworkGraphEngineMode","description":""},{"path":"/docs/types/NetworkGraphEngineTier","title":"NetworkGraphEngineTier","description":""},{"path":"/docs/types/NetworkGraphExtent","title":"NetworkGraphExtent","description":""},{"path":"/docs/types/NetworkGraphForceStats","title":"NetworkGraphForceStats","description":""},{"path":"/docs/types/NetworkGraphGraphInput","title":"NetworkGraphGraphInput","description":""},{"path":"/docs/types/NetworkGraphHierarchicalStats","title":"NetworkGraphHierarchicalStats","description":""},{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","description":""},{"path":"/docs/types/NetworkGraphLabelMode","title":"NetworkGraphLabelMode","description":""},{"path":"/docs/types/NetworkGraphLayout","title":"NetworkGraphLayout","description":""},{"path":"/docs/types/NetworkGraphLayoutLink","title":"NetworkGraphLayoutLink","description":""},{"path":"/docs/types/NetworkGraphLayoutNode","title":"NetworkGraphLayoutNode","description":""},{"path":"/docs/types/NetworkGraphLayoutResult","title":"NetworkGraphLayoutResult","description":""},{"path":"/docs/types/NetworkGraphLink","title":"NetworkGraphLink","description":""},{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","description":""},{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":""},{"path":"/docs/types/NetworkGraphLinkObject","title":"NetworkGraphLinkObject","description":""},{"path":"/docs/types/NetworkGraphLinkTuple","title":"NetworkGraphLinkTuple","description":""},{"path":"/docs/types/NetworkGraphNode","title":"NetworkGraphNode","description":""},{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","description":""},{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":""},{"path":"/docs/types/NetworkGraphNodeInput","title":"NetworkGraphNodeInput","description":""},{"path":"/docs/types/NetworkGraphNodeLabel","title":"NetworkGraphNodeLabel","description":""},{"path":"/docs/types/NetworkGraphNodeObject","title":"NetworkGraphNodeObject","description":""},{"path":"/docs/types/NetworkGraphPinnedNode","title":"NetworkGraphPinnedNode","description":""},{"path":"/docs/types/NetworkGraphPoint","title":"NetworkGraphPoint","description":""},{"path":"/docs/types/NetworkGraphRenderResult","title":"NetworkGraphRenderResult","description":""},{"path":"/docs/types/NetworkGraphSelection","title":"NetworkGraphSelection","description":""},{"path":"/docs/types/NetworkGraphSelectionChangeEventDetail","title":"NetworkGraphSelectionChangeEventDetail","description":""},{"path":"/docs/types/NetworkGraphSelectionSource","title":"NetworkGraphSelectionSource","description":""},{"path":"/docs/types/NetworkGraphStreamEvent","title":"NetworkGraphStreamEvent","description":""},{"path":"/docs/types/NetworkGraphStreamSource","title":"NetworkGraphStreamSource","description":""},{"path":"/docs/types/NetworkGraphUnavailableBehaviour","title":"NetworkGraphUnavailableBehaviour","description":""}]}]},{"id":"O","title":"O","blocks":[{"kind":"links","items":[{"path":"/docs/types/Orbit3DAction","title":"Orbit3DAction","description":""},{"path":"/docs/types/Orbit3DOptions","title":"Orbit3DOptions","description":""}]}]},{"id":"P","title":"P","blocks":[{"kind":"links","items":[{"path":"/docs/types/PaneSpecInput","title":"PaneSpecInput","description":""},{"path":"/docs/types/ParallelCoordinatesAnimationType","title":"ParallelCoordinatesAnimationType","description":""},{"path":"/docs/types/ParallelCoordinatesAxesInput","title":"ParallelCoordinatesAxesInput","description":""},{"path":"/docs/types/ParallelCoordinatesAxesSpec","title":"ParallelCoordinatesAxesSpec","description":""},{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","description":""},{"path":"/docs/types/ParallelCoordinatesAxisBrush","title":"ParallelCoordinatesAxisBrush","description":""},{"path":"/docs/types/ParallelCoordinatesAxisModel","title":"ParallelCoordinatesAxisModel","description":""},{"path":"/docs/types/ParallelCoordinatesAxisTick","title":"ParallelCoordinatesAxisTick","description":""},{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":""},{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","description":""},{"path":"/docs/types/ParallelCoordinatesBrushInput","title":"ParallelCoordinatesBrushInput","description":""},{"path":"/docs/types/ParallelCoordinatesBrushModel","title":"ParallelCoordinatesBrushModel","description":""},{"path":"/docs/types/ParallelCoordinatesBrushSource","title":"ParallelCoordinatesBrushSource","description":""},{"path":"/docs/types/ParallelCoordinatesBrushSpec","title":"ParallelCoordinatesBrushSpec","description":""},{"path":"/docs/types/ParallelCoordinatesCrosshairDetail","title":"ParallelCoordinatesCrosshairDetail","description":""},{"path":"/docs/types/ParallelCoordinatesData","title":"ParallelCoordinatesData","description":""},{"path":"/docs/types/ParallelCoordinatesDeclaration","title":"ParallelCoordinatesDeclaration","description":""},{"path":"/docs/types/ParallelCoordinatesDiagnostics","title":"ParallelCoordinatesDiagnostics","description":""},{"path":"/docs/types/ParallelCoordinatesDimensionInput","title":"ParallelCoordinatesDimensionInput","description":""},{"path":"/docs/types/ParallelCoordinatesEasing","title":"ParallelCoordinatesEasing","description":""},{"path":"/docs/types/ParallelCoordinatesEngineMode","title":"ParallelCoordinatesEngineMode","description":""},{"path":"/docs/types/ParallelCoordinatesEngineTier","title":"ParallelCoordinatesEngineTier","description":""},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":""},{"path":"/docs/types/ParallelCoordinatesLabelBox","title":"ParallelCoordinatesLabelBox","description":""},{"path":"/docs/types/ParallelCoordinatesLayoutResult","title":"ParallelCoordinatesLayoutResult","description":""},{"path":"/docs/types/ParallelCoordinatesLine","title":"ParallelCoordinatesLine","description":""},{"path":"/docs/types/ParallelCoordinatesLineModel","title":"ParallelCoordinatesLineModel","description":""},{"path":"/docs/types/ParallelCoordinatesLinePoint","title":"ParallelCoordinatesLinePoint","description":""},{"path":"/docs/types/ParallelCoordinatesLineStyle","title":"ParallelCoordinatesLineStyle","description":""},{"path":"/docs/types/ParallelCoordinatesRenderResult","title":"ParallelCoordinatesRenderResult","description":""},{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":""},{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":""},{"path":"/docs/types/ParallelCoordinatesSelection","title":"ParallelCoordinatesSelection","description":""},{"path":"/docs/types/ParallelCoordinatesSelectionChangeEventDetail","title":"ParallelCoordinatesSelectionChangeEventDetail","description":""},{"path":"/docs/types/ParallelCoordinatesSelectionSource","title":"ParallelCoordinatesSelectionSource","description":""},{"path":"/docs/types/ParallelCoordinatesStreamEvent","title":"ParallelCoordinatesStreamEvent","description":""},{"path":"/docs/types/ParallelCoordinatesStreamSource","title":"ParallelCoordinatesStreamSource","description":""},{"path":"/docs/types/ParallelCoordinatesUnavailableBehaviour","title":"ParallelCoordinatesUnavailableBehaviour","description":""},{"path":"/docs/types/ParallelCoordinatesVertex","title":"ParallelCoordinatesVertex","description":""},{"path":"/docs/types/ParetoBarDatum","title":"ParetoBarDatum","description":""},{"path":"/docs/types/ParetoChartAnimationType","title":"ParetoChartAnimationType","description":""},{"path":"/docs/types/ParetoChartDatum","title":"ParetoChartDatum","description":""},{"path":"/docs/types/ParetoChartEasing","title":"ParetoChartEasing","description":""},{"path":"/docs/types/ParetoChartEngineMode","title":"ParetoChartEngineMode","description":""},{"path":"/docs/types/ParetoChartEngineTier","title":"ParetoChartEngineTier","description":""},{"path":"/docs/types/ParetoChartLegendItemEventDetail","title":"ParetoChartLegendItemEventDetail","description":""},{"path":"/docs/types/ParetoChartLegendPosition","title":"ParetoChartLegendPosition","description":""},{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","description":""},{"path":"/docs/types/ParetoChartRenderResult","title":"ParetoChartRenderResult","description":""},{"path":"/docs/types/ParetoChartStreamEvent","title":"ParetoChartStreamEvent","description":""},{"path":"/docs/types/ParetoChartStreamSource","title":"ParetoChartStreamSource","description":""},{"path":"/docs/types/ParetoChartUnavailableBehaviour","title":"ParetoChartUnavailableBehaviour","description":""},{"path":"/docs/types/ParetoChartValues","title":"ParetoChartValues","description":""},{"path":"/docs/types/PictorialBarDatum","title":"PictorialBarDatum","description":""},{"path":"/docs/types/PictorialChartAnimationType","title":"PictorialChartAnimationType","description":""},{"path":"/docs/types/PictorialChartDatum","title":"PictorialChartDatum","description":""},{"path":"/docs/types/PictorialChartEasing","title":"PictorialChartEasing","description":""},{"path":"/docs/types/PictorialChartEngineMode","title":"PictorialChartEngineMode","description":""},{"path":"/docs/types/PictorialChartEngineTier","title":"PictorialChartEngineTier","description":""},{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","description":""},{"path":"/docs/types/PictorialChartRenderResult","title":"PictorialChartRenderResult","description":""},{"path":"/docs/types/PictorialChartStreamEvent","title":"PictorialChartStreamEvent","description":""},{"path":"/docs/types/PictorialChartStreamSource","title":"PictorialChartStreamSource","description":""},{"path":"/docs/types/PictorialChartUnavailableBehaviour","title":"PictorialChartUnavailableBehaviour","description":""},{"path":"/docs/types/PictorialChartValues","title":"PictorialChartValues","description":""},{"path":"/docs/types/PieChartAnimationType","title":"PieChartAnimationType","description":""},{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":""},{"path":"/docs/types/PieChartEasing","title":"PieChartEasing","description":""},{"path":"/docs/types/PieChartEngineMode","title":"PieChartEngineMode","description":""},{"path":"/docs/types/PieChartEngineTier","title":"PieChartEngineTier","description":""},{"path":"/docs/types/PieChartLabelContent","title":"PieChartLabelContent","description":""},{"path":"/docs/types/PieChartLabelMode","title":"PieChartLabelMode","description":""},{"path":"/docs/types/PieChartLegendPosition","title":"PieChartLegendPosition","description":""},{"path":"/docs/types/PieChartPaletteName","title":"PieChartPaletteName","description":""},{"path":"/docs/types/PieChartPerPointDataLabel","title":"PieChartPerPointDataLabel","description":""},{"path":"/docs/types/PieChartRenderResult","title":"PieChartRenderResult","description":""},{"path":"/docs/types/PieChartResolvedSlice","title":"PieChartResolvedSlice","description":""},{"path":"/docs/types/PieChartSelectedEventDetail","title":"PieChartSelectedEventDetail","description":""},{"path":"/docs/types/PieChartSizeBy","title":"PieChartSizeBy","description":""},{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":""},{"path":"/docs/types/PieChartStreamEvent","title":"PieChartStreamEvent","description":""},{"path":"/docs/types/PieChartStreamSource","title":"PieChartStreamSource","description":""},{"path":"/docs/types/PieChartTooltipActionEventDetail","title":"PieChartTooltipActionEventDetail","description":""},{"path":"/docs/types/PieChartTooltipConnectorInput","title":"PieChartTooltipConnectorInput","description":""},{"path":"/docs/types/PieChartTooltipConnectorSpec","title":"PieChartTooltipConnectorSpec","description":""},{"path":"/docs/types/PieChartTooltipFormatContext","title":"PieChartTooltipFormatContext","description":""},{"path":"/docs/types/PieChartTooltipInput","title":"PieChartTooltipInput","description":""},{"path":"/docs/types/PieChartTooltipObjectInput","title":"PieChartTooltipObjectInput","description":""},{"path":"/docs/types/PieChartTooltipOpenMode","title":"PieChartTooltipOpenMode","description":""},{"path":"/docs/types/PieChartTooltipShowEventDetail","title":"PieChartTooltipShowEventDetail","description":""},{"path":"/docs/types/PieChartTooltipSide","title":"PieChartTooltipSide","description":""},{"path":"/docs/types/PieChartTooltipSpec","title":"PieChartTooltipSpec","description":""},{"path":"/docs/types/PieChartTooltipStyle","title":"PieChartTooltipStyle","description":""},{"path":"/docs/types/PieChartTooltipStyleValue","title":"PieChartTooltipStyleValue","description":""},{"path":"/docs/types/PieChartTooltipTrigger","title":"PieChartTooltipTrigger","description":""},{"path":"/docs/types/PieChartUnavailableBehaviour","title":"PieChartUnavailableBehaviour","description":""},{"path":"/docs/types/PieChartValues","title":"PieChartValues","description":""},{"path":"/docs/types/PiecewiseVisualMapSnapshot","title":"PiecewiseVisualMapSnapshot","description":""},{"path":"/docs/types/PiecewiseVisualMapSpec","title":"PiecewiseVisualMapSpec","description":""},{"path":"/docs/types/Point","title":"Point","description":""},{"path":"/docs/types/PolarChartAnimationType","title":"PolarChartAnimationType","description":""},{"path":"/docs/types/PolarChartData","title":"PolarChartData","description":""},{"path":"/docs/types/PolarChartEasing","title":"PolarChartEasing","description":""},{"path":"/docs/types/PolarChartEngineMode","title":"PolarChartEngineMode","description":""},{"path":"/docs/types/PolarChartEngineTier","title":"PolarChartEngineTier","description":""},{"path":"/docs/types/PolarChartLegendPosition","title":"PolarChartLegendPosition","description":""},{"path":"/docs/types/PolarChartPaletteName","title":"PolarChartPaletteName","description":""},{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":""},{"path":"/docs/types/PolarChartRenderResult","title":"PolarChartRenderResult","description":""},{"path":"/docs/types/PolarChartStackingMode","title":"PolarChartStackingMode","description":""},{"path":"/docs/types/PolarChartStreamEvent","title":"PolarChartStreamEvent","description":""},{"path":"/docs/types/PolarChartStreamSource","title":"PolarChartStreamSource","description":""},{"path":"/docs/types/PolarChartTooltipActionEventDetail","title":"PolarChartTooltipActionEventDetail","description":""},{"path":"/docs/types/PolarChartTooltipConnectorInput","title":"PolarChartTooltipConnectorInput","description":""},{"path":"/docs/types/PolarChartTooltipConnectorSpec","title":"PolarChartTooltipConnectorSpec","description":""},{"path":"/docs/types/PolarChartTooltipFormatContext","title":"PolarChartTooltipFormatContext","description":""},{"path":"/docs/types/PolarChartTooltipInput","title":"PolarChartTooltipInput","description":""},{"path":"/docs/types/PolarChartTooltipObjectInput","title":"PolarChartTooltipObjectInput","description":""},{"path":"/docs/types/PolarChartTooltipOpenMode","title":"PolarChartTooltipOpenMode","description":""},{"path":"/docs/types/PolarChartTooltipShowEventDetail","title":"PolarChartTooltipShowEventDetail","description":""},{"path":"/docs/types/PolarChartTooltipSide","title":"PolarChartTooltipSide","description":""},{"path":"/docs/types/PolarChartTooltipSpec","title":"PolarChartTooltipSpec","description":""},{"path":"/docs/types/PolarChartTooltipStyle","title":"PolarChartTooltipStyle","description":""},{"path":"/docs/types/PolarChartTooltipStyleValue","title":"PolarChartTooltipStyleValue","description":""},{"path":"/docs/types/PolarChartTooltipTrigger","title":"PolarChartTooltipTrigger","description":""},{"path":"/docs/types/PolarChartUnavailableBehaviour","title":"PolarChartUnavailableBehaviour","description":""},{"path":"/docs/types/PolarChartVariant","title":"PolarChartVariant","description":""},{"path":"/docs/types/PolarProRenderStats","title":"PolarProRenderStats","description":""},{"path":"/docs/types/PolarRoseRowDatum","title":"PolarRoseRowDatum","description":""},{"path":"/docs/types/PolarRoseSegment","title":"PolarRoseSegment","description":""},{"path":"/docs/types/PolarSeriesSpec","title":"PolarSeriesSpec","description":""},{"path":"/docs/types/PositionSide","title":"PositionSide","description":""}]}]},{"id":"R","title":"R","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartAnimationType","title":"RadarChartAnimationType","description":""},{"path":"/docs/types/RadarChartData","title":"RadarChartData","description":""},{"path":"/docs/types/RadarChartEasing","title":"RadarChartEasing","description":""},{"path":"/docs/types/RadarChartEngineMode","title":"RadarChartEngineMode","description":""},{"path":"/docs/types/RadarChartEngineTier","title":"RadarChartEngineTier","description":""},{"path":"/docs/types/RadarChartLegendPosition","title":"RadarChartLegendPosition","description":""},{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":""},{"path":"/docs/types/RadarChartRenderResult","title":"RadarChartRenderResult","description":""},{"path":"/docs/types/RadarChartSeriesActiveTrigger","title":"RadarChartSeriesActiveTrigger","description":""},{"path":"/docs/types/RadarChartStreamEvent","title":"RadarChartStreamEvent","description":""},{"path":"/docs/types/RadarChartStreamSource","title":"RadarChartStreamSource","description":""},{"path":"/docs/types/RadarChartTooltipActionEventDetail","title":"RadarChartTooltipActionEventDetail","description":""},{"path":"/docs/types/RadarChartTooltipConnectorInput","title":"RadarChartTooltipConnectorInput","description":""},{"path":"/docs/types/RadarChartTooltipConnectorSpec","title":"RadarChartTooltipConnectorSpec","description":""},{"path":"/docs/types/RadarChartTooltipFormatContext","title":"RadarChartTooltipFormatContext","description":""},{"path":"/docs/types/RadarChartTooltipInput","title":"RadarChartTooltipInput","description":""},{"path":"/docs/types/RadarChartTooltipObjectInput","title":"RadarChartTooltipObjectInput","description":""},{"path":"/docs/types/RadarChartTooltipOpenMode","title":"RadarChartTooltipOpenMode","description":""},{"path":"/docs/types/RadarChartTooltipShowEventDetail","title":"RadarChartTooltipShowEventDetail","description":""},{"path":"/docs/types/RadarChartTooltipSide","title":"RadarChartTooltipSide","description":""},{"path":"/docs/types/RadarChartTooltipSpec","title":"RadarChartTooltipSpec","description":""},{"path":"/docs/types/RadarChartTooltipStyle","title":"RadarChartTooltipStyle","description":""},{"path":"/docs/types/RadarChartTooltipStyleValue","title":"RadarChartTooltipStyleValue","description":""},{"path":"/docs/types/RadarChartTooltipTrigger","title":"RadarChartTooltipTrigger","description":""},{"path":"/docs/types/RadarChartUnavailableBehaviour","title":"RadarChartUnavailableBehaviour","description":""},{"path":"/docs/types/RadarChartVariant","title":"RadarChartVariant","description":""},{"path":"/docs/types/RadarGridShape","title":"RadarGridShape","description":""},{"path":"/docs/types/RadarSeriesSpec","title":"RadarSeriesSpec","description":""},{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":""},{"path":"/docs/types/RegressionMethod","title":"RegressionMethod","description":""},{"path":"/docs/types/RegressionOptions","title":"RegressionOptions","description":""}]}]},{"id":"S","title":"S","blocks":[{"kind":"links","items":[{"path":"/docs/types/SampleMethod","title":"SampleMethod","description":""},{"path":"/docs/types/SampleOptions","title":"SampleOptions","description":""},{"path":"/docs/types/SankeyAlign","title":"SankeyAlign","description":""},{"path":"/docs/types/SankeyAnimationType","title":"SankeyAnimationType","description":""},{"path":"/docs/types/SankeyData","title":"SankeyData","description":""},{"path":"/docs/types/SankeyDrawStats","title":"SankeyDrawStats","description":""},{"path":"/docs/types/SankeyEasing","title":"SankeyEasing","description":""},{"path":"/docs/types/SankeyEngineMode","title":"SankeyEngineMode","description":""},{"path":"/docs/types/SankeyEngineTier","title":"SankeyEngineTier","description":""},{"path":"/docs/types/SankeyExtent","title":"SankeyExtent","description":""},{"path":"/docs/types/SankeyGraphInput","title":"SankeyGraphInput","description":""},{"path":"/docs/types/SankeyHitDetail","title":"SankeyHitDetail","description":""},{"path":"/docs/types/SankeyLabelMode","title":"SankeyLabelMode","description":""},{"path":"/docs/types/SankeyLayoutResult","title":"SankeyLayoutResult","description":""},{"path":"/docs/types/SankeyLink","title":"SankeyLink","description":""},{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","description":""},{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":""},{"path":"/docs/types/SankeyLinkObject","title":"SankeyLinkObject","description":""},{"path":"/docs/types/SankeyLinkRibbon","title":"SankeyLinkRibbon","description":""},{"path":"/docs/types/SankeyLinkTuple","title":"SankeyLinkTuple","description":""},{"path":"/docs/types/SankeyNode","title":"SankeyNode","description":""},{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":""},{"path":"/docs/types/SankeyNodeInput","title":"SankeyNodeInput","description":""},{"path":"/docs/types/SankeyNodeLabel","title":"SankeyNodeLabel","description":""},{"path":"/docs/types/SankeyNodeObject","title":"SankeyNodeObject","description":""},{"path":"/docs/types/SankeyNodeRect","title":"SankeyNodeRect","description":""},{"path":"/docs/types/SankeyRenderResult","title":"SankeyRenderResult","description":""},{"path":"/docs/types/SankeySelection","title":"SankeySelection","description":""},{"path":"/docs/types/SankeySelectionChangeEventDetail","title":"SankeySelectionChangeEventDetail","description":""},{"path":"/docs/types/SankeySelectionSource","title":"SankeySelectionSource","description":""},{"path":"/docs/types/SankeyStreamEvent","title":"SankeyStreamEvent","description":""},{"path":"/docs/types/SankeyStreamSource","title":"SankeyStreamSource","description":""},{"path":"/docs/types/SankeyUnavailableBehaviour","title":"SankeyUnavailableBehaviour","description":""},{"path":"/docs/types/Scatter3DAxesOptions","title":"Scatter3DAxesOptions","description":""},{"path":"/docs/types/Scatter3DCameraChangeEventDetail","title":"Scatter3DCameraChangeEventDetail","description":""},{"path":"/docs/types/Scatter3DCrosshairDetail","title":"Scatter3DCrosshairDetail","description":""},{"path":"/docs/types/Scatter3DData","title":"Scatter3DData","description":""},{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":""},{"path":"/docs/types/Scatter3DDiagnostics","title":"Scatter3DDiagnostics","description":""},{"path":"/docs/types/Scatter3DDomain","title":"Scatter3DDomain","description":""},{"path":"/docs/types/Scatter3DEasing","title":"Scatter3DEasing","description":""},{"path":"/docs/types/Scatter3DEngineMode","title":"Scatter3DEngineMode","description":""},{"path":"/docs/types/Scatter3DEngineTier","title":"Scatter3DEngineTier","description":""},{"path":"/docs/types/Scatter3DGeometry","title":"Scatter3DGeometry","description":""},{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":""},{"path":"/docs/types/Scatter3DMarker","title":"Scatter3DMarker","description":""},{"path":"/docs/types/Scatter3DPoint","title":"Scatter3DPoint","description":""},{"path":"/docs/types/Scatter3DRenderResult","title":"Scatter3DRenderResult","description":""},{"path":"/docs/types/Scatter3DSelection","title":"Scatter3DSelection","description":""},{"path":"/docs/types/Scatter3DSelectionChangeEventDetail","title":"Scatter3DSelectionChangeEventDetail","description":""},{"path":"/docs/types/Scatter3DSelectionSource","title":"Scatter3DSelectionSource","description":""},{"path":"/docs/types/Scatter3DStreamEvent","title":"Scatter3DStreamEvent","description":""},{"path":"/docs/types/Scatter3DStreamSource","title":"Scatter3DStreamSource","description":""},{"path":"/docs/types/Scatter3DTuple","title":"Scatter3DTuple","description":""},{"path":"/docs/types/Scatter3DUnavailableBehaviour","title":"Scatter3DUnavailableBehaviour","description":""},{"path":"/docs/types/ScatterChartAnimationType","title":"ScatterChartAnimationType","description":""},{"path":"/docs/types/ScatterChartDatum","title":"ScatterChartDatum","description":""},{"path":"/docs/types/ScatterChartEasing","title":"ScatterChartEasing","description":""},{"path":"/docs/types/ScatterChartEngineMode","title":"ScatterChartEngineMode","description":""},{"path":"/docs/types/ScatterChartEngineTier","title":"ScatterChartEngineTier","description":""},{"path":"/docs/types/ScatterChartLegendItemEventDetail","title":"ScatterChartLegendItemEventDetail","description":""},{"path":"/docs/types/ScatterChartLegendPosition","title":"ScatterChartLegendPosition","description":""},{"path":"/docs/types/ScatterChartMarkerSymbol","title":"ScatterChartMarkerSymbol","description":""},{"path":"/docs/types/ScatterChartRenderResult","title":"ScatterChartRenderResult","description":""},{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","description":""},{"path":"/docs/types/ScatterChartSeriesActiveTrigger","title":"ScatterChartSeriesActiveTrigger","description":""},{"path":"/docs/types/ScatterChartSeriesStateOptions","title":"ScatterChartSeriesStateOptions","description":""},{"path":"/docs/types/ScatterChartSeriesStateStyle","title":"ScatterChartSeriesStateStyle","description":""},{"path":"/docs/types/ScatterChartSeriesToggledEventDetail","title":"ScatterChartSeriesToggledEventDetail","description":""},{"path":"/docs/types/ScatterChartStreamEvent","title":"ScatterChartStreamEvent","description":""},{"path":"/docs/types/ScatterChartStreamSource","title":"ScatterChartStreamSource","description":""},{"path":"/docs/types/ScatterChartUnavailableBehaviour","title":"ScatterChartUnavailableBehaviour","description":""},{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":""},{"path":"/docs/types/ScatterColorMap","title":"ScatterColorMap","description":""},{"path":"/docs/types/ScatterColorMapStop","title":"ScatterColorMapStop","description":""},{"path":"/docs/types/ScatterSizeMap","title":"ScatterSizeMap","description":""},{"path":"/docs/types/Scene3DAxesOptions","title":"Scene3DAxesOptions","description":""},{"path":"/docs/types/Scene3DAxis","title":"Scene3DAxis","description":""},{"path":"/docs/types/Scene3DBounds","title":"Scene3DBounds","description":""},{"path":"/docs/types/Scene3DCameraChangeEventDetail","title":"Scene3DCameraChangeEventDetail","description":""},{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":""},{"path":"/docs/types/Scene3DDataSpace","title":"Scene3DDataSpace","description":""},{"path":"/docs/types/Scene3DDirectionalLight","title":"Scene3DDirectionalLight","description":""},{"path":"/docs/types/Scene3DDomain","title":"Scene3DDomain","description":""},{"path":"/docs/types/Scene3DLight","title":"Scene3DLight","description":""},{"path":"/docs/types/Scene3DLightColor","title":"Scene3DLightColor","description":""},{"path":"/docs/types/Scene3DLightingOptions","title":"Scene3DLightingOptions","description":""},{"path":"/docs/types/Scene3DMaterialOptions","title":"Scene3DMaterialOptions","description":""},{"path":"/docs/types/Scene3DPointLight","title":"Scene3DPointLight","description":""},{"path":"/docs/types/Scene3DProjection","title":"Scene3DProjection","description":""},{"path":"/docs/types/Scene3DRgb","title":"Scene3DRgb","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""},{"path":"/docs/types/SpectrogramAnimationType","title":"SpectrogramAnimationType","description":""},{"path":"/docs/types/SpectrogramAppendSamplesResult","title":"SpectrogramAppendSamplesResult","description":""},{"path":"/docs/types/SpectrogramColumns","title":"SpectrogramColumns","description":""},{"path":"/docs/types/SpectrogramEasing","title":"SpectrogramEasing","description":""},{"path":"/docs/types/SpectrogramEngineMode","title":"SpectrogramEngineMode","description":""},{"path":"/docs/types/SpectrogramEngineTier","title":"SpectrogramEngineTier","description":""},{"path":"/docs/types/SpectrogramFftInfo","title":"SpectrogramFftInfo","description":""},{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","description":""},{"path":"/docs/types/SpectrogramInput","title":"SpectrogramInput","description":""},{"path":"/docs/types/SpectrogramLodMode","title":"SpectrogramLodMode","description":""},{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":""},{"path":"/docs/types/SpectrogramRanges","title":"SpectrogramRanges","description":""},{"path":"/docs/types/SpectrogramRenderResult","title":"SpectrogramRenderResult","description":""},{"path":"/docs/types/SpectrogramStreamEvent","title":"SpectrogramStreamEvent","description":""},{"path":"/docs/types/SpectrogramStreamSource","title":"SpectrogramStreamSource","description":""},{"path":"/docs/types/SpectrogramUnavailableBehaviour","title":"SpectrogramUnavailableBehaviour","description":""},{"path":"/docs/types/SpectrogramValueExtent","title":"SpectrogramValueExtent","description":""},{"path":"/docs/types/SpectrogramValueScale","title":"SpectrogramValueScale","description":""},{"path":"/docs/types/SpectrogramWindowKind","title":"SpectrogramWindowKind","description":""},{"path":"/docs/types/StemLeafAnimationType","title":"StemLeafAnimationType","description":""},{"path":"/docs/types/StemLeafEasing","title":"StemLeafEasing","description":""},{"path":"/docs/types/StemLeafEngineMode","title":"StemLeafEngineMode","description":""},{"path":"/docs/types/StemLeafEngineTier","title":"StemLeafEngineTier","description":""},{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":""},{"path":"/docs/types/StemLeafRenderResult","title":"StemLeafRenderResult","description":""},{"path":"/docs/types/StemLeafStreamDatum","title":"StemLeafStreamDatum","description":""},{"path":"/docs/types/StemLeafStreamEvent","title":"StemLeafStreamEvent","description":""},{"path":"/docs/types/StemLeafStreamSource","title":"StemLeafStreamSource","description":""},{"path":"/docs/types/StemLeafTooltipActionEventDetail","title":"StemLeafTooltipActionEventDetail","description":""},{"path":"/docs/types/StemLeafTooltipConnectorInput","title":"StemLeafTooltipConnectorInput","description":""},{"path":"/docs/types/StemLeafTooltipConnectorSpec","title":"StemLeafTooltipConnectorSpec","description":""},{"path":"/docs/types/StemLeafTooltipFormatContext","title":"StemLeafTooltipFormatContext","description":""},{"path":"/docs/types/StemLeafTooltipInput","title":"StemLeafTooltipInput","description":""},{"path":"/docs/types/StemLeafTooltipObjectInput","title":"StemLeafTooltipObjectInput","description":""},{"path":"/docs/types/StemLeafTooltipOpenMode","title":"StemLeafTooltipOpenMode","description":""},{"path":"/docs/types/StemLeafTooltipShowEventDetail","title":"StemLeafTooltipShowEventDetail","description":""},{"path":"/docs/types/StemLeafTooltipSide","title":"StemLeafTooltipSide","description":""},{"path":"/docs/types/StemLeafTooltipSpec","title":"StemLeafTooltipSpec","description":""},{"path":"/docs/types/StemLeafTooltipStyle","title":"StemLeafTooltipStyle","description":""},{"path":"/docs/types/StemLeafTooltipStyleValue","title":"StemLeafTooltipStyleValue","description":""},{"path":"/docs/types/StemLeafTooltipTarget","title":"StemLeafTooltipTarget","description":""},{"path":"/docs/types/StemLeafTooltipTrigger","title":"StemLeafTooltipTrigger","description":""},{"path":"/docs/types/StemLeafUnavailableBehaviour","title":"StemLeafUnavailableBehaviour","description":""},{"path":"/docs/types/StemLeafValues","title":"StemLeafValues","description":""},{"path":"/docs/types/StockDrawing","title":"StockDrawing","description":""},{"path":"/docs/types/StockDrawingInput","title":"StockDrawingInput","description":""},{"path":"/docs/types/StockFlagInput","title":"StockFlagInput","description":""},{"path":"/docs/types/StockFlagPosition","title":"StockFlagPosition","description":""},{"path":"/docs/types/StockFlagShape","title":"StockFlagShape","description":""},{"path":"/docs/types/StockIndicatorInput","title":"StockIndicatorInput","description":""},{"path":"/docs/types/StockPositionInput","title":"StockPositionInput","description":""},{"path":"/docs/types/StockRangeKey","title":"StockRangeKey","description":""},{"path":"/docs/types/StockResolution","title":"StockResolution","description":""},{"path":"/docs/types/StockSeriesStyle","title":"StockSeriesStyle","description":""},{"path":"/docs/types/StockSessionInput","title":"StockSessionInput","description":""},{"path":"/docs/types/StockTickInput","title":"StockTickInput","description":""},{"path":"/docs/types/StockTradeInput","title":"StockTradeInput","description":""},{"path":"/docs/types/SunburstAnimationType","title":"SunburstAnimationType","description":""},{"path":"/docs/types/SunburstArc","title":"SunburstArc","description":""},{"path":"/docs/types/SunburstData","title":"SunburstData","description":""},{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","description":""},{"path":"/docs/types/SunburstEasing","title":"SunburstEasing","description":""},{"path":"/docs/types/SunburstEngineMode","title":"SunburstEngineMode","description":""},{"path":"/docs/types/SunburstEngineTier","title":"SunburstEngineTier","description":""},{"path":"/docs/types/SunburstExtent","title":"SunburstExtent","description":""},{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":""},{"path":"/docs/types/SunburstLabel","title":"SunburstLabel","description":""},{"path":"/docs/types/SunburstLabelMode","title":"SunburstLabelMode","description":""},{"path":"/docs/types/SunburstLayout","title":"SunburstLayout","description":""},{"path":"/docs/types/SunburstLayoutResult","title":"SunburstLayoutResult","description":""},{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":""},{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":""},{"path":"/docs/types/SunburstRenderResult","title":"SunburstRenderResult","description":""},{"path":"/docs/types/SunburstSelection","title":"SunburstSelection","description":""},{"path":"/docs/types/SunburstSelectionChangeEventDetail","title":"SunburstSelectionChangeEventDetail","description":""},{"path":"/docs/types/SunburstSelectionSource","title":"SunburstSelectionSource","description":""},{"path":"/docs/types/SunburstStreamEvent","title":"SunburstStreamEvent","description":""},{"path":"/docs/types/SunburstStreamSource","title":"SunburstStreamSource","description":""},{"path":"/docs/types/SunburstUnavailableBehaviour","title":"SunburstUnavailableBehaviour","description":""},{"path":"/docs/types/Surface3DAxesOptions","title":"Surface3DAxesOptions","description":""},{"path":"/docs/types/Surface3DAxis","title":"Surface3DAxis","description":""},{"path":"/docs/types/Surface3DCameraChangeEventDetail","title":"Surface3DCameraChangeEventDetail","description":""},{"path":"/docs/types/Surface3DCrosshairDetail","title":"Surface3DCrosshairDetail","description":""},{"path":"/docs/types/Surface3DData","title":"Surface3DData","description":""},{"path":"/docs/types/Surface3DDiagnostics","title":"Surface3DDiagnostics","description":""},{"path":"/docs/types/Surface3DDomain","title":"Surface3DDomain","description":""},{"path":"/docs/types/Surface3DDomains","title":"Surface3DDomains","description":""},{"path":"/docs/types/Surface3DEasing","title":"Surface3DEasing","description":""},{"path":"/docs/types/Surface3DEngineMode","title":"Surface3DEngineMode","description":""},{"path":"/docs/types/Surface3DEngineTier","title":"Surface3DEngineTier","description":""},{"path":"/docs/types/Surface3DGeometry","title":"Surface3DGeometry","description":""},{"path":"/docs/types/Surface3DGrid","title":"Surface3DGrid","description":""},{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":""},{"path":"/docs/types/Surface3DNumbers","title":"Surface3DNumbers","description":""},{"path":"/docs/types/Surface3DPoint","title":"Surface3DPoint","description":""},{"path":"/docs/types/Surface3DRenderResult","title":"Surface3DRenderResult","description":""},{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":""},{"path":"/docs/types/Surface3DSelection","title":"Surface3DSelection","description":""},{"path":"/docs/types/Surface3DSelectionChangeEventDetail","title":"Surface3DSelectionChangeEventDetail","description":""},{"path":"/docs/types/Surface3DSelectionSource","title":"Surface3DSelectionSource","description":""},{"path":"/docs/types/Surface3DStreamEvent","title":"Surface3DStreamEvent","description":""},{"path":"/docs/types/Surface3DStreamSource","title":"Surface3DStreamSource","description":""},{"path":"/docs/types/Surface3DUnavailableBehaviour","title":"Surface3DUnavailableBehaviour","description":""},{"path":"/docs/types/Surface3DValues","title":"Surface3DValues","description":""},{"path":"/docs/types/SvgLayer","title":"SvgLayer","description":""}]}]},{"id":"T","title":"T","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverAnimationType","title":"ThemeRiverAnimationType","description":""},{"path":"/docs/types/ThemeRiverAxesOptions","title":"ThemeRiverAxesOptions","description":""},{"path":"/docs/types/ThemeRiverBand","title":"ThemeRiverBand","description":""},{"path":"/docs/types/ThemeRiverBandPoint","title":"ThemeRiverBandPoint","description":""},{"path":"/docs/types/ThemeRiverCrosshairDetail","title":"ThemeRiverCrosshairDetail","description":""},{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","description":""},{"path":"/docs/types/ThemeRiverDiagnostics","title":"ThemeRiverDiagnostics","description":""},{"path":"/docs/types/ThemeRiverEasing","title":"ThemeRiverEasing","description":""},{"path":"/docs/types/ThemeRiverEngineMode","title":"ThemeRiverEngineMode","description":""},{"path":"/docs/types/ThemeRiverEngineTier","title":"ThemeRiverEngineTier","description":""},{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":""},{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":""},{"path":"/docs/types/ThemeRiverLayout","title":"ThemeRiverLayout","description":""},{"path":"/docs/types/ThemeRiverOffset","title":"ThemeRiverOffset","description":""},{"path":"/docs/types/ThemeRiverOrder","title":"ThemeRiverOrder","description":""},{"path":"/docs/types/ThemeRiverRenderResult","title":"ThemeRiverRenderResult","description":""},{"path":"/docs/types/ThemeRiverRgba","title":"ThemeRiverRgba","description":""},{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":""},{"path":"/docs/types/ThemeRiverSelection","title":"ThemeRiverSelection","description":""},{"path":"/docs/types/ThemeRiverSelectionChangeEventDetail","title":"ThemeRiverSelectionChangeEventDetail","description":""},{"path":"/docs/types/ThemeRiverSeriesInput","title":"ThemeRiverSeriesInput","description":""},{"path":"/docs/types/ThemeRiverStreamEvent","title":"ThemeRiverStreamEvent","description":""},{"path":"/docs/types/ThemeRiverStreamSource","title":"ThemeRiverStreamSource","description":""},{"path":"/docs/types/ThemeRiverUnavailableBehaviour","title":"ThemeRiverUnavailableBehaviour","description":""},{"path":"/docs/types/TilemapAnimationType","title":"TilemapAnimationType","description":""},{"path":"/docs/types/TilemapColorAxisInput","title":"TilemapColorAxisInput","description":""},{"path":"/docs/types/TilemapColorAxisObjectInput","title":"TilemapColorAxisObjectInput","description":""},{"path":"/docs/types/TilemapData","title":"TilemapData","description":""},{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":""},{"path":"/docs/types/TilemapEasing","title":"TilemapEasing","description":""},{"path":"/docs/types/TilemapEngineMode","title":"TilemapEngineMode","description":""},{"path":"/docs/types/TilemapEngineTier","title":"TilemapEngineTier","description":""},{"path":"/docs/types/TilemapLegendPosition","title":"TilemapLegendPosition","description":""},{"path":"/docs/types/TilemapPaletteName","title":"TilemapPaletteName","description":""},{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","description":""},{"path":"/docs/types/TilemapRenderResult","title":"TilemapRenderResult","description":""},{"path":"/docs/types/TilemapResolvedTile","title":"TilemapResolvedTile","description":""},{"path":"/docs/types/TilemapSequentialSchemeName","title":"TilemapSequentialSchemeName","description":""},{"path":"/docs/types/TilemapStreamEvent","title":"TilemapStreamEvent","description":""},{"path":"/docs/types/TilemapStreamSource","title":"TilemapStreamSource","description":""},{"path":"/docs/types/TilemapTileShape","title":"TilemapTileShape","description":""},{"path":"/docs/types/TilemapTooltipActionEventDetail","title":"TilemapTooltipActionEventDetail","description":""},{"path":"/docs/types/TilemapTooltipConnectorInput","title":"TilemapTooltipConnectorInput","description":""},{"path":"/docs/types/TilemapTooltipConnectorSpec","title":"TilemapTooltipConnectorSpec","description":""},{"path":"/docs/types/TilemapTooltipFormatContext","title":"TilemapTooltipFormatContext","description":""},{"path":"/docs/types/TilemapTooltipInput","title":"TilemapTooltipInput","description":""},{"path":"/docs/types/TilemapTooltipObjectInput","title":"TilemapTooltipObjectInput","description":""},{"path":"/docs/types/TilemapTooltipOpenMode","title":"TilemapTooltipOpenMode","description":""},{"path":"/docs/types/TilemapTooltipShowEventDetail","title":"TilemapTooltipShowEventDetail","description":""},{"path":"/docs/types/TilemapTooltipSide","title":"TilemapTooltipSide","description":""},{"path":"/docs/types/TilemapTooltipSpec","title":"TilemapTooltipSpec","description":""},{"path":"/docs/types/TilemapTooltipStyle","title":"TilemapTooltipStyle","description":""},{"path":"/docs/types/TilemapTooltipStyleValue","title":"TilemapTooltipStyleValue","description":""},{"path":"/docs/types/TilemapTooltipTrigger","title":"TilemapTooltipTrigger","description":""},{"path":"/docs/types/TilemapUnavailableBehaviour","title":"TilemapUnavailableBehaviour","description":""},{"path":"/docs/types/TornadoChartAnimationType","title":"TornadoChartAnimationType","description":""},{"path":"/docs/types/TornadoChartDatum","title":"TornadoChartDatum","description":""},{"path":"/docs/types/TornadoChartEasing","title":"TornadoChartEasing","description":""},{"path":"/docs/types/TornadoChartEngineMode","title":"TornadoChartEngineMode","description":""},{"path":"/docs/types/TornadoChartEngineTier","title":"TornadoChartEngineTier","description":""},{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","description":""},{"path":"/docs/types/TornadoChartRenderResult","title":"TornadoChartRenderResult","description":""},{"path":"/docs/types/TornadoChartSide","title":"TornadoChartSide","description":""},{"path":"/docs/types/TornadoChartStreamEvent","title":"TornadoChartStreamEvent","description":""},{"path":"/docs/types/TornadoChartStreamSource","title":"TornadoChartStreamSource","description":""},{"path":"/docs/types/TornadoChartUnavailableBehaviour","title":"TornadoChartUnavailableBehaviour","description":""},{"path":"/docs/types/TornadoChartValues","title":"TornadoChartValues","description":""},{"path":"/docs/types/TornadoDatum","title":"TornadoDatum","description":""},{"path":"/docs/types/TornadoRowDatum","title":"TornadoRowDatum","description":""},{"path":"/docs/types/TradeSide","title":"TradeSide","description":""},{"path":"/docs/types/TreemapAnimationType","title":"TreemapAnimationType","description":""},{"path":"/docs/types/TreemapData","title":"TreemapData","description":""},{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","description":""},{"path":"/docs/types/TreemapEasing","title":"TreemapEasing","description":""},{"path":"/docs/types/TreemapEngineMode","title":"TreemapEngineMode","description":""},{"path":"/docs/types/TreemapEngineTier","title":"TreemapEngineTier","description":""},{"path":"/docs/types/TreemapExtent","title":"TreemapExtent","description":""},{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":""},{"path":"/docs/types/TreemapLabel","title":"TreemapLabel","description":""},{"path":"/docs/types/TreemapLabelMode","title":"TreemapLabelMode","description":""},{"path":"/docs/types/TreemapLayout","title":"TreemapLayout","description":""},{"path":"/docs/types/TreemapLayoutResult","title":"TreemapLayoutResult","description":""},{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":""},{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":""},{"path":"/docs/types/TreemapRect","title":"TreemapRect","description":""},{"path":"/docs/types/TreemapRenderResult","title":"TreemapRenderResult","description":""},{"path":"/docs/types/TreemapSelection","title":"TreemapSelection","description":""},{"path":"/docs/types/TreemapSelectionChangeEventDetail","title":"TreemapSelectionChangeEventDetail","description":""},{"path":"/docs/types/TreemapSelectionSource","title":"TreemapSelectionSource","description":""},{"path":"/docs/types/TreemapStreamEvent","title":"TreemapStreamEvent","description":""},{"path":"/docs/types/TreemapStreamSource","title":"TreemapStreamSource","description":""},{"path":"/docs/types/TreemapUnavailableBehaviour","title":"TreemapUnavailableBehaviour","description":""}]}]},{"id":"V","title":"V","blocks":[{"kind":"links","items":[{"path":"/docs/types/VariwideChartAnimationType","title":"VariwideChartAnimationType","description":""},{"path":"/docs/types/VariwideChartDatum","title":"VariwideChartDatum","description":""},{"path":"/docs/types/VariwideChartEasing","title":"VariwideChartEasing","description":""},{"path":"/docs/types/VariwideChartEngineMode","title":"VariwideChartEngineMode","description":""},{"path":"/docs/types/VariwideChartEngineTier","title":"VariwideChartEngineTier","description":""},{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","description":""},{"path":"/docs/types/VariwideChartRenderResult","title":"VariwideChartRenderResult","description":""},{"path":"/docs/types/VariwideChartStreamEvent","title":"VariwideChartStreamEvent","description":""},{"path":"/docs/types/VariwideChartStreamSource","title":"VariwideChartStreamSource","description":""},{"path":"/docs/types/VariwideChartUnavailableBehaviour","title":"VariwideChartUnavailableBehaviour","description":""},{"path":"/docs/types/VariwideChartValues","title":"VariwideChartValues","description":""},{"path":"/docs/types/VariwideColumnDatum","title":"VariwideColumnDatum","description":""},{"path":"/docs/types/VariwideDatum","title":"VariwideDatum","description":""},{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":""},{"path":"/docs/types/VisualMapColorInput","title":"VisualMapColorInput","description":""},{"path":"/docs/types/VisualMapDimension","title":"VisualMapDimension","description":""},{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":""},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":""},{"path":"/docs/types/VisualMapPiece","title":"VisualMapPiece","description":""},{"path":"/docs/types/VisualMapPieceInput","title":"VisualMapPieceInput","description":""},{"path":"/docs/types/VisualMapPiecewiseMode","title":"VisualMapPiecewiseMode","description":""},{"path":"/docs/types/VisualMapRange","title":"VisualMapRange","description":""},{"path":"/docs/types/VisualMapRangeChangeEventDetail","title":"VisualMapRangeChangeEventDetail","description":""},{"path":"/docs/types/VisualMapRangeChangeSource","title":"VisualMapRangeChangeSource","description":""},{"path":"/docs/types/VisualMapSelectedMode","title":"VisualMapSelectedMode","description":""},{"path":"/docs/types/VisualMapSelectionChangeEventDetail","title":"VisualMapSelectionChangeEventDetail","description":""},{"path":"/docs/types/VisualMapSizeSpec","title":"VisualMapSizeSpec","description":""},{"path":"/docs/types/VisualMapSnapshot","title":"VisualMapSnapshot","description":""},{"path":"/docs/types/VisualMapStop","title":"VisualMapStop","description":""},{"path":"/docs/types/VisualMapTargetElement","title":"VisualMapTargetElement","description":""},{"path":"/docs/types/VisualMapType","title":"VisualMapType","description":""}]}]},{"id":"W","title":"W","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferCorrelationMetric","title":"WaferCorrelationMetric","description":""},{"path":"/docs/types/WaferCorrelationResult","title":"WaferCorrelationResult","description":""},{"path":"/docs/types/WaferDefectData","title":"WaferDefectData","description":""},{"path":"/docs/types/WaferDefectDatum","title":"WaferDefectDatum","description":""},{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":""},{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","description":""},{"path":"/docs/types/WaferIndicator","title":"WaferIndicator","description":""},{"path":"/docs/types/WaferMapAnimationType","title":"WaferMapAnimationType","description":""},{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":""},{"path":"/docs/types/WaferMapEasing","title":"WaferMapEasing","description":""},{"path":"/docs/types/WaferMapEngineMode","title":"WaferMapEngineMode","description":""},{"path":"/docs/types/WaferMapEngineTier","title":"WaferMapEngineTier","description":""},{"path":"/docs/types/WaferMapLegendPosition","title":"WaferMapLegendPosition","description":""},{"path":"/docs/types/WaferMapMode","title":"WaferMapMode","description":""},{"path":"/docs/types/WaferMapRenderResult","title":"WaferMapRenderResult","description":""},{"path":"/docs/types/WaferMapStreamEvent","title":"WaferMapStreamEvent","description":""},{"path":"/docs/types/WaferMapStreamEventType","title":"WaferMapStreamEventType","description":""},{"path":"/docs/types/WaferMapStreamSource","title":"WaferMapStreamSource","description":""},{"path":"/docs/types/WaferMapUnavailableBehaviour","title":"WaferMapUnavailableBehaviour","description":""},{"path":"/docs/types/WaferOrientation","title":"WaferOrientation","description":""},{"path":"/docs/types/WaferStackMetric","title":"WaferStackMetric","description":""},{"path":"/docs/types/WaferStackResult","title":"WaferStackResult","description":""},{"path":"/docs/types/WaferStackWafer","title":"WaferStackWafer","description":""},{"path":"/docs/types/WaferValueAxisInput","title":"WaferValueAxisInput","description":""},{"path":"/docs/types/WaferValueAxisObjectInput","title":"WaferValueAxisObjectInput","description":""},{"path":"/docs/types/WaferValueStats","title":"WaferValueStats","description":""},{"path":"/docs/types/WaterfallAnimationType","title":"WaterfallAnimationType","description":""},{"path":"/docs/types/WaterfallBar","title":"WaterfallBar","description":""},{"path":"/docs/types/WaterfallBarKind","title":"WaterfallBarKind","description":""},{"path":"/docs/types/WaterfallData","title":"WaterfallData","description":""},{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","description":""},{"path":"/docs/types/WaterfallDatumObject","title":"WaterfallDatumObject","description":""},{"path":"/docs/types/WaterfallDatumTuple","title":"WaterfallDatumTuple","description":""},{"path":"/docs/types/WaterfallDirection","title":"WaterfallDirection","description":""},{"path":"/docs/types/WaterfallDomain","title":"WaterfallDomain","description":""},{"path":"/docs/types/WaterfallDrawStats","title":"WaterfallDrawStats","description":""},{"path":"/docs/types/WaterfallEasing","title":"WaterfallEasing","description":""},{"path":"/docs/types/WaterfallEngineMode","title":"WaterfallEngineMode","description":""},{"path":"/docs/types/WaterfallEngineTier","title":"WaterfallEngineTier","description":""},{"path":"/docs/types/WaterfallExtent","title":"WaterfallExtent","description":""},{"path":"/docs/types/WaterfallLabelMode","title":"WaterfallLabelMode","description":""},{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":""},{"path":"/docs/types/WaterfallRenderResult","title":"WaterfallRenderResult","description":""},{"path":"/docs/types/WaterfallStreamEvent","title":"WaterfallStreamEvent","description":""},{"path":"/docs/types/WaterfallStreamSource","title":"WaterfallStreamSource","description":""},{"path":"/docs/types/WaterfallUnavailableBehaviour","title":"WaterfallUnavailableBehaviour","description":""},{"path":"/docs/types/WordCloudAnimationType","title":"WordCloudAnimationType","description":""},{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":""},{"path":"/docs/types/WordCloudEasing","title":"WordCloudEasing","description":""},{"path":"/docs/types/WordCloudEngineMode","title":"WordCloudEngineMode","description":""},{"path":"/docs/types/WordCloudEngineTier","title":"WordCloudEngineTier","description":""},{"path":"/docs/types/WordCloudPaletteName","title":"WordCloudPaletteName","description":""},{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","description":""},{"path":"/docs/types/WordCloudRenderResult","title":"WordCloudRenderResult","description":""},{"path":"/docs/types/WordCloudResolvedWord","title":"WordCloudResolvedWord","description":""},{"path":"/docs/types/WordCloudSpiral","title":"WordCloudSpiral","description":""},{"path":"/docs/types/WordCloudStreamEvent","title":"WordCloudStreamEvent","description":""},{"path":"/docs/types/WordCloudStreamSource","title":"WordCloudStreamSource","description":""},{"path":"/docs/types/WordCloudTooltipActionEventDetail","title":"WordCloudTooltipActionEventDetail","description":""},{"path":"/docs/types/WordCloudTooltipConnectorInput","title":"WordCloudTooltipConnectorInput","description":""},{"path":"/docs/types/WordCloudTooltipConnectorSpec","title":"WordCloudTooltipConnectorSpec","description":""},{"path":"/docs/types/WordCloudTooltipFormatContext","title":"WordCloudTooltipFormatContext","description":""},{"path":"/docs/types/WordCloudTooltipInput","title":"WordCloudTooltipInput","description":""},{"path":"/docs/types/WordCloudTooltipObjectInput","title":"WordCloudTooltipObjectInput","description":""},{"path":"/docs/types/WordCloudTooltipOpenMode","title":"WordCloudTooltipOpenMode","description":""},{"path":"/docs/types/WordCloudTooltipShowEventDetail","title":"WordCloudTooltipShowEventDetail","description":""},{"path":"/docs/types/WordCloudTooltipSide","title":"WordCloudTooltipSide","description":""},{"path":"/docs/types/WordCloudTooltipSpec","title":"WordCloudTooltipSpec","description":""},{"path":"/docs/types/WordCloudTooltipStyle","title":"WordCloudTooltipStyle","description":""},{"path":"/docs/types/WordCloudTooltipStyleValue","title":"WordCloudTooltipStyleValue","description":""},{"path":"/docs/types/WordCloudTooltipTrigger","title":"WordCloudTooltipTrigger","description":""},{"path":"/docs/types/WordCloudUnavailableBehaviour","title":"WordCloudUnavailableBehaviour","description":""},{"path":"/docs/types/WordCloudValues","title":"WordCloudValues","description":""},{"path":"/docs/types/WordCloudWeightScale","title":"WordCloudWeightScale","description":""}]}]},{"id":"X","title":"X","blocks":[{"kind":"links","items":[{"path":"/docs/types/XAxisInput","title":"XAxisInput","description":""}]}]},{"id":"Y","title":"Y","blocks":[{"kind":"links","items":[{"path":"/docs/types/YAxisInput","title":"YAxisInput","description":""},{"path":"/docs/types/YieldZone","title":"YieldZone","description":""},{"path":"/docs/types/YieldZoneResult","title":"YieldZoneResult","description":""}]}]},{"id":"Z","title":"Z","blocks":[{"kind":"links","items":[{"path":"/docs/types/ZoomConnectAxes","title":"ZoomConnectAxes","description":""},{"path":"/docs/types/ZoomConnectOptions","title":"ZoomConnectOptions","description":""},{"path":"/docs/types/ZoomExtent","title":"ZoomExtent","description":""}]}]}]},{"path":"/docs/types/AreaChartAnimationType","title":"AreaChartAnimationType","summary":"The AreaChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartDatum","title":"AreaChartDatum","summary":"The AreaChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartEasing","title":"AreaChartEasing","summary":"The AreaChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartEngineMode","title":"AreaChartEngineMode","summary":"The AreaChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartEngineMode = 'auto' | AreaChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartEngineTier","title":"AreaChartEngineTier","description":""}]}]}]},{"path":"/docs/types/AreaChartEngineTier","title":"AreaChartEngineTier","summary":"The AreaChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartFillGradient","title":"AreaChartFillGradient","summary":"The AreaChartFillGradient type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartFillGradient = AreaChartLinearGradient | AreaChartRadialGradient;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartLinearGradient","title":"AreaChartLinearGradient","description":""},{"path":"/docs/types/AreaChartRadialGradient","title":"AreaChartRadialGradient","description":""}]}]}]},{"path":"/docs/types/AreaChartFillPattern","title":"AreaChartFillPattern","summary":"The AreaChartFillPattern type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartFillPattern {\n  type: AreaChartFillPatternKind;\n  color?: string;\n  background?: string;\n  size?: number;\n  thickness?: number;\n  direction?: 'forward' | 'backward';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartFillPatternKind","title":"AreaChartFillPatternKind","description":""}]}]}]},{"path":"/docs/types/AreaChartFillPatternKind","title":"AreaChartFillPatternKind","summary":"The AreaChartFillPatternKind type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartFillPatternKind = 'dots' | 'diagonal' | 'cross-hatch';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartGradientStop","title":"AreaChartGradientStop","summary":"The AreaChartGradientStop type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartGradientStop {\n  offset: number;\n  color: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartLegendItemEventDetail","title":"AreaChartLegendItemEventDetail","summary":"The AreaChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartLegendItemEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartLegendPosition","title":"AreaChartLegendPosition","summary":"The AreaChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartLinearGradient","title":"AreaChartLinearGradient","summary":"The AreaChartLinearGradient type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartLinearGradient {\n  type: 'linear';\n  stops: ReadonlyArray<AreaChartGradientStop>;\n  x0?: number;\n  y0?: number;\n  x1?: number;\n  y1?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartGradientStop","title":"AreaChartGradientStop","description":""}]}]}]},{"path":"/docs/types/AreaChartPatternKind","title":"AreaChartPatternKind","summary":"The AreaChartPatternKind type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartPatternKind = AreaChartFillPatternKind | 'diagonal-forward' | 'diagonal-backward' | 'fill';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartFillPatternKind","title":"AreaChartFillPatternKind","description":""}]}]}]},{"path":"/docs/types/AreaChartRadialGradient","title":"AreaChartRadialGradient","summary":"The AreaChartRadialGradient type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartRadialGradient {\n  type: 'radial';\n  stops: ReadonlyArray<AreaChartGradientStop>;\n  cx?: number;\n  cy?: number;\n  r?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartGradientStop","title":"AreaChartGradientStop","description":""}]}]}]},{"path":"/docs/types/AreaChartRenderResult","title":"AreaChartRenderResult","summary":"The AreaChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartSeries","title":"AreaChartSeries","summary":"The AreaChartSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartSeries extends Omit<CartesianSeriesBase<AreaChartValues>, 'values' | 'marker'> {\n  values?: AreaChartValues;\n  thickness?: number;\n  fillColor?: string;\n  fillOpacity?: number;\n  marker?: LineChartMarker | CartesianSeriesMarkerInput;\n  markerSize?: number;\n  markerFilter?: LineChartMarkerFilter;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","description":""},{"path":"/docs/types/AreaChartValues","title":"AreaChartValues","description":""},{"path":"/docs/types/LineChartMarker","title":"LineChartMarker","description":""},{"path":"/docs/types/CartesianSeriesMarkerInput","title":"CartesianSeriesMarkerInput","description":""},{"path":"/docs/types/LineChartMarkerFilter","title":"LineChartMarkerFilter","description":""}]}]}]},{"path":"/docs/types/AreaChartSeriesActiveTrigger","title":"AreaChartSeriesActiveTrigger","summary":"The AreaChartSeriesActiveTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartSeriesActiveTrigger = 'hover' | 'click' | 'custom';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartSeriesStateOptions","title":"AreaChartSeriesStateOptions","summary":"The AreaChartSeriesStateOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartSeriesStateOptions {\n  enabled?: boolean;\n  inactive?: AreaChartSeriesStateStyle;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartSeriesStateStyle","title":"AreaChartSeriesStateStyle","description":""}]}]}]},{"path":"/docs/types/AreaChartSeriesStateStyle","title":"AreaChartSeriesStateStyle","summary":"The AreaChartSeriesStateStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartSeriesStateStyle {\n  opacity?: number;\n  thickness?: number;\n  thicknessScale?: number;\n  markerSize?: number;\n  markerSizeScale?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartSeriesToggledEventDetail","title":"AreaChartSeriesToggledEventDetail","summary":"The AreaChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartSeriesToggledEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartStreamEvent","title":"AreaChartStreamEvent","summary":"The AreaChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartStreamSource","title":"AreaChartStreamSource","summary":"The AreaChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface AreaChartStreamSource {\n  push(value: number): void;\n  pushBatch(values: ReadonlyArray<number> | Float32Array): void;\n  shift(count: number): void;\n  replace(values: ReadonlyArray<number> | Float32Array): void;\n  snapshot(window?: number): Float32Array;\n  subscribe(listener: (event: AreaChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartStreamEvent","title":"AreaChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/AreaChartUnavailableBehaviour","title":"AreaChartUnavailableBehaviour","summary":"The AreaChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartUnavailableBehaviour = 'fallback' | 'error';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/AreaChartValues","title":"AreaChartValues","summary":"The AreaChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type AreaChartValues = Float32Array | AreaChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartDatum","title":"AreaChartDatum","description":""}]}]}]},{"path":"/docs/types/Bar3DAxesOptions","title":"Bar3DAxesOptions","summary":"The Bar3DAxesOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DAxesOptions extends Omit<Scene3DAxesOptions,'format'> {format?:(value:Bar3DCategory,axis:'x'|'y'|'z')=>string}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DAxesOptions","title":"Scene3DAxesOptions","description":""},{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":""}]}]}]},{"path":"/docs/types/Bar3DCameraChangeEventDetail","title":"Bar3DCameraChangeEventDetail","summary":"The Bar3DCameraChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DCameraChangeEventDetail=Scene3DCameraChangeEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraChangeEventDetail","title":"Scene3DCameraChangeEventDetail","description":""}]}]}]},{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","summary":"The Bar3DCategory type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DCategory=string|number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Bar3DCrosshairDetail","title":"Bar3DCrosshairDetail","summary":"The Bar3DCrosshairDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DCrosshairDetail {cssX:number;cssY:number;dataX:Bar3DCategory;dataY:Bar3DCategory;dataZ:number;point:Bar3DPoint;snapped:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":""},{"path":"/docs/types/Bar3DPoint","title":"Bar3DPoint","description":""}]}]}]},{"path":"/docs/types/Bar3DCrosshairShowRequest","title":"Bar3DCrosshairShowRequest","summary":"The Bar3DCrosshairShowRequest type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DCrosshairShowRequest {dataX?:Bar3DCategory;dataY?:Bar3DCategory;dataZ?:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":""}]}]}]},{"path":"/docs/types/Bar3DData","title":"Bar3DData","summary":"The Bar3DData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DData=ReadonlyArray<Bar3DDatum|Bar3DTuple>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":""},{"path":"/docs/types/Bar3DTuple","title":"Bar3DTuple","description":""}]}]}]},{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","summary":"The Bar3DDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DDatum {\n  id?:string|number;label?:string;x:Bar3DCategory|null;y:Bar3DCategory|null;z:number|null;\n  base?:number;value?:number|null;color?:string;\n  width?:number;depth?:number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":""}]}]}]},{"path":"/docs/types/Bar3DDiagnostics","title":"Bar3DDiagnostics","summary":"The Bar3DDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DDiagnostics {points:number;validPoints:number;missingCoordinates:number;invalidCoordinates:number;missingValues:number;zeroHeight:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Bar3DDomain","title":"Bar3DDomain","summary":"The Bar3DDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DDomain=Scene3DDomain;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DDomain","title":"Scene3DDomain","description":""}]}]}]},{"path":"/docs/types/Bar3DEasing","title":"Bar3DEasing","summary":"The Bar3DEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DEasing=HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/Bar3DEngineMode","title":"Bar3DEngineMode","summary":"The Bar3DEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DEngineMode=HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/Bar3DEngineTier","title":"Bar3DEngineTier","summary":"The Bar3DEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DEngineTier=HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/Bar3DGeometry","title":"Bar3DGeometry","summary":"The Bar3DGeometry type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DGeometry extends Scene3DDataSpace {\n  points:number;drawn:number;triangles:number;positions:Float32Array;normals:Float32Array;colors:Float32Array;indices:Uint32Array;\n  pointIndices:Uint32Array;trianglePoints:Uint32Array;categories:{x:Bar3DCategory[];y:Bar3DCategory[]};\n  colorDomain:Scene3DDomain;bounds:Scene3DBounds;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DDataSpace","title":"Scene3DDataSpace","description":""},{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":""},{"path":"/docs/types/Scene3DDomain","title":"Scene3DDomain","description":""},{"path":"/docs/types/Scene3DBounds","title":"Scene3DBounds","description":""}]}]}]},{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","summary":"The Bar3DHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DHitDetail {kind:'bar3d';point:Bar3DPoint;pointIndex:number;world:Scene3DVector;center:Scene3DVector;cssX:number;cssY:number;depth:number;triangle:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DPoint","title":"Bar3DPoint","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""}]}]}]},{"path":"/docs/types/Bar3DPoint","title":"Bar3DPoint","summary":"The Bar3DPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DPoint extends Bar3DDatum {index:number;key:string;valid:boolean;base:number;value:number|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":""}]}]}]},{"path":"/docs/types/Bar3DRenderResult","title":"Bar3DRenderResult","summary":"The Bar3DRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DRenderResult {points:number;drawn:number;renderMs:number;bar3d?:{triangles:number;vertices:number;chunks:number;drawCalls:number;uploadedBytes:number}}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Bar3DSelection","title":"Bar3DSelection","summary":"The Bar3DSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DSelection {point:Bar3DPoint|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DPoint","title":"Bar3DPoint","description":""}]}]}]},{"path":"/docs/types/Bar3DSelectionChangeEventDetail","title":"Bar3DSelectionChangeEventDetail","summary":"The Bar3DSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DSelectionChangeEventDetail extends Bar3DSelection {by:Bar3DSelectionSource}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DSelection","title":"Bar3DSelection","description":""},{"path":"/docs/types/Bar3DSelectionSource","title":"Bar3DSelectionSource","description":""}]}]}]},{"path":"/docs/types/Bar3DSelectionSource","title":"Bar3DSelectionSource","summary":"The Bar3DSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DSelectionSource='pointer'|'keyboard'|'method'|'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Bar3DStreamEvent","title":"Bar3DStreamEvent","summary":"The Bar3DStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DStreamEvent {type:'push'|'pushBatch'|'shift'|'replace';count:number;replaced:number;entries:Bar3DDatum[]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":""}]}]}]},{"path":"/docs/types/Bar3DStreamSource","title":"Bar3DStreamSource","summary":"The Bar3DStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Bar3DStreamSource {\n  readonly length:number;readonly capacity:number;readonly dropped:number;\n  push(point:Bar3DDatum):void;pushBatch(points:ReadonlyArray<Bar3DDatum>):void;shift(count:number):void;replace(points:ReadonlyArray<Bar3DDatum>):void;setCapacity(capacity:number):void;\n  snapshot():Bar3DDatum[];subscribe(listener:(event:Bar3DStreamEvent)=>void):()=>void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DDatum","title":"Bar3DDatum","description":""},{"path":"/docs/types/Bar3DStreamEvent","title":"Bar3DStreamEvent","description":""}]}]}]},{"path":"/docs/types/Bar3DTuple","title":"Bar3DTuple","summary":"The Bar3DTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DTuple=readonly[Bar3DCategory|null,Bar3DCategory|null,number|null,number?];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Bar3DCategory","title":"Bar3DCategory","description":""}]}]}]},{"path":"/docs/types/Bar3DUnavailableBehaviour","title":"Bar3DUnavailableBehaviour","summary":"The Bar3DUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Bar3DUnavailableBehaviour=HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/BarBorderScope","title":"BarBorderScope","summary":"The BarBorderScope type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarBorderScope = 'point' | 'stack' | 'outline';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartAnimationType","title":"BarChartAnimationType","summary":"The BarChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartDatum","title":"BarChartDatum","summary":"The BarChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartEasing","title":"BarChartEasing","summary":"The BarChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartEngineMode","title":"BarChartEngineMode","summary":"The BarChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartEngineMode = 'auto' | BarChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BarChartEngineTier","title":"BarChartEngineTier","description":""}]}]}]},{"path":"/docs/types/BarChartEngineTier","title":"BarChartEngineTier","summary":"The BarChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartLegendItemEventDetail","title":"BarChartLegendItemEventDetail","summary":"The BarChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BarChartLegendItemEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartLegendPosition","title":"BarChartLegendPosition","summary":"The BarChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartRenderResult","title":"BarChartRenderResult","summary":"The BarChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BarChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartSeries","title":"BarChartSeries","summary":"The BarChartSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BarChartSeries extends Omit<CartesianSeriesBase<BarChartValues>, 'values'> {\n  values?: BarChartValues;\n  thickness?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","description":""},{"path":"/docs/types/BarChartValues","title":"BarChartValues","description":""}]}]}]},{"path":"/docs/types/BarChartSeriesActiveTrigger","title":"BarChartSeriesActiveTrigger","summary":"The BarChartSeriesActiveTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartSeriesActiveTrigger = 'hover' | 'click' | 'custom';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartSeriesStateOptions","title":"BarChartSeriesStateOptions","summary":"The BarChartSeriesStateOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BarChartSeriesStateOptions {\n  enabled?: boolean;\n  inactive?: BarChartSeriesStateStyle;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BarChartSeriesStateStyle","title":"BarChartSeriesStateStyle","description":""}]}]}]},{"path":"/docs/types/BarChartSeriesStateStyle","title":"BarChartSeriesStateStyle","summary":"The BarChartSeriesStateStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BarChartSeriesStateStyle {\n  opacity?: number;\n  thickness?: number;\n  thicknessScale?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartSeriesToggledEventDetail","title":"BarChartSeriesToggledEventDetail","summary":"The BarChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BarChartSeriesToggledEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartStreamEvent","title":"BarChartStreamEvent","summary":"The BarChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartStreamSource","title":"BarChartStreamSource","summary":"The BarChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BarChartStreamSource {\n  push(value: number): void;\n  pushBatch(values: ReadonlyArray<number> | Float32Array): void;\n  shift(count: number): void;\n  replace(values: ReadonlyArray<number> | Float32Array): void;\n  snapshot(window?: number): Float32Array;\n  subscribe(listener: (event: BarChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BarChartStreamEvent","title":"BarChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/BarChartUnavailableBehaviour","title":"BarChartUnavailableBehaviour","summary":"The BarChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartUnavailableBehaviour = 'fallback' | 'error';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BarChartValues","title":"BarChartValues","summary":"The BarChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BarChartValues = Float32Array | BarChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BarChartDatum","title":"BarChartDatum","description":""}]}]}]},{"path":"/docs/types/BinarySummary","title":"BinarySummary","summary":"The BinarySummary type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BinarySummary {\n  readonly pass: number;\n  readonly fail: number;\n  readonly probed: number;\n  readonly yield: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotAnimationType","title":"BoxPlotAnimationType","summary":"The BoxPlotAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/BoxPlotBox","title":"BoxPlotBox","summary":"The BoxPlotBox type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotBox {\n  index: number;\n  category: string;\n  min: number;\n  q1: number;\n  median: number;\n  q3: number;\n  max: number;\n  outliers: number[];\n  farOutliers: number[];\n  count: number;\n  mean: number | null;\n  stddev: number | null;\n  notch: BoxPlotNotch | null;\n  fences: { low: number; high: number } | null;\n  source: 'samples' | 'summary';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotNotch","title":"BoxPlotNotch","description":""}]}]}]},{"path":"/docs/types/BoxPlotData","title":"BoxPlotData","summary":"The BoxPlotData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotData = ReadonlyArray<BoxPlotDatumInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","description":""}]}]}]},{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","summary":"The BoxPlotDatumInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotDatumInput = BoxPlotSamplesInput | BoxPlotSummaryInput | BoxPlotSamplesTupleInput | BoxPlotSummaryTupleInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotSamplesInput","title":"BoxPlotSamplesInput","description":""},{"path":"/docs/types/BoxPlotSummaryInput","title":"BoxPlotSummaryInput","description":""},{"path":"/docs/types/BoxPlotSamplesTupleInput","title":"BoxPlotSamplesTupleInput","description":""},{"path":"/docs/types/BoxPlotSummaryTupleInput","title":"BoxPlotSummaryTupleInput","description":""}]}]}]},{"path":"/docs/types/BoxPlotDomain","title":"BoxPlotDomain","summary":"The BoxPlotDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotDomain {\n  yMin: number;\n  yMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotDrawStats","title":"BoxPlotDrawStats","summary":"The BoxPlotDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotDrawStats {\n  boxes: number;\n  drawn: number;\n  instances: number;\n  outliers: number;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  pitchPx: number;\n  boxPx: number;\n  whiskerPx: number;\n  parts: number;\n  orientation: BoxPlotOrientation;\n  notched: boolean;\n  showMean: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotOrientation","title":"BoxPlotOrientation","description":""}]}]}]},{"path":"/docs/types/BoxPlotEasing","title":"BoxPlotEasing","summary":"The BoxPlotEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/BoxPlotEngineMode","title":"BoxPlotEngineMode","summary":"The BoxPlotEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/BoxPlotEngineTier","title":"BoxPlotEngineTier","summary":"The BoxPlotEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/BoxPlotExtent","title":"BoxPlotExtent","summary":"The BoxPlotExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotExtent {\n  boxes: number;\n  valueMin: number;\n  valueMax: number;\n  outliers: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotNotch","title":"BoxPlotNotch","summary":"The BoxPlotNotch type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotNotch {\n  low: number;\n  high: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotOrientation","title":"BoxPlotOrientation","summary":"The BoxPlotOrientation type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotOrientation = 'vertical' | 'horizontal';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","summary":"The BoxPlotPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotPointEventDetail {\n  index: number;\n  category: string;\n  min: number;\n  q1: number;\n  median: number;\n  q3: number;\n  max: number;\n  iqr: number;\n  outliers: number[];\n  count: number;\n  mean: number | null;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotQuantileMethod","title":"BoxPlotQuantileMethod","summary":"The BoxPlotQuantileMethod type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotQuantileMethod = 'linear' | 'exclusive' | 'nearest' | 'lower' | 'higher' | 'midpoint';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotRenderResult","title":"BoxPlotRenderResult","summary":"The BoxPlotRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotRenderResult {\n  boxes: number;\n  drawn: number;\n  renderMs: number;\n  boxPlot?: BoxPlotDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotDrawStats","title":"BoxPlotDrawStats","description":""}]}]}]},{"path":"/docs/types/BoxPlotSamplesInput","title":"BoxPlotSamplesInput","summary":"The BoxPlotSamplesInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotSamplesInput {\n  category: string;\n  values: ReadonlyArray<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotSamplesTupleInput","title":"BoxPlotSamplesTupleInput","summary":"The BoxPlotSamplesTupleInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotSamplesTupleInput = readonly [category: string, values: ReadonlyArray<number>];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotStatistics","title":"BoxPlotStatistics","summary":"The BoxPlotStatistics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotStatistics extends BoxPlotBox {\n  iqr: number;\n  variance: number | null;\n  whisker: { rule: BoxPlotWhiskerRule; low: number; high: number };\n  method: BoxPlotQuantileMethod;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotBox","title":"BoxPlotBox","description":""},{"path":"/docs/types/BoxPlotWhiskerRule","title":"BoxPlotWhiskerRule","description":""},{"path":"/docs/types/BoxPlotQuantileMethod","title":"BoxPlotQuantileMethod","description":""}]}]}]},{"path":"/docs/types/BoxPlotStreamEvent","title":"BoxPlotStreamEvent","summary":"The BoxPlotStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: BoxPlotDatumInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","description":""}]}]}]},{"path":"/docs/types/BoxPlotStreamSource","title":"BoxPlotStreamSource","summary":"The BoxPlotStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(datum: BoxPlotDatumInput): void;\n  pushBatch(data: ReadonlyArray<BoxPlotDatumInput>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<BoxPlotDatumInput>): void;\n  snapshot(): BoxPlotDatumInput[];\n  subscribe(listener: (event: BoxPlotStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BoxPlotDatumInput","title":"BoxPlotDatumInput","description":""},{"path":"/docs/types/BoxPlotStreamEvent","title":"BoxPlotStreamEvent","description":""}]}]}]},{"path":"/docs/types/BoxPlotSummaryInput","title":"BoxPlotSummaryInput","summary":"The BoxPlotSummaryInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxPlotSummaryInput {\n  category: string;\n  min: number;\n  q1: number;\n  median: number;\n  q3: number;\n  max: number;\n  outliers?: ReadonlyArray<number>;\n  mean?: number;\n  count?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotSummaryTupleInput","title":"BoxPlotSummaryTupleInput","summary":"The BoxPlotSummaryTupleInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotSummaryTupleInput = readonly [category: string, min: number, q1: number, median: number, q3: number, max: number, outliers?: ReadonlyArray<number>];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxPlotUnavailableBehaviour","title":"BoxPlotUnavailableBehaviour","summary":"The BoxPlotUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/BoxPlotWhiskerRule","title":"BoxPlotWhiskerRule","summary":"The BoxPlotWhiskerRule type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BoxPlotWhiskerRule = 'tukey' | 'min-max' | 'percentile' | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BoxplotOptions","title":"BoxplotOptions","summary":"The BoxplotOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BoxplotOptions {\n  dimension?: string | number;\n  groupBy?: string | number;\n  whisker?: number;\n  nameDimension?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleAnimationType","title":"BubbleAnimationType","summary":"The BubbleAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/BubbleData","title":"BubbleData","summary":"The BubbleData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleData = ReadonlyArray<BubbleDatumInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","description":""}]}]}]},{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","summary":"The BubbleDatumInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleDatumInput = BubbleDatumObject | BubbleDatumTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubbleDatumObject","title":"BubbleDatumObject","description":""},{"path":"/docs/types/BubbleDatumTuple","title":"BubbleDatumTuple","description":""}]}]}]},{"path":"/docs/types/BubbleDatumObject","title":"BubbleDatumObject","summary":"The BubbleDatumObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleDatumObject {\n  x: number;\n  y: number;\n  z: number;\n  name?: string;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleDatumTuple","title":"BubbleDatumTuple","summary":"The BubbleDatumTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleDatumTuple = readonly [x: number, y: number, z: number, name?: string];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleDomain","title":"BubbleDomain","summary":"The BubbleDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleDomain {\n  xMin: number;\n  xMax: number;\n  yMin: number;\n  yMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleDrawStats","title":"BubbleDrawStats","summary":"The BubbleDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleDrawStats {\n  points: number;\n  drawn: number;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  minRadiusPx: number;\n  maxRadiusPx: number;\n  activeIndex: number;\n  layout?: BubbleLayoutMode;\n  packScale?: number;\n  shading?: BubbleShading;\n  colored?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubbleLayoutMode","title":"BubbleLayoutMode","description":""},{"path":"/docs/types/BubbleShading","title":"BubbleShading","description":""}]}]}]},{"path":"/docs/types/BubbleEasing","title":"BubbleEasing","summary":"The BubbleEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/BubbleEngineMode","title":"BubbleEngineMode","summary":"The BubbleEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/BubbleEngineTier","title":"BubbleEngineTier","summary":"The BubbleEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleExtent","title":"BubbleExtent","summary":"The BubbleExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleExtent {\n  points: number;\n  xMin: number;\n  xMax: number;\n  yMin: number;\n  yMax: number;\n  zMin: number;\n  zMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleLayoutMode","title":"BubbleLayoutMode","summary":"The BubbleLayoutMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleLayoutMode = 'xy' | 'pack';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubblePackCircle","title":"BubblePackCircle","summary":"The BubblePackCircle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubblePackCircle {\n  index: number;\n  x: number;\n  y: number;\n  r: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubblePackFit","title":"BubblePackFit","summary":"The BubblePackFit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubblePackFit = 'contain' | 'fill';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubblePackLayout","title":"BubblePackLayout","summary":"The BubblePackLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubblePackLayout {\n  scale: number;\n  enclosing: { x: number; y: number; r: number };\n  circles: BubblePackCircle[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubblePackCircle","title":"BubblePackCircle","description":""}]}]}]},{"path":"/docs/types/BubblePoint","title":"BubblePoint","summary":"The BubblePoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubblePoint {\n  index: number;\n  x: number;\n  y: number;\n  z: number;\n  name: string | null;\n  color: string | null;\n  source: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","summary":"The BubblePointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubblePointEventDetail {\n  index: number;\n  x: number;\n  y: number;\n  z: number;\n  name: string | null;\n  radiusPx: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleRadiusScale","title":"BubbleRadiusScale","summary":"The BubbleRadiusScale type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleRadiusScale {\n  zMin: number;\n  zMax: number;\n  minPx: number;\n  maxPx: number;\n  scale: BubbleSizeScale;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubbleSizeScale","title":"BubbleSizeScale","description":""}]}]}]},{"path":"/docs/types/BubbleRenderResult","title":"BubbleRenderResult","summary":"The BubbleRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  bubble?: BubbleDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubbleDrawStats","title":"BubbleDrawStats","description":""}]}]}]},{"path":"/docs/types/BubbleShading","title":"BubbleShading","summary":"The BubbleShading type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleShading = 'flat' | 'sphere';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleSizeScale","title":"BubbleSizeScale","summary":"The BubbleSizeScale type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleSizeScale = 'area' | 'radius';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/BubbleStreamEvent","title":"BubbleStreamEvent","summary":"The BubbleStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: BubbleDatumInput[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","description":""}]}]}]},{"path":"/docs/types/BubbleStreamSource","title":"BubbleStreamSource","summary":"The BubbleStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface BubbleStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(datum: BubbleDatumInput): void;\n  pushBatch(data: ReadonlyArray<BubbleDatumInput>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<BubbleDatumInput>): void;\n  snapshot(): BubbleDatumInput[];\n  subscribe(listener: (event: BubbleStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/BubbleDatumInput","title":"BubbleDatumInput","description":""},{"path":"/docs/types/BubbleStreamEvent","title":"BubbleStreamEvent","description":""}]}]}]},{"path":"/docs/types/BubbleUnavailableBehaviour","title":"BubbleUnavailableBehaviour","summary":"The BubbleUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type BubbleUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/CalendarAggregate","title":"CalendarAggregate","summary":"The CalendarAggregate type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarAggregate = 'sum' | 'max' | 'min' | 'mean' | 'last';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CalendarDateInput","title":"CalendarDateInput","summary":"The CalendarDateInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarDateInput = string | number | Date;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CalendarHeatmapAnimationType","title":"CalendarHeatmapAnimationType","summary":"The CalendarHeatmapAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapData","title":"CalendarHeatmapData","summary":"The CalendarHeatmapData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapData = ReadonlyArray<CalendarHeatmapEntry>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapDatum","title":"CalendarHeatmapDatum","summary":"The CalendarHeatmapDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarHeatmapDatum {\n  date: CalendarDateInput;\n  value: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarDateInput","title":"CalendarDateInput","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapEasing","title":"CalendarHeatmapEasing","summary":"The CalendarHeatmapEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapEngineMode","title":"CalendarHeatmapEngineMode","summary":"The CalendarHeatmapEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapEngineTier","title":"CalendarHeatmapEngineTier","summary":"The CalendarHeatmapEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","summary":"The CalendarHeatmapEntry type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapEntry = CalendarHeatmapDatum | CalendarHeatmapTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapDatum","title":"CalendarHeatmapDatum","description":""},{"path":"/docs/types/CalendarHeatmapTuple","title":"CalendarHeatmapTuple","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","summary":"The CalendarHeatmapPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarHeatmapPointEventDetail {\n  date: string;\n  year: number;\n  month: number;\n  day: number;\n  week: number;\n  weekday: number;\n  index: number;\n  value: number | null;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CalendarHeatmapRange","title":"CalendarHeatmapRange","summary":"The CalendarHeatmapRange type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarHeatmapRange {\n  start: string;\n  end: string;\n  days: number;\n  weeks: number;\n  weekStart: CalendarWeekStart;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarWeekStart","title":"CalendarWeekStart","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapRenderPath","title":"CalendarHeatmapRenderPath","summary":"The CalendarHeatmapRenderPath type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapRenderPath = HeatmapRenderPath;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapRenderPath","title":"HeatmapRenderPath","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapRenderResult","title":"CalendarHeatmapRenderResult","summary":"The CalendarHeatmapRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarHeatmapRenderResult {\n  days: number;\n  valued: number;\n  drawn: number;\n  renderMs: number;\n  plane?: HeatmapPlaneStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapPlaneStats","title":"HeatmapPlaneStats","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapStreamEvent","title":"CalendarHeatmapStreamEvent","summary":"The CalendarHeatmapStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarHeatmapStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: ReadonlyArray<CalendarHeatmapEntry>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapStreamSource","title":"CalendarHeatmapStreamSource","summary":"The CalendarHeatmapStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarHeatmapStreamSource {\n  push(entry: CalendarHeatmapEntry): void;\n  pushBatch(entries: ReadonlyArray<CalendarHeatmapEntry>): void;\n  shift(count: number): void;\n  replace(entries: ReadonlyArray<CalendarHeatmapEntry>): void;\n  snapshot(): CalendarHeatmapEntry[];\n  latest(): CalendarHeatmapEntry | undefined;\n  subscribe(listener: (event: CalendarHeatmapStreamEvent) => void): () => void;\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarHeatmapEntry","title":"CalendarHeatmapEntry","description":""},{"path":"/docs/types/CalendarHeatmapStreamEvent","title":"CalendarHeatmapStreamEvent","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapTuple","title":"CalendarHeatmapTuple","summary":"The CalendarHeatmapTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapTuple = readonly [CalendarDateInput, number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CalendarDateInput","title":"CalendarDateInput","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapUnavailableBehaviour","title":"CalendarHeatmapUnavailableBehaviour","summary":"The CalendarHeatmapUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarHeatmapUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/CalendarHeatmapValueExtent","title":"CalendarHeatmapValueExtent","summary":"The CalendarHeatmapValueExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarHeatmapValueExtent {\n  min: number;\n  max: number;\n  finite: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CalendarMonthMark","title":"CalendarMonthMark","summary":"The CalendarMonthMark type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CalendarMonthMark {\n  year: number;\n  month: number;\n  label: string;\n  week: number;\n  weekday: number;\n  date: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CalendarWeekStart","title":"CalendarWeekStart","summary":"The CalendarWeekStart type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarWeekStart = 'monday' | 'sunday';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CalendarWeekdayLabels","title":"CalendarWeekdayLabels","summary":"The CalendarWeekdayLabels type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CalendarWeekdayLabels = 'short' | 'all' | 'none';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickAnimationType","title":"CandlestickAnimationType","summary":"The CandlestickAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/CandlestickAntialias","title":"CandlestickAntialias","summary":"The CandlestickAntialias type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickAntialias = 'auto' | 'on' | 'off';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","summary":"The CandlestickBar type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickBar {\n  readonly time: number;\n  readonly open: number;\n  readonly high: number;\n  readonly low: number;\n  readonly close: number;\n  readonly volume?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","summary":"The CandlestickBarInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickBarInput = CandlestickBarObjectInput | CandlestickBarTupleInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickBarObjectInput","title":"CandlestickBarObjectInput","description":""},{"path":"/docs/types/CandlestickBarTupleInput","title":"CandlestickBarTupleInput","description":""}]}]}]},{"path":"/docs/types/CandlestickBarObjectInput","title":"CandlestickBarObjectInput","summary":"The CandlestickBarObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickBarObjectInput {\n  readonly time: number | string | Date;\n  readonly open: number;\n  readonly high: number;\n  readonly low: number;\n  readonly close: number;\n  readonly volume?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickBarStyle","title":"CandlestickBarStyle","summary":"The CandlestickBarStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickBarStyle = 'candle' | 'ohlc' | 'hlc' | 'hilo';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickBarTupleInput","title":"CandlestickBarTupleInput","summary":"The CandlestickBarTupleInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickBarTupleInput = readonly [number | string | Date, number, number, number, number, number?];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickBodyStyle","title":"CandlestickBodyStyle","summary":"The CandlestickBodyStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickBodyStyle = 'solid' | 'hollow' | 'hollow-up';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickData","title":"CandlestickData","summary":"The CandlestickData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickData = ReadonlyArray<CandlestickBarInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":""}]}]}]},{"path":"/docs/types/CandlestickDirection","title":"CandlestickDirection","summary":"The CandlestickDirection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickDirection = 'up' | 'down' | 'flat';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickDomain","title":"CandlestickDomain","summary":"The CandlestickDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickDomain {\n  xMin: number;\n  xMax: number;\n  yMin: number;\n  yMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickDrawStats","title":"CandlestickDrawStats","summary":"The CandlestickDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickDrawStats {\n  bars: number;\n  drawn: number;\n  instances: number;\n  visibleFrom: number;\n  journal: { from: number; to: number } | null;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  pitchPx: number;\n  bodyPx: number;\n  wickPx: number;\n  bodyStyle: CandlestickBodyStyle;\n  antialiased: boolean;\n  snapped: boolean;\n  bodyDevicePx: number;\n  wickDevicePx: number;\n  parts: number;\n  barStyle: CandlestickBarStyle;\n  volume?: CandlestickVolumeStats;\n  overlays?: CandlestickOverlayStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickBodyStyle","title":"CandlestickBodyStyle","description":""},{"path":"/docs/types/CandlestickBarStyle","title":"CandlestickBarStyle","description":""},{"path":"/docs/types/CandlestickVolumeStats","title":"CandlestickVolumeStats","description":""},{"path":"/docs/types/CandlestickOverlayStats","title":"CandlestickOverlayStats","description":""}]}]}]},{"path":"/docs/types/CandlestickEasing","title":"CandlestickEasing","summary":"The CandlestickEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/CandlestickEngineMode","title":"CandlestickEngineMode","summary":"The CandlestickEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/CandlestickEngineTier","title":"CandlestickEngineTier","summary":"The CandlestickEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/CandlestickExtent","title":"CandlestickExtent","summary":"The CandlestickExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickExtent {\n  bars: number;\n  timeMin: number;\n  timeMax: number;\n  priceMin: number;\n  priceMax: number;\n  volumeMax: number;\n  interval: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickOverlayBand","title":"CandlestickOverlayBand","summary":"The CandlestickOverlayBand type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickOverlayBand {\n  upper: string;\n  lower: string;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickOverlayInput","title":"CandlestickOverlayInput","summary":"The CandlestickOverlayInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickOverlayInput = ReadonlyArray<CandlestickOverlaySpecInput | string> | string;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlaySpecInput","title":"CandlestickOverlaySpecInput","description":""}]}]}]},{"path":"/docs/types/CandlestickOverlayKind","title":"CandlestickOverlayKind","summary":"The CandlestickOverlayKind type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickOverlayKind = 'sma' | 'ema' | 'wma' | 'dema' | 'tema' | 'vwma' | 'hma' | 'linreg' | (string & {});","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickOverlayOutput","title":"CandlestickOverlayOutput","summary":"The CandlestickOverlayOutput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickOverlayOutput {\n  key: string;\n  width: number;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickOverlaySpec","title":"CandlestickOverlaySpec","summary":"The CandlestickOverlaySpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickOverlaySpec {\n  id: string;\n  kind: string;\n  period: number;\n  color: string;\n  width: number;\n  label: string;\n  params: Readonly<Record<string, number>>;\n  outputs: ReadonlyArray<CandlestickOverlayOutput>;\n  band?: CandlestickOverlayBand;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlayOutput","title":"CandlestickOverlayOutput","description":""},{"path":"/docs/types/CandlestickOverlayBand","title":"CandlestickOverlayBand","description":""}]}]}]},{"path":"/docs/types/CandlestickOverlaySpecInput","title":"CandlestickOverlaySpecInput","summary":"The CandlestickOverlaySpecInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickOverlaySpecInput {\n  kind: CandlestickOverlayKind;\n  period?: number;\n  color?: string;\n  width?: number;\n  label?: string;\n  id?: string;\n  params?: Readonly<Record<string, number>>;\n  deviations?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlayKind","title":"CandlestickOverlayKind","description":""}]}]}]},{"path":"/docs/types/CandlestickOverlayState","title":"CandlestickOverlayState","summary":"The CandlestickOverlayState type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickOverlayState extends CandlestickOverlaySpec {\n  firstValid: number;\n  visibleFrom: number;\n  visibleCount: number;\n  last: number | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickOverlaySpec","title":"CandlestickOverlaySpec","description":""}]}]}]},{"path":"/docs/types/CandlestickOverlayStats","title":"CandlestickOverlayStats","summary":"The CandlestickOverlayStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickOverlayStats {\n  lines: number;\n  segments: number;\n  points: number;\n  fills: number;\n  fillVertices: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickPaneRect","title":"CandlestickPaneRect","summary":"The CandlestickPaneRect type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickPaneRect {\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickPaneRects","title":"CandlestickPaneRects","summary":"The CandlestickPaneRects type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickPaneRects {\n  price: CandlestickPaneRect;\n  volume?: CandlestickPaneRect;\n  separatorPx: number;\n  volumeReason?: 'off' | 'no volume data';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickPaneRect","title":"CandlestickPaneRect","description":""}]}]}]},{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","summary":"The CandlestickPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickPointEventDetail {\n  index: number;\n  time: number;\n  open: number;\n  high: number;\n  low: number;\n  close: number;\n  volume: number | null;\n  direction: CandlestickDirection;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickDirection","title":"CandlestickDirection","description":""}]}]}]},{"path":"/docs/types/CandlestickRenderResult","title":"CandlestickRenderResult","summary":"The CandlestickRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickRenderResult {\n  bars: number;\n  drawn: number;\n  renderMs: number;\n  candles?: CandlestickDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickDrawStats","title":"CandlestickDrawStats","description":""}]}]}]},{"path":"/docs/types/CandlestickSessionInput","title":"CandlestickSessionInput","summary":"The CandlestickSessionInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickSessionInput = '24x7' | 'us-equity' | { readonly timezone?: string; readonly sessions?: ReadonlyArray<string>; readonly holidays?: ReadonlyArray<string>; readonly closedWeekdays?: ReadonlyArray<number> };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickStreamEvent","title":"CandlestickStreamEvent","summary":"The CandlestickStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  bars: ReadonlyArray<CandlestickBar>;\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","description":""}]}]}]},{"path":"/docs/types/CandlestickStreamSource","title":"CandlestickStreamSource","summary":"The CandlestickStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickStreamSource {\n  push(bar: CandlestickBarInput): void;\n  pushBatch(bars: ReadonlyArray<CandlestickBarInput>): void;\n  shift(count: number): void;\n  replace(bars: ReadonlyArray<CandlestickBarInput>): void;\n  snapshot(): CandlestickBar[];\n  latest(): CandlestickBar | undefined;\n  subscribe(listener: (event: CandlestickStreamEvent) => void): () => void;\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickBarInput","title":"CandlestickBarInput","description":""},{"path":"/docs/types/CandlestickBar","title":"CandlestickBar","description":""},{"path":"/docs/types/CandlestickStreamEvent","title":"CandlestickStreamEvent","description":""}]}]}]},{"path":"/docs/types/CandlestickTimeScale","title":"CandlestickTimeScale","summary":"The CandlestickTimeScale type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickTimeScale = 'ordinal' | 'linear';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickTimeScaleState","title":"CandlestickTimeScaleState","summary":"The CandlestickTimeScaleState type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickTimeScaleState {\n  kind: CandlestickTimeScale;\n  from: number;\n  to: number;\n  count: number;\n  barSpacing: number;\n  ticks: ReadonlyArray<CandlestickTimeTick>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CandlestickTimeScale","title":"CandlestickTimeScale","description":""},{"path":"/docs/types/CandlestickTimeTick","title":"CandlestickTimeTick","description":""}]}]}]},{"path":"/docs/types/CandlestickTimeTick","title":"CandlestickTimeTick","summary":"The CandlestickTimeTick type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickTimeTick {\n  index: number;\n  time: number;\n  label: string;\n  unit: 'year' | 'month' | 'day' | 'time';\n  major: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickUnavailableBehaviour","title":"CandlestickUnavailableBehaviour","summary":"The CandlestickUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/CandlestickVisibleRange","title":"CandlestickVisibleRange","summary":"The CandlestickVisibleRange type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickVisibleRange {\n  from: number;\n  to: number;\n  count: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickVolumeMode","title":"CandlestickVolumeMode","summary":"The CandlestickVolumeMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CandlestickVolumeMode = 'off' | 'pane';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CandlestickVolumeStats","title":"CandlestickVolumeStats","summary":"The CandlestickVolumeStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CandlestickVolumeStats {\n  drawn: number;\n  max: number;\n  paneHeightPx: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","summary":"The CartesianAxisId type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianAxisId = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","summary":"The CartesianAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianAxisInput =\r\n  | undefined\r\n  | null\r\n  | 'auto'\r\n  | 'off'\r\n  | boolean\r\n  | Partial<CartesianAxisSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianAxisSpec","title":"CartesianAxisSpec","description":""}]}]}]},{"path":"/docs/types/CartesianAxisKind","title":"CartesianAxisKind","summary":"The CartesianAxisKind type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianAxisKind = (typeof CARTESIAN_AXIS_KINDS)[number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianAxisPosition","title":"CartesianAxisPosition","summary":"The CartesianAxisPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianAxisPosition = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianAxisSpec","title":"CartesianAxisSpec","summary":"The CartesianAxisSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianAxisSpec {\r\n  id?: CartesianAxisId;\r\n  kind: CartesianAxisKind;\r\n  show: boolean;\r\n  position: CartesianAxisPosition;\r\n  label?: string;\r\n  min?: number;\r\n  max?: number;\r\n  tickCount?: number;\r\n  categories?: ReadonlyArray<string>;\r\n  format?: (value: number) => string;\r\n  linkedTo?: CartesianAxisId;\r\n  reversed?: boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","description":""},{"path":"/docs/types/CartesianAxisKind","title":"CartesianAxisKind","description":""},{"path":"/docs/types/CartesianAxisPosition","title":"CartesianAxisPosition","description":""}]}]}]},{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","summary":"The CartesianBrushArea type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushArea = CartesianBrushRectArea | CartesianBrushLassoArea | CartesianBrushBandArea;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushRectArea","title":"CartesianBrushRectArea","description":""},{"path":"/docs/types/CartesianBrushLassoArea","title":"CartesianBrushLassoArea","description":""},{"path":"/docs/types/CartesianBrushBandArea","title":"CartesianBrushBandArea","description":""}]}]}]},{"path":"/docs/types/CartesianBrushAreaInput","title":"CartesianBrushAreaInput","summary":"The CartesianBrushAreaInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushAreaInput =\n  | { type?: 'rect'; x: CartesianBrushRange | readonly [number, number]; y: CartesianBrushRange | readonly [number, number] }\n  | { type: 'lasso'; points: ReadonlyArray<CartesianBrushPoint | readonly [number, number]> }\n  | { type: 'band'; axis: 'x' | 'y'; range: CartesianBrushRange | readonly [number, number] };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushRange","title":"CartesianBrushRange","description":""},{"path":"/docs/types/CartesianBrushPoint","title":"CartesianBrushPoint","description":""}]}]}]},{"path":"/docs/types/CartesianBrushBandArea","title":"CartesianBrushBandArea","summary":"The CartesianBrushBandArea type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushBandArea {\n  type: 'band';\n  axis: 'x' | 'y';\n  range: CartesianBrushRange;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushRange","title":"CartesianBrushRange","description":""}]}]}]},{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","summary":"The CartesianBrushChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushChangeEventDetail {\n  areas: CartesianBrushArea[];\n  selected: CartesianBrushSelectedSeries[];\n  count: number;\n  source: CartesianBrushSource;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":""},{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":""},{"path":"/docs/types/CartesianBrushSource","title":"CartesianBrushSource","description":""}]}]}]},{"path":"/docs/types/CartesianBrushCoverage","title":"CartesianBrushCoverage","summary":"The CartesianBrushCoverage type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushCoverage = 'xy' | 'x' | 'y';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianBrushEndEventDetail","title":"CartesianBrushEndEventDetail","summary":"The CartesianBrushEndEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushEndEventDetail = CartesianBrushChangeEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushChangeEventDetail","title":"CartesianBrushChangeEventDetail","description":""}]}]}]},{"path":"/docs/types/CartesianBrushInput","title":"CartesianBrushInput","summary":"The CartesianBrushInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushInput =\n  | undefined\n  | null\n  | boolean\n  | 'auto'\n  | 'off'\n  | 'true'\n  | 'false'\n  | CartesianBrushType\n  | Partial<CartesianBrushSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushType","title":"CartesianBrushType","description":""},{"path":"/docs/types/CartesianBrushSpec","title":"CartesianBrushSpec","description":""}]}]}]},{"path":"/docs/types/CartesianBrushLassoArea","title":"CartesianBrushLassoArea","summary":"The CartesianBrushLassoArea type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushLassoArea {\n  type: 'lasso';\n  points: CartesianBrushPoint[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushPoint","title":"CartesianBrushPoint","description":""}]}]}]},{"path":"/docs/types/CartesianBrushMode","title":"CartesianBrushMode","summary":"The CartesianBrushMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianBrushModifier","title":"CartesianBrushModifier","summary":"The CartesianBrushModifier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushModifier = 'none' | 'shift' | 'alt';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianBrushMoveEventDetail","title":"CartesianBrushMoveEventDetail","summary":"The CartesianBrushMoveEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushMoveEventDetail {\n  area: CartesianBrushArea;\n  selected?: CartesianBrushSelectedSeries[];\n  count?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushArea","title":"CartesianBrushArea","description":""},{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","description":""}]}]}]},{"path":"/docs/types/CartesianBrushPoint","title":"CartesianBrushPoint","summary":"The CartesianBrushPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushPoint {\n  x: number;\n  y: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianBrushRange","title":"CartesianBrushRange","summary":"The CartesianBrushRange type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushRange {\n  min: number;\n  max: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianBrushRectArea","title":"CartesianBrushRectArea","summary":"The CartesianBrushRectArea type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushRectArea {\n  type: 'rect';\n  x: CartesianBrushRange;\n  y: CartesianBrushRange;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushRange","title":"CartesianBrushRange","description":""}]}]}]},{"path":"/docs/types/CartesianBrushSelectedPoint","title":"CartesianBrushSelectedPoint","summary":"The CartesianBrushSelectedPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushSelectedPoint {\n  index: number;\n  x?: number;\n  y?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianBrushSelectedSeries","title":"CartesianBrushSelectedSeries","summary":"The CartesianBrushSelectedSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushSelectedSeries {\n  seriesIndex: number;\n  points: number[];\n  data?: CartesianBrushSelectedPoint[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushSelectedPoint","title":"CartesianBrushSelectedPoint","description":""}]}]}]},{"path":"/docs/types/CartesianBrushSource","title":"CartesianBrushSource","summary":"The CartesianBrushSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushSource = 'drag' | 'api' | 'clear' | 'keyboard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianBrushSpec","title":"CartesianBrushSpec","summary":"The CartesianBrushSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushSpec {\n  enabled: boolean;\n  type: CartesianBrushType;\n  mode: CartesianBrushMode;\n  coverage: CartesianBrushCoverage;\n  modifier: CartesianBrushModifier;\n  minSizePx: number;\n  keyboard: boolean;\n  clearOnClick: boolean;\n  liveSelection: boolean;\n  moveThrottleMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushType","title":"CartesianBrushType","description":""},{"path":"/docs/types/CartesianBrushMode","title":"CartesianBrushMode","description":""},{"path":"/docs/types/CartesianBrushCoverage","title":"CartesianBrushCoverage","description":""},{"path":"/docs/types/CartesianBrushModifier","title":"CartesianBrushModifier","description":""}]}]}]},{"path":"/docs/types/CartesianBrushStartEventDetail","title":"CartesianBrushStartEventDetail","summary":"The CartesianBrushStartEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianBrushStartEventDetail {\n  type: CartesianBrushType;\n  coverage: CartesianBrushCoverage;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianBrushType","title":"CartesianBrushType","description":""},{"path":"/docs/types/CartesianBrushCoverage","title":"CartesianBrushCoverage","description":""}]}]}]},{"path":"/docs/types/CartesianBrushType","title":"CartesianBrushType","summary":"The CartesianBrushType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianBrushType = 'rect' | 'lasso';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianCrosshairEventDetail","title":"CartesianCrosshairEventDetail","summary":"The CartesianCrosshairEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianCrosshairEventDetail {\r\n  cssX: number;\r\n  cssY: number;\r\n  dataX?: number;\r\n  dataY?: number;\r\n  snappedPointIndex?: number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianCrosshairInput","title":"CartesianCrosshairInput","summary":"The CartesianCrosshairInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianCrosshairInput =\r\n  | undefined\r\n  | null\r\n  | string\r\n  | boolean\r\n  | Partial<CartesianCrosshairSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairSpec","title":"CartesianCrosshairSpec","description":""}]}]}]},{"path":"/docs/types/CartesianCrosshairMode","title":"CartesianCrosshairMode","summary":"The CartesianCrosshairMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianCrosshairMode = 'vertical' | 'horizontal' | 'cross';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianCrosshairShowRequest","title":"CartesianCrosshairShowRequest","summary":"The CartesianCrosshairShowRequest type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianCrosshairShowRequest {\n  dataX?: number;\n  dataY?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianCrosshairSnap","title":"CartesianCrosshairSnap","summary":"The CartesianCrosshairSnap type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianCrosshairSnap = 'nearest' | 'index' | 'off';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianCrosshairSpec","title":"CartesianCrosshairSpec","summary":"The CartesianCrosshairSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianCrosshairSpec {\r\n  show: boolean;\r\n  mode: CartesianCrosshairMode;\r\n  snap: CartesianCrosshairSnap;\r\n  color?: string;\r\n  dash?: number[];\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianCrosshairMode","title":"CartesianCrosshairMode","description":""},{"path":"/docs/types/CartesianCrosshairSnap","title":"CartesianCrosshairSnap","description":""}]}]}]},{"path":"/docs/types/CartesianGridLinesInput","title":"CartesianGridLinesInput","summary":"The CartesianGridLinesInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianGridLinesInput =\r\n  | undefined\r\n  | null\r\n  | 'auto'\r\n  | 'off'\r\n  | boolean\r\n  | Partial<CartesianGridLinesSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianGridLinesSpec","title":"CartesianGridLinesSpec","description":""}]}]}]},{"path":"/docs/types/CartesianGridLinesSpec","title":"CartesianGridLinesSpec","summary":"The CartesianGridLinesSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianGridLinesSpec {\r\n  x: boolean;\r\n  y: boolean;\r\n  color?: string;\r\n  dash?: number[];\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","summary":"The CartesianPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianPointEventDetail {\r\n  seriesIndex: number;\r\n  seriesId?: string | number;\r\n  seriesName?: string;\r\n  pointIndex: number;\r\n  pointId?: string | number;\r\n  value: number;\r\n  cssX: number;\r\n  cssY: number;\r\n  dataX?: number;\r\n  dataY?: number;\r\n  interactionTarget?: 'point' | 'marker' | 'bar';\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","summary":"The CartesianSeriesBase type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesBase<TValues = unknown> {\n  id?: CartesianSeriesId;\n  name?: string;\n  label?: string;\n  visible?: boolean;\n  showInLegend?: boolean;\n  linkedTo?: CartesianSeriesId | ':previous';\n  color?: string;\n  opacity?: number;\n  yAxis?: CartesianAxisId;\n  xAxis?: CartesianAxisId;\n  xAxisIndex?: number;\n  yAxisIndex?: number;\n  values?: TValues;\n  data?: CartesianSeriesData;\n  keys?: ReadonlyArray<string>;\n  pointStart?: number;\n  pointInterval?: number;\n  pointIntervalUnit?: CartesianSeriesPointIntervalUnit;\n  relativeXValue?: boolean;\n  marker?: CartesianSeriesMarkerInput | CartesianSeriesMarkerSymbol | 'none';\n  states?: CartesianSeriesStatesInput;\n  events?: CartesianSeriesEventsInput;\n  tooltip?: CartesianSeriesTooltipInput;\n  zones?: ReadonlyArray<CartesianSeriesZone>;\n  zoneAxis?: CartesianSeriesZoneAxis;\n  dataLabels?: CartesianSeriesDataLabelsInput;\n  dataSorting?: CartesianSeriesDataSortingInput;\n  selected?: boolean;\n  stack?: CartesianSeriesId;\n  stacking?: CartesianSeriesStackingMode;\n  borderRadius?: CartesianSeriesCornerRadiusValue;\n  borderColor?: string;\n  borderWidth?: number;\n  borderDashStyle?: CartesianSeriesBorderDashStyle;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesId","title":"CartesianSeriesId","description":""},{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","description":""},{"path":"/docs/types/CartesianSeriesData","title":"CartesianSeriesData","description":""},{"path":"/docs/types/CartesianSeriesPointIntervalUnit","title":"CartesianSeriesPointIntervalUnit","description":""},{"path":"/docs/types/CartesianSeriesMarkerInput","title":"CartesianSeriesMarkerInput","description":""},{"path":"/docs/types/CartesianSeriesMarkerSymbol","title":"CartesianSeriesMarkerSymbol","description":""},{"path":"/docs/types/CartesianSeriesStatesInput","title":"CartesianSeriesStatesInput","description":""},{"path":"/docs/types/CartesianSeriesEventsInput","title":"CartesianSeriesEventsInput","description":""},{"path":"/docs/types/CartesianSeriesTooltipInput","title":"CartesianSeriesTooltipInput","description":""},{"path":"/docs/types/CartesianSeriesZone","title":"CartesianSeriesZone","description":""},{"path":"/docs/types/CartesianSeriesZoneAxis","title":"CartesianSeriesZoneAxis","description":""},{"path":"/docs/types/CartesianSeriesDataLabelsInput","title":"CartesianSeriesDataLabelsInput","description":""},{"path":"/docs/types/CartesianSeriesDataSortingInput","title":"CartesianSeriesDataSortingInput","description":""},{"path":"/docs/types/CartesianSeriesStackingMode","title":"CartesianSeriesStackingMode","description":""},{"path":"/docs/types/CartesianSeriesCornerRadiusValue","title":"CartesianSeriesCornerRadiusValue","description":""},{"path":"/docs/types/CartesianSeriesBorderDashStyle","title":"CartesianSeriesBorderDashStyle","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesBorderDashStyle","title":"CartesianSeriesBorderDashStyle","summary":"The CartesianSeriesBorderDashStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesBorderDashStyle = 'Solid' | 'Dash' | 'Dot' | 'DashDot' | 'LongDash' | 'LongDashDot';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesCornerRadiusInput","title":"CartesianSeriesCornerRadiusInput","summary":"The CartesianSeriesCornerRadiusInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesCornerRadiusInput {\n  topLeft?: number;\n  topRight?: number;\n  bottomRight?: number;\n  bottomLeft?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesCornerRadiusTuple","title":"CartesianSeriesCornerRadiusTuple","summary":"The CartesianSeriesCornerRadiusTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesCornerRadiusTuple = ReadonlyArray<number>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesCornerRadiusValue","title":"CartesianSeriesCornerRadiusValue","summary":"The CartesianSeriesCornerRadiusValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesCornerRadiusValue = number | CartesianSeriesCornerRadiusInput | CartesianSeriesCornerRadiusTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesCornerRadiusInput","title":"CartesianSeriesCornerRadiusInput","description":""},{"path":"/docs/types/CartesianSeriesCornerRadiusTuple","title":"CartesianSeriesCornerRadiusTuple","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesData","title":"CartesianSeriesData","summary":"The CartesianSeriesData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesData = ReadonlyArray<CartesianSeriesDataItem>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesDataItem","title":"CartesianSeriesDataItem","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesDataItem","title":"CartesianSeriesDataItem","summary":"The CartesianSeriesDataItem type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesDataItem =\n  | CartesianSeriesPointDatum\n  | CartesianSeriesDataTuple\n  | CartesianSeriesPointObject;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesPointDatum","title":"CartesianSeriesPointDatum","description":""},{"path":"/docs/types/CartesianSeriesDataTuple","title":"CartesianSeriesDataTuple","description":""},{"path":"/docs/types/CartesianSeriesPointObject","title":"CartesianSeriesPointObject","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesDataLabelsInput","title":"CartesianSeriesDataLabelsInput","summary":"The CartesianSeriesDataLabelsInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesDataLabelsInput {\n  enabled?: boolean;\n  format?: string;\n  formatter?: (context: { value: number; pointIndex: number; seriesIndex: number; seriesId?: CartesianSeriesId; seriesName?: string }) => string;\n  color?: string;\n  align?: 'left' | 'center' | 'right';\n  verticalAlign?: 'top' | 'middle' | 'bottom';\n  filter?: (context: { value: number; pointIndex: number }) => boolean;\n  allowOverlap?: boolean;\n  padding?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesId","title":"CartesianSeriesId","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesDataSortingInput","title":"CartesianSeriesDataSortingInput","summary":"The CartesianSeriesDataSortingInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesDataSortingInput {\n  enabled?: boolean;\n  sortKey?: 'x' | 'y' | string;\n  matchByName?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesDataTuple","title":"CartesianSeriesDataTuple","summary":"The CartesianSeriesDataTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesDataTuple = readonly [number | bigint | string, CartesianSeriesPointDatum];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesPointDatum","title":"CartesianSeriesPointDatum","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesEventHandler","title":"CartesianSeriesEventHandler","summary":"The CartesianSeriesEventHandler type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesEventHandler = (event: { seriesId?: CartesianSeriesId; seriesIndex: number; seriesName?: string; original?: Event }) => void;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesId","title":"CartesianSeriesId","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesEventName","title":"CartesianSeriesEventName","summary":"The CartesianSeriesEventName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesEventName = 'click' | 'mouseOver' | 'mouseOut' | 'show' | 'hide' | 'legendItemClick';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesEventsInput","title":"CartesianSeriesEventsInput","summary":"The CartesianSeriesEventsInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesEventsInput = Partial<Record<CartesianSeriesEventName, CartesianSeriesEventHandler>>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesEventName","title":"CartesianSeriesEventName","description":""},{"path":"/docs/types/CartesianSeriesEventHandler","title":"CartesianSeriesEventHandler","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesId","title":"CartesianSeriesId","summary":"The CartesianSeriesId type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesId = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesMarkerInput","title":"CartesianSeriesMarkerInput","summary":"The CartesianSeriesMarkerInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesMarkerInput extends CartesianSeriesMarkerStateInput {\n  states?: {\n    hover?: CartesianSeriesMarkerStateInput;\n    select?: CartesianSeriesMarkerStateInput;\n    inactive?: CartesianSeriesMarkerStateInput;\n  };\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesMarkerStateInput","title":"CartesianSeriesMarkerStateInput","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesMarkerStateInput","title":"CartesianSeriesMarkerStateInput","summary":"The CartesianSeriesMarkerStateInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesMarkerStateInput {\n  enabled?: boolean;\n  symbol?: CartesianSeriesMarkerSymbol;\n  radius?: number;\n  fillColor?: string;\n  lineColor?: string;\n  lineWidth?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesMarkerSymbol","title":"CartesianSeriesMarkerSymbol","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesMarkerSymbol","title":"CartesianSeriesMarkerSymbol","summary":"The CartesianSeriesMarkerSymbol type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesMarkerSymbol =\n  | 'circle'\n  | 'square'\n  | 'triangle'\n  | 'triangle-down'\n  | 'cross'\n  | 'diamond'\n  | 'star'\n  | 'wye';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesOutsideClickEventDetail","title":"CartesianSeriesOutsideClickEventDetail","summary":"The CartesianSeriesOutsideClickEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesOutsideClickEventDetail {\r\n  cssX: number;\r\n  cssY: number;\r\n  dataX?: number;\r\n  dataY?: number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesPointDatum","title":"CartesianSeriesPointDatum","summary":"The CartesianSeriesPointDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesPointDatum = number | bigint | string | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesPointIntervalUnit","title":"CartesianSeriesPointIntervalUnit","summary":"The CartesianSeriesPointIntervalUnit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesPointIntervalUnit = 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesPointObject","title":"CartesianSeriesPointObject","summary":"The CartesianSeriesPointObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesPointObject {\n  x?: number | bigint | string;\n  y: CartesianSeriesPointDatum;\n  name?: string;\n  color?: string;\n  marker?: CartesianSeriesMarkerInput;\n  custom?: Record<string, unknown>;\n  id?: CartesianSeriesId;\n  selected?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesPointDatum","title":"CartesianSeriesPointDatum","description":""},{"path":"/docs/types/CartesianSeriesMarkerInput","title":"CartesianSeriesMarkerInput","description":""},{"path":"/docs/types/CartesianSeriesId","title":"CartesianSeriesId","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesStackingMode","title":"CartesianSeriesStackingMode","summary":"The CartesianSeriesStackingMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesStackingMode = 'normal' | 'percent';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesStateStyle","title":"CartesianSeriesStateStyle","summary":"The CartesianSeriesStateStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesStateStyle {\n  enabled?: boolean;\n  opacity?: number;\n  brightness?: number;\n  lineWidth?: number;\n  lineWidthPlus?: number;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesStatesInput","title":"CartesianSeriesStatesInput","summary":"The CartesianSeriesStatesInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesStatesInput {\n  hover?: CartesianSeriesStateStyle;\n  inactive?: CartesianSeriesStateStyle;\n  select?: CartesianSeriesStateStyle;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesStateStyle","title":"CartesianSeriesStateStyle","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesTooltipInput","title":"CartesianSeriesTooltipInput","summary":"The CartesianSeriesTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesTooltipInput {\n  format?: (value: number, context: CartesianTooltipFormatContext) => string;\n  pointFormat?: string;\n  pointFormatter?: (context: CartesianTooltipFormatContext) => string;\n  valuePrefix?: string;\n  valueSuffix?: string;\n  valueDecimals?: number;\n  xDateFormat?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipFormatContext","title":"CartesianTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/CartesianSeriesZone","title":"CartesianSeriesZone","summary":"The CartesianSeriesZone type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianSeriesZone {\n  value?: number;\n  color?: string;\n  fillColor?: string;\n  dashStyle?: 'Solid' | 'Dash' | 'Dot' | 'DashDot' | 'LongDash' | 'LongDashDot';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianSeriesZoneAxis","title":"CartesianSeriesZoneAxis","summary":"The CartesianSeriesZoneAxis type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianSeriesZoneAxis = 'x' | 'y';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","summary":"The CartesianTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianTooltipActionEventDetail extends CartesianTooltipFormatContext {\r\n  action: string;\r\n  text: string;\r\n  html?: string;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipFormatContext","title":"CartesianTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipConnectorInput","title":"CartesianTooltipConnectorInput","summary":"The CartesianTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipConnectorInput =\r\n  | undefined\r\n  | null\r\n  | boolean\r\n  | Partial<CartesianTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipConnectorSpec","title":"CartesianTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipConnectorSpec","title":"CartesianTooltipConnectorSpec","summary":"The CartesianTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianTooltipConnectorSpec {\r\n  show: boolean;\r\n  color?: string;\r\n  width?: number;\r\n  dash?: number[];\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianTooltipEventDetail","title":"CartesianTooltipEventDetail","summary":"The CartesianTooltipEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianTooltipEventDetail {\r\n  cssX: number;\r\n  cssY: number;\r\n  anchor: 'top' | 'right' | 'bottom' | 'left';\r\n  text: string;\r\n  html?: string;\r\n  context?: CartesianTooltipFormatContext;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipFormatContext","title":"CartesianTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipFormatContext","title":"CartesianTooltipFormatContext","summary":"The CartesianTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianTooltipFormatContext {\n  seriesIndex: number;\r\n  pointIndex: number;\r\n  index: number;\r\n  value: number;\r\n  cssX: number;\r\n  cssY: number;\r\n  dataX?: number;\r\n  dataY?: number;\r\n  mode: CartesianTooltipMode;\r\n  stackTotal?: number;\r\n  stackPercent?: number;\r\n  geoMap?: GeoMapHitDetail | GeoMapFeatureHitDetail;\r\n  gantt?: GanttHitDetail;\r\n  parallelCoordinates?:ParallelCoordinatesHitDetail;\n  surface3d?:Surface3DHitDetail;\n  scatter3d?:Scatter3DHitDetail;\n  bar3d?:Bar3DHitDetail;\n  themeRiver?:ThemeRiverHitDetail;\n  flowLines?:FlowLinesHitDetail;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipMode","title":"CartesianTooltipMode","description":""},{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":""},{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":""},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":""},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":""},{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":""},{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":""},{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":""},{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":""},{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipInput","title":"CartesianTooltipInput","summary":"The CartesianTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipInput =\r\n  | undefined\r\n  | null\r\n  | 'auto'\r\n  | 'off'\r\n  | boolean\r\n  | CartesianTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipObjectInput","title":"CartesianTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipMode","title":"CartesianTooltipMode","summary":"The CartesianTooltipMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipMode = 'single' | 'shared' | 'crosshair';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianTooltipObjectInput","title":"CartesianTooltipObjectInput","summary":"The CartesianTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipObjectInput = Omit<Partial<CartesianTooltipSpec>, 'connector'> & {\r\n  connector?: CartesianTooltipConnectorInput;\r\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipSpec","title":"CartesianTooltipSpec","description":""},{"path":"/docs/types/CartesianTooltipConnectorInput","title":"CartesianTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipOpenMode","title":"CartesianTooltipOpenMode","summary":"The CartesianTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianTooltipSpec","title":"CartesianTooltipSpec","summary":"The CartesianTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianTooltipSpec {\r\n  show: boolean;\r\n  mode: CartesianTooltipMode;\r\n  openMode?: CartesianTooltipOpenMode;\r\n  trigger?: CartesianTooltipTrigger;\r\n  side?: 'top' | 'right' | 'bottom' | 'left';\r\n  offset?: number;\r\n  format?: (value: number, context?: CartesianTooltipFormatContext) => string;\r\n  html?: (value: number, context?: CartesianTooltipFormatContext) => string;\r\n  className?: string;\r\n  style?: CartesianTooltipStyle;\r\n  width?: number | string;\r\n  minWidth?: number | string;\r\n  maxWidth?: number | string;\r\n  padding?: number | string;\r\n  interactive?: boolean;\r\n  hideOnLeave?: boolean;\r\n  connector?: CartesianTooltipConnectorSpec;\r\n  draggable?: boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipMode","title":"CartesianTooltipMode","description":""},{"path":"/docs/types/CartesianTooltipOpenMode","title":"CartesianTooltipOpenMode","description":""},{"path":"/docs/types/CartesianTooltipTrigger","title":"CartesianTooltipTrigger","description":""},{"path":"/docs/types/CartesianTooltipFormatContext","title":"CartesianTooltipFormatContext","description":""},{"path":"/docs/types/CartesianTooltipStyle","title":"CartesianTooltipStyle","description":""},{"path":"/docs/types/CartesianTooltipConnectorSpec","title":"CartesianTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipStyle","title":"CartesianTooltipStyle","summary":"The CartesianTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipStyle = Record<string, CartesianTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipStyleValue","title":"CartesianTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/CartesianTooltipStyleValue","title":"CartesianTooltipStyleValue","summary":"The CartesianTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianTooltipTrigger","title":"CartesianTooltipTrigger","summary":"The CartesianTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianYAxisInput","title":"CartesianYAxisInput","summary":"The CartesianYAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianYAxisInput = CartesianAxisInput | ReadonlyArray<CartesianAxisInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":""}]}]}]},{"path":"/docs/types/CartesianZoomAxisExtent","title":"CartesianZoomAxisExtent","summary":"The CartesianZoomAxisExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomAxisExtent {\n  key: string;\n  min: number;\n  max: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","summary":"The CartesianZoomChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomChangeEventDetail {\n  zoom: CartesianZoomState | null;\n  source: CartesianZoomSource;\n  x?: CartesianZoomWindow;\n  y?: CartesianZoomWindow;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":""},{"path":"/docs/types/CartesianZoomSource","title":"CartesianZoomSource","description":""},{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":""}]}]}]},{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","summary":"The CartesianZoomExtentDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomExtentDetail {\n  x?: CartesianZoomAxisExtent;\n  y?: CartesianZoomAxisExtent;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomAxisExtent","title":"CartesianZoomAxisExtent","description":""}]}]}]},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","summary":"The CartesianZoomExtentRequest type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomExtentRequest {\n  xAxis?: CartesianAxisId;\n  yAxis?: CartesianAxisId;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","description":""}]}]}]},{"path":"/docs/types/CartesianZoomInput","title":"CartesianZoomInput","summary":"The CartesianZoomInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomInput =\n  | undefined\n  | null\n  | boolean\n  | 'auto'\n  | 'off'\n  | 'true'\n  | 'false'\n  | CartesianZoomMode\n  | 'inside'\n  | (Partial<Omit<CartesianZoomSpec, 'pan' | 'wheel'>> & { pan?: CartesianZoomPanInput; wheel?: CartesianZoomWheelInput });","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomMode","title":"CartesianZoomMode","description":""},{"path":"/docs/types/CartesianZoomSpec","title":"CartesianZoomSpec","description":""},{"path":"/docs/types/CartesianZoomPanInput","title":"CartesianZoomPanInput","description":""},{"path":"/docs/types/CartesianZoomWheelInput","title":"CartesianZoomWheelInput","description":""}]}]}]},{"path":"/docs/types/CartesianZoomMode","title":"CartesianZoomMode","summary":"The CartesianZoomMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomMode = 'x' | 'y' | 'xy';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianZoomPanInput","title":"CartesianZoomPanInput","summary":"The CartesianZoomPanInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomPanInput = boolean | CartesianZoomPanModifier | Partial<CartesianZoomPanSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomPanModifier","title":"CartesianZoomPanModifier","description":""},{"path":"/docs/types/CartesianZoomPanSpec","title":"CartesianZoomPanSpec","description":""}]}]}]},{"path":"/docs/types/CartesianZoomPanModifier","title":"CartesianZoomPanModifier","summary":"The CartesianZoomPanModifier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomPanModifier = 'shift' | 'alt' | 'none';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianZoomPanSpec","title":"CartesianZoomPanSpec","summary":"The CartesianZoomPanSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomPanSpec {\n  enabled: boolean;\n  modifier: CartesianZoomPanModifier;\n  keyboard: boolean;\n  stepFraction: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomPanModifier","title":"CartesianZoomPanModifier","description":""}]}]}]},{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","summary":"The CartesianZoomRequest type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomRequest {\n  x?: CartesianZoomWindow | readonly [number, number] | null;\n  y?: CartesianZoomWindow | readonly [number, number] | null;\n  xAxis?: CartesianAxisId;\n  yAxis?: CartesianAxisId;\n  source?: CartesianZoomRequestSource;\n  live?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":""},{"path":"/docs/types/CartesianAxisId","title":"CartesianAxisId","description":""},{"path":"/docs/types/CartesianZoomRequestSource","title":"CartesianZoomRequestSource","description":""}]}]}]},{"path":"/docs/types/CartesianZoomRequestSource","title":"CartesianZoomRequestSource","summary":"The CartesianZoomRequestSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomRequestSource = 'api' | 'slider' | 'sync';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianZoomSource","title":"CartesianZoomSource","summary":"The CartesianZoomSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomSource = 'drag' | 'keyboard' | 'api' | 'reset' | 'pan' | 'wheel' | 'pinch' | 'slider' | 'sync';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianZoomSpec","title":"CartesianZoomSpec","summary":"The CartesianZoomSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomSpec {\n  enabled: boolean;\n  mode: CartesianZoomMode;\n  drag: boolean;\n  keyboard: boolean;\n  minRangePx: number;\n  resetButton: boolean;\n  pan: CartesianZoomPanSpec;\n  wheel: CartesianZoomWheelSpec;\n  pinch: boolean;\n  inside: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomMode","title":"CartesianZoomMode","description":""},{"path":"/docs/types/CartesianZoomPanSpec","title":"CartesianZoomPanSpec","description":""},{"path":"/docs/types/CartesianZoomWheelSpec","title":"CartesianZoomWheelSpec","description":""}]}]}]},{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","summary":"The CartesianZoomState type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomState {\n  x?: Readonly<Record<string, CartesianZoomWindow>>;\n  y?: Readonly<Record<string, CartesianZoomWindow>>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":""}]}]}]},{"path":"/docs/types/CartesianZoomWheelInput","title":"CartesianZoomWheelInput","summary":"The CartesianZoomWheelInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomWheelInput = boolean | CartesianZoomWheelModifier | Partial<CartesianZoomWheelSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWheelModifier","title":"CartesianZoomWheelModifier","description":""},{"path":"/docs/types/CartesianZoomWheelSpec","title":"CartesianZoomWheelSpec","description":""}]}]}]},{"path":"/docs/types/CartesianZoomWheelModifier","title":"CartesianZoomWheelModifier","summary":"The CartesianZoomWheelModifier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type CartesianZoomWheelModifier = 'ctrl' | 'none';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/CartesianZoomWheelSpec","title":"CartesianZoomWheelSpec","summary":"The CartesianZoomWheelSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomWheelSpec {\n  enabled: boolean;\n  modifier: CartesianZoomWheelModifier;\n  pan: boolean;\n  factor: number;\n  settleMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWheelModifier","title":"CartesianZoomWheelModifier","description":""}]}]}]},{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","summary":"The CartesianZoomWindow type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CartesianZoomWindow {\n  min: number;\n  max: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartAction","title":"ChartAction","summary":"The ChartAction type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartAction {\n  type: ChartActionType | (string & {});\n  payload?: Record<string, unknown> | null;\n  [field: string]: unknown;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartActionType","title":"ChartActionType","description":""}]}]}]},{"path":"/docs/types/ChartActionEventDetail","title":"ChartActionEventDetail","summary":"The ChartActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartActionEventDetail {\n  type: string;\n  payload: Record<string, unknown>;\n  handled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartActionResult","title":"ChartActionResult","summary":"The ChartActionResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartActionResult {\n  type: string;\n  handled: boolean;\n  result?: unknown;\n  error?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartActionType","title":"ChartActionType","summary":"The ChartActionType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartActionType =\n  | 'zoomTo'\n  | 'dataZoom'\n  | 'zoomBy'\n  | 'panBy'\n  | 'resetZoom'\n  | 'brush'\n  | 'clearBrush'\n  | 'visualMap'\n  | 'clearVisualMap'\n  | 'showTip'\n  | 'hideTip'\n  | 'showCrosshair'\n  | 'hideCrosshair'\n  | 'highlight'\n  | 'downplay'\n  | 'select'\n  | 'unselect'\n  | 'legendSelect'\n  | 'legendUnSelect'\n  | 'restore'\n  | 'replaceData'\n  | 'appendData'\n  | 'export'\n  | 'print'\n  | 'showDataTable'\n  | 'hideDataTable'\n  | 'connect'\n  | 'disconnect'\n  | 'addDrawing'\n  | 'removeDrawing'\n  | 'removeDrawings'\n  | 'clearDrawings'\n  | 'undoDrawing'\n  | 'redoDrawing'\n  | 'selectDrawings'\n  | 'setDrawings'\n  | 'drawingMode'\n  | 'exportDrawings'\n  | 'importDrawings'\n  | 'setDrawingSpace';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartAnimationType","title":"ChartAnimationType","summary":"The ChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartAppendedEventDetail","title":"ChartAppendedEventDetail","summary":"The ChartAppendedEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartAppendedEventDetail { count: number; replaced?: number; }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartContextMenuEventDetail","title":"ChartContextMenuEventDetail","summary":"The ChartContextMenuEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartContextMenuEventDetail {\n  x: number;\n  y: number;\n  clientX: number;\n  clientY: number;\n  chartType: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartContextMenuItemEventDetail","title":"ChartContextMenuItemEventDetail","summary":"The ChartContextMenuItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartContextMenuItemEventDetail extends ChartContextMenuEventDetail {\n  id: string;\n  label: string;\n  action?: ChartMenuActionId;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartContextMenuEventDetail","title":"ChartContextMenuEventDetail","description":""},{"path":"/docs/types/ChartMenuActionId","title":"ChartMenuActionId","description":""}]}]}]},{"path":"/docs/types/ChartContextMenuOpenOptions","title":"ChartContextMenuOpenOptions","summary":"The ChartContextMenuOpenOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"interface ChartContextMenuOpenOptions {\n  x?: number;\n  y?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartDataTable","title":"ChartDataTable","summary":"The ChartDataTable type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartDataTable {\n  readonly columns: string[];\n  readonly rows: Array<Array<string | number | null>>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartDataValidationErrorDetail","title":"ChartDataValidationErrorDetail","summary":"The ChartDataValidationErrorDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartDataValidationErrorDetail { message: string; source?: 'data' | 'stream'; }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","summary":"The ChartDrawing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartDrawing {\n  readonly id: string;\n  readonly tool: string;\n  readonly anchors: ReadonlyArray<DrawingAnchor>;\n  readonly space: DrawingSpace;\n  readonly visible: boolean;\n  readonly locked?: boolean;\n  readonly style?: DrawingStyle;\n  readonly options?: Readonly<Record<string, unknown>>;\n  readonly meta?: DrawingMeta;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingAnchor","title":"DrawingAnchor","description":""},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":""},{"path":"/docs/types/DrawingStyle","title":"DrawingStyle","description":""},{"path":"/docs/types/DrawingMeta","title":"DrawingMeta","description":""}]}]}]},{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","summary":"The ChartDrawingInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartDrawingInput {\n  id?: string;\n  tool: string;\n  anchors: ReadonlyArray<DrawingAnchorInput>;\n  space?: DrawingSpace;\n  visible?: boolean;\n  locked?: boolean;\n  style?: DrawingStyle;\n  options?: Readonly<Record<string, unknown>>;\n  meta?: DrawingMeta;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingAnchorInput","title":"DrawingAnchorInput","description":""},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","description":""},{"path":"/docs/types/DrawingStyle","title":"DrawingStyle","description":""},{"path":"/docs/types/DrawingMeta","title":"DrawingMeta","description":""}]}]}]},{"path":"/docs/types/ChartDrawingsInput","title":"ChartDrawingsInput","summary":"The ChartDrawingsInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartDrawingsInput = ReadonlyArray<ChartDrawingInput> | DrawingDocument | string | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartDrawingInput","title":"ChartDrawingInput","description":""},{"path":"/docs/types/DrawingDocument","title":"DrawingDocument","description":""}]}]}]},{"path":"/docs/types/ChartEngineCode","title":"ChartEngineCode","summary":"The ChartEngineCode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartEngineCode =\n  | 'ok'\n  | 'auto-standard'\n  | 'license-pending'\n  | 'license-required'\n  | 'load-failed'\n  | 'module-missing'\n  | 'engine-unsupported'\n  | 'renderer-not-in-build'\n  | 'gpu-unavailable'\n  | 'no-pro-renderer'\n  | 'no-standard-renderer';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartEngineEffective","title":"ChartEngineEffective","summary":"The ChartEngineEffective type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartEngineEffective = 'standard' | 'pro' | 'unavailable';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartEngineRequest","title":"ChartEngineRequest","summary":"The ChartEngineRequest type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartEngineRequest = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartEngineStatus","title":"ChartEngineStatus","summary":"The ChartEngineStatus type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartEngineStatus {\n  readonly requested: ChartEngineRequest;\n  readonly effective: ChartEngineEffective;\n  readonly reason: string | null;\n  readonly code: ChartEngineCode;\n  readonly entitlement: { readonly feature: string; readonly state: ChartEntitlementState } | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartEngineRequest","title":"ChartEngineRequest","description":""},{"path":"/docs/types/ChartEngineEffective","title":"ChartEngineEffective","description":""},{"path":"/docs/types/ChartEngineCode","title":"ChartEngineCode","description":""},{"path":"/docs/types/ChartEntitlementState","title":"ChartEntitlementState","description":""}]}]}]},{"path":"/docs/types/ChartEngineTier","title":"ChartEngineTier","summary":"The ChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartEngineTier =\n  | Surface3DEngineTier\n  | LineChartEngineTier\n  | ScatterChartEngineTier\n  | PieChartEngineTier\n  | GaugeChartEngineTier\n  | RadarChartEngineTier\n  | FunnelChartEngineTier\n  | ChordEngineTier\n  | NetworkGraphEngineTier\n  | TreemapEngineTier\n  | SunburstEngineTier\n  | GanttEngineTier\n  | ParallelCoordinatesEngineTier\n  | IcicleEngineTier\n  | GeoMapEngineTier\n  | DendrogramEngineTier\n  | SankeyEngineTier\n  | ErrorBarEngineTier\n  | WaterfallEngineTier\n  | BubbleEngineTier\n  | BoxPlotEngineTier\n  | CandlestickEngineTier\n  | CalendarHeatmapEngineTier\n  | SpectrogramEngineTier\n  | DensityMapEngineTier\n  | HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DEngineTier","title":"Surface3DEngineTier","description":""},{"path":"/docs/types/LineChartEngineTier","title":"LineChartEngineTier","description":""},{"path":"/docs/types/ScatterChartEngineTier","title":"ScatterChartEngineTier","description":""},{"path":"/docs/types/PieChartEngineTier","title":"PieChartEngineTier","description":""},{"path":"/docs/types/GaugeChartEngineTier","title":"GaugeChartEngineTier","description":""},{"path":"/docs/types/RadarChartEngineTier","title":"RadarChartEngineTier","description":""},{"path":"/docs/types/FunnelChartEngineTier","title":"FunnelChartEngineTier","description":""},{"path":"/docs/types/ChordEngineTier","title":"ChordEngineTier","description":""},{"path":"/docs/types/NetworkGraphEngineTier","title":"NetworkGraphEngineTier","description":""},{"path":"/docs/types/TreemapEngineTier","title":"TreemapEngineTier","description":""},{"path":"/docs/types/SunburstEngineTier","title":"SunburstEngineTier","description":""},{"path":"/docs/types/GanttEngineTier","title":"GanttEngineTier","description":""},{"path":"/docs/types/ParallelCoordinatesEngineTier","title":"ParallelCoordinatesEngineTier","description":""},{"path":"/docs/types/IcicleEngineTier","title":"IcicleEngineTier","description":""},{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","description":""},{"path":"/docs/types/DendrogramEngineTier","title":"DendrogramEngineTier","description":""},{"path":"/docs/types/SankeyEngineTier","title":"SankeyEngineTier","description":""},{"path":"/docs/types/ErrorBarEngineTier","title":"ErrorBarEngineTier","description":""},{"path":"/docs/types/WaterfallEngineTier","title":"WaterfallEngineTier","description":""},{"path":"/docs/types/BubbleEngineTier","title":"BubbleEngineTier","description":""},{"path":"/docs/types/BoxPlotEngineTier","title":"BoxPlotEngineTier","description":""},{"path":"/docs/types/CandlestickEngineTier","title":"CandlestickEngineTier","description":""},{"path":"/docs/types/CalendarHeatmapEngineTier","title":"CalendarHeatmapEngineTier","description":""},{"path":"/docs/types/SpectrogramEngineTier","title":"SpectrogramEngineTier","description":""},{"path":"/docs/types/DensityMapEngineTier","title":"DensityMapEngineTier","description":""},{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/ChartEntitlementState","title":"ChartEntitlementState","summary":"The ChartEntitlementState type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartEntitlementState = EntitlementState | 'load-failed';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartLegendItemEventDetail","title":"ChartLegendItemEventDetail","summary":"The ChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartLegendItemEventDetail =\n  | AreaChartLegendItemEventDetail\n  | BarChartLegendItemEventDetail\n  | ColumnChartLegendItemEventDetail\n  | DotPlotChartLegendItemEventDetail\n  | DumbbellChartLegendItemEventDetail\n  | { index: number; sectionId: string; label: string; disabled: boolean }\n  | { index: number; needleId: string; label: string; disabled: boolean }\n  | { index: number; partyId: string; label: string; disabled: boolean }\n  | LineChartLegendItemEventDetail\n  | MarimekkoChartLegendItemEventDetail\n  | ParetoChartLegendItemEventDetail\n  | { index: number; sliceId: string; label: string; disabled: boolean }\n  | { index: number; seriesId: string; label: string; disabled: boolean }\n  | ScatterChartLegendItemEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/AreaChartLegendItemEventDetail","title":"AreaChartLegendItemEventDetail","description":""},{"path":"/docs/types/BarChartLegendItemEventDetail","title":"BarChartLegendItemEventDetail","description":""},{"path":"/docs/types/ColumnChartLegendItemEventDetail","title":"ColumnChartLegendItemEventDetail","description":""},{"path":"/docs/types/DotPlotChartLegendItemEventDetail","title":"DotPlotChartLegendItemEventDetail","description":""},{"path":"/docs/types/DumbbellChartLegendItemEventDetail","title":"DumbbellChartLegendItemEventDetail","description":""},{"path":"/docs/types/LineChartLegendItemEventDetail","title":"LineChartLegendItemEventDetail","description":""},{"path":"/docs/types/MarimekkoChartLegendItemEventDetail","title":"MarimekkoChartLegendItemEventDetail","description":""},{"path":"/docs/types/ParetoChartLegendItemEventDetail","title":"ParetoChartLegendItemEventDetail","description":""},{"path":"/docs/types/ScatterChartLegendItemEventDetail","title":"ScatterChartLegendItemEventDetail","description":""}]}]}]},{"path":"/docs/types/ChartLoadStatus","title":"ChartLoadStatus","summary":"The ChartLoadStatus type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartLoadStatus =\n  | 'idle'\n  | 'license-pending'\n  | 'loading'\n  | 'ready'\n  | 'license-required'\n  | 'module-missing'\n  | 'out-of-scope'\n  | 'load-failed'\n  | 'unknown-type'\n  | 'unsupported-environment';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartLocale","title":"ChartLocale","summary":"The ChartLocale type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartLocale {\n  readonly localeCode: string;\n  readonly loading: string;\n  readonly noData: string;\n  readonly errorTitle: string;\n  readonly errorDefault: string;\n  readonly retry: string;\n  readonly contextButtonTitle: string;\n  readonly downloadPNG: string;\n  readonly downloadSVG: string;\n  readonly downloadCSV: string;\n  readonly viewDataTable: string;\n  readonly printChart: string;\n  readonly dataTableCaption: string;\n  readonly close: string;\n  readonly typeNotLoadedTitle: string;\n  readonly typeNotLoadedText: string;\n  readonly typeLicenseRequiredTitle: string;\n  readonly typeLicenseRequiredText: string;\n  readonly typeModuleMissingTitle: string;\n  readonly typeModuleMissingText: string;\n  readonly typeLoadFailedTitle: string;\n  readonly typeLoadFailedText: string;\n  readonly typeLoadRetry: string;\n  readonly typeLoadReloadHint: string;\n  readonly typeLicenseUnavailableTitle: string;\n  readonly typeLicenseUnavailableText: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartLocaleName","title":"ChartLocaleName","summary":"The ChartLocaleName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartLocaleName = 'en' | 'ko' | 'ja' | 'zh';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartMenuActionId","title":"ChartMenuActionId","summary":"The ChartMenuActionId type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartMenuActionId =\n  | 'downloadPNG'\n  | 'downloadSVG'\n  | 'downloadCSV'\n  | 'viewDataTable'\n  | 'printChart';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartMenuItem","title":"ChartMenuItem","summary":"The ChartMenuItem type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartMenuItem {\n  readonly id: string;\n  readonly label?: string;\n  readonly type?: 'item' | 'separator';\n  readonly action?: ChartMenuActionId;\n  readonly disabled?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartMenuActionId","title":"ChartMenuActionId","description":""}]}]}]},{"path":"/docs/types/ChartPointContextMenuEventDetail","title":"ChartPointContextMenuEventDetail","summary":"The ChartPointContextMenuEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartPointContextMenuEventDetail<TPoint = unknown> {\n  readonly chartType: string;\n  readonly x: number;\n  readonly y: number;\n  readonly clientX: number;\n  readonly clientY: number;\n  readonly point: TPoint;\n  readonly series: ChartPointContextMenuSeriesDetail;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartPointContextMenuSeriesDetail","title":"ChartPointContextMenuSeriesDetail","description":""}]}]}]},{"path":"/docs/types/ChartPointContextMenuSeriesDetail","title":"ChartPointContextMenuSeriesDetail","summary":"The ChartPointContextMenuSeriesDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartPointContextMenuSeriesDetail {\n  readonly index: number;\n  readonly id?: string | number;\n  readonly name?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartPointEventDetail","title":"ChartPointEventDetail","summary":"The ChartPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartPointEventDetail =\n  | CartesianPointEventDetail\n  | Bar3DHitDetail\n  | BoxPlotPointEventDetail\n  | BubblePointEventDetail\n  | CalendarHeatmapPointEventDetail\n  | CandlestickPointEventDetail\n  | DensityMapPointEventDetail\n  | DotPlotChartPointerEventDetail\n  | DumbbellChartPointerEventDetail\n  | ErrorBarPointEventDetail\n  | FlowLinesHitDetail\n  | HeatmapPointEventDetail\n  | HistogramPointEventDetail\n  | ItemChartPointEventDetail\n  | LineChartPointEventDetail\n  | LollipopChartPointerEventDetail\n  | MarimekkoChartPointerEventDetail\n  | ParetoChartPointerEventDetail\n  | PictorialChartPointerEventDetail\n  | PolarChartPointEventDetail\n  | RadarChartPointerEventDetail\n  | Scatter3DHitDetail\n  | SpectrogramPointEventDetail\n  | StemLeafPointEventDetail\n  | Surface3DHitDetail\n  | ThemeRiverHitDetail\n  | TilemapPointEventDetail\n  | TornadoChartPointerEventDetail\n  | VariwideChartPointerEventDetail\n  | WaterfallPointEventDetail\n  | WordCloudPointEventDetail\n  | ChordHitDetail\n  | NetworkGraphHitDetail\n  | TreemapHitDetail\n  | SunburstHitDetail\n  | IcicleHitDetail\n  | GanttHitDetail\n  | ParallelCoordinatesHitDetail\n  | DendrogramHitDetail\n  | GeoMapHitDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":""},{"path":"/docs/types/Bar3DHitDetail","title":"Bar3DHitDetail","description":""},{"path":"/docs/types/BoxPlotPointEventDetail","title":"BoxPlotPointEventDetail","description":""},{"path":"/docs/types/BubblePointEventDetail","title":"BubblePointEventDetail","description":""},{"path":"/docs/types/CalendarHeatmapPointEventDetail","title":"CalendarHeatmapPointEventDetail","description":""},{"path":"/docs/types/CandlestickPointEventDetail","title":"CandlestickPointEventDetail","description":""},{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","description":""},{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","description":""},{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","description":""},{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","description":""},{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","description":""},{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","description":""},{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","description":""},{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","description":""},{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","description":""},{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","description":""},{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","description":""},{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","description":""},{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","description":""},{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","description":""},{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":""},{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","description":""},{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","description":""},{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":""},{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","description":""},{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":""},{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","description":""},{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","description":""},{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","description":""},{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","description":""},{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","description":""},{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","description":""},{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","description":""},{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","description":""},{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","description":""},{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","description":""},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","description":""},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","description":""},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","description":""},{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":""}]}]}]},{"path":"/docs/types/ChartRenderResult","title":"ChartRenderResult","summary":"The ChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartRenderResult =\n  | FlowLinesRenderResult\n  | ThemeRiverRenderResult\n  | Bar3DRenderResult\n  | Scatter3DRenderResult\n  | Surface3DRenderResult\n  | (LineChartRenderResult & { budget?: LineChartFrameBudgetInfo; stream?: LineChartStreamFrameInfo })\n  | ScatterChartRenderResult\n  | PieChartRenderResult\n  | ItemChartRenderResult\n  | WordCloudRenderResult\n  | TilemapRenderResult\n  | StemLeafRenderResult\n  | HistogramRenderResult\n  | WaferMapRenderResult\n  | PolarChartRenderResult\n  | GaugeChartRenderResult\n  | RadarChartRenderResult\n  | FunnelChartRenderResult\n  | ChordRenderResult\n  | NetworkGraphRenderResult\n  | TreemapRenderResult\n  | SunburstRenderResult\n  | GanttRenderResult\n  | ParallelCoordinatesRenderResult\n  | IcicleRenderResult\n  | GeoMapRenderResult\n  | DendrogramRenderResult\n  | SankeyRenderResult\n  | ErrorBarRenderResult\n  | WaterfallRenderResult\n  | BubbleRenderResult\n  | BoxPlotRenderResult\n  | CandlestickRenderResult\n  | CalendarHeatmapRenderResult\n  | SpectrogramRenderResult\n  | DensityMapRenderResult\n  | HeatmapRenderResult;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesRenderResult","title":"FlowLinesRenderResult","description":""},{"path":"/docs/types/ThemeRiverRenderResult","title":"ThemeRiverRenderResult","description":""},{"path":"/docs/types/Bar3DRenderResult","title":"Bar3DRenderResult","description":""},{"path":"/docs/types/Scatter3DRenderResult","title":"Scatter3DRenderResult","description":""},{"path":"/docs/types/Surface3DRenderResult","title":"Surface3DRenderResult","description":""},{"path":"/docs/types/LineChartRenderResult","title":"LineChartRenderResult","description":""},{"path":"/docs/types/LineChartFrameBudgetInfo","title":"LineChartFrameBudgetInfo","description":""},{"path":"/docs/types/LineChartStreamFrameInfo","title":"LineChartStreamFrameInfo","description":""},{"path":"/docs/types/ScatterChartRenderResult","title":"ScatterChartRenderResult","description":""},{"path":"/docs/types/PieChartRenderResult","title":"PieChartRenderResult","description":""},{"path":"/docs/types/ItemChartRenderResult","title":"ItemChartRenderResult","description":""},{"path":"/docs/types/WordCloudRenderResult","title":"WordCloudRenderResult","description":""},{"path":"/docs/types/TilemapRenderResult","title":"TilemapRenderResult","description":""},{"path":"/docs/types/StemLeafRenderResult","title":"StemLeafRenderResult","description":""},{"path":"/docs/types/HistogramRenderResult","title":"HistogramRenderResult","description":""},{"path":"/docs/types/WaferMapRenderResult","title":"WaferMapRenderResult","description":""},{"path":"/docs/types/PolarChartRenderResult","title":"PolarChartRenderResult","description":""},{"path":"/docs/types/GaugeChartRenderResult","title":"GaugeChartRenderResult","description":""},{"path":"/docs/types/RadarChartRenderResult","title":"RadarChartRenderResult","description":""},{"path":"/docs/types/FunnelChartRenderResult","title":"FunnelChartRenderResult","description":""},{"path":"/docs/types/ChordRenderResult","title":"ChordRenderResult","description":""},{"path":"/docs/types/NetworkGraphRenderResult","title":"NetworkGraphRenderResult","description":""},{"path":"/docs/types/TreemapRenderResult","title":"TreemapRenderResult","description":""},{"path":"/docs/types/SunburstRenderResult","title":"SunburstRenderResult","description":""},{"path":"/docs/types/GanttRenderResult","title":"GanttRenderResult","description":""},{"path":"/docs/types/ParallelCoordinatesRenderResult","title":"ParallelCoordinatesRenderResult","description":""},{"path":"/docs/types/IcicleRenderResult","title":"IcicleRenderResult","description":""},{"path":"/docs/types/GeoMapRenderResult","title":"GeoMapRenderResult","description":""},{"path":"/docs/types/DendrogramRenderResult","title":"DendrogramRenderResult","description":""},{"path":"/docs/types/SankeyRenderResult","title":"SankeyRenderResult","description":""},{"path":"/docs/types/ErrorBarRenderResult","title":"ErrorBarRenderResult","description":""},{"path":"/docs/types/WaterfallRenderResult","title":"WaterfallRenderResult","description":""},{"path":"/docs/types/BubbleRenderResult","title":"BubbleRenderResult","description":""},{"path":"/docs/types/BoxPlotRenderResult","title":"BoxPlotRenderResult","description":""},{"path":"/docs/types/CandlestickRenderResult","title":"CandlestickRenderResult","description":""},{"path":"/docs/types/CalendarHeatmapRenderResult","title":"CalendarHeatmapRenderResult","description":""},{"path":"/docs/types/SpectrogramRenderResult","title":"SpectrogramRenderResult","description":""},{"path":"/docs/types/DensityMapRenderResult","title":"DensityMapRenderResult","description":""},{"path":"/docs/types/HeatmapRenderResult","title":"HeatmapRenderResult","description":""}]}]}]},{"path":"/docs/types/ChartSeriesToggledEventDetail","title":"ChartSeriesToggledEventDetail","summary":"The ChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartSeriesToggledEventDetail =\n  | { index: number; seriesIndex: number; seriesId?: string | number; seriesName?: string; disabled: boolean }\n  | { index: number; seriesId: string; disabled: boolean };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartStreamSource","title":"ChartStreamSource","summary":"The ChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"type ChartStreamSource =\n  | Scatter3DStreamSource\n  | FlowLinesStreamSource\n  | ThemeRiverStreamSource\n  | Bar3DStreamSource\n  | Surface3DStreamSource\n  | GanttStreamSource | ParallelCoordinatesStreamSource\n  | LineChartStreamSource\n  | AreaChartStreamSource\n  | ColumnChartStreamSource\n  | BarChartStreamSource\n  | ScatterChartStreamSource\n  | PieChartStreamSource\n  | GaugeChartStreamSource\n  | RadarChartStreamSource\n  | FunnelChartStreamSource\n  | ChordStreamSource\n  | NetworkGraphStreamSource;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DStreamSource","title":"Scatter3DStreamSource","description":""},{"path":"/docs/types/FlowLinesStreamSource","title":"FlowLinesStreamSource","description":""},{"path":"/docs/types/ThemeRiverStreamSource","title":"ThemeRiverStreamSource","description":""},{"path":"/docs/types/Bar3DStreamSource","title":"Bar3DStreamSource","description":""},{"path":"/docs/types/Surface3DStreamSource","title":"Surface3DStreamSource","description":""},{"path":"/docs/types/GanttStreamSource","title":"GanttStreamSource","description":""},{"path":"/docs/types/ParallelCoordinatesStreamSource","title":"ParallelCoordinatesStreamSource","description":""},{"path":"/docs/types/LineChartStreamSource","title":"LineChartStreamSource","description":""},{"path":"/docs/types/AreaChartStreamSource","title":"AreaChartStreamSource","description":""},{"path":"/docs/types/ColumnChartStreamSource","title":"ColumnChartStreamSource","description":""},{"path":"/docs/types/BarChartStreamSource","title":"BarChartStreamSource","description":""},{"path":"/docs/types/ScatterChartStreamSource","title":"ScatterChartStreamSource","description":""},{"path":"/docs/types/PieChartStreamSource","title":"PieChartStreamSource","description":""},{"path":"/docs/types/GaugeChartStreamSource","title":"GaugeChartStreamSource","description":""},{"path":"/docs/types/RadarChartStreamSource","title":"RadarChartStreamSource","description":""},{"path":"/docs/types/FunnelChartStreamSource","title":"FunnelChartStreamSource","description":""},{"path":"/docs/types/ChordStreamSource","title":"ChordStreamSource","description":""},{"path":"/docs/types/NetworkGraphStreamSource","title":"NetworkGraphStreamSource","description":""}]}]}]},{"path":"/docs/types/ChartTheme","title":"ChartTheme","summary":"The ChartTheme type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartTheme {\n  readonly name: string;\n  readonly cssClass?: string;\n  readonly background: string;\n  readonly surface: string;\n  readonly text: string;\n  readonly textMuted: string;\n  readonly border: string;\n  readonly gridLine: string;\n  readonly axisLine: string;\n  readonly axisLabel: string;\n  readonly tooltipBackground: string;\n  readonly tooltipText: string;\n  readonly accent: string;\n  readonly hover: string;\n  readonly palette: ReadonlyArray<string>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartThemeName","title":"ChartThemeName","summary":"The ChartThemeName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartThemeName = 'light' | 'dark' | 'high-contrast';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartTooltipActionEventDetail","title":"ChartTooltipActionEventDetail","summary":"The ChartTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartTooltipActionEventDetail =\n  | CartesianTooltipActionEventDetail\n  | FunnelChartTooltipActionEventDetail\n  | GaugeChartTooltipActionEventDetail\n  | ItemChartTooltipActionEventDetail\n  | PieChartTooltipActionEventDetail\n  | PolarChartTooltipActionEventDetail\n  | RadarChartTooltipActionEventDetail\n  | StemLeafTooltipActionEventDetail\n  | TilemapTooltipActionEventDetail\n  | WordCloudTooltipActionEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianTooltipActionEventDetail","title":"CartesianTooltipActionEventDetail","description":""},{"path":"/docs/types/FunnelChartTooltipActionEventDetail","title":"FunnelChartTooltipActionEventDetail","description":""},{"path":"/docs/types/GaugeChartTooltipActionEventDetail","title":"GaugeChartTooltipActionEventDetail","description":""},{"path":"/docs/types/ItemChartTooltipActionEventDetail","title":"ItemChartTooltipActionEventDetail","description":""},{"path":"/docs/types/PieChartTooltipActionEventDetail","title":"PieChartTooltipActionEventDetail","description":""},{"path":"/docs/types/PolarChartTooltipActionEventDetail","title":"PolarChartTooltipActionEventDetail","description":""},{"path":"/docs/types/RadarChartTooltipActionEventDetail","title":"RadarChartTooltipActionEventDetail","description":""},{"path":"/docs/types/StemLeafTooltipActionEventDetail","title":"StemLeafTooltipActionEventDetail","description":""},{"path":"/docs/types/TilemapTooltipActionEventDetail","title":"TilemapTooltipActionEventDetail","description":""},{"path":"/docs/types/WordCloudTooltipActionEventDetail","title":"WordCloudTooltipActionEventDetail","description":""}]}]}]},{"path":"/docs/types/ChartType","title":"ChartType","summary":"The ChartType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartType = 'flow-lines' | 'theme-river' | 'bar-3d' | 'scatter-3d' | 'surface-3d' | 'line' | 'area' | 'column' | 'bar' | 'scatter' | 'pie' | 'item' | 'polar' | 'gauge' | 'radar' | 'funnel' | 'pyramid' | 'pareto' | 'lollipop' | 'dumbbell' | 'variwide' | 'tornado' | 'marimekko' | 'dot-plot' | 'word-cloud' | 'pictorial' | 'tilemap' | 'stem-leaf' | 'histogram' | 'wafer-map' | 'heatmap' | 'density-map' | 'spectrogram' | 'calendar-heatmap' | 'candlestick' | 'ohlc' | 'box-plot' | 'bubble' | 'waterfall' | 'error-bar' | 'sankey' | 'chord' | 'network-graph' | 'treemap' | 'sunburst' | 'icicle' | 'gantt' | 'parallel-coordinates' | 'dendrogram' | 'geo-map' | (string & {});","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChartTypeLoadDetail","title":"ChartTypeLoadDetail","summary":"The ChartTypeLoadDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChartTypeLoadDetail {\n  readonly type: string;\n  readonly tag?: string;\n  readonly status: ChartLoadStatus;\n  readonly entitlement?: ChartEntitlementState;\n  readonly reason?: string;\n  readonly attempt: number;\n  readonly repeatedFailure?: true;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartLoadStatus","title":"ChartLoadStatus","description":""},{"path":"/docs/types/ChartEntitlementState","title":"ChartEntitlementState","description":""}]}]}]},{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","summary":"The ChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChartUnavailableBehaviour = 'fallback' | 'error' | 'throw';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordAnimationType","title":"ChordAnimationType","summary":"The ChordAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/ChordArc","title":"ChordArc","summary":"The ChordArc type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordArc {\n  index: number;\n  cx: number;\n  cy: number;\n  r0: number;\n  r1: number;\n  scaleX?: number;\n  scaleY?: number;\n  startAngle: number;\n  endAngle: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordData","title":"ChordData","summary":"The ChordData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordData = ChordGraphInput | ReadonlyArray<ChordLinkInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordGraphInput","title":"ChordGraphInput","description":""},{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":""}]}]}]},{"path":"/docs/types/ChordDrawStats","title":"ChordDrawStats","summary":"The ChordDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordDrawStats {\n  nodes: number;\n  links: number;\n  drawn: number;\n  vertices: number;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  activeNode: number;\n  activeLink: number;\n  colored: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordEasing","title":"ChordEasing","summary":"The ChordEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/ChordEngineMode","title":"ChordEngineMode","summary":"The ChordEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/ChordEngineTier","title":"ChordEngineTier","summary":"The ChordEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/ChordExtent","title":"ChordExtent","summary":"The ChordExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordExtent {\n  nodes: number;\n  links: number;\n  total: number;\n  valueMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordGraphInput","title":"ChordGraphInput","summary":"The ChordGraphInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordGraphInput {\n  nodes?: ReadonlyArray<ChordNodeInput>;\n  links: ReadonlyArray<ChordLinkInput>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordNodeInput","title":"ChordNodeInput","description":""},{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":""}]}]}]},{"path":"/docs/types/ChordHitDetail","title":"ChordHitDetail","summary":"The ChordHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordHitDetail = ChordNodeEventDetail | ChordLinkEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":""},{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","description":""}]}]}]},{"path":"/docs/types/ChordLabelMode","title":"ChordLabelMode","summary":"The ChordLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordLayoutResult","title":"ChordLayoutResult","summary":"The ChordLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordLayoutResult {\n  nodes: ChordArc[];\n  links: ChordRibbon[];\n  width: number;\n  height: number;\n  cx: number;\n  cy: number;\n  radius: number;\n  nodeWidth: number;\n  padAngle: number;\n  total: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordArc","title":"ChordArc","description":""},{"path":"/docs/types/ChordRibbon","title":"ChordRibbon","description":""}]}]}]},{"path":"/docs/types/ChordLink","title":"ChordLink","summary":"The ChordLink type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordLink {\n  index: number;\n  source: number;\n  target: number;\n  sourceId: string;\n  targetId: string;\n  value: number;\n  color: string | null;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","summary":"The ChordLinkEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordLinkEventDetail {\n  kind: 'link';\n  index: number;\n  source: string;\n  target: string;\n  sourceIndex: number;\n  targetIndex: number;\n  value: number;\n  selected: boolean;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","summary":"The ChordLinkInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordLinkInput = ChordLinkObject | ChordLinkTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordLinkObject","title":"ChordLinkObject","description":""},{"path":"/docs/types/ChordLinkTuple","title":"ChordLinkTuple","description":""}]}]}]},{"path":"/docs/types/ChordLinkObject","title":"ChordLinkObject","summary":"The ChordLinkObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordLinkObject {\n  source: string;\n  target: string;\n  value: number;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordLinkTuple","title":"ChordLinkTuple","summary":"The ChordLinkTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordLinkTuple = readonly [source: string, target: string, value: number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordNode","title":"ChordNode","summary":"The ChordNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordNode {\n  index: number;\n  id: string;\n  label: string;\n  value: number;\n  inValue: number;\n  outValue: number;\n  color: string | null;\n  sourceLinks: number[];\n  targetLinks: number[];\n  declared: boolean;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","summary":"The ChordNodeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordNodeEventDetail {\n  kind: 'node';\n  index: number;\n  id: string;\n  label: string;\n  value: number;\n  inValue: number;\n  outValue: number;\n  links: number;\n  sourceIds: string[];\n  targetIds: string[];\n  selected: boolean;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordNodeInput","title":"ChordNodeInput","summary":"The ChordNodeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordNodeInput = ChordNodeObject | string;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordNodeObject","title":"ChordNodeObject","description":""}]}]}]},{"path":"/docs/types/ChordNodeLabel","title":"ChordNodeLabel","summary":"The ChordNodeLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordNodeLabel {\n  index: number;\n  text: string;\n  x: number;\n  y: number;\n  side: 'left' | 'right';\n  maxWidth?: number;\n  shown: boolean;\n  hiddenBy?: 'overlap' | 'mode' | 'viewport';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordNodeObject","title":"ChordNodeObject","summary":"The ChordNodeObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordNodeObject {\n  id: string;\n  label?: string;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordRenderResult","title":"ChordRenderResult","summary":"The ChordRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  chord?: ChordDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordDrawStats","title":"ChordDrawStats","description":""}]}]}]},{"path":"/docs/types/ChordRibbon","title":"ChordRibbon","summary":"The ChordRibbon type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordRibbon {\n  index: number;\n  cx: number;\n  cy: number;\n  radius: number;\n  scaleX?: number;\n  scaleY?: number;\n  sourceStart: number;\n  sourceEnd: number;\n  targetStart: number;\n  targetEnd: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordSelection","title":"ChordSelection","summary":"The ChordSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordSelection {\n  node: ChordNodeEventDetail | null;\n  link: ChordLinkEventDetail | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordNodeEventDetail","title":"ChordNodeEventDetail","description":""},{"path":"/docs/types/ChordLinkEventDetail","title":"ChordLinkEventDetail","description":""}]}]}]},{"path":"/docs/types/ChordSelectionChangeEventDetail","title":"ChordSelectionChangeEventDetail","summary":"The ChordSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordSelectionChangeEventDetail extends ChordSelection {\n  by: ChordSelectionSource;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordSelection","title":"ChordSelection","description":""},{"path":"/docs/types/ChordSelectionSource","title":"ChordSelectionSource","description":""}]}]}]},{"path":"/docs/types/ChordSelectionSource","title":"ChordSelectionSource","summary":"The ChordSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordSelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ChordStreamEvent","title":"ChordStreamEvent","summary":"The ChordStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: ChordLinkInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":""}]}]}]},{"path":"/docs/types/ChordStreamSource","title":"ChordStreamSource","summary":"The ChordStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ChordStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(link: ChordLinkInput): void;\n  pushBatch(links: ReadonlyArray<ChordLinkInput>): void;\n  shift(count: number): void;\n  replace(links: ReadonlyArray<ChordLinkInput>): void;\n  snapshot(): ChordLinkInput[];\n  subscribe(listener: (event: ChordStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChordLinkInput","title":"ChordLinkInput","description":""},{"path":"/docs/types/ChordStreamEvent","title":"ChordStreamEvent","description":""}]}]}]},{"path":"/docs/types/ChordUnavailableBehaviour","title":"ChordUnavailableBehaviour","summary":"The ChordUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ChordUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/ColorSpace","title":"ColorSpace","summary":"The ColorSpace type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColorSpace = 'rgb' | 'hsl' | 'lab' | 'lch';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnBorderScope","title":"ColumnBorderScope","summary":"The ColumnBorderScope type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnBorderScope = 'point' | 'stack' | 'outline';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartAnimationType","title":"ColumnChartAnimationType","summary":"The ColumnChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartDatum","title":"ColumnChartDatum","summary":"The ColumnChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartEasing","title":"ColumnChartEasing","summary":"The ColumnChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartEngineMode","title":"ColumnChartEngineMode","summary":"The ColumnChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartEngineMode = 'auto' | ColumnChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ColumnChartEngineTier","title":"ColumnChartEngineTier","description":""}]}]}]},{"path":"/docs/types/ColumnChartEngineTier","title":"ColumnChartEngineTier","summary":"The ColumnChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartLegendItemEventDetail","title":"ColumnChartLegendItemEventDetail","summary":"The ColumnChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ColumnChartLegendItemEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartLegendPosition","title":"ColumnChartLegendPosition","summary":"The ColumnChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartRenderResult","title":"ColumnChartRenderResult","summary":"The ColumnChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ColumnChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartSeries","title":"ColumnChartSeries","summary":"The ColumnChartSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ColumnChartSeries extends Omit<CartesianSeriesBase<ColumnChartValues>, 'values'> {\n  values?: ColumnChartValues;\n  thickness?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","description":""},{"path":"/docs/types/ColumnChartValues","title":"ColumnChartValues","description":""}]}]}]},{"path":"/docs/types/ColumnChartSeriesActiveTrigger","title":"ColumnChartSeriesActiveTrigger","summary":"The ColumnChartSeriesActiveTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartSeriesActiveTrigger = 'hover' | 'click' | 'custom';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartSeriesStateOptions","title":"ColumnChartSeriesStateOptions","summary":"The ColumnChartSeriesStateOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ColumnChartSeriesStateOptions {\n  enabled?: boolean;\n  inactive?: ColumnChartSeriesStateStyle;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ColumnChartSeriesStateStyle","title":"ColumnChartSeriesStateStyle","description":""}]}]}]},{"path":"/docs/types/ColumnChartSeriesStateStyle","title":"ColumnChartSeriesStateStyle","summary":"The ColumnChartSeriesStateStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ColumnChartSeriesStateStyle {\n  opacity?: number;\n  thickness?: number;\n  thicknessScale?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartSeriesToggledEventDetail","title":"ColumnChartSeriesToggledEventDetail","summary":"The ColumnChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ColumnChartSeriesToggledEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartStreamEvent","title":"ColumnChartStreamEvent","summary":"The ColumnChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartStreamSource","title":"ColumnChartStreamSource","summary":"The ColumnChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ColumnChartStreamSource {\n  push(value: number): void;\n  pushBatch(values: ReadonlyArray<number> | Float32Array): void;\n  shift(count: number): void;\n  replace(values: ReadonlyArray<number> | Float32Array): void;\n  snapshot(window?: number): Float32Array;\n  subscribe(listener: (event: ColumnChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ColumnChartStreamEvent","title":"ColumnChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/ColumnChartUnavailableBehaviour","title":"ColumnChartUnavailableBehaviour","summary":"The ColumnChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartUnavailableBehaviour = 'fallback' | 'error';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ColumnChartValues","title":"ColumnChartValues","summary":"The ColumnChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ColumnChartValues = Float32Array | ColumnChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ColumnChartDatum","title":"ColumnChartDatum","description":""}]}]}]},{"path":"/docs/types/CompareSymbolInput","title":"CompareSymbolInput","summary":"The CompareSymbolInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CompareSymbolInput {\n  readonly id: string;\n  readonly name?: string;\n  readonly color?: string;\n  readonly data: StockDataInput;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ContinuousVisualMapSnapshot","title":"ContinuousVisualMapSnapshot","summary":"The ContinuousVisualMapSnapshot type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ContinuousVisualMapSnapshot extends ContinuousVisualMapSpec {\n  range: VisualMapRange | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ContinuousVisualMapSpec","title":"ContinuousVisualMapSpec","description":""},{"path":"/docs/types/VisualMapRange","title":"VisualMapRange","description":""}]}]}]},{"path":"/docs/types/ContinuousVisualMapSpec","title":"ContinuousVisualMapSpec","summary":"The ContinuousVisualMapSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ContinuousVisualMapSpec {\n  type: 'continuous';\n  min: number;\n  max: number;\n  stops: ReadonlyArray<VisualMapStop>;\n  space: ColorSpace;\n  outOfRangeColor: string;\n  calculable: boolean;\n  precision: number | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapStop","title":"VisualMapStop","description":""},{"path":"/docs/types/ColorSpace","title":"ColorSpace","description":""}]}]}]},{"path":"/docs/types/CsvOptions","title":"CsvOptions","summary":"The CsvOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface CsvOptions {\n  readonly itemDelimiter?: string;\n  readonly lineDelimiter?: string;\n  readonly decimalPoint?: string;\n  readonly withBom?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DataZoomOrientation","title":"DataZoomOrientation","summary":"The DataZoomOrientation type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DataZoomOrientation = 'horizontal' | 'vertical';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DataZoomRangeChangeEventDetail","title":"DataZoomRangeChangeEventDetail","summary":"The DataZoomRangeChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DataZoomRangeChangeEventDetail {\n  window: CartesianZoomWindow | null;\n  source: DataZoomRangeChangeSource;\n  live: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomWindow","title":"CartesianZoomWindow","description":""},{"path":"/docs/types/DataZoomRangeChangeSource","title":"DataZoomRangeChangeSource","description":""}]}]}]},{"path":"/docs/types/DataZoomRangeChangeSource","title":"DataZoomRangeChangeSource","summary":"The DataZoomRangeChangeSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DataZoomRangeChangeSource = 'slider' | 'chart' | 'api';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DataZoomTargetElement","title":"DataZoomTargetElement","summary":"The DataZoomTargetElement type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DataZoomTargetElement extends HTMLElement {\n  zoomTo?: (request: CartesianZoomRequest) => Promise<CartesianZoomChangeEventDetail | null>;\n  getZoom?: () => Promise<CartesianZoomState | null>;\n  getZoomExtent?: (request?: CartesianZoomExtentRequest) => Promise<CartesianZoomExtentDetail | null>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianZoomRequest","title":"CartesianZoomRequest","description":""},{"path":"/docs/types/CartesianZoomChangeEventDetail","title":"CartesianZoomChangeEventDetail","description":""},{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":""},{"path":"/docs/types/CartesianZoomExtentRequest","title":"CartesianZoomExtentRequest","description":""},{"path":"/docs/types/CartesianZoomExtentDetail","title":"CartesianZoomExtentDetail","description":""}]}]}]},{"path":"/docs/types/Dataset","title":"Dataset","summary":"The Dataset type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Dataset {\n  readonly id: string | undefined;\n  readonly dimensions: ReadonlyArray<DatasetDimension>;\n  readonly rows: ReadonlyArray<DatasetRowArray>;\n  readonly rowCount: number;\n  dimension(ref: string | number): DatasetDimension | undefined;\n  column(ref: string | number): DatasetPrimitive[];\n  numbers(ref: string | number): Array<number | null>;\n  categories(ref: string | number): string[];\n  row(index: number): Record<string, DatasetPrimitive>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetDimension","title":"DatasetDimension","description":""},{"path":"/docs/types/DatasetRowArray","title":"DatasetRowArray","description":""},{"path":"/docs/types/DatasetPrimitive","title":"DatasetPrimitive","description":""}]}]}]},{"path":"/docs/types/DatasetColumns","title":"DatasetColumns","summary":"The DatasetColumns type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetColumns = Readonly<Record<string, ReadonlyArray<DatasetPrimitive>>>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetPrimitive","title":"DatasetPrimitive","description":""}]}]}]},{"path":"/docs/types/DatasetCondition","title":"DatasetCondition","summary":"The DatasetCondition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetCondition =\n  | DatasetFieldCondition\n  | { and: ReadonlyArray<DatasetCondition> }\n  | { or: ReadonlyArray<DatasetCondition> }\n  | { not: DatasetCondition };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetFieldCondition","title":"DatasetFieldCondition","description":""}]}]}]},{"path":"/docs/types/DatasetDimension","title":"DatasetDimension","summary":"The DatasetDimension type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DatasetDimension {\n  index: number;\n  name: string;\n  displayName: string;\n  type: DatasetDimensionType;\n  declared: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetDimensionType","title":"DatasetDimensionType","description":""}]}]}]},{"path":"/docs/types/DatasetDimensionInput","title":"DatasetDimensionInput","summary":"The DatasetDimensionInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DatasetDimensionInput {\n  name: string;\n  type?: DatasetDimensionType;\n  displayName?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetDimensionType","title":"DatasetDimensionType","description":""}]}]}]},{"path":"/docs/types/DatasetDimensionType","title":"DatasetDimensionType","summary":"The DatasetDimensionType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetDimensionType = 'number' | 'ordinal' | 'time';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DatasetEncode","title":"DatasetEncode","summary":"The DatasetEncode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DatasetEncode {\n  x?: string | number;\n  y?: string | number;\n  z?: string | number;\n  itemName?: string | number;\n  tooltip?: ReadonlyArray<string | number>;\n  seriesName?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DatasetFieldCondition","title":"DatasetFieldCondition","summary":"The DatasetFieldCondition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DatasetFieldCondition {\n  dimension: string | number;\n  eq?: DatasetPrimitive;\n  ne?: DatasetPrimitive;\n  gt?: number | string | Date;\n  gte?: number | string | Date;\n  lt?: number | string | Date;\n  lte?: number | string | Date;\n  in?: ReadonlyArray<DatasetPrimitive>;\n  notIn?: ReadonlyArray<DatasetPrimitive>;\n  contains?: string;\n  startsWith?: string;\n  regexp?: RegExp | string;\n  empty?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetPrimitive","title":"DatasetPrimitive","description":""}]}]}]},{"path":"/docs/types/DatasetPrimitive","title":"DatasetPrimitive","summary":"The DatasetPrimitive type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetPrimitive = number | bigint | string | boolean | null | undefined | Date;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DatasetRow","title":"DatasetRow","summary":"The DatasetRow type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetRow = DatasetRowArray | DatasetRowObject;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetRowArray","title":"DatasetRowArray","description":""},{"path":"/docs/types/DatasetRowObject","title":"DatasetRowObject","description":""}]}]}]},{"path":"/docs/types/DatasetRowArray","title":"DatasetRowArray","summary":"The DatasetRowArray type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetRowArray = ReadonlyArray<DatasetPrimitive>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetPrimitive","title":"DatasetPrimitive","description":""}]}]}]},{"path":"/docs/types/DatasetRowObject","title":"DatasetRowObject","summary":"The DatasetRowObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetRowObject = Readonly<Record<string, DatasetPrimitive>>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetPrimitive","title":"DatasetPrimitive","description":""}]}]}]},{"path":"/docs/types/DatasetSortKey","title":"DatasetSortKey","summary":"The DatasetSortKey type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DatasetSortKey {\n  dimension: string | number;\n  order?: 'asc' | 'desc';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DatasetSourceInput","title":"DatasetSourceInput","summary":"The DatasetSourceInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DatasetSourceInput {\n  source: ReadonlyArray<DatasetRow> | DatasetColumns;\n  dimensions?: ReadonlyArray<string | DatasetDimensionInput>;\n  sourceHeader?: boolean | 'auto';\n  id?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetRow","title":"DatasetRow","description":""},{"path":"/docs/types/DatasetColumns","title":"DatasetColumns","description":""},{"path":"/docs/types/DatasetDimensionInput","title":"DatasetDimensionInput","description":""}]}]}]},{"path":"/docs/types/DatasetTransform","title":"DatasetTransform","summary":"The DatasetTransform type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DatasetTransform =\n  | { type: 'filter'; config: DatasetCondition }\n  | { type: 'sort'; config: DatasetSortKey | ReadonlyArray<DatasetSortKey> }\n  | { type: 'regression'; config?: RegressionOptions }\n  | { type: 'boxplot'; config?: BoxplotOptions }\n  | { type: 'sample'; config?: SampleOptions };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DatasetCondition","title":"DatasetCondition","description":""},{"path":"/docs/types/DatasetSortKey","title":"DatasetSortKey","description":""},{"path":"/docs/types/RegressionOptions","title":"RegressionOptions","description":""},{"path":"/docs/types/BoxplotOptions","title":"BoxplotOptions","description":""},{"path":"/docs/types/SampleOptions","title":"SampleOptions","description":""}]}]}]},{"path":"/docs/types/DendrogramAnimationType","title":"DendrogramAnimationType","summary":"The DendrogramAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/DendrogramData","title":"DendrogramData","summary":"The DendrogramData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramData = DendrogramNodeInput | ReadonlyArray<DendrogramNodeInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":""}]}]}]},{"path":"/docs/types/DendrogramDirection","title":"DendrogramDirection","summary":"The DendrogramDirection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramDirection = 'top-down' | 'bottom-up' | 'left-right' | 'right-left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramDrillChangeEventDetail","title":"DendrogramDrillChangeEventDetail","summary":"The DendrogramDrillChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramDrillChangeEventDetail { rootId: string | null; previousRootId: string | null; by: DendrogramSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramSelectionSource","title":"DendrogramSelectionSource","description":""}]}]}]},{"path":"/docs/types/DendrogramEasing","title":"DendrogramEasing","summary":"The DendrogramEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/DendrogramEngineMode","title":"DendrogramEngineMode","summary":"The DendrogramEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/DendrogramEngineTier","title":"DendrogramEngineTier","summary":"The DendrogramEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/DendrogramExtent","title":"DendrogramExtent","summary":"The DendrogramExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramExtent { nodes: number; leaves: number; total: number; depth: number; valueMax: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramHitDetail","title":"DendrogramHitDetail","summary":"The DendrogramHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramHitDetail {\n  kind: 'node' | 'link';\n  linkIndex?: number;\n  link?: DendrogramLink;\n  nodeIndex: number;\n  node: DendrogramNode;\n  cssX: number;\n  cssY: number;\n  value: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramLink","title":"DendrogramLink","description":""},{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":""}]}]}]},{"path":"/docs/types/DendrogramLabel","title":"DendrogramLabel","summary":"The DendrogramLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramLabel { index: number; id: string; text: string; x: number; y: number; width: number; height: number; shown: boolean; opacity: number; color: string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramLabelMode","title":"DendrogramLabelMode","summary":"The DendrogramLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramLayout","title":"DendrogramLayout","summary":"The DendrogramLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramLayout = 'cluster';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramLayoutResult","title":"DendrogramLayoutResult","summary":"The DendrogramLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramLayoutResult {\n  nodes: DendrogramRect[];\n  links: DendrogramLinkPath[];\n  width: number;\n  height: number;\n  total: number;\n  rootId: string | null;\n  layout: DendrogramLayout;\n  direction: DendrogramDirection;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramRect","title":"DendrogramRect","description":""},{"path":"/docs/types/DendrogramLinkPath","title":"DendrogramLinkPath","description":""},{"path":"/docs/types/DendrogramLayout","title":"DendrogramLayout","description":""},{"path":"/docs/types/DendrogramDirection","title":"DendrogramDirection","description":""}]}]}]},{"path":"/docs/types/DendrogramLink","title":"DendrogramLink","summary":"The DendrogramLink type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramLink { index: number; key: string; source: number; target: number; sourceId: string; targetId: string; value: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramLinkPath","title":"DendrogramLinkPath","summary":"The DendrogramLinkPath type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramLinkPath extends DendrogramLink { points: [DendrogramPoint, DendrogramPoint, DendrogramPoint]; opacity: number; passive?: boolean }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramLink","title":"DendrogramLink","description":""},{"path":"/docs/types/DendrogramPoint","title":"DendrogramPoint","description":""}]}]}]},{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","summary":"The DendrogramNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramNode {\n  index: number;\n  id: string;\n  label: string;\n  color: string | null;\n  parent: number | null;\n  children: number[];\n  depth: number;\n  ownValue: number;\n  value: number;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","summary":"The DendrogramNodeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramNodeInput {\n  id: string;\n  label?: string;\n  color?: string;\n  parent?: string | null;\n  value?: number;\n  children?: ReadonlyArray<DendrogramNodeInput>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramPoint","title":"DendrogramPoint","summary":"The DendrogramPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramPoint = {x:number;y:number};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramRect","title":"DendrogramRect","summary":"The DendrogramRect type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramRect {\n  index: number;\n  id: string;\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n  depth: number;\n  opacity: number;\n  passive?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramRenderResult","title":"DendrogramRenderResult","summary":"The DendrogramRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  dendrogram?: { nodes: number; links: number; drawn: number; vertices: number; bytes: number; uploaded: number; full: boolean; version: number; activeNode: number; chunks: number; chunkVertices: number; capacity: number; cut: number };\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramSelection","title":"DendrogramSelection","summary":"The DendrogramSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramSelection { nodeIndex: number; node: DendrogramNode | null; linkIndex: number; link: DendrogramLink | null }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramNode","title":"DendrogramNode","description":""},{"path":"/docs/types/DendrogramLink","title":"DendrogramLink","description":""}]}]}]},{"path":"/docs/types/DendrogramSelectionChangeEventDetail","title":"DendrogramSelectionChangeEventDetail","summary":"The DendrogramSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramSelectionChangeEventDetail extends DendrogramSelection { by: DendrogramSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramSelection","title":"DendrogramSelection","description":""},{"path":"/docs/types/DendrogramSelectionSource","title":"DendrogramSelectionSource","description":""}]}]}]},{"path":"/docs/types/DendrogramSelectionSource","title":"DendrogramSelectionSource","summary":"The DendrogramSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramSelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DendrogramStreamEvent","title":"DendrogramStreamEvent","summary":"The DendrogramStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: DendrogramNodeInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":""}]}]}]},{"path":"/docs/types/DendrogramStreamSource","title":"DendrogramStreamSource","summary":"The DendrogramStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DendrogramStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(node: DendrogramNodeInput): void;\n  pushBatch(nodes: ReadonlyArray<DendrogramNodeInput>): void;\n  shift(count: number): void;\n  replace(nodes: ReadonlyArray<DendrogramNodeInput>): void;\n  snapshot(): DendrogramNodeInput[];\n  subscribe(listener: (event: DendrogramStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DendrogramNodeInput","title":"DendrogramNodeInput","description":""},{"path":"/docs/types/DendrogramStreamEvent","title":"DendrogramStreamEvent","description":""}]}]}]},{"path":"/docs/types/DendrogramUnavailableBehaviour","title":"DendrogramUnavailableBehaviour","summary":"The DendrogramUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DendrogramUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/DensityMapAnimationType","title":"DensityMapAnimationType","summary":"The DensityMapAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/DensityMapBandwidth","title":"DensityMapBandwidth","summary":"The DensityMapBandwidth type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapBandwidth {\n  x: number;\n  y: number;\n  px: { x: number; y: number };\n  cells: { x: number; y: number };\n  auto: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapBandwidthInput","title":"DensityMapBandwidthInput","summary":"The DensityMapBandwidthInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapBandwidthInput = number | 'auto' | { x: number; y: number } | string;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapBandwidthUnit","title":"DensityMapBandwidthUnit","summary":"The DensityMapBandwidthUnit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapBandwidthUnit = 'data' | 'px';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapColumns","title":"DensityMapColumns","summary":"The DensityMapColumns type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapColumns {\n  x: ArrayLike<number>;\n  y: ArrayLike<number>;\n  weight?: ArrayLike<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapComputePath","title":"DensityMapComputePath","summary":"The DensityMapComputePath type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapComputePath = 'cpu' | 'gpu';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapComputePathInput","title":"DensityMapComputePathInput","summary":"The DensityMapComputePathInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapComputePathInput = 'auto' | 'cpu' | 'gpu';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapComputeStats","title":"DensityMapComputeStats","summary":"The DensityMapComputeStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapComputeStats {\n  path: DensityMapComputePath;\n  points: number;\n  dropped: number;\n  columns: number;\n  rows: number;\n  cells: number;\n  kernel: DensityMapKernel;\n  bandwidth: DensityMapBandwidth;\n  radius: { x: number; y: number };\n  computeMs: number;\n  densityMax: number;\n  mass: number;\n  version: number;\n  incremental?: boolean;\n  fixedScale?: number;\n  submitMs?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DensityMapComputePath","title":"DensityMapComputePath","description":""},{"path":"/docs/types/DensityMapKernel","title":"DensityMapKernel","description":""},{"path":"/docs/types/DensityMapBandwidth","title":"DensityMapBandwidth","description":""}]}]}]},{"path":"/docs/types/DensityMapData","title":"DensityMapData","summary":"The DensityMapData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapData = ReadonlyArray<DensityMapPoint | DensityMapTuple>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","description":""},{"path":"/docs/types/DensityMapTuple","title":"DensityMapTuple","description":""}]}]}]},{"path":"/docs/types/DensityMapDomain","title":"DensityMapDomain","summary":"The DensityMapDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapDomain {\n  xMin: number;\n  xMax: number;\n  yMin: number;\n  yMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapEasing","title":"DensityMapEasing","summary":"The DensityMapEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/DensityMapEngineMode","title":"DensityMapEngineMode","summary":"The DensityMapEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/DensityMapEngineTier","title":"DensityMapEngineTier","summary":"The DensityMapEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/DensityMapInput","title":"DensityMapInput","summary":"The DensityMapInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapInput = DensityMapData | DensityMapColumns;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DensityMapData","title":"DensityMapData","description":""},{"path":"/docs/types/DensityMapColumns","title":"DensityMapColumns","description":""}]}]}]},{"path":"/docs/types/DensityMapKernel","title":"DensityMapKernel","summary":"The DensityMapKernel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapKernel = 'gaussian' | 'epanechnikov' | 'quartic' | 'triangular' | 'uniform';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapLodMode","title":"DensityMapLodMode","summary":"The DensityMapLodMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapLodMode = HeatmapLodMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapLodMode","title":"HeatmapLodMode","description":""}]}]}]},{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","summary":"The DensityMapPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapPoint {\n  x: number;\n  y: number;\n  weight?: number | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapPointEventDetail","title":"DensityMapPointEventDetail","summary":"The DensityMapPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapPointEventDetail {\n  col: number;\n  row: number;\n  index: number;\n  x: number;\n  y: number;\n  density: number | null;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapRenderResult","title":"DensityMapRenderResult","summary":"The DensityMapRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapRenderResult {\n  points: number;\n  cells: number;\n  drawn: number;\n  renderMs: number;\n  compute?: DensityMapComputeStats;\n  plane?: HeatmapPlaneStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DensityMapComputeStats","title":"DensityMapComputeStats","description":""},{"path":"/docs/types/HeatmapPlaneStats","title":"HeatmapPlaneStats","description":""}]}]}]},{"path":"/docs/types/DensityMapStreamEvent","title":"DensityMapStreamEvent","summary":"The DensityMapStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  points: ReadonlyArray<DensityMapPoint>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","description":""}]}]}]},{"path":"/docs/types/DensityMapStreamSource","title":"DensityMapStreamSource","summary":"The DensityMapStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapStreamSource {\n  push(point: DensityMapPoint | DensityMapTuple): void;\n  pushBatch(points: ReadonlyArray<DensityMapPoint | DensityMapTuple>): void;\n  shift(count: number): void;\n  replace(points: ReadonlyArray<DensityMapPoint | DensityMapTuple>): void;\n  snapshot(): DensityMapPoint[];\n  latest(): DensityMapPoint | undefined;\n  subscribe(listener: (event: DensityMapStreamEvent) => void): () => void;\n  readonly length: number;\n  readonly capacity: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DensityMapPoint","title":"DensityMapPoint","description":""},{"path":"/docs/types/DensityMapTuple","title":"DensityMapTuple","description":""},{"path":"/docs/types/DensityMapStreamEvent","title":"DensityMapStreamEvent","description":""}]}]}]},{"path":"/docs/types/DensityMapTuple","title":"DensityMapTuple","summary":"The DensityMapTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapTuple = readonly [number, number] | readonly [number, number, number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapUnavailableBehaviour","title":"DensityMapUnavailableBehaviour","summary":"The DensityMapUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/DensityMapUnitInput","title":"DensityMapUnitInput","summary":"The DensityMapUnitInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DensityMapUnitInput = 'mass' | 'per-area';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DensityMapValueExtent","title":"DensityMapValueExtent","summary":"The DensityMapValueExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DensityMapValueExtent {\n  min: number;\n  max: number;\n  finite: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DerivedStockStyle","title":"DerivedStockStyle","summary":"The DerivedStockStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DerivedStockStyle = 'heikin-ashi' | 'renko' | 'kagi' | 'point-figure' | 'line-break';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DieIndexEntry","title":"DieIndexEntry","summary":"The DieIndexEntry type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DieIndexEntry {\n  readonly col: number;\n  readonly row: number;\n  readonly ix: number;\n  readonly iy: number;\n  readonly ordinal: number;\n  readonly status: DieStatus;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DieStatus","title":"DieStatus","description":""}]}]}]},{"path":"/docs/types/DieIndexOrigin","title":"DieIndexOrigin","summary":"The DieIndexOrigin type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DieIndexOrigin = 'top-left' | 'center';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DieStatus","title":"DieStatus","summary":"The DieStatus type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DieStatus = 'full' | 'partial';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotCategoryDatum","title":"DotPlotCategoryDatum","summary":"The DotPlotCategoryDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DotPlotCategoryDatum {\n  category?: string;\n  values: ReadonlyArray<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartAnimationType","title":"DotPlotChartAnimationType","summary":"The DotPlotChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartEasing","title":"DotPlotChartEasing","summary":"The DotPlotChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartEngineMode","title":"DotPlotChartEngineMode","summary":"The DotPlotChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotChartEngineMode = 'auto' | DotPlotChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DotPlotChartEngineTier","title":"DotPlotChartEngineTier","description":""}]}]}]},{"path":"/docs/types/DotPlotChartEngineTier","title":"DotPlotChartEngineTier","summary":"The DotPlotChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartLegendItemEventDetail","title":"DotPlotChartLegendItemEventDetail","summary":"The DotPlotChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DotPlotChartLegendItemEventDetail {\n  index: number;\n  seriesId: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartLegendPosition","title":"DotPlotChartLegendPosition","summary":"The DotPlotChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartPointerEventDetail","title":"DotPlotChartPointerEventDetail","summary":"The DotPlotChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DotPlotChartPointerEventDetail {\n  categoryIndex: number;\n  seriesIndex: number;\n  category: string;\n  seriesName: string;\n  value: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartRenderResult","title":"DotPlotChartRenderResult","summary":"The DotPlotChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DotPlotChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartSeriesToggledEventDetail","title":"DotPlotChartSeriesToggledEventDetail","summary":"The DotPlotChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DotPlotChartSeriesToggledEventDetail {\n  index: number;\n  seriesId: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartStreamEvent","title":"DotPlotChartStreamEvent","summary":"The DotPlotChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DotPlotChartStreamSource","title":"DotPlotChartStreamSource","summary":"The DotPlotChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DotPlotChartStreamSource {\n  push(datum: DotPlotCategoryDatum): void;\n  pushBatch(data: ReadonlyArray<DotPlotCategoryDatum>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<DotPlotCategoryDatum>): void;\n  snapshot(window?: number): DotPlotCategoryDatum[];\n  latest(): DotPlotCategoryDatum | undefined;\n  subscribe(listener: (event: DotPlotChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DotPlotCategoryDatum","title":"DotPlotCategoryDatum","description":""},{"path":"/docs/types/DotPlotChartStreamEvent","title":"DotPlotChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/DotPlotChartUnavailableBehaviour","title":"DotPlotChartUnavailableBehaviour","summary":"The DotPlotChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/DotPlotDatum","title":"DotPlotDatum","summary":"The DotPlotDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DotPlotDatum {\n  category: string;\n  values: ReadonlyArray<number | null>;\n  colors?: ReadonlyArray<string | null>;\n  markers?: ReadonlyArray<DotPlotMarkerSymbol | null>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DotPlotMarkerSymbol","title":"DotPlotMarkerSymbol","description":""}]}]}]},{"path":"/docs/types/DotPlotMarkerSymbol","title":"DotPlotMarkerSymbol","summary":"The DotPlotMarkerSymbol type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DotPlotMarkerSymbol = 'circle' | 'square' | 'diamond' | 'triangle';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DrawingAction","title":"DrawingAction","summary":"The DrawingAction type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingAction =\n  | { type: 'add'; drawing: StockDrawingInput }\n  | { type: 'update'; id: string; patch: Partial<Omit<StockDrawing, 'id'>> }\n  | { type: 'move'; id: string; deltaTime: number; deltaPrice: number }\n  | { type: 'remove'; id: string }\n  | { type: 'clear' }\n  | { type: 'set'; drawings: ReadonlyArray<StockDrawingInput> };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StockDrawingInput","title":"StockDrawingInput","description":""},{"path":"/docs/types/StockDrawing","title":"StockDrawing","description":""}]}]}]},{"path":"/docs/types/DrawingActionType","title":"DrawingActionType","summary":"The DrawingActionType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingActionType = DrawingAction['type'];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingAction","title":"DrawingAction","description":""}]}]}]},{"path":"/docs/types/DrawingAnchor","title":"DrawingAnchor","summary":"The DrawingAnchor type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DrawingAnchor {\n  readonly time: number;\n  readonly price: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DrawingAnchorInput","title":"DrawingAnchorInput","summary":"The DrawingAnchorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingAnchorInput = DrawingAnchor | { x: number | string | Date; y: number } | readonly [number | string | Date, number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingAnchor","title":"DrawingAnchor","description":""}]}]}]},{"path":"/docs/types/DrawingDocument","title":"DrawingDocument","summary":"The DrawingDocument type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DrawingDocument {\n  v: number;\n  seed: number;\n  drawings: ChartDrawing[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":""}]}]}]},{"path":"/docs/types/DrawingLayerSnapshot","title":"DrawingLayerSnapshot","summary":"The DrawingLayerSnapshot type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DrawingLayerSnapshot extends SvgLayer {\n  readonly count: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SvgLayer","title":"SvgLayer","description":""}]}]}]},{"path":"/docs/types/DrawingMeta","title":"DrawingMeta","summary":"The DrawingMeta type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingMeta = Readonly<Record<string, string | number | boolean>>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DrawingMode","title":"DrawingMode","summary":"The DrawingMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingMode = 'none' | 'draw' | 'select';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DrawingModeInput","title":"DrawingModeInput","summary":"The DrawingModeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingModeInput = DrawingMode | 'off' | 'true' | 'false' | boolean | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingMode","title":"DrawingMode","description":""}]}]}]},{"path":"/docs/types/DrawingSelectionChangeEventDetail","title":"DrawingSelectionChangeEventDetail","summary":"The DrawingSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DrawingSelectionChangeEventDetail {\n  selected: string[];\n  source: DrawingSelectionSource;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingSelectionSource","title":"DrawingSelectionSource","description":""}]}]}]},{"path":"/docs/types/DrawingSelectionSource","title":"DrawingSelectionSource","summary":"The DrawingSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingSelectionSource = 'click' | 'marquee' | 'api' | 'clear' | 'keyboard' | 'prune' | 'mode';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DrawingSpace","title":"DrawingSpace","summary":"The DrawingSpace type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingSpace = 'data' | 'pixel';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DrawingStyle","title":"DrawingStyle","summary":"The DrawingStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DrawingStyle {\n  readonly color?: string;\n  readonly width?: number;\n  readonly dash?: boolean;\n  readonly opacity?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DrawingsChangeEventDetail","title":"DrawingsChangeEventDetail","summary":"The DrawingsChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DrawingsChangeEventDetail {\n  drawings: ChartDrawing[];\n  action: DrawingActionType | 'undo' | 'redo';\n  source: DrawingsChangeSource;\n  id?: string;\n  canUndo: boolean;\n  canRedo: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartDrawing","title":"ChartDrawing","description":""},{"path":"/docs/types/DrawingActionType","title":"DrawingActionType","description":""},{"path":"/docs/types/DrawingsChangeSource","title":"DrawingsChangeSource","description":""}]}]}]},{"path":"/docs/types/DrawingsChangeSource","title":"DrawingsChangeSource","summary":"The DrawingsChangeSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DrawingsChangeSource = 'draw' | 'api' | 'undo' | 'redo' | 'clear' | 'prop' | 'move' | 'keyboard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartAnimationType","title":"DumbbellChartAnimationType","summary":"The DumbbellChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartDatum","title":"DumbbellChartDatum","summary":"The DumbbellChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartEasing","title":"DumbbellChartEasing","summary":"The DumbbellChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartEngineMode","title":"DumbbellChartEngineMode","summary":"The DumbbellChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartEngineMode = 'auto' | DumbbellChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DumbbellChartEngineTier","title":"DumbbellChartEngineTier","description":""}]}]}]},{"path":"/docs/types/DumbbellChartEngineTier","title":"DumbbellChartEngineTier","summary":"The DumbbellChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartLegendItemEventDetail","title":"DumbbellChartLegendItemEventDetail","summary":"The DumbbellChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DumbbellChartLegendItemEventDetail {\n  index: number;\n  seriesId: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartLegendPosition","title":"DumbbellChartLegendPosition","summary":"The DumbbellChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartPointerEventDetail","title":"DumbbellChartPointerEventDetail","summary":"The DumbbellChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DumbbellChartPointerEventDetail {\n  index: number;\n  category: string;\n  low: number | null;\n  high: number | null;\n  range: number | null;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartRenderResult","title":"DumbbellChartRenderResult","summary":"The DumbbellChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DumbbellChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartSeriesToggledEventDetail","title":"DumbbellChartSeriesToggledEventDetail","summary":"The DumbbellChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DumbbellChartSeriesToggledEventDetail {\n  index: number;\n  seriesId: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartStreamEvent","title":"DumbbellChartStreamEvent","summary":"The DumbbellChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellChartStreamSource","title":"DumbbellChartStreamSource","summary":"The DumbbellChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DumbbellChartStreamSource {\n  push(datum: DumbbellPairDatum): void;\n  pushBatch(data: ReadonlyArray<DumbbellPairDatum>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<DumbbellPairDatum>): void;\n  snapshot(window?: number): DumbbellPairDatum[];\n  latest(): DumbbellPairDatum | undefined;\n  subscribe(listener: (event: DumbbellChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DumbbellPairDatum","title":"DumbbellPairDatum","description":""},{"path":"/docs/types/DumbbellChartStreamEvent","title":"DumbbellChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/DumbbellChartUnavailableBehaviour","title":"DumbbellChartUnavailableBehaviour","summary":"The DumbbellChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/DumbbellDatum","title":"DumbbellDatum","summary":"The DumbbellDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DumbbellDatum {\n  category: string;\n  values?: ReadonlyArray<DumbbellChartDatum>;\n  low?: DumbbellChartDatum;\n  high?: DumbbellChartDatum;\n  lowColor?: string;\n  highColor?: string;\n  lowMarker?: DumbbellMarkerSymbol;\n  highMarker?: DumbbellMarkerSymbol;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DumbbellChartDatum","title":"DumbbellChartDatum","description":""},{"path":"/docs/types/DumbbellMarkerSymbol","title":"DumbbellMarkerSymbol","description":""}]}]}]},{"path":"/docs/types/DumbbellMarkerSymbol","title":"DumbbellMarkerSymbol","summary":"The DumbbellMarkerSymbol type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type DumbbellMarkerSymbol = 'circle' | 'square' | 'diamond';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/DumbbellPairDatum","title":"DumbbellPairDatum","summary":"The DumbbellPairDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface DumbbellPairDatum {\n  values?: ReadonlyArray<number | null | undefined>;\n  low?: number;\n  high?: number;\n  category?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/EncodedDataset","title":"EncodedDataset","summary":"The EncodedDataset type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface EncodedDataset {\n  series: EncodedSeries[];\n  categories: string[];\n  xKind: 'number' | 'time' | 'ordinal' | 'index';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/EncodedSeries","title":"EncodedSeries","description":""}]}]}]},{"path":"/docs/types/EncodedSeries","title":"EncodedSeries","summary":"The EncodedSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface EncodedSeries {\n  name: string;\n  values: Array<number | null> | Array<{ x: number; y: number | null; z?: number; name?: string }>;\n  xValues?: number[];\n  encode: { x: string | undefined; y: string | undefined; z: string | undefined; itemName: string | undefined; tooltip: string[] };\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarAnimationType","title":"ErrorBarAnimationType","summary":"The ErrorBarAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/ErrorBarData","title":"ErrorBarData","summary":"The ErrorBarData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarData = ReadonlyArray<ErrorBarDatumInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","description":""}]}]}]},{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","summary":"The ErrorBarDatumInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarDatumInput = ErrorBarDatumObject | ErrorBarDatumTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ErrorBarDatumObject","title":"ErrorBarDatumObject","description":""},{"path":"/docs/types/ErrorBarDatumTuple","title":"ErrorBarDatumTuple","description":""}]}]}]},{"path":"/docs/types/ErrorBarDatumObject","title":"ErrorBarDatumObject","summary":"The ErrorBarDatumObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarDatumObject {\n  category: string;\n  value: number;\n  low?: number;\n  high?: number;\n  error?: number;\n  minus?: number;\n  plus?: number;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarDatumTuple","title":"ErrorBarDatumTuple","summary":"The ErrorBarDatumTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarDatumTuple = readonly [category: string, value: number, errorOrLow?: number, high?: number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarDomain","title":"ErrorBarDomain","summary":"The ErrorBarDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarDomain {\n  yMin: number;\n  yMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarDrawStats","title":"ErrorBarDrawStats","summary":"The ErrorBarDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarDrawStats {\n  points: number;\n  drawn: number;\n  instances: number;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  pitchPx: number;\n  barPx: number;\n  capPx: number;\n  markerPx: number;\n  whiskerPx: number;\n  mode: ErrorBarMode;\n  caps: boolean;\n  activeIndex: number;\n  colored: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ErrorBarMode","title":"ErrorBarMode","description":""}]}]}]},{"path":"/docs/types/ErrorBarEasing","title":"ErrorBarEasing","summary":"The ErrorBarEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/ErrorBarEngineMode","title":"ErrorBarEngineMode","summary":"The ErrorBarEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/ErrorBarEngineTier","title":"ErrorBarEngineTier","summary":"The ErrorBarEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/ErrorBarExtent","title":"ErrorBarExtent","summary":"The ErrorBarExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarExtent {\n  points: number;\n  valueMin: number;\n  valueMax: number;\n  errorMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarMode","title":"ErrorBarMode","summary":"The ErrorBarMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarMode = 'point' | 'bar';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarPoint","title":"ErrorBarPoint","summary":"The ErrorBarPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarPoint {\n  index: number;\n  category: string;\n  value: number;\n  low: number;\n  high: number;\n  minus: number;\n  plus: number;\n  color: string | null;\n  source: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarPointEventDetail","title":"ErrorBarPointEventDetail","summary":"The ErrorBarPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarPointEventDetail {\n  index: number;\n  category: string;\n  value: number;\n  low: number;\n  high: number;\n  minus: number;\n  plus: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ErrorBarRenderResult","title":"ErrorBarRenderResult","summary":"The ErrorBarRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  errorBar?: ErrorBarDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ErrorBarDrawStats","title":"ErrorBarDrawStats","description":""}]}]}]},{"path":"/docs/types/ErrorBarStreamEvent","title":"ErrorBarStreamEvent","summary":"The ErrorBarStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: ErrorBarDatumInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","description":""}]}]}]},{"path":"/docs/types/ErrorBarStreamSource","title":"ErrorBarStreamSource","summary":"The ErrorBarStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ErrorBarStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(datum: ErrorBarDatumInput): void;\n  pushBatch(data: ReadonlyArray<ErrorBarDatumInput>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<ErrorBarDatumInput>): void;\n  snapshot(): ErrorBarDatumInput[];\n  subscribe(listener: (event: ErrorBarStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ErrorBarDatumInput","title":"ErrorBarDatumInput","description":""},{"path":"/docs/types/ErrorBarStreamEvent","title":"ErrorBarStreamEvent","description":""}]}]}]},{"path":"/docs/types/ErrorBarUnavailableBehaviour","title":"ErrorBarUnavailableBehaviour","summary":"The ErrorBarUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ErrorBarUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/FlowLinesCoordinate","title":"FlowLinesCoordinate","summary":"The FlowLinesCoordinate type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FlowLinesCoordinate=readonly[longitude:number,latitude:number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FlowLinesData","title":"FlowLinesData","summary":"The FlowLinesData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesData {locations:ReadonlyArray<FlowLinesLocationInput>;flows:ReadonlyArray<FlowLinesRouteInput>}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesLocationInput","title":"FlowLinesLocationInput","description":""},{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":""}]}]}]},{"path":"/docs/types/FlowLinesDiagnostics","title":"FlowLinesDiagnostics","summary":"The FlowLinesDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesDiagnostics {locations:number;flows:number;zeroValues:number;coincidentFlows:number;wrappedLongitudes:number;totalValue:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FlowLinesHitDetail","title":"FlowLinesHitDetail","summary":"The FlowLinesHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FlowLinesHitDetail=FlowLinesRouteHit|FlowLinesLocationHit;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesRouteHit","title":"FlowLinesRouteHit","description":""},{"path":"/docs/types/FlowLinesLocationHit","title":"FlowLinesLocationHit","description":""}]}]}]},{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","summary":"The FlowLinesId type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FlowLinesId=string|number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FlowLinesLayout","title":"FlowLinesLayout","summary":"The FlowLinesLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesLayout {map:GeoMapLayoutResult|null;flows:GeoMapConnectionView[]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapLayoutResult","title":"GeoMapLayoutResult","description":""},{"path":"/docs/types/GeoMapConnectionView","title":"GeoMapConnectionView","description":""}]}]}]},{"path":"/docs/types/FlowLinesLocation","title":"FlowLinesLocation","summary":"The FlowLinesLocation type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesLocation extends FlowLinesLocationInput {key:string;index:number;label:string;incoming:number;outgoing:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesLocationInput","title":"FlowLinesLocationInput","description":""}]}]}]},{"path":"/docs/types/FlowLinesLocationHit","title":"FlowLinesLocationHit","summary":"The FlowLinesLocationHit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesLocationHit {kind:'location';locationIndex:number;location:FlowLinesLocation;cssX:number;cssY:number;value:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesLocation","title":"FlowLinesLocation","description":""}]}]}]},{"path":"/docs/types/FlowLinesLocationInput","title":"FlowLinesLocationInput","summary":"The FlowLinesLocationInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesLocationInput {id:FlowLinesId;label?:string;longitude:number;latitude:number;color?:string;radius?:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","description":""}]}]}]},{"path":"/docs/types/FlowLinesRenderResult","title":"FlowLinesRenderResult","summary":"The FlowLinesRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesRenderResult {points:number;drawn:number;renderMs:number;flowLines:{locations:number;flows:number;vertices:number;bytes:number;uploaded:number;version:number;chunks:number;cut:number}}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FlowLinesRoute","title":"FlowLinesRoute","summary":"The FlowLinesRoute type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesRoute extends FlowLinesRouteInput {key:string;index:number;name:string;value:number;via:FlowLinesCoordinate[];fromIndex:number;toIndex:number;coordinates:FlowLinesCoordinate[];coincident:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":""},{"path":"/docs/types/FlowLinesCoordinate","title":"FlowLinesCoordinate","description":""}]}]}]},{"path":"/docs/types/FlowLinesRouteHit","title":"FlowLinesRouteHit","summary":"The FlowLinesRouteHit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesRouteHit {kind:'flow';flowIndex:number;flow:FlowLinesRoute;cssX:number;cssY:number;value:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesRoute","title":"FlowLinesRoute","description":""}]}]}]},{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","summary":"The FlowLinesRouteInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesRouteInput {id:FlowLinesId;from:FlowLinesId;to:FlowLinesId;name?:string;value?:number;color?:string;width?:number;opacity?:number;via?:ReadonlyArray<FlowLinesCoordinate>}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","description":""},{"path":"/docs/types/FlowLinesCoordinate","title":"FlowLinesCoordinate","description":""}]}]}]},{"path":"/docs/types/FlowLinesSelection","title":"FlowLinesSelection","summary":"The FlowLinesSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesSelection {kind:'flow'|'location'|null;id:FlowLinesId|null;index:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","description":""}]}]}]},{"path":"/docs/types/FlowLinesSelectionChangeEventDetail","title":"FlowLinesSelectionChangeEventDetail","summary":"The FlowLinesSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesSelectionChangeEventDetail extends FlowLinesSelection {by:'pointer'|'keyboard'|'method'|'data'}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesSelection","title":"FlowLinesSelection","description":""}]}]}]},{"path":"/docs/types/FlowLinesStreamEvent","title":"FlowLinesStreamEvent","summary":"The FlowLinesStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesStreamEvent {type:'push'|'pushBatch'|'shift'|'replace';count:number;replaced:number;entries:FlowLinesRouteInput[]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":""}]}]}]},{"path":"/docs/types/FlowLinesStreamSource","title":"FlowLinesStreamSource","summary":"The FlowLinesStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesStreamSource {readonly length:number;readonly capacity:number;readonly dropped:number;readonly locationIds:ReadonlyArray<FlowLinesId>;push(flow:FlowLinesRouteInput):void;pushBatch(flows:ReadonlyArray<FlowLinesRouteInput>):void;shift(count:number):void;replace(flows:ReadonlyArray<FlowLinesRouteInput>):void;setCapacity(capacity:number):void;snapshot():FlowLinesRouteInput[];subscribe(listener:(event:FlowLinesStreamEvent)=>void):()=>void}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FlowLinesId","title":"FlowLinesId","description":""},{"path":"/docs/types/FlowLinesRouteInput","title":"FlowLinesRouteInput","description":""},{"path":"/docs/types/FlowLinesStreamEvent","title":"FlowLinesStreamEvent","description":""}]}]}]},{"path":"/docs/types/FlowLinesStyle","title":"FlowLinesStyle","summary":"The FlowLinesStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FlowLinesStyle {minWidth?:number;maxWidth?:number;valueMax?:number;colors?:ReadonlyArray<string>;opacity?:number;arrows?:boolean;locationRadius?:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartAnimationType","title":"FunnelChartAnimationType","summary":"The FunnelChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartData","title":"FunnelChartData","summary":"The FunnelChartData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartData = ReadonlyArray<FunnelSectionSpec> | ReadonlyArray<number>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":""}]}]}]},{"path":"/docs/types/FunnelChartEasing","title":"FunnelChartEasing","summary":"The FunnelChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartEngineMode","title":"FunnelChartEngineMode","summary":"The FunnelChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartEngineTier","title":"FunnelChartEngineTier","summary":"The FunnelChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartLegendPosition","title":"FunnelChartLegendPosition","summary":"The FunnelChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","summary":"The FunnelChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelChartPointerEventDetail {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly value: number;\n  readonly percentage: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartRenderResult","title":"FunnelChartRenderResult","summary":"The FunnelChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelChartRenderResult {\n  readonly sections: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartStreamEvent","title":"FunnelChartStreamEvent","summary":"The FunnelChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartStreamSource","title":"FunnelChartStreamSource","summary":"The FunnelChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelChartStreamSource {\n  push(section: FunnelSectionSpec): void;\n  pushBatch(sections: ReadonlyArray<FunnelSectionSpec>): void;\n  shift(count: number): void;\n  replace(sections: ReadonlyArray<FunnelSectionSpec>): void;\n  snapshot(window?: number): FunnelSectionSpec[];\n  latest(): FunnelSectionSpec | undefined;\n  subscribe(listener: (event: FunnelChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","description":""},{"path":"/docs/types/FunnelChartStreamEvent","title":"FunnelChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipActionEventDetail","title":"FunnelChartTooltipActionEventDetail","summary":"The FunnelChartTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelChartTooltipActionEventDetail extends FunnelChartTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipFormatContext","title":"FunnelChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipConnectorInput","title":"FunnelChartTooltipConnectorInput","summary":"The FunnelChartTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<FunnelChartTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipConnectorSpec","title":"FunnelChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipConnectorSpec","title":"FunnelChartTooltipConnectorSpec","summary":"The FunnelChartTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelChartTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartTooltipFormatContext","title":"FunnelChartTooltipFormatContext","summary":"The FunnelChartTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipFormatContext = FunnelChartPointerEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipInput","title":"FunnelChartTooltipInput","summary":"The FunnelChartTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | FunnelChartTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipObjectInput","title":"FunnelChartTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipObjectInput","title":"FunnelChartTooltipObjectInput","summary":"The FunnelChartTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipObjectInput = Omit<Partial<FunnelChartTooltipSpec>, 'connector'> & {\n  connector?: FunnelChartTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipSpec","title":"FunnelChartTooltipSpec","description":""},{"path":"/docs/types/FunnelChartTooltipConnectorInput","title":"FunnelChartTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipOpenMode","title":"FunnelChartTooltipOpenMode","summary":"The FunnelChartTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartTooltipShowEventDetail","title":"FunnelChartTooltipShowEventDetail","summary":"The FunnelChartTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelChartTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: FunnelChartTooltipSide;\n  text: string;\n  html?: string;\n  context?: FunnelChartTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipSide","title":"FunnelChartTooltipSide","description":""},{"path":"/docs/types/FunnelChartTooltipFormatContext","title":"FunnelChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipSide","title":"FunnelChartTooltipSide","summary":"The FunnelChartTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartTooltipSpec","title":"FunnelChartTooltipSpec","summary":"The FunnelChartTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelChartTooltipSpec {\n  show: boolean;\n  openMode: FunnelChartTooltipOpenMode;\n  trigger: FunnelChartTooltipTrigger;\n  side?: FunnelChartTooltipSide;\n  offset: number;\n  format?: (detail: FunnelChartPointerEventDetail, context?: FunnelChartTooltipFormatContext) => string;\n  html?: (detail: FunnelChartPointerEventDetail, context?: FunnelChartTooltipFormatContext) => string;\n  className?: string;\n  style?: FunnelChartTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: FunnelChartTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipOpenMode","title":"FunnelChartTooltipOpenMode","description":""},{"path":"/docs/types/FunnelChartTooltipTrigger","title":"FunnelChartTooltipTrigger","description":""},{"path":"/docs/types/FunnelChartTooltipSide","title":"FunnelChartTooltipSide","description":""},{"path":"/docs/types/FunnelChartPointerEventDetail","title":"FunnelChartPointerEventDetail","description":""},{"path":"/docs/types/FunnelChartTooltipFormatContext","title":"FunnelChartTooltipFormatContext","description":""},{"path":"/docs/types/FunnelChartTooltipStyle","title":"FunnelChartTooltipStyle","description":""},{"path":"/docs/types/FunnelChartTooltipConnectorSpec","title":"FunnelChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipStyle","title":"FunnelChartTooltipStyle","summary":"The FunnelChartTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipStyle = Record<string, FunnelChartTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/FunnelChartTooltipStyleValue","title":"FunnelChartTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/FunnelChartTooltipStyleValue","title":"FunnelChartTooltipStyleValue","summary":"The FunnelChartTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartTooltipTrigger","title":"FunnelChartTooltipTrigger","summary":"The FunnelChartTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelChartUnavailableBehaviour","title":"FunnelChartUnavailableBehaviour","summary":"The FunnelChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/FunnelLabelPlacement","title":"FunnelLabelPlacement","summary":"The FunnelLabelPlacement type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type FunnelLabelPlacement = 'inside' | 'right' | 'left' | 'none';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/FunnelSectionSpec","title":"FunnelSectionSpec","summary":"The FunnelSectionSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface FunnelSectionSpec {\n  readonly value: number;\n  readonly id?: string | number;\n  readonly name?: string;\n  readonly color?: string;\n  readonly opacity?: number;\n  readonly borderColor?: string;\n  readonly borderWidth?: number;\n  readonly borderDash?: ReadonlyArray<number>;\n  readonly labelColor?: string;\n  readonly visible?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttAnimationType","title":"GanttAnimationType","summary":"The GanttAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttAnimationType=HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/GanttBaseline","title":"GanttBaseline","summary":"The GanttBaseline type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttBaseline {start:number;end:number;milestone:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttBaselineComparison","title":"GanttBaselineComparison","summary":"The GanttBaselineComparison type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttBaselineComparison {\r\n  taskId:string;taskIndex:number;actualStart:number;actualEnd:number;baselineStart:number;baselineEnd:number;\r\n  startVariance:number;finishVariance:number;durationVariance:number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttBaselineInput","title":"GanttBaselineInput","summary":"The GanttBaselineInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttBaselineInput {start:GanttTime;end?:GanttTime;milestone?:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTime","title":"GanttTime","description":""}]}]}]},{"path":"/docs/types/GanttBaselineStyle","title":"GanttBaselineStyle","summary":"The GanttBaselineStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttBaselineStyle {show:boolean;color:string;opacity:number;height:number;gap:number;includeInDomain:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttBaselineStyleInput","title":"GanttBaselineStyleInput","summary":"The GanttBaselineStyleInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttBaselineStyleInput=boolean|string|Partial<GanttBaselineStyle>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttBaselineStyle","title":"GanttBaselineStyle","description":""}]}]}]},{"path":"/docs/types/GanttCriticalDependency","title":"GanttCriticalDependency","summary":"The GanttCriticalDependency type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttCriticalDependency {id:string;index:number;freeFloat:number;critical:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttCriticalPathInput","title":"GanttCriticalPathInput","summary":"The GanttCriticalPathInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttCriticalPathInput=boolean|string|Partial<GanttCriticalPathSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttCriticalPathSpec","title":"GanttCriticalPathSpec","description":""}]}]}]},{"path":"/docs/types/GanttCriticalPathResult","title":"GanttCriticalPathResult","summary":"The GanttCriticalPathResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttCriticalPathResult {\r\n  status:'ok'|'empty'|'invalid-input'|'cycle'|'overflow';reason:string|null;\r\n  projectStart:number|null;projectFinish:number|null;deadline:number|null;duration:number;\r\n  tasks:GanttCriticalTask[];links:GanttCriticalDependency[];criticalTaskIds:string[];criticalDependencyIds:string[];\r\n  cycles:string[][];taskDiagnostics:GanttDiagnostics;dependencyDiagnostics:GanttDependencyDiagnostics;\r\n  respectStartDates:boolean;tolerance:number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttCriticalTask","title":"GanttCriticalTask","description":""},{"path":"/docs/types/GanttCriticalDependency","title":"GanttCriticalDependency","description":""},{"path":"/docs/types/GanttDiagnostics","title":"GanttDiagnostics","description":""},{"path":"/docs/types/GanttDependencyDiagnostics","title":"GanttDependencyDiagnostics","description":""}]}]}]},{"path":"/docs/types/GanttCriticalPathSpec","title":"GanttCriticalPathSpec","summary":"The GanttCriticalPathSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttCriticalPathSpec {\r\n  show:boolean;color:string;linkColor:string;\r\n  respectStartDates:boolean;\r\n  deadline?:GanttTime;\r\n  tolerance:number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTime","title":"GanttTime","description":""}]}]}]},{"path":"/docs/types/GanttCriticalTask","title":"GanttCriticalTask","summary":"The GanttCriticalTask type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttCriticalTask {\r\n  id:string;index:number;earlyStart:number;earlyFinish:number;lateStart:number;lateFinish:number;\r\n  totalFloat:number;freeFloat:number;critical:boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttCrosshairTimeUnit","title":"GanttCrosshairTimeUnit","summary":"The GanttCrosshairTimeUnit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttCrosshairTimeUnit='year'|'month'|'week'|'day'|'hour'|'minute'|'second';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttData","title":"GanttData","summary":"The GanttData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttData = ReadonlyArray<GanttTaskInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":""}]}]}]},{"path":"/docs/types/GanttDeclaration","title":"GanttDeclaration","summary":"The GanttDeclaration type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDeclaration extends GanttTaskInput {\r\n  start:number;\r\n  end:number;\r\n  milestone:boolean;\r\n  progress:number;\r\n  baseline?:GanttBaseline;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":""},{"path":"/docs/types/GanttBaseline","title":"GanttBaseline","description":""}]}]}]},{"path":"/docs/types/GanttDependency","title":"GanttDependency","summary":"The GanttDependency type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependency {index:number;id:string;source:string;target:string;type:GanttDependencyType;lag:number;sourceIndex:number;targetIndex:number;slack:number;violated:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependencyType","title":"GanttDependencyType","description":""}]}]}]},{"path":"/docs/types/GanttDependencyDataset","title":"GanttDependencyDataset","summary":"The GanttDependencyDataset type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencyDataset {links:GanttDependency[];diagnostics:GanttDependencyDiagnostics}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependency","title":"GanttDependency","description":""},{"path":"/docs/types/GanttDependencyDiagnostics","title":"GanttDependencyDiagnostics","description":""}]}]}]},{"path":"/docs/types/GanttDependencyDiagnostics","title":"GanttDependencyDiagnostics","summary":"The GanttDependencyDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencyDiagnostics {invalidRecords:number;duplicates:number;missingTasks:number;selfLinks:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttDependencyHitDetail","title":"GanttDependencyHitDetail","summary":"The GanttDependencyHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencyHitDetail {kind:'dependency';dependency:GanttDependency;source:GanttTask;target:GanttTask;cssX:number;cssY:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependency","title":"GanttDependency","description":""},{"path":"/docs/types/GanttTask","title":"GanttTask","description":""}]}]}]},{"path":"/docs/types/GanttDependencyInput","title":"GanttDependencyInput","summary":"The GanttDependencyInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencyInput {\r\n  id:string;source:string;target:string;type?:GanttDependencyType;\r\n  lag?:number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependencyType","title":"GanttDependencyType","description":""}]}]}]},{"path":"/docs/types/GanttDependencyPath","title":"GanttDependencyPath","summary":"The GanttDependencyPath type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencyPath {index:number;id:string;source:string;target:string;points:GanttDependencyPoint[];arrow:GanttDependencyPoint[];opacity:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependencyPoint","title":"GanttDependencyPoint","description":""}]}]}]},{"path":"/docs/types/GanttDependencyPoint","title":"GanttDependencyPoint","summary":"The GanttDependencyPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencyPoint {x:number;y:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttDependencySelection","title":"GanttDependencySelection","summary":"The GanttDependencySelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencySelection {dependency:GanttDependency|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependency","title":"GanttDependency","description":""}]}]}]},{"path":"/docs/types/GanttDependencySelectionChange","title":"GanttDependencySelectionChange","summary":"The GanttDependencySelectionChange type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencySelectionChange extends GanttDependencySelection {by:GanttSelectionSource}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependencySelection","title":"GanttDependencySelection","description":""},{"path":"/docs/types/GanttSelectionSource","title":"GanttSelectionSource","description":""}]}]}]},{"path":"/docs/types/GanttDependencyStyle","title":"GanttDependencyStyle","summary":"The GanttDependencyStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDependencyStyle {show:boolean;color:string;width:number;arrowSize:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttDependencyStyleInput","title":"GanttDependencyStyleInput","summary":"The GanttDependencyStyleInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttDependencyStyleInput=boolean|string|Partial<GanttDependencyStyle>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDependencyStyle","title":"GanttDependencyStyle","description":""}]}]}]},{"path":"/docs/types/GanttDependencyType","title":"GanttDependencyType","summary":"The GanttDependencyType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttDependencyType='FS'|'SS'|'FF'|'SF';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttDiagnostics","title":"GanttDiagnostics","summary":"The GanttDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttDiagnostics {\r\n  invalidRecords:number;\r\n  invalidIds:number;\r\n  invalidDates:number;\r\n  reversedIntervals:number;\r\n  invalidProgress:number;\r\n  duplicates:number;\r\n  invalidBaselines?:number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttEasing","title":"GanttEasing","summary":"The GanttEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttEasing=HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/GanttEngineMode","title":"GanttEngineMode","summary":"The GanttEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttEngineMode=HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/GanttEngineTier","title":"GanttEngineTier","summary":"The GanttEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttEngineTier=HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/GanttExtent","title":"GanttExtent","summary":"The GanttExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttExtent {tasks:number;start:number|null;end:number|null;duration:number;milestones:number;completedTasks:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttHitDetail","title":"GanttHitDetail","summary":"The GanttHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttHitDetail {kind:'task';part?:'baseline';taskIndex:number;task:GanttTask;value:number;cssX:number;cssY:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":""}]}]}]},{"path":"/docs/types/GanttLabel","title":"GanttLabel","summary":"The GanttLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttLabel {index:number;id:string;text:string;x:number;y:number;width:number;height:number;shown:boolean;opacity:number;color:string;haloColor?:string}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttLabelMode","title":"GanttLabelMode","summary":"The GanttLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttLabelMode='auto'|'show'|'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttLayoutResult","title":"GanttLayoutResult","summary":"The GanttLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttLayoutResult {tasks:GanttMark[];baselines?:GanttMark[];width:number;height:number;domain:readonly[number,number];rows:number;layout:'time-rows'}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttMark","title":"GanttMark","description":""}]}]}]},{"path":"/docs/types/GanttMark","title":"GanttMark","summary":"The GanttMark type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttMark {\r\n  index:number;id:string;x:number;y:number;width:number;height:number;\r\n  milestone:boolean;progress:number;opacity:number;passive?:boolean\n  paintOrder?:number;\r\n  progressWidth:number;\r\n  radius:number;\r\n  startClipped:boolean;\r\n  endClipped:boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttRenderResult","title":"GanttRenderResult","summary":"The GanttRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttRenderResult {\r\n  points:number;drawn:number;renderMs:number;\r\n  gantt?:{tasks:number;drawn:number;vertices:number;bytes:number;uploaded:number;full:boolean;version:number;activeTask:number;chunks:number;chunkVertices:number;capacity:number;cut:number};\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttSelection","title":"GanttSelection","summary":"The GanttSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttSelection {taskIndex:number;task:GanttTask|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTask","title":"GanttTask","description":""}]}]}]},{"path":"/docs/types/GanttSelectionChangeEventDetail","title":"GanttSelectionChangeEventDetail","summary":"The GanttSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttSelectionChangeEventDetail extends GanttSelection {by:GanttSelectionSource}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttSelection","title":"GanttSelection","description":""},{"path":"/docs/types/GanttSelectionSource","title":"GanttSelectionSource","description":""}]}]}]},{"path":"/docs/types/GanttSelectionSource","title":"GanttSelectionSource","summary":"The GanttSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttSelectionSource='pointer'|'keyboard'|'method'|'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttStreamEvent","title":"GanttStreamEvent","summary":"The GanttStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttStreamEvent {type:'push'|'pushBatch'|'shift'|'replace';count:number;entries:GanttDeclaration[];replaced:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttDeclaration","title":"GanttDeclaration","description":""}]}]}]},{"path":"/docs/types/GanttStreamSource","title":"GanttStreamSource","summary":"The GanttStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttStreamSource {\r\n  readonly length:number;\r\n  readonly capacity:number;\r\n  readonly dropped:number;\r\n  push(task:GanttTaskInput):void;\r\n  pushBatch(tasks:ReadonlyArray<GanttTaskInput>):void;\r\n  shift(count:number):void;\r\n  replace(tasks:ReadonlyArray<GanttTaskInput>):void;\r\n  snapshot():GanttDeclaration[];\r\n  subscribe(listener:(event:GanttStreamEvent)=>void):()=>void;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","description":""},{"path":"/docs/types/GanttDeclaration","title":"GanttDeclaration","description":""},{"path":"/docs/types/GanttStreamEvent","title":"GanttStreamEvent","description":""}]}]}]},{"path":"/docs/types/GanttTask","title":"GanttTask","summary":"The GanttTask type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTask {\r\n  index:number;\r\n  id:string;\r\n  label:string;\r\n  start:number;\r\n  end:number;\r\n  duration:number;\r\n  milestone:boolean;\r\n  progress:number;\r\n  color:string|null;\r\n  origin:'data'|'stream';\r\n  baseline?:GanttBaseline;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttBaseline","title":"GanttBaseline","description":""}]}]}]},{"path":"/docs/types/GanttTaskEdit","title":"GanttTaskEdit","summary":"The GanttTaskEdit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTaskEdit {\n  id:string;start:number;end:number;\n  progress?:number;\n  rowIndex?:number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttTaskEditAction","title":"GanttTaskEditAction","summary":"The GanttTaskEditAction type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTaskEditAction='move'|'resize-start'|'resize-end'|'progress';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttTaskEditCancelReason","title":"GanttTaskEditCancelReason","summary":"The GanttTaskEditCancelReason type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTaskEditCancelReason='escape'|'pointer-cancel'|'capture-lost'|'data'|'configuration'|'zoom'|'disconnect'|'prevented'|'method';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttTaskEditEventDetail","title":"GanttTaskEditEventDetail","summary":"The GanttTaskEditEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTaskEditEventDetail {\r\n  action:GanttTaskEditAction;taskId:string;before:GanttTask;task:GanttTask;\r\n  by:'pointer'|'keyboard';pointerType:string;changed:boolean;reason?:GanttTaskEditCancelReason;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditAction","title":"GanttTaskEditAction","description":""},{"path":"/docs/types/GanttTask","title":"GanttTask","description":""},{"path":"/docs/types/GanttTaskEditCancelReason","title":"GanttTaskEditCancelReason","description":""}]}]}]},{"path":"/docs/types/GanttTaskEditingInput","title":"GanttTaskEditingInput","summary":"The GanttTaskEditingInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTaskEditingInput=boolean|string|Partial<GanttTaskEditingSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskEditingSpec","title":"GanttTaskEditingSpec","description":""}]}]}]},{"path":"/docs/types/GanttTaskEditingSpec","title":"GanttTaskEditingSpec","summary":"The GanttTaskEditingSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTaskEditingSpec {\r\n  enabled:boolean;move:boolean;resize:boolean;\n  reorder:boolean;\n  progress:boolean;\n  snap:GanttTaskSnapInput;\n  minDuration:number;\r\n  minTime?:GanttTime;maxTime?:GanttTime;\r\n  taskIds?:ReadonlyArray<string>;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskSnapInput","title":"GanttTaskSnapInput","description":""},{"path":"/docs/types/GanttTime","title":"GanttTime","description":""}]}]}]},{"path":"/docs/types/GanttTaskInput","title":"GanttTaskInput","summary":"The GanttTaskInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTaskInput {\r\n  id:string;\r\n  label?:string;\r\n  start:GanttTime;\r\n  end?:GanttTime;\r\n  milestone?:boolean;\r\n  progress?:number;\r\n  color?:string;\r\n  baseline?:GanttBaselineInput;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTime","title":"GanttTime","description":""},{"path":"/docs/types/GanttBaselineInput","title":"GanttBaselineInput","description":""}]}]}]},{"path":"/docs/types/GanttTaskSnapInput","title":"GanttTaskSnapInput","summary":"The GanttTaskSnapInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTaskSnapInput=number|GanttTaskSnapUnitInput|{unit:GanttTaskSnapUnitInput;step?:number};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskSnapUnitInput","title":"GanttTaskSnapUnitInput","description":""}]}]}]},{"path":"/docs/types/GanttTaskSnapUnit","title":"GanttTaskSnapUnit","summary":"The GanttTaskSnapUnit type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTaskSnapUnit='none'|'second'|'minute'|'hour'|'day'|'week'|'month'|'year';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttTaskSnapUnitInput","title":"GanttTaskSnapUnitInput","summary":"The GanttTaskSnapUnitInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTaskSnapUnitInput=GanttTaskSnapUnit|'없음'|'초'|'분'|'시'|'시간'|'일'|'주'|'월'|'년';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTaskSnapUnit","title":"GanttTaskSnapUnit","description":""}]}]}]},{"path":"/docs/types/GanttTime","title":"GanttTime","summary":"The GanttTime type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTime = number | string | Date;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttTimeAxisInput","title":"GanttTimeAxisInput","summary":"The GanttTimeAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttTimeAxisInput=boolean|string|Partial<GanttTimeAxisSpec>|undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTimeAxisSpec","title":"GanttTimeAxisSpec","description":""}]}]}]},{"path":"/docs/types/GanttTimeAxisModel","title":"GanttTimeAxisModel","summary":"The GanttTimeAxisModel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTimeAxisModel {\r\n  show:boolean;position:'top'|'bottom';utc:boolean;gridLines:boolean;\r\n  domain:readonly[number,number];width:number;caption:string;ticks:GanttTimeAxisTick[];\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GanttTimeAxisTick","title":"GanttTimeAxisTick","description":""}]}]}]},{"path":"/docs/types/GanttTimeAxisSpec","title":"GanttTimeAxisSpec","summary":"The GanttTimeAxisSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTimeAxisSpec {\r\n  show:boolean;\r\n  position:'top'|'bottom';\r\n  utc:boolean;\r\n  tickCount:number;\r\n  gridLines:boolean;\r\n  format?:(date:Date,index:number)=>string;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttTimeAxisTick","title":"GanttTimeAxisTick","summary":"The GanttTimeAxisTick type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GanttTimeAxisTick {value:number;offset:number;label:string}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GanttUnavailableBehaviour","title":"GanttUnavailableBehaviour","summary":"The GanttUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GanttUnavailableBehaviour=HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/GaugeActivityRingSpec","title":"GaugeActivityRingSpec","summary":"The GaugeActivityRingSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeActivityRingSpec {\n  readonly value: number;\n  readonly max?: number;\n  readonly id?: string | number;\n  readonly name?: string;\n  readonly color?: string;\n  readonly trackColor?: string;\n  readonly visible?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeBandLevel","title":"GaugeBandLevel","summary":"The GaugeBandLevel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeBandLevel = 'normal' | 'info' | 'warning' | 'danger' | 'critical' | 'neutral';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartAnimationType","title":"GaugeChartAnimationType","summary":"The GaugeChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartEasing","title":"GaugeChartEasing","summary":"The GaugeChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out' | 'analog';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartEngineMode","title":"GaugeChartEngineMode","summary":"The GaugeChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartEngineTier","title":"GaugeChartEngineTier","summary":"The GaugeChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartLegendPosition","title":"GaugeChartLegendPosition","summary":"The GaugeChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","summary":"The GaugeChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartPointerEventDetail {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly value: number;\n  readonly fraction: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartRenderResult","title":"GaugeChartRenderResult","summary":"The GaugeChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartRenderResult {\n  readonly needles: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartStreamEvent","title":"GaugeChartStreamEvent","summary":"The GaugeChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartStreamSource","title":"GaugeChartStreamSource","summary":"The GaugeChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartStreamSource {\n  push(value: number): void;\n  pushBatch(values: ReadonlyArray<number>): void;\n  shift(count: number): void;\n  replace(values: ReadonlyArray<number>): void;\n  snapshot(window?: number): number[];\n  latest(): number | undefined;\n  subscribe(listener: (event: GaugeChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartStreamEvent","title":"GaugeChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipActionEventDetail","title":"GaugeChartTooltipActionEventDetail","summary":"The GaugeChartTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartTooltipActionEventDetail extends GaugeChartTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipFormatContext","title":"GaugeChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipConnectorInput","title":"GaugeChartTooltipConnectorInput","summary":"The GaugeChartTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<GaugeChartTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipConnectorSpec","title":"GaugeChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipConnectorSpec","title":"GaugeChartTooltipConnectorSpec","summary":"The GaugeChartTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartTooltipFormatContext","title":"GaugeChartTooltipFormatContext","summary":"The GaugeChartTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartTooltipFormatContext {\n  index: number;\n  id: string;\n  name: string;\n  value: number;\n  fraction: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartTooltipInput","title":"GaugeChartTooltipInput","summary":"The GaugeChartTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | GaugeChartTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipObjectInput","title":"GaugeChartTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipObjectInput","title":"GaugeChartTooltipObjectInput","summary":"The GaugeChartTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipObjectInput = Omit<Partial<GaugeChartTooltipSpec>, 'connector'> & {\n  connector?: GaugeChartTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipSpec","title":"GaugeChartTooltipSpec","description":""},{"path":"/docs/types/GaugeChartTooltipConnectorInput","title":"GaugeChartTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipOpenMode","title":"GaugeChartTooltipOpenMode","summary":"The GaugeChartTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartTooltipShowEventDetail","title":"GaugeChartTooltipShowEventDetail","summary":"The GaugeChartTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: GaugeChartTooltipSide;\n  text: string;\n  html?: string;\n  context?: GaugeChartTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipSide","title":"GaugeChartTooltipSide","description":""},{"path":"/docs/types/GaugeChartTooltipFormatContext","title":"GaugeChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipSide","title":"GaugeChartTooltipSide","summary":"The GaugeChartTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartTooltipSpec","title":"GaugeChartTooltipSpec","summary":"The GaugeChartTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeChartTooltipSpec {\n  show: boolean;\n  openMode: GaugeChartTooltipOpenMode;\n  trigger: GaugeChartTooltipTrigger;\n  side?: GaugeChartTooltipSide;\n  offset: number;\n  format?: (detail: GaugeChartPointerEventDetail, context?: GaugeChartTooltipFormatContext) => string;\n  html?: (detail: GaugeChartPointerEventDetail, context?: GaugeChartTooltipFormatContext) => string;\n  className?: string;\n  style?: GaugeChartTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: GaugeChartTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipOpenMode","title":"GaugeChartTooltipOpenMode","description":""},{"path":"/docs/types/GaugeChartTooltipTrigger","title":"GaugeChartTooltipTrigger","description":""},{"path":"/docs/types/GaugeChartTooltipSide","title":"GaugeChartTooltipSide","description":""},{"path":"/docs/types/GaugeChartPointerEventDetail","title":"GaugeChartPointerEventDetail","description":""},{"path":"/docs/types/GaugeChartTooltipFormatContext","title":"GaugeChartTooltipFormatContext","description":""},{"path":"/docs/types/GaugeChartTooltipStyle","title":"GaugeChartTooltipStyle","description":""},{"path":"/docs/types/GaugeChartTooltipConnectorSpec","title":"GaugeChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipStyle","title":"GaugeChartTooltipStyle","summary":"The GaugeChartTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipStyle = Record<string, GaugeChartTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeChartTooltipStyleValue","title":"GaugeChartTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/GaugeChartTooltipStyleValue","title":"GaugeChartTooltipStyleValue","summary":"The GaugeChartTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartTooltipTrigger","title":"GaugeChartTooltipTrigger","summary":"The GaugeChartTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeChartUnavailableBehaviour","title":"GaugeChartUnavailableBehaviour","summary":"The GaugeChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/GaugeChartVariant","title":"GaugeChartVariant","summary":"The GaugeChartVariant type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeChartVariant = 'dial' | 'solid' | 'activity' | 'vuMeter' | 'speedometer' | 'clock';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeColorStop","title":"GaugeColorStop","summary":"The GaugeColorStop type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeColorStop {\n  readonly stop: number;\n  readonly color: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeNeedleShape","title":"GaugeNeedleShape","summary":"The GaugeNeedleShape type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeNeedleShape = 'needle' | 'arrow' | 'line' | 'wedge';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GaugeNeedleSpec","title":"GaugeNeedleSpec","summary":"The GaugeNeedleSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugeNeedleSpec {\n  readonly value: number;\n  readonly id?: string | number;\n  readonly name?: string;\n  readonly color?: string;\n  readonly shape?: GaugeNeedleShape;\n  readonly length?: number | string;\n  readonly rearLength?: number | string;\n  readonly width?: number;\n  readonly visible?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeNeedleShape","title":"GaugeNeedleShape","description":""}]}]}]},{"path":"/docs/types/GaugePlotBand","title":"GaugePlotBand","summary":"The GaugePlotBand type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GaugePlotBand {\n  readonly from: number;\n  readonly to: number;\n  readonly color?: GaugeBandLevel | string;\n  readonly id?: string | number;\n  readonly thickness?: number;\n  readonly outerRadius?: number | string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GaugeBandLevel","title":"GaugeBandLevel","description":""}]}]}]},{"path":"/docs/types/GaugeValueDisplay","title":"GaugeValueDisplay","summary":"The GaugeValueDisplay type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GaugeValueDisplay = 'value' | 'percent';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapAlbersProjection","title":"GeoMapAlbersProjection","summary":"The GeoMapAlbersProjection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapAlbersProjection {\r\n  type: 'albers';\r\n  centralMeridian?: number;\r\n  centerLatitude?: number;\r\n  roll?: number;\r\n  standardParallels?: readonly [number, number];\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapAnimationType","title":"GeoMapAnimationType","summary":"The GeoMapAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/GeoMapAvailabilityDetail","title":"GeoMapAvailabilityDetail","summary":"The GeoMapAvailabilityDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapAvailabilityDetail { requested:GeoMapEngineMode; tier:GeoMapEngineTier; ready:boolean; reason:string|null; policy:GeoMapUnavailableBehaviour }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapEngineMode","title":"GeoMapEngineMode","description":""},{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","description":""},{"path":"/docs/types/GeoMapUnavailableBehaviour","title":"GeoMapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/GeoMapBackground","title":"GeoMapBackground","summary":"The GeoMapBackground type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapBackground = 'natural-earth' | 'none';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapBubbleInput","title":"GeoMapBubbleInput","summary":"The GeoMapBubbleInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapBubbleInput = boolean | GeoMapBubbleOptions | null;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapBubbleOptions","title":"GeoMapBubbleOptions","description":""}]}]}]},{"path":"/docs/types/GeoMapBubbleOptions","title":"GeoMapBubbleOptions","summary":"The GeoMapBubbleOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapBubbleOptions {\r\n  minRadius?: number;\r\n  maxRadius?: number;\r\n  valueMax?: number;\r\n  showLegend?: boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapBubbleScaleDetail","title":"GeoMapBubbleScaleDetail","summary":"The GeoMapBubbleScaleDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapBubbleScaleDetail { minRadius:number; maxRadius:number; valueMax:number; showLegend:boolean }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapColorAxis","title":"GeoMapColorAxis","summary":"The GeoMapColorAxis type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapColorAxis {\r\n  property?: string;\r\n  min?: number;\r\n  max?: number;\r\n  scheme?: string;\r\n  minColor?: string;\r\n  maxColor?: string;\r\n  stops?: ReadonlyArray<readonly [number,string]>;\r\n  center?: number;\r\n  reverse?: boolean;\r\n  missingColor?: string;\r\n  showLegend?: boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapColorAxisDetail","title":"GeoMapColorAxisDetail","summary":"The GeoMapColorAxisDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapColorAxisDetail { min:number; max:number; center:number|null; property:string; missing:number; gradientStops:Array<[number,string]> }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapColorAxisInput","title":"GeoMapColorAxisInput","summary":"The GeoMapColorAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapColorAxisInput = boolean | 'auto' | GeoMapColorAxis | null;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapColorAxis","title":"GeoMapColorAxis","description":""}]}]}]},{"path":"/docs/types/GeoMapConnectionPath","title":"GeoMapConnectionPath","summary":"The GeoMapConnectionPath type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapConnectionPath='great-circle'|'straight';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapConnectionView","title":"GeoMapConnectionView","summary":"The GeoMapConnectionView type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapConnectionView {featureIndex:number;key:string;paths:Array<Array<[number,number]>>;width:number;opacity:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapData","title":"GeoMapData","summary":"The GeoMapData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapData = ReadonlyArray<GeoMapPointInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":""}]}]}]},{"path":"/docs/types/GeoMapDeclaration","title":"GeoMapDeclaration","summary":"The GeoMapDeclaration type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapDeclaration extends GeoMapPointInput { id: string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":""}]}]}]},{"path":"/docs/types/GeoMapDiagnostics","title":"GeoMapDiagnostics","summary":"The GeoMapDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapDiagnostics { invalidIds: number; invalidCoordinates: number; invalidValues: number; duplicates: number; wrappedLongitudes: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapEasing","title":"GeoMapEasing","summary":"The GeoMapEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/GeoMapEngineMode","title":"GeoMapEngineMode","summary":"The GeoMapEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/GeoMapEngineTier","title":"GeoMapEngineTier","summary":"The GeoMapEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/GeoMapEquirectangularProjection","title":"GeoMapEquirectangularProjection","summary":"The GeoMapEquirectangularProjection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapEquirectangularProjection {\r\n  type: 'equirectangular';\r\n  centralMeridian?: number;\r\n  standardParallel?: number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapExtent","title":"GeoMapExtent","summary":"The GeoMapExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapExtent { nodes: number; total: number; valueMax: number; longitudeMin: number | null; longitudeMax: number | null; latitudeMin: number | null; latitudeMax: number | null }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapFeature","title":"GeoMapFeature","summary":"The GeoMapFeature type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFeature {\n  type: 'Feature';\n  id?: string | number;\n  properties: GeoMapProperties;\n  geometry: GeoMapGeometry | null;\n  bbox?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapProperties","title":"GeoMapProperties","description":""},{"path":"/docs/types/GeoMapGeometry","title":"GeoMapGeometry","description":""}]}]}]},{"path":"/docs/types/GeoMapFeatureCollection","title":"GeoMapFeatureCollection","summary":"The GeoMapFeatureCollection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFeatureCollection {\n  type: 'FeatureCollection';\n  features: GeoMapFeature[];\n  bbox?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapFeature","title":"GeoMapFeature","description":""}]}]}]},{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","summary":"The GeoMapFeatureHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFeatureHitDetail { kind: 'feature'; featureIndex: number; key: string; feature: GeoMapFeature; label: string; value: number | null; cssX: number; cssY: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapFeature","title":"GeoMapFeature","description":""}]}]}]},{"path":"/docs/types/GeoMapFeatureLabel","title":"GeoMapFeatureLabel","summary":"The GeoMapFeatureLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFeatureLabel { featureIndex:number; key:string; text:string; displayText:string; x:number; y:number; width:number; height:number; shown:boolean; opacity:number; color:string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapFeatureSelection","title":"GeoMapFeatureSelection","summary":"The GeoMapFeatureSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFeatureSelection { featureIndex: number; key: string | null; feature: GeoMapFeature | null }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapFeature","title":"GeoMapFeature","description":""}]}]}]},{"path":"/docs/types/GeoMapFeatureSelectionChangeEventDetail","title":"GeoMapFeatureSelectionChangeEventDetail","summary":"The GeoMapFeatureSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFeatureSelectionChangeEventDetail extends GeoMapFeatureSelection { by: GeoMapSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapFeatureSelection","title":"GeoMapFeatureSelection","description":""},{"path":"/docs/types/GeoMapSelectionSource","title":"GeoMapSelectionSource","description":""}]}]}]},{"path":"/docs/types/GeoMapFitDetail","title":"GeoMapFitDetail","summary":"The GeoMapFitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFitDetail extends GeoMapViewDetail { target:'all'|'points'|'features'; visiblePoints:number; hiddenPoints:number; features:number; visibleFeatures:number; scale:number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapViewDetail","title":"GeoMapViewDetail","description":""}]}]}]},{"path":"/docs/types/GeoMapFitOptions","title":"GeoMapFitOptions","summary":"The GeoMapFitOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapFitOptions {\r\n  target?: 'all' | 'points' | 'features';\r\n  pointIds?: ReadonlyArray<string>;\r\n  featureIndexes?: ReadonlyArray<number>;\r\n  padding?: number;\r\n  maxZoom?: number;\r\n  recenter?: boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapGeometry","title":"GeoMapGeometry","summary":"The GeoMapGeometry type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapGeometry = GeoMapGeometryMetadata & (\n  | { type: 'Point'; coordinates: GeoMapPosition }\n  | { type: 'MultiPoint' | 'LineString'; coordinates: GeoMapPosition[] }\n  | { type: 'MultiLineString' | 'Polygon'; coordinates: GeoMapPosition[][] }\n  | { type: 'MultiPolygon'; coordinates: GeoMapPosition[][][] }\n  | { type: 'GeometryCollection'; geometries: Array<GeoMapGeometry | null> }\n);","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapGeometryMetadata","title":"GeoMapGeometryMetadata","description":""},{"path":"/docs/types/Point","title":"Point","description":""},{"path":"/docs/types/GeoMapPosition","title":"GeoMapPosition","description":""}]}]}]},{"path":"/docs/types/GeoMapGeometryMetadata","title":"GeoMapGeometryMetadata","summary":"The GeoMapGeometryMetadata type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapGeometryMetadata { bbox?: number[] }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapHeatDetail","title":"GeoMapHeatDetail","summary":"The GeoMapHeatDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapHeatDetail { path:'cpu'; bandwidth:number; cellWidth:number; cellHeight:number; columns:number; rows:number; points:number; mass:number; densityMax:number; colorMax:number; weight:'value'|'count' }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapHeatInput","title":"GeoMapHeatInput","summary":"The GeoMapHeatInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapHeatInput = boolean | GeoMapHeatOptions | null;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapHeatOptions","title":"GeoMapHeatOptions","description":""}]}]}]},{"path":"/docs/types/GeoMapHeatOptions","title":"GeoMapHeatOptions","summary":"The GeoMapHeatOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapHeatOptions {\r\n  bandwidth?:number;\r\n  cellSize?:number;\r\n  weight?:'value'|'count';\r\n  max?:number;\r\n  scheme?:string;\r\n  opacity?:number;\r\n  showPoints?:boolean;\r\n  showLegend?:boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapHeatPointDetail","title":"GeoMapHeatPointDetail","summary":"The GeoMapHeatPointDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapHeatPointDetail { density:number; longitude:number; latitude:number; cssX:number; cssY:number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","summary":"The GeoMapHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapHitDetail { kind: 'point'; nodeIndex: number; node: GeoMapPoint; cssX: number; cssY: number; value: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapPoint","title":"GeoMapPoint","description":""}]}]}]},{"path":"/docs/types/GeoMapIdentityProjection","title":"GeoMapIdentityProjection","summary":"The GeoMapIdentityProjection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapIdentityProjection {\r\n  type: 'identity';\r\n  centralMeridian?: number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapJsonValue","title":"GeoMapJsonValue","summary":"The GeoMapJsonValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapJsonValue = null | boolean | number | string | GeoMapJsonValue[] | { [key: string]: GeoMapJsonValue };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapLabel","title":"GeoMapLabel","summary":"The GeoMapLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapLabel { index: number; id: string; text: string; x: number; y: number; width: number; height: number; shown: boolean; opacity: number; color: string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapLabelMode","title":"GeoMapLabelMode","summary":"The GeoMapLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapLabelView","title":"GeoMapLabelView","summary":"The GeoMapLabelView type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapLabelView { points:GeoMapPointLabel[]; features:GeoMapFeatureLabel[] }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapPointLabel","title":"GeoMapPointLabel","description":""},{"path":"/docs/types/GeoMapFeatureLabel","title":"GeoMapFeatureLabel","description":""}]}]}]},{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","summary":"The GeoMapLayer type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapLayer = 'points' | 'polygons' | 'connections' | 'heat';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapLayerChangeEventDetail","title":"GeoMapLayerChangeEventDetail","summary":"The GeoMapLayerChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapLayerChangeEventDetail {\r\n  layers:GeoMapLayerVisibility; changed:GeoMapLayer[]; by:'legend'|'method'|'prop';\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerVisibility","title":"GeoMapLayerVisibility","description":""},{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":""}]}]}]},{"path":"/docs/types/GeoMapLayerDetail","title":"GeoMapLayerDetail","summary":"The GeoMapLayerDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapLayerDetail {\r\n  id:GeoMapLayer; label:string; visible:boolean;\r\n  count:number;\r\n  available:boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":""}]}]}]},{"path":"/docs/types/GeoMapLayerVisibility","title":"GeoMapLayerVisibility","summary":"The GeoMapLayerVisibility type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapLayerVisibility = Record<GeoMapLayer,boolean>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":""}]}]}]},{"path":"/docs/types/GeoMapLayersInput","title":"GeoMapLayersInput","summary":"The GeoMapLayersInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapLayersInput = Partial<GeoMapLayerVisibility> | null;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapLayerVisibility","title":"GeoMapLayerVisibility","description":""}]}]}]},{"path":"/docs/types/GeoMapLayoutResult","title":"GeoMapLayoutResult","summary":"The GeoMapLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapLayoutResult {\r\n  nodes: GeoMapMark[];\r\n  width: number;\r\n  height: number;\r\n  total: number;\r\n  layout: 'coordinates';\r\n  projection: GeoMapProjection;\r\n  frame: { x: number; y: number; width: number; height: number };\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapMark","title":"GeoMapMark","description":""},{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","description":""}]}]}]},{"path":"/docs/types/GeoMapMark","title":"GeoMapMark","summary":"The GeoMapMark type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapMark {\r\n  index: number;\r\n  id: string;\r\n  x: number;\r\n  y: number;\r\n  width: number;\r\n  height: number;\r\n  opacity: number;\r\n  passive?: boolean;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapMercatorProjection","title":"GeoMapMercatorProjection","summary":"The GeoMapMercatorProjection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapMercatorProjection {\r\n  type: 'mercator';\r\n  centralMeridian?: number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapOrthographicProjection","title":"GeoMapOrthographicProjection","summary":"The GeoMapOrthographicProjection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapOrthographicProjection {\r\n  type: 'orthographic';\r\n  centralMeridian?: number;\r\n  centerLatitude?: number;\r\n  roll?: number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapPickDetail","title":"GeoMapPickDetail","summary":"The GeoMapPickDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapPickDetail = GeoMapHitDetail | GeoMapFeatureHitDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapHitDetail","title":"GeoMapHitDetail","description":""},{"path":"/docs/types/GeoMapFeatureHitDetail","title":"GeoMapFeatureHitDetail","description":""}]}]}]},{"path":"/docs/types/GeoMapPoint","title":"GeoMapPoint","summary":"The GeoMapPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapPoint {\r\n  index: number;\r\n  id: string;\r\n  label: string;\r\n  longitude: number;\r\n  latitude: number;\r\n  value: number;\r\n  color: string | null;\r\n  radius?: number;\r\n  origin: 'data' | 'stream';\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","summary":"The GeoMapPointInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapPointInput {\r\n  id?: string;\r\n  label?: string;\r\n  longitude: number;\r\n  latitude: number;\r\n  value?: number;\r\n  color?: string;\r\n  radius?: number;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapPointLabel","title":"GeoMapPointLabel","summary":"The GeoMapPointLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapPointLabel extends GeoMapLabel { displayText:string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapLabel","title":"GeoMapLabel","description":""}]}]}]},{"path":"/docs/types/GeoMapPosition","title":"GeoMapPosition","summary":"The GeoMapPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapPosition = [number, number, ...number[]];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","summary":"The GeoMapProjection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapProjection = GeoMapProjectionName | GeoMapIdentityProjection | GeoMapMercatorProjection | GeoMapEquirectangularProjection | GeoMapAlbersProjection | GeoMapOrthographicProjection;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapProjectionName","title":"GeoMapProjectionName","description":""},{"path":"/docs/types/GeoMapIdentityProjection","title":"GeoMapIdentityProjection","description":""},{"path":"/docs/types/GeoMapMercatorProjection","title":"GeoMapMercatorProjection","description":""},{"path":"/docs/types/GeoMapEquirectangularProjection","title":"GeoMapEquirectangularProjection","description":""},{"path":"/docs/types/GeoMapAlbersProjection","title":"GeoMapAlbersProjection","description":""},{"path":"/docs/types/GeoMapOrthographicProjection","title":"GeoMapOrthographicProjection","description":""}]}]}]},{"path":"/docs/types/GeoMapProjectionName","title":"GeoMapProjectionName","summary":"The GeoMapProjectionName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapProjectionName = 'identity' | 'mercator' | 'equirectangular' | 'albers' | 'orthographic';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapProperties","title":"GeoMapProperties","summary":"The GeoMapProperties type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapProperties = { [key: string]: GeoMapJsonValue } | null;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapJsonValue","title":"GeoMapJsonValue","description":""}]}]}]},{"path":"/docs/types/GeoMapRegion","title":"GeoMapRegion","summary":"The GeoMapRegion type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapRegion = 'world' | 'africa' | 'asia' | 'europe' | 'north-america' | 'south-america' | 'oceania' | 'antarctica';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapRenderResult","title":"GeoMapRenderResult","summary":"The GeoMapRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapRenderResult {\r\n  points: number; drawn: number; renderMs: number;\r\n  geoMap?: {\r\n    prepareMs?:number;\r\n    layerVertices?:Record<GeoMapLayer,number>;\r\n    heat?:GeoMapHeatDetail; nodes: number; features?: number; drawn: number; vertices: number; bytes: number; uploaded: number; full: boolean; version: number; activeNode: number; chunks: number; chunkVertices: number; capacity: number; cut: number;\r\n  };\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapLayer","title":"GeoMapLayer","description":""},{"path":"/docs/types/GeoMapHeatDetail","title":"GeoMapHeatDetail","description":""}]}]}]},{"path":"/docs/types/GeoMapSelection","title":"GeoMapSelection","summary":"The GeoMapSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapSelection { nodeIndex: number; node: GeoMapPoint | null }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapPoint","title":"GeoMapPoint","description":""}]}]}]},{"path":"/docs/types/GeoMapSelectionChangeEventDetail","title":"GeoMapSelectionChangeEventDetail","summary":"The GeoMapSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapSelectionChangeEventDetail extends GeoMapSelection { by: GeoMapSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapSelection","title":"GeoMapSelection","description":""},{"path":"/docs/types/GeoMapSelectionSource","title":"GeoMapSelectionSource","description":""}]}]}]},{"path":"/docs/types/GeoMapSelectionSource","title":"GeoMapSelectionSource","summary":"The GeoMapSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapSelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/GeoMapStreamEvent","title":"GeoMapStreamEvent","summary":"The GeoMapStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapStreamEvent { type: 'push' | 'pushBatch' | 'shift' | 'replace'; count: number; entries: GeoMapDeclaration[]; replaced: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapDeclaration","title":"GeoMapDeclaration","description":""}]}]}]},{"path":"/docs/types/GeoMapStreamSource","title":"GeoMapStreamSource","summary":"The GeoMapStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapStreamSource {\r\n  readonly length: number;\r\n  readonly capacity: number;\r\n  readonly dropped: number;\r\n  push(point: GeoMapPointInput): void;\r\n  pushBatch(points: ReadonlyArray<GeoMapPointInput>): void;\r\n  shift(count: number): void;\r\n  replace(points: ReadonlyArray<GeoMapPointInput>): void;\r\n  snapshot(): GeoMapDeclaration[];\r\n  subscribe(listener: (event: GeoMapStreamEvent) => void): () => void;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapPointInput","title":"GeoMapPointInput","description":""},{"path":"/docs/types/GeoMapDeclaration","title":"GeoMapDeclaration","description":""},{"path":"/docs/types/GeoMapStreamEvent","title":"GeoMapStreamEvent","description":""}]}]}]},{"path":"/docs/types/GeoMapUnavailableBehaviour","title":"GeoMapUnavailableBehaviour","summary":"The GeoMapUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type GeoMapUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/GeoMapViewChangeEventDetail","title":"GeoMapViewChangeEventDetail","summary":"The GeoMapViewChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapViewChangeEventDetail { projection: GeoMapProjection; source: 'drag' | 'reset' | 'fit'; pan?: {x:number;y:number} }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","description":""}]}]}]},{"path":"/docs/types/GeoMapViewDetail","title":"GeoMapViewDetail","summary":"The GeoMapViewDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface GeoMapViewDetail { projection:GeoMapProjection; region:GeoMapRegion; pan:{x:number;y:number}; zoom:CartesianZoomState|null; fitted:boolean }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/GeoMapProjection","title":"GeoMapProjection","description":""},{"path":"/docs/types/GeoMapRegion","title":"GeoMapRegion","description":""},{"path":"/docs/types/CartesianZoomState","title":"CartesianZoomState","description":""}]}]}]},{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","summary":"The HeatmapAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapAreaReduce","title":"HeatmapAreaReduce","summary":"The HeatmapAreaReduce type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapAreaReduce = 'mean' | 'max';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapCategoriesInput","title":"HeatmapCategoriesInput","summary":"The HeatmapCategoriesInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapCategoriesInput = ReadonlyArray<string> | string;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapCellValue","title":"HeatmapCellValue","summary":"The HeatmapCellValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapCellValue = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapColorInput","title":"HeatmapColorInput","summary":"The HeatmapColorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapColorInput = VisualMapColorInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapColorInput","title":"VisualMapColorInput","description":""}]}]}]},{"path":"/docs/types/HeatmapData","title":"HeatmapData","summary":"The HeatmapData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapData = ReadonlyArray<HeatmapDatum | HeatmapTuple>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","description":""},{"path":"/docs/types/HeatmapTuple","title":"HeatmapTuple","description":""}]}]}]},{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","summary":"The HeatmapDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapDatum {\n  readonly x: number | string;\n  readonly y: number | string;\n  readonly value: HeatmapCellValue;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapCellValue","title":"HeatmapCellValue","description":""}]}]}]},{"path":"/docs/types/HeatmapDrawLod","title":"HeatmapDrawLod","summary":"The HeatmapDrawLod type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapDrawLod = 'point' | 'area' | 'smooth';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapDrawPath","title":"HeatmapDrawPath","summary":"The HeatmapDrawPath type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapDrawPath = 'plane' | 'cells';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","summary":"The HeatmapEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","summary":"The HeatmapEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapEngineMode = 'auto' | 'pro' | 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","summary":"The HeatmapEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapEngineTier = 'pro' | 'unavailable';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapLodMode","title":"HeatmapLodMode","summary":"The HeatmapLodMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapLodMode = 'auto' | 'point' | 'area' | 'smooth';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapMatrixInput","title":"HeatmapMatrixInput","summary":"The HeatmapMatrixInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapMatrixInput = HeatmapMatrixObject | HeatmapMatrixRows;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapMatrixObject","title":"HeatmapMatrixObject","description":""},{"path":"/docs/types/HeatmapMatrixRows","title":"HeatmapMatrixRows","description":""}]}]}]},{"path":"/docs/types/HeatmapMatrixObject","title":"HeatmapMatrixObject","summary":"The HeatmapMatrixObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapMatrixObject {\n  readonly columns: number;\n  readonly rows: number;\n  readonly values: ArrayLike<number> | ReadonlyArray<HeatmapCellValue>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapCellValue","title":"HeatmapCellValue","description":""}]}]}]},{"path":"/docs/types/HeatmapMatrixRows","title":"HeatmapMatrixRows","summary":"The HeatmapMatrixRows type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapMatrixRows = ReadonlyArray<ReadonlyArray<HeatmapCellValue> | ArrayLike<number>>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapCellValue","title":"HeatmapCellValue","description":""}]}]}]},{"path":"/docs/types/HeatmapPlaneStats","title":"HeatmapPlaneStats","summary":"The HeatmapPlaneStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapPlaneStats {\n  readonly path: HeatmapDrawPath;\n  readonly instances: number;\n  readonly lod: HeatmapDrawLod;\n  readonly reduce: HeatmapAreaReduce;\n  readonly ring?: { readonly head: number; readonly slots: number; readonly count: number };\n  readonly cellPx: { readonly width: number; readonly height: number };\n  readonly columns: number;\n  readonly rows: number;\n  readonly cells: number;\n  readonly drawn: number;\n  readonly bytes: number;\n  readonly uploaded: number;\n  readonly full: boolean;\n  readonly runs: number;\n  readonly version: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapDrawPath","title":"HeatmapDrawPath","description":""},{"path":"/docs/types/HeatmapDrawLod","title":"HeatmapDrawLod","description":""},{"path":"/docs/types/HeatmapAreaReduce","title":"HeatmapAreaReduce","description":""}]}]}]},{"path":"/docs/types/HeatmapPointEventDetail","title":"HeatmapPointEventDetail","summary":"The HeatmapPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapPointEventDetail {\n  readonly col: number;\n  readonly row: number;\n  readonly x: string;\n  readonly y: string;\n  readonly value: number | null;\n  readonly index: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapRenderPath","title":"HeatmapRenderPath","summary":"The HeatmapRenderPath type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapRenderPath = 'auto' | 'plane' | 'cells';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapRenderResult","title":"HeatmapRenderResult","summary":"The HeatmapRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapRenderResult {\n  readonly cells: number;\n  readonly drawn: number;\n  readonly renderMs: number;\n  readonly plane?: HeatmapPlaneStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapPlaneStats","title":"HeatmapPlaneStats","description":""}]}]}]},{"path":"/docs/types/HeatmapStreamEvent","title":"HeatmapStreamEvent","summary":"The HeatmapStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapStreamEvent {\n  readonly type: HeatmapStreamEventType;\n  readonly count: number;\n  readonly cells: ReadonlyArray<HeatmapDatum>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapStreamEventType","title":"HeatmapStreamEventType","description":""},{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","description":""}]}]}]},{"path":"/docs/types/HeatmapStreamEventType","title":"HeatmapStreamEventType","summary":"The HeatmapStreamEventType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapStreamEventType = 'push' | 'pushBatch' | 'shift' | 'replace';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapStreamSource","title":"HeatmapStreamSource","summary":"The HeatmapStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapStreamSource {\n  push(cell: HeatmapDatum | HeatmapTuple): void;\n  pushBatch(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): void;\n  shift(count: number): void;\n  replace(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): void;\n  snapshot(): HeatmapDatum[];\n  latest(): HeatmapDatum | undefined;\n  subscribe(listener: (event: HeatmapStreamEvent) => void): () => void;\n  readonly length: number;\n  readonly capacity: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapDatum","title":"HeatmapDatum","description":""},{"path":"/docs/types/HeatmapTuple","title":"HeatmapTuple","description":""},{"path":"/docs/types/HeatmapStreamEvent","title":"HeatmapStreamEvent","description":""}]}]}]},{"path":"/docs/types/HeatmapTuple","title":"HeatmapTuple","summary":"The HeatmapTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapTuple = readonly [x: number | string, y: number | string, value: HeatmapCellValue];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapCellValue","title":"HeatmapCellValue","description":""}]}]}]},{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","summary":"The HeatmapUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HeatmapUnavailableBehaviour = 'fallback' | 'error';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HeatmapValueExtent","title":"HeatmapValueExtent","summary":"The HeatmapValueExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HeatmapValueExtent {\n  readonly min: number;\n  readonly max: number;\n  readonly finite: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramAnimationType","title":"HistogramAnimationType","summary":"The HistogramAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramBinning","title":"HistogramBinning","summary":"The HistogramBinning type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HistogramBinning {\n  readonly rule: HistogramBinsRule | 'bin-width';\n  readonly kind: 'count' | 'width' | 'bin-width';\n  readonly count: number;\n  readonly width: number;\n  readonly n: number;\n  readonly sigma: number | null;\n  readonly iqr: number | null;\n  readonly fallback?: 'scott' | 'square-root';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HistogramBinsRule","title":"HistogramBinsRule","description":""}]}]}]},{"path":"/docs/types/HistogramBinsRule","title":"HistogramBinsRule","summary":"The HistogramBinsRule type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramBinsRule = 'square-root' | 'sturges' | 'rice' | 'scott' | 'freedman-diaconis' | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramEasing","title":"HistogramEasing","summary":"The HistogramEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramEngineMode","title":"HistogramEngineMode","summary":"The HistogramEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramEngineMode = 'auto' | HistogramEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HistogramEngineTier","title":"HistogramEngineTier","description":""}]}]}]},{"path":"/docs/types/HistogramEngineTier","title":"HistogramEngineTier","summary":"The HistogramEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramNormalize","title":"HistogramNormalize","summary":"The HistogramNormalize type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramNormalize = 'count' | 'percent' | 'density';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramPointEventDetail","title":"HistogramPointEventDetail","summary":"The HistogramPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HistogramPointEventDetail {\n  readonly binIndex: number;\n  readonly x0: number;\n  readonly x1: number;\n  readonly count: number;\n  readonly value: number;\n  readonly measure: HistogramNormalize;\n  readonly cumulative: boolean;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HistogramNormalize","title":"HistogramNormalize","description":""}]}]}]},{"path":"/docs/types/HistogramProDrawStats","title":"HistogramProDrawStats","summary":"The HistogramProDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HistogramProDrawStats {\n  readonly bars: number;\n  readonly vertices: number;\n  readonly bytes: number;\n  readonly edgePx: number;\n  readonly uploaded: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramRenderResult","title":"HistogramRenderResult","summary":"The HistogramRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HistogramRenderResult {\n  readonly points: number;\n  readonly bins: number;\n  readonly renderMs: number;\n  readonly pro?: HistogramProDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HistogramProDrawStats","title":"HistogramProDrawStats","description":""}]}]}]},{"path":"/docs/types/HistogramStreamDatum","title":"HistogramStreamDatum","summary":"The HistogramStreamDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HistogramStreamDatum {\n  value: number;\n  category?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramStreamEvent","title":"HistogramStreamEvent","summary":"The HistogramStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramStreamSource","title":"HistogramStreamSource","summary":"The HistogramStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface HistogramStreamSource {\n  push(datum: HistogramStreamDatum | number): void;\n  pushBatch(data: ReadonlyArray<HistogramStreamDatum | number>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<HistogramStreamDatum | number>): void;\n  snapshot(window?: number): HistogramStreamDatum[];\n  latest(): HistogramStreamDatum | undefined;\n  subscribe(listener: (event: HistogramStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HistogramStreamDatum","title":"HistogramStreamDatum","description":""},{"path":"/docs/types/HistogramStreamEvent","title":"HistogramStreamEvent","description":""}]}]}]},{"path":"/docs/types/HistogramUnavailableBehaviour","title":"HistogramUnavailableBehaviour","summary":"The HistogramUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramUnavailableBehaviour = 'fallback' | 'error';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/HistogramValues","title":"HistogramValues","summary":"The HistogramValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type HistogramValues = Float32Array | ReadonlyArray<number | null | undefined>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleAnimationType","title":"IcicleAnimationType","summary":"The IcicleAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/IcicleData","title":"IcicleData","summary":"The IcicleData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleData = IcicleNodeInput | ReadonlyArray<IcicleNodeInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":""}]}]}]},{"path":"/docs/types/IcicleDirection","title":"IcicleDirection","summary":"The IcicleDirection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleDirection = 'top-down' | 'bottom-up' | 'left-right' | 'right-left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleDrillChangeEventDetail","title":"IcicleDrillChangeEventDetail","summary":"The IcicleDrillChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleDrillChangeEventDetail { rootId: string | null; previousRootId: string | null; by: IcicleSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleSelectionSource","title":"IcicleSelectionSource","description":""}]}]}]},{"path":"/docs/types/IcicleEasing","title":"IcicleEasing","summary":"The IcicleEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/IcicleEngineMode","title":"IcicleEngineMode","summary":"The IcicleEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/IcicleEngineTier","title":"IcicleEngineTier","summary":"The IcicleEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/IcicleExtent","title":"IcicleExtent","summary":"The IcicleExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleExtent { nodes: number; leaves: number; total: number; depth: number; valueMax: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleHitDetail","title":"IcicleHitDetail","summary":"The IcicleHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleHitDetail {\n  kind: 'node';\n  nodeIndex: number;\n  node: IcicleNode;\n  cssX: number;\n  cssY: number;\n  value: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":""}]}]}]},{"path":"/docs/types/IcicleLabel","title":"IcicleLabel","summary":"The IcicleLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleLabel { index: number; id: string; text: string; x: number; y: number; width: number; height: number; shown: boolean; opacity: number; color: string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleLabelMode","title":"IcicleLabelMode","summary":"The IcicleLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleLayout","title":"IcicleLayout","summary":"The IcicleLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleLayout = 'partition';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleLayoutResult","title":"IcicleLayoutResult","summary":"The IcicleLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleLayoutResult {\n  nodes: IcicleRect[];\n  width: number;\n  height: number;\n  total: number;\n  rootId: string | null;\n  layout: IcicleLayout;\n  direction: IcicleDirection;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleRect","title":"IcicleRect","description":""},{"path":"/docs/types/IcicleLayout","title":"IcicleLayout","description":""},{"path":"/docs/types/IcicleDirection","title":"IcicleDirection","description":""}]}]}]},{"path":"/docs/types/IcicleNode","title":"IcicleNode","summary":"The IcicleNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleNode {\n  index: number;\n  id: string;\n  label: string;\n  color: string | null;\n  parent: number | null;\n  children: number[];\n  depth: number;\n  ownValue: number;\n  value: number;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","summary":"The IcicleNodeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleNodeInput {\n  id: string;\n  label?: string;\n  color?: string;\n  parent?: string | null;\n  value?: number;\n  children?: ReadonlyArray<IcicleNodeInput>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleRect","title":"IcicleRect","summary":"The IcicleRect type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleRect {\n  index: number;\n  id: string;\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n  depth: number;\n  opacity: number;\n  passive?: boolean;\n  paintOrder?:number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleRenderResult","title":"IcicleRenderResult","summary":"The IcicleRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  icicle?: { nodes: number; drawn: number; vertices: number; bytes: number; uploaded: number; full: boolean; version: number; activeNode: number; chunks: number; chunkVertices: number; capacity: number; cut: number };\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleSelection","title":"IcicleSelection","summary":"The IcicleSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleSelection { nodeIndex: number; node: IcicleNode | null }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleNode","title":"IcicleNode","description":""}]}]}]},{"path":"/docs/types/IcicleSelectionChangeEventDetail","title":"IcicleSelectionChangeEventDetail","summary":"The IcicleSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleSelectionChangeEventDetail extends IcicleSelection { by: IcicleSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleSelection","title":"IcicleSelection","description":""},{"path":"/docs/types/IcicleSelectionSource","title":"IcicleSelectionSource","description":""}]}]}]},{"path":"/docs/types/IcicleSelectionSource","title":"IcicleSelectionSource","summary":"The IcicleSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleSelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IcicleStreamEvent","title":"IcicleStreamEvent","summary":"The IcicleStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: IcicleNodeInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":""}]}]}]},{"path":"/docs/types/IcicleStreamSource","title":"IcicleStreamSource","summary":"The IcicleStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IcicleStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(node: IcicleNodeInput): void;\n  pushBatch(nodes: ReadonlyArray<IcicleNodeInput>): void;\n  shift(count: number): void;\n  replace(nodes: ReadonlyArray<IcicleNodeInput>): void;\n  snapshot(): IcicleNodeInput[];\n  subscribe(listener: (event: IcicleStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IcicleNodeInput","title":"IcicleNodeInput","description":""},{"path":"/docs/types/IcicleStreamEvent","title":"IcicleStreamEvent","description":""}]}]}]},{"path":"/docs/types/IcicleUnavailableBehaviour","title":"IcicleUnavailableBehaviour","summary":"The IcicleUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IcicleUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/IndicatorBandSpec","title":"IndicatorBandSpec","summary":"The IndicatorBandSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IndicatorBandSpec {\n  readonly upper: string;\n  readonly lower: string;\n  readonly color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IndicatorColumns","title":"IndicatorColumns","summary":"The IndicatorColumns type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IndicatorColumns = Readonly<Record<string, ReadonlyArray<number | null>>>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IndicatorDefinition","title":"IndicatorDefinition","summary":"The IndicatorDefinition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IndicatorDefinition {\n  readonly kind: string;\n  readonly label: string;\n  readonly placement: IndicatorPlacement;\n  readonly defaults: Readonly<Record<string, number>>;\n  readonly outputs: ReadonlyArray<IndicatorOutputSpec>;\n  readonly bands?: ReadonlyArray<IndicatorBandSpec>;\n  readonly compute: (bars: ReadonlyArray<StockBar>, params: Record<string, number>) => IndicatorColumns;\n  readonly guides?: ReadonlyArray<number>;\n  readonly guideBand?: readonly [number, number];\n  readonly computeLevels?: (\n    bars: ReadonlyArray<StockBar>,\n    from: number,\n    to: number,\n    params: Record<string, number>,\n  ) => IndicatorLevel[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IndicatorPlacement","title":"IndicatorPlacement","description":""},{"path":"/docs/types/IndicatorOutputSpec","title":"IndicatorOutputSpec","description":""},{"path":"/docs/types/IndicatorBandSpec","title":"IndicatorBandSpec","description":""},{"path":"/docs/types/IndicatorColumns","title":"IndicatorColumns","description":""},{"path":"/docs/types/IndicatorLevel","title":"IndicatorLevel","description":""}]}]}]},{"path":"/docs/types/IndicatorLevel","title":"IndicatorLevel","summary":"The IndicatorLevel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IndicatorLevel {\n  readonly price0: number;\n  readonly price1: number;\n  readonly weightUp: number;\n  readonly weightDown: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IndicatorOutputSpec","title":"IndicatorOutputSpec","summary":"The IndicatorOutputSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface IndicatorOutputSpec {\n  readonly key: string;\n  readonly style: IndicatorOutputStyle;\n  readonly color?: string;\n  readonly width?: number;\n  readonly signed?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/IndicatorOutputStyle","title":"IndicatorOutputStyle","description":""}]}]}]},{"path":"/docs/types/IndicatorOutputStyle","title":"IndicatorOutputStyle","summary":"The IndicatorOutputStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IndicatorOutputStyle = 'line' | 'area' | 'histogram' | 'points';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/IndicatorPlacement","title":"IndicatorPlacement","summary":"The IndicatorPlacement type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type IndicatorPlacement = 'overlay' | 'pane';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartAnimationType","title":"ItemChartAnimationType","summary":"The ItemChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","summary":"The ItemChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartDatum =\n  | number\n  | {\n      readonly name?: string;\n      readonly value: number;\n      readonly color?: string;\n      readonly symbol?: ItemChartSymbol;\n      readonly visible?: boolean;\n      readonly id?: string | number;\n      readonly label?: string;\n    };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartSymbol","title":"ItemChartSymbol","description":""}]}]}]},{"path":"/docs/types/ItemChartEasing","title":"ItemChartEasing","summary":"The ItemChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartEngineMode","title":"ItemChartEngineMode","summary":"The ItemChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartEngineTier","title":"ItemChartEngineTier","summary":"The ItemChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartLegendPosition","title":"ItemChartLegendPosition","summary":"The ItemChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartPaletteName","title":"ItemChartPaletteName","summary":"The ItemChartPaletteName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartPaletteName = 'tableau10' | 'tableau20' | 'observable10' | 'paired12' | 'set3_12';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartPointEventDetail","title":"ItemChartPointEventDetail","summary":"The ItemChartPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartPointEventDetail {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly label?: string;\n  readonly value: number;\n  readonly percentage: number;\n  readonly color: string;\n  readonly seatIndex?: number;\n  readonly seatInParty?: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartRenderResult","title":"ItemChartRenderResult","summary":"The ItemChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartRenderResult {\n  readonly seats: number;\n  readonly parties: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartResolvedParty","title":"ItemChartResolvedParty","summary":"The ItemChartResolvedParty type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartResolvedParty {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly label?: string;\n  readonly value: number;\n  readonly percentage: number;\n  readonly color: string;\n  readonly symbol: ItemChartSymbol;\n  readonly visible: boolean;\n  readonly firstSeat: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartSymbol","title":"ItemChartSymbol","description":""}]}]}]},{"path":"/docs/types/ItemChartStreamEvent","title":"ItemChartStreamEvent","summary":"The ItemChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartStreamSource","title":"ItemChartStreamSource","summary":"The ItemChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartStreamSource {\n  push(datum: ItemChartDatum): void;\n  pushBatch(datums: ReadonlyArray<ItemChartDatum>): void;\n  shift(count: number): void;\n  replace(datums: ReadonlyArray<ItemChartDatum>): void;\n  snapshot(window?: number): ItemChartDatum[];\n  subscribe(listener: (event: ItemChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":""},{"path":"/docs/types/ItemChartStreamEvent","title":"ItemChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/ItemChartSymbol","title":"ItemChartSymbol","summary":"The ItemChartSymbol type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartSymbol = 'circle' | 'square' | 'diamond';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartTooltipActionEventDetail","title":"ItemChartTooltipActionEventDetail","summary":"The ItemChartTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartTooltipActionEventDetail extends ItemChartTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipFormatContext","title":"ItemChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/ItemChartTooltipConnectorInput","title":"ItemChartTooltipConnectorInput","summary":"The ItemChartTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<ItemChartTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipConnectorSpec","title":"ItemChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/ItemChartTooltipConnectorSpec","title":"ItemChartTooltipConnectorSpec","summary":"The ItemChartTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartTooltipFormatContext","title":"ItemChartTooltipFormatContext","summary":"The ItemChartTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartTooltipFormatContext {\n  index: number;\n  id: string;\n  name: string;\n  label?: string;\n  value: number;\n  percentage: number;\n  seatIndex?: number;\n  seatInParty?: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartTooltipInput","title":"ItemChartTooltipInput","summary":"The ItemChartTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | ItemChartTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipObjectInput","title":"ItemChartTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/ItemChartTooltipObjectInput","title":"ItemChartTooltipObjectInput","summary":"The ItemChartTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipObjectInput = Omit<Partial<ItemChartTooltipSpec>, 'connector'> & {\n  connector?: ItemChartTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipSpec","title":"ItemChartTooltipSpec","description":""},{"path":"/docs/types/ItemChartTooltipConnectorInput","title":"ItemChartTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/ItemChartTooltipOpenMode","title":"ItemChartTooltipOpenMode","summary":"The ItemChartTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartTooltipShowEventDetail","title":"ItemChartTooltipShowEventDetail","summary":"The ItemChartTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: ItemChartTooltipSide;\n  text: string;\n  html?: string;\n  context?: ItemChartTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipSide","title":"ItemChartTooltipSide","description":""},{"path":"/docs/types/ItemChartTooltipFormatContext","title":"ItemChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/ItemChartTooltipSide","title":"ItemChartTooltipSide","summary":"The ItemChartTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartTooltipSpec","title":"ItemChartTooltipSpec","summary":"The ItemChartTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ItemChartTooltipSpec {\n  show: boolean;\n  openMode: ItemChartTooltipOpenMode;\n  trigger: ItemChartTooltipTrigger;\n  side?: ItemChartTooltipSide;\n  offset: number;\n  format?: (party: ItemChartResolvedParty, context?: ItemChartTooltipFormatContext) => string;\n  html?: (party: ItemChartResolvedParty, context?: ItemChartTooltipFormatContext) => string;\n  className?: string;\n  style?: ItemChartTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: ItemChartTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipOpenMode","title":"ItemChartTooltipOpenMode","description":""},{"path":"/docs/types/ItemChartTooltipTrigger","title":"ItemChartTooltipTrigger","description":""},{"path":"/docs/types/ItemChartTooltipSide","title":"ItemChartTooltipSide","description":""},{"path":"/docs/types/ItemChartResolvedParty","title":"ItemChartResolvedParty","description":""},{"path":"/docs/types/ItemChartTooltipFormatContext","title":"ItemChartTooltipFormatContext","description":""},{"path":"/docs/types/ItemChartTooltipStyle","title":"ItemChartTooltipStyle","description":""},{"path":"/docs/types/ItemChartTooltipConnectorSpec","title":"ItemChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/ItemChartTooltipStyle","title":"ItemChartTooltipStyle","summary":"The ItemChartTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipStyle = Record<string, ItemChartTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartTooltipStyleValue","title":"ItemChartTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/ItemChartTooltipStyleValue","title":"ItemChartTooltipStyleValue","summary":"The ItemChartTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartTooltipTrigger","title":"ItemChartTooltipTrigger","summary":"The ItemChartTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ItemChartUnavailableBehaviour","title":"ItemChartUnavailableBehaviour","summary":"The ItemChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/ItemChartValues","title":"ItemChartValues","summary":"The ItemChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ItemChartValues = ReadonlyArray<ItemChartDatum>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ItemChartDatum","title":"ItemChartDatum","description":""}]}]}]},{"path":"/docs/types/LegendItem","title":"LegendItem","summary":"The LegendItem type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LegendItem {\n  label: string;\n  swatchColor: string;\n  swatchShape?: 'square' | 'circle' | 'line';\n  disabled?: boolean;\n  seriesIndex?: number;\n  id?: string | number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartAnimationType","title":"LineChartAnimationType","summary":"The LineChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartDatum","title":"LineChartDatum","summary":"The LineChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartEasing","title":"LineChartEasing","summary":"The LineChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartEngineMode","title":"LineChartEngineMode","summary":"The LineChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartEngineMode = 'auto' | LineChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LineChartEngineTier","title":"LineChartEngineTier","description":""}]}]}]},{"path":"/docs/types/LineChartEngineTier","title":"LineChartEngineTier","summary":"The LineChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartFrameBudgetEventDetail","title":"LineChartFrameBudgetEventDetail","summary":"The LineChartFrameBudgetEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartFrameBudgetEventDetail {\n  readonly kind: 'skipped' | 'exceeded';\n  readonly reason?: 'over-budget' | 'gpu-backlog';\n  readonly ms: number;\n  readonly budgetMs: number;\n  readonly skipped: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartFrameBudgetInfo","title":"LineChartFrameBudgetInfo","summary":"The LineChartFrameBudgetInfo type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartFrameBudgetInfo {\n  readonly ms: number;\n  readonly budgetMs: number;\n  readonly exceeded: boolean;\n  readonly skippedBefore: number;\n  readonly gpuBacklog: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartLegendItemEventDetail","title":"LineChartLegendItemEventDetail","summary":"The LineChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartLegendItemEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartLegendPosition","title":"LineChartLegendPosition","summary":"The LineChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartMarker","title":"LineChartMarker","summary":"The LineChartMarker type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartMarker =\n  | 'none'\n  | 'circle'\n  | 'square'\n  | 'triangle'\n  | 'cross'\n  | 'diamond'\n  | 'star';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartMarkerActiveTrigger","title":"LineChartMarkerActiveTrigger","summary":"The LineChartMarkerActiveTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartMarkerActiveTrigger = 'hover' | 'click' | 'custom';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartMarkerFilter","title":"LineChartMarkerFilter","summary":"The LineChartMarkerFilter type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartMarkerFilter = (index: number, value: number) => boolean;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartPointEventDetail","title":"LineChartPointEventDetail","summary":"The LineChartPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartPointEventDetail extends CartesianPointEventDetail {\n  index: number;\n  distancePx?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianPointEventDetail","title":"CartesianPointEventDetail","description":""}]}]}]},{"path":"/docs/types/LineChartRenderResult","title":"LineChartRenderResult","summary":"The LineChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartRenderResult {\n  points: number;\n  renderMs: number;\n  ring?: LineChartRingRenderStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LineChartRingRenderStats","title":"LineChartRingRenderStats","description":""}]}]}]},{"path":"/docs/types/LineChartRingRenderStats","title":"LineChartRingRenderStats","summary":"The LineChartRingRenderStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartRingRenderStats {\n  readonly path: 'ring';\n  readonly uploads: number;\n  readonly bytes: number;\n  readonly full: boolean;\n  readonly visible: number;\n  readonly capacity: number;\n  readonly requests: number;\n  readonly writes: number;\n  readonly skippedBytes: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartSeries","title":"LineChartSeries","summary":"The LineChartSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartSeries extends Omit<CartesianSeriesBase<LineChartValues>, 'values' | 'marker'> {\n  values?: LineChartValues;\n  thickness?: number;\n  marker?: LineChartMarker | CartesianSeriesMarkerInput;\n  markerSize?: number;\n  markerFilter?: LineChartMarkerFilter;\n  lineDash?: number[];\n  smooth?: LineChartSmooth;\n  smoothTension?: number;\n  step?: LineChartStep;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","description":""},{"path":"/docs/types/LineChartValues","title":"LineChartValues","description":""},{"path":"/docs/types/LineChartMarker","title":"LineChartMarker","description":""},{"path":"/docs/types/CartesianSeriesMarkerInput","title":"CartesianSeriesMarkerInput","description":""},{"path":"/docs/types/LineChartMarkerFilter","title":"LineChartMarkerFilter","description":""},{"path":"/docs/types/LineChartSmooth","title":"LineChartSmooth","description":""},{"path":"/docs/types/LineChartStep","title":"LineChartStep","description":""}]}]}]},{"path":"/docs/types/LineChartSeriesStateOptions","title":"LineChartSeriesStateOptions","summary":"The LineChartSeriesStateOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartSeriesStateOptions {\n  enabled?: boolean;\n  inactive?: LineChartSeriesStateStyle;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LineChartSeriesStateStyle","title":"LineChartSeriesStateStyle","description":""}]}]}]},{"path":"/docs/types/LineChartSeriesStateStyle","title":"LineChartSeriesStateStyle","summary":"The LineChartSeriesStateStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartSeriesStateStyle {\n  opacity?: number;\n  thickness?: number;\n  markerSize?: number;\n  thicknessScale?: number;\n  markerSizeScale?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartSeriesToggledEventDetail","title":"LineChartSeriesToggledEventDetail","summary":"The LineChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartSeriesToggledEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartSmooth","title":"LineChartSmooth","summary":"The LineChartSmooth type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartSmooth = 'none' | 'monotone' | 'cardinal';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartStep","title":"LineChartStep","summary":"The LineChartStep type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartStep = 'none' | 'left' | 'center' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartStreamEvent","title":"LineChartStreamEvent","summary":"The LineChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartStreamFrameInfo","title":"LineChartStreamFrameInfo","summary":"The LineChartStreamFrameInfo type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartStreamFrameInfo {\n  readonly mode: 'absolute' | 'last-n' | 'all';\n  readonly visible: number;\n  readonly lazy: boolean;\n  readonly materialized: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartStreamSource","title":"LineChartStreamSource","summary":"The LineChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LineChartStreamSource {\n  push(value: number): void;\n  pushBatch(values: ReadonlyArray<number> | Float32Array): void;\n  shift(count: number): void;\n  replace(values: ReadonlyArray<number> | Float32Array): void;\n  snapshot(window?: number): Float32Array;\n  subscribe(listener: (event: LineChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LineChartStreamEvent","title":"LineChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/LineChartUnavailableBehaviour","title":"LineChartUnavailableBehaviour","summary":"The LineChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartUnavailableBehaviour = 'fallback' | 'error';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LineChartValues","title":"LineChartValues","summary":"The LineChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LineChartValues = Float32Array | LineChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LineChartDatum","title":"LineChartDatum","description":""}]}]}]},{"path":"/docs/types/LollipopBarDatum","title":"LollipopBarDatum","summary":"The LollipopBarDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LollipopBarDatum {\n  value: number;\n  category?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartAnimationType","title":"LollipopChartAnimationType","summary":"The LollipopChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartDatum","title":"LollipopChartDatum","summary":"The LollipopChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartEasing","title":"LollipopChartEasing","summary":"The LollipopChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartEngineMode","title":"LollipopChartEngineMode","summary":"The LollipopChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartEngineMode = 'auto' | LollipopChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LollipopChartEngineTier","title":"LollipopChartEngineTier","description":""}]}]}]},{"path":"/docs/types/LollipopChartEngineTier","title":"LollipopChartEngineTier","summary":"The LollipopChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartPointerEventDetail","title":"LollipopChartPointerEventDetail","summary":"The LollipopChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LollipopChartPointerEventDetail {\n  index: number;\n  category: string;\n  value: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartRenderResult","title":"LollipopChartRenderResult","summary":"The LollipopChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LollipopChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartStreamEvent","title":"LollipopChartStreamEvent","summary":"The LollipopChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopChartStreamSource","title":"LollipopChartStreamSource","summary":"The LollipopChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface LollipopChartStreamSource {\n  push(datum: LollipopBarDatum | number): void;\n  pushBatch(data: ReadonlyArray<LollipopBarDatum | number>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<LollipopBarDatum | number>): void;\n  snapshot(window?: number): LollipopBarDatum[];\n  latest(): LollipopBarDatum | undefined;\n  subscribe(listener: (event: LollipopChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LollipopBarDatum","title":"LollipopBarDatum","description":""},{"path":"/docs/types/LollipopChartStreamEvent","title":"LollipopChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/LollipopChartUnavailableBehaviour","title":"LollipopChartUnavailableBehaviour","summary":"The LollipopChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/LollipopChartValues","title":"LollipopChartValues","summary":"The LollipopChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopChartValues = Float32Array | LollipopChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/LollipopChartDatum","title":"LollipopChartDatum","description":""}]}]}]},{"path":"/docs/types/LollipopMarkerSymbol","title":"LollipopMarkerSymbol","summary":"The LollipopMarkerSymbol type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopMarkerSymbol = 'circle' | 'square' | 'diamond' | 'triangle';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/LollipopOrientation","title":"LollipopOrientation","summary":"The LollipopOrientation type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type LollipopOrientation = 'vertical' | 'horizontal';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartAnimationType","title":"MarimekkoChartAnimationType","summary":"The MarimekkoChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type MarimekkoChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartEasing","title":"MarimekkoChartEasing","summary":"The MarimekkoChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type MarimekkoChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartEngineMode","title":"MarimekkoChartEngineMode","summary":"The MarimekkoChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type MarimekkoChartEngineMode = 'auto' | MarimekkoChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/MarimekkoChartEngineTier","title":"MarimekkoChartEngineTier","description":""}]}]}]},{"path":"/docs/types/MarimekkoChartEngineTier","title":"MarimekkoChartEngineTier","summary":"The MarimekkoChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type MarimekkoChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartLegendItemEventDetail","title":"MarimekkoChartLegendItemEventDetail","summary":"The MarimekkoChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface MarimekkoChartLegendItemEventDetail {\n  index: number;\n  seriesId: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartLegendPosition","title":"MarimekkoChartLegendPosition","summary":"The MarimekkoChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type MarimekkoChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartPointerEventDetail","title":"MarimekkoChartPointerEventDetail","summary":"The MarimekkoChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface MarimekkoChartPointerEventDetail {\n  columnIndex: number;\n  seriesIndex: number;\n  category: string;\n  seriesName: string;\n  value: number;\n  shareOfColumn: number;\n  shareOfTotal: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartRenderResult","title":"MarimekkoChartRenderResult","summary":"The MarimekkoChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface MarimekkoChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartStreamEvent","title":"MarimekkoChartStreamEvent","summary":"The MarimekkoChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type MarimekkoChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoChartStreamSource","title":"MarimekkoChartStreamSource","summary":"The MarimekkoChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface MarimekkoChartStreamSource {\n  push(datum: MarimekkoColumnDatum): void;\n  pushBatch(data: ReadonlyArray<MarimekkoColumnDatum>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<MarimekkoColumnDatum>): void;\n  snapshot(window?: number): MarimekkoColumnDatum[];\n  latest(): MarimekkoColumnDatum | undefined;\n  subscribe(listener: (event: MarimekkoChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/MarimekkoColumnDatum","title":"MarimekkoColumnDatum","description":""},{"path":"/docs/types/MarimekkoChartStreamEvent","title":"MarimekkoChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/MarimekkoChartUnavailableBehaviour","title":"MarimekkoChartUnavailableBehaviour","summary":"The MarimekkoChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type MarimekkoChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/MarimekkoColumnDatum","title":"MarimekkoColumnDatum","summary":"The MarimekkoColumnDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface MarimekkoColumnDatum {\n  category?: string;\n  values: ReadonlyArray<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/MarimekkoSeries","title":"MarimekkoSeries","summary":"The MarimekkoSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface MarimekkoSeries {\n  name: string;\n  color?: string;\n  values: ReadonlyArray<number> | Float32Array;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NavigatorSampling","title":"NavigatorSampling","summary":"The NavigatorSampling type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NavigatorSampling = 'minmax' | 'lttb';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NavigatorTargetElement","title":"NavigatorTargetElement","summary":"The NavigatorTargetElement type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NavigatorTargetElement extends DataZoomTargetElement {\n  series?: ReadonlyArray<CartesianSeriesBase>;\n  values?: unknown;\n  color?: unknown;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DataZoomTargetElement","title":"DataZoomTargetElement","description":""},{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","description":""}]}]}]},{"path":"/docs/types/NetworkGraphAnimationType","title":"NetworkGraphAnimationType","summary":"The NetworkGraphAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/NetworkGraphBundling","title":"NetworkGraphBundling","summary":"The NetworkGraphBundling type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphBundling = 'none' | 'force';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphBundlingStats","title":"NetworkGraphBundlingStats","summary":"The NetworkGraphBundlingStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphBundlingStats {\n  algorithm: 'force-directed';\n  bundles: number;\n  compatiblePairs: number;\n  cycles: number;\n  iterations: number;\n  points: number;\n  workUsed: number;\n  workBudget: number;\n  stopReason: 'complete' | 'budget';\n  strength: number;\n  compatibility: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphCluster","title":"NetworkGraphCluster","summary":"The NetworkGraphCluster type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphCluster {\n  id: string;\n  nodeIds: string[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphClustering","title":"NetworkGraphClustering","summary":"The NetworkGraphClustering type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphClustering = 'none' | 'louvain';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphClusteringResult","title":"NetworkGraphClusteringResult","summary":"The NetworkGraphClusteringResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphClusteringResult {\n  clusters: NetworkGraphCluster[];\n  stats: NetworkGraphClusteringStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphCluster","title":"NetworkGraphCluster","description":""},{"path":"/docs/types/NetworkGraphClusteringStats","title":"NetworkGraphClusteringStats","description":""}]}]}]},{"path":"/docs/types/NetworkGraphClusteringStats","title":"NetworkGraphClusteringStats","summary":"The NetworkGraphClusteringStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphClusteringStats {\n  algorithm: 'louvain';\n  clusterCount: number;\n  modularity: number;\n  levels: number;\n  passes: number;\n  moves: number;\n  stopReason: 'stable' | 'limit' | 'budget' | 'edgeless';\n  workUsed: number;\n  workBudget: number;\n  disconnectedSplits: number;\n  weightScale: number;\n  underflowedLinks: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphData","title":"NetworkGraphData","summary":"The NetworkGraphData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphData = NetworkGraphGraphInput | ReadonlyArray<NetworkGraphLinkInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphGraphInput","title":"NetworkGraphGraphInput","description":""},{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":""}]}]}]},{"path":"/docs/types/NetworkGraphDragSource","title":"NetworkGraphDragSource","summary":"The NetworkGraphDragSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphDragSource = 'pointer' | 'keyboard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphDrawStats","title":"NetworkGraphDrawStats","summary":"The NetworkGraphDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphDrawStats {\n  nodes: number;\n  links: number;\n  drawn: number;\n  vertices: number;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  activeNode: number;\n  activeLink: number;\n  colored: number;\n  chunks: number;\n  chunkVertices: number;\n  capacity: number;\n  cut: number;\n  drawnNodes: number;\n  drawnLinks: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphEasing","title":"NetworkGraphEasing","summary":"The NetworkGraphEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/NetworkGraphEngineMode","title":"NetworkGraphEngineMode","summary":"The NetworkGraphEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/NetworkGraphEngineTier","title":"NetworkGraphEngineTier","summary":"The NetworkGraphEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/NetworkGraphExtent","title":"NetworkGraphExtent","summary":"The NetworkGraphExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphExtent {\n  nodes: number;\n  links: number;\n  total: number;\n  valueMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphForceStats","title":"NetworkGraphForceStats","summary":"The NetworkGraphForceStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphForceStats {\n  algorithm: 'exact' | 'barnes-hut';\n  theta: number;\n  iterations: number;\n  requestedIterations: number;\n  converged: boolean;\n  maxDisplacement: number;\n  stopReason: 'converged' | 'iterations' | 'budget';\n  pairInteractions: number;\n  springInteractions: number;\n  workUsed: number;\n  attemptedIterations: number;\n  treeBuildVisits: number;\n  cellVisits: number;\n  leafInteractions: number;\n  collisionPairs: number;\n  workBudget: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphGraphInput","title":"NetworkGraphGraphInput","summary":"The NetworkGraphGraphInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphGraphInput {\n  nodes?: ReadonlyArray<NetworkGraphNodeInput>;\n  links: ReadonlyArray<NetworkGraphLinkInput>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeInput","title":"NetworkGraphNodeInput","description":""},{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":""}]}]}]},{"path":"/docs/types/NetworkGraphHierarchicalStats","title":"NetworkGraphHierarchicalStats","summary":"The NetworkGraphHierarchicalStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphHierarchicalStats {\n  componentCount: number;\n  sccCount: number;\n  layerCount: number;\n  cyclicComponentCount: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphHitDetail","title":"NetworkGraphHitDetail","summary":"The NetworkGraphHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphHitDetail = NetworkGraphNodeEventDetail | NetworkGraphLinkEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":""},{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","description":""}]}]}]},{"path":"/docs/types/NetworkGraphLabelMode","title":"NetworkGraphLabelMode","summary":"The NetworkGraphLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphLayout","title":"NetworkGraphLayout","summary":"The NetworkGraphLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphLayout = 'circular' | 'force' | 'hierarchical';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphLayoutLink","title":"NetworkGraphLayoutLink","summary":"The NetworkGraphLayoutLink type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphLayoutLink {\n  index: number;\n  points: NetworkGraphPoint[];\n  width: number;\n  scaleX?: number;\n  scaleY?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphPoint","title":"NetworkGraphPoint","description":""}]}]}]},{"path":"/docs/types/NetworkGraphLayoutNode","title":"NetworkGraphLayoutNode","summary":"The NetworkGraphLayoutNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphLayoutNode {\n  index: number;\n  x: number;\n  y: number;\n  radius: number;\n  scaleX?: number;\n  scaleY?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphLayoutResult","title":"NetworkGraphLayoutResult","summary":"The NetworkGraphLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphLayoutResult {\n  nodes: NetworkGraphLayoutNode[];\n  links: NetworkGraphLayoutLink[];\n  width: number;\n  height: number;\n  nodeRadius: number;\n  linkWidth: number;\n  layout: NetworkGraphLayout;\n  total: number;\n  force?: NetworkGraphForceStats;\n  hierarchical?: NetworkGraphHierarchicalStats;\n  bundling?: NetworkGraphBundlingStats;\n  pinned?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLayoutNode","title":"NetworkGraphLayoutNode","description":""},{"path":"/docs/types/NetworkGraphLayoutLink","title":"NetworkGraphLayoutLink","description":""},{"path":"/docs/types/NetworkGraphLayout","title":"NetworkGraphLayout","description":""},{"path":"/docs/types/NetworkGraphForceStats","title":"NetworkGraphForceStats","description":""},{"path":"/docs/types/NetworkGraphHierarchicalStats","title":"NetworkGraphHierarchicalStats","description":""},{"path":"/docs/types/NetworkGraphBundlingStats","title":"NetworkGraphBundlingStats","description":""}]}]}]},{"path":"/docs/types/NetworkGraphLink","title":"NetworkGraphLink","summary":"The NetworkGraphLink type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphLink {\n  index: number;\n  key: string;\n  id: string | null;\n  source: number;\n  target: number;\n  sourceId: string;\n  targetId: string;\n  value: number;\n  color: string | null;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","summary":"The NetworkGraphLinkEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphLinkEventDetail {\n  kind: 'link';\n  key: string;\n  id: string | null;\n  index: number;\n  source: string;\n  target: string;\n  sourceIndex: number;\n  targetIndex: number;\n  value: number;\n  selected: boolean;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","summary":"The NetworkGraphLinkInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphLinkInput = NetworkGraphLinkObject | NetworkGraphLinkTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkObject","title":"NetworkGraphLinkObject","description":""},{"path":"/docs/types/NetworkGraphLinkTuple","title":"NetworkGraphLinkTuple","description":""}]}]}]},{"path":"/docs/types/NetworkGraphLinkObject","title":"NetworkGraphLinkObject","summary":"The NetworkGraphLinkObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphLinkObject {\n  id?: string;\n  source: string;\n  target: string;\n  value?: number;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphLinkTuple","title":"NetworkGraphLinkTuple","summary":"The NetworkGraphLinkTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphLinkTuple = readonly [source: string, target: string, value?: number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphNode","title":"NetworkGraphNode","summary":"The NetworkGraphNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphNode {\n  index: number;\n  id: string;\n  label: string;\n  value: number;\n  inValue: number;\n  outValue: number;\n  color: string | null;\n  sourceLinks: number[];\n  targetLinks: number[];\n  declared: boolean;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphNodeDragEventDetail","title":"NetworkGraphNodeDragEventDetail","summary":"The NetworkGraphNodeDragEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphNodeDragEventDetail extends NetworkGraphNodeEventDetail {\n  x: number;\n  y: number;\n  startX: number;\n  startY: number;\n  pointerType: string;\n  by: NetworkGraphDragSource;\n  pinned: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":""},{"path":"/docs/types/NetworkGraphDragSource","title":"NetworkGraphDragSource","description":""}]}]}]},{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","summary":"The NetworkGraphNodeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphNodeEventDetail {\n  kind: 'node';\n  index: number;\n  id: string;\n  label: string;\n  value: number;\n  inValue: number;\n  outValue: number;\n  links: number;\n  sourceIds: string[];\n  targetIds: string[];\n  selected: boolean;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphNodeInput","title":"NetworkGraphNodeInput","summary":"The NetworkGraphNodeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphNodeInput = NetworkGraphNodeObject | string;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeObject","title":"NetworkGraphNodeObject","description":""}]}]}]},{"path":"/docs/types/NetworkGraphNodeLabel","title":"NetworkGraphNodeLabel","summary":"The NetworkGraphNodeLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphNodeLabel {\n  index: number;\n  text: string;\n  x: number;\n  y: number;\n  side: 'left' | 'right';\n  placement?: 'top' | 'bottom';\n  maxWidth?: number;\n  shown: boolean;\n  hiddenBy?: 'overlap' | 'mode' | 'viewport';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphNodeObject","title":"NetworkGraphNodeObject","summary":"The NetworkGraphNodeObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphNodeObject {\n  id: string;\n  label?: string;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphPinnedNode","title":"NetworkGraphPinnedNode","summary":"The NetworkGraphPinnedNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphPinnedNode {\n  id: string;\n  x: number;\n  y: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphPoint","title":"NetworkGraphPoint","summary":"The NetworkGraphPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphPoint { x: number; y: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphRenderResult","title":"NetworkGraphRenderResult","summary":"The NetworkGraphRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  networkGraph?: NetworkGraphDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphDrawStats","title":"NetworkGraphDrawStats","description":""}]}]}]},{"path":"/docs/types/NetworkGraphSelection","title":"NetworkGraphSelection","summary":"The NetworkGraphSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphSelection {\n  node: NetworkGraphNodeEventDetail | null;\n  link: NetworkGraphLinkEventDetail | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphNodeEventDetail","title":"NetworkGraphNodeEventDetail","description":""},{"path":"/docs/types/NetworkGraphLinkEventDetail","title":"NetworkGraphLinkEventDetail","description":""}]}]}]},{"path":"/docs/types/NetworkGraphSelectionChangeEventDetail","title":"NetworkGraphSelectionChangeEventDetail","summary":"The NetworkGraphSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphSelectionChangeEventDetail extends NetworkGraphSelection {\n  by: NetworkGraphSelectionSource;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphSelection","title":"NetworkGraphSelection","description":""},{"path":"/docs/types/NetworkGraphSelectionSource","title":"NetworkGraphSelectionSource","description":""}]}]}]},{"path":"/docs/types/NetworkGraphSelectionSource","title":"NetworkGraphSelectionSource","summary":"The NetworkGraphSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphSelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/NetworkGraphStreamEvent","title":"NetworkGraphStreamEvent","summary":"The NetworkGraphStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: NetworkGraphLinkInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":""}]}]}]},{"path":"/docs/types/NetworkGraphStreamSource","title":"NetworkGraphStreamSource","summary":"The NetworkGraphStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface NetworkGraphStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(link: NetworkGraphLinkInput): void;\n  pushBatch(links: ReadonlyArray<NetworkGraphLinkInput>): void;\n  shift(count: number): void;\n  replace(links: ReadonlyArray<NetworkGraphLinkInput>): void;\n  snapshot(): NetworkGraphLinkInput[];\n  subscribe(listener: (event: NetworkGraphStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/NetworkGraphLinkInput","title":"NetworkGraphLinkInput","description":""},{"path":"/docs/types/NetworkGraphStreamEvent","title":"NetworkGraphStreamEvent","description":""}]}]}]},{"path":"/docs/types/NetworkGraphUnavailableBehaviour","title":"NetworkGraphUnavailableBehaviour","summary":"The NetworkGraphUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type NetworkGraphUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/Orbit3DAction","title":"Orbit3DAction","summary":"The Orbit3DAction type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Orbit3DAction = 'rotate' | 'pan' | 'dolly' | 'none';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Orbit3DOptions","title":"Orbit3DOptions","summary":"The Orbit3DOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Orbit3DOptions {\n  enabled?: boolean;\n  enableRotate?: boolean;\n  enablePan?: boolean;\n  enableZoom?: boolean;\n  rotateSpeed?: number;\n  panSpeed?: number;\n  zoomSpeed?: number;\n  minDistance?: number;\n  maxDistance?: number;\n  minZoom?: number;\n  maxZoom?: number;\n  minPolarAngle?: number;\n  maxPolarAngle?: number;\n  minAzimuthAngle?: number;\n  maxAzimuthAngle?: number;\n  screenSpacePanning?: boolean;\n  zoomToCursor?: boolean;\n  targetCenter?: Scene3DVector;\n  minTargetRadius?: number;\n  maxTargetRadius?: number;\n  enableDamping?: boolean;\n  dampingTime?: number;\n  autoRotate?: boolean;\n  autoRotateSpeed?: number;\n  reducedMotion?: boolean;\n  keyPanSpeed?: number;\n  keyRotateSpeed?: number;\n  mouseButtons?: { left?: Orbit3DAction; middle?: Orbit3DAction; right?: Orbit3DAction };\n  oneTouch?: 'rotate' | 'pan' | 'none';\n  twoTouch?: 'dolly-pan' | 'dolly-rotate' | 'pan' | 'none';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""},{"path":"/docs/types/Orbit3DAction","title":"Orbit3DAction","description":""}]}]}]},{"path":"/docs/types/PaneSpecInput","title":"PaneSpecInput","summary":"The PaneSpecInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PaneSpecInput {\n  readonly id: string;\n  readonly weight?: number;\n  readonly label?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesAnimationType","title":"ParallelCoordinatesAnimationType","summary":"The ParallelCoordinatesAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesAnimationType=HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesAxesInput","title":"ParallelCoordinatesAxesInput","summary":"The ParallelCoordinatesAxesInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesAxesInput=Partial<ParallelCoordinatesAxesSpec>|boolean|string|null|undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxesSpec","title":"ParallelCoordinatesAxesSpec","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesAxesSpec","title":"ParallelCoordinatesAxesSpec","summary":"The ParallelCoordinatesAxesSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesAxesSpec {\n  show:boolean;tickCount:number;labelPosition:'top'|'bottom';labelFontSize:number;tickFontSize:number;labelGap:number;tickSize:number;gridLines:boolean;\n  color?:string;textColor?:string;gridColor?:string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","summary":"The ParallelCoordinatesAxis type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesAxis {index:number;id:string;label:string;x:number;domain:readonly[number,number];inverted:boolean;scale?:'linear'|'log';missing:number;excluded?:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesAxisBrush","title":"ParallelCoordinatesAxisBrush","summary":"The ParallelCoordinatesAxisBrush type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesAxisBrush {dimensionId:string;range:readonly[number,number]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesAxisModel","title":"ParallelCoordinatesAxisModel","summary":"The ParallelCoordinatesAxisModel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesAxisModel {axis:ParallelCoordinatesAxis;cssX:number;visibleDomain:readonly[number,number];caption:string;displayCaption:string;captionBox:ParallelCoordinatesLabelBox|null;tickSide:'left'|'right';ticks:ParallelCoordinatesAxisTick[];gridStart:number;gridEnd:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","description":""},{"path":"/docs/types/ParallelCoordinatesLabelBox","title":"ParallelCoordinatesLabelBox","description":""},{"path":"/docs/types/ParallelCoordinatesAxisTick","title":"ParallelCoordinatesAxisTick","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesAxisTick","title":"ParallelCoordinatesAxisTick","summary":"The ParallelCoordinatesAxisTick type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesAxisTick {value:number;cssY:number;text:string;displayText:string;labelBox:ParallelCoordinatesLabelBox|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLabelBox","title":"ParallelCoordinatesLabelBox","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","summary":"The ParallelCoordinatesBrushChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesBrushChangeEventDetail {\n  brushes:ParallelCoordinatesAxisBrush[];selectedRowIds:string[];count:number;total:number;by:ParallelCoordinatesBrushSource;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxisBrush","title":"ParallelCoordinatesAxisBrush","description":""},{"path":"/docs/types/ParallelCoordinatesBrushSource","title":"ParallelCoordinatesBrushSource","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesBrushGestureEventDetail","title":"ParallelCoordinatesBrushGestureEventDetail","summary":"The ParallelCoordinatesBrushGestureEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesBrushGestureEventDetail extends ParallelCoordinatesBrushChangeEventDetail {dimensionId:string;cancelled:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushChangeEventDetail","title":"ParallelCoordinatesBrushChangeEventDetail","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesBrushInput","title":"ParallelCoordinatesBrushInput","summary":"The ParallelCoordinatesBrushInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesBrushInput=Partial<ParallelCoordinatesBrushSpec>|boolean|string|null|undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesBrushSpec","title":"ParallelCoordinatesBrushSpec","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesBrushModel","title":"ParallelCoordinatesBrushModel","summary":"The ParallelCoordinatesBrushModel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesBrushModel {\n  axis:ParallelCoordinatesAxis;rect:ParallelCoordinatesLabelBox;range:readonly[number,number]|null;\n  selection:ParallelCoordinatesLabelBox|null;handles:Array<{bound:'min'|'max';cssY:number;value:number}>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","description":""},{"path":"/docs/types/ParallelCoordinatesLabelBox","title":"ParallelCoordinatesLabelBox","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesBrushSource","title":"ParallelCoordinatesBrushSource","summary":"The ParallelCoordinatesBrushSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesBrushSource='pointer'|'keyboard'|'method'|'clear'|'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesBrushSpec","title":"ParallelCoordinatesBrushSpec","summary":"The ParallelCoordinatesBrushSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesBrushSpec {\n  enabled:boolean;width:number;minSizePx:number;keyboard:boolean;modifier:'none'|'shift'|'alt';inactiveOpacity:number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesCrosshairDetail","title":"ParallelCoordinatesCrosshairDetail","summary":"The ParallelCoordinatesCrosshairDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesCrosshairDetail {cssX:number;cssY:number;dataX:number;dataY:number;dimensionId:string;snappedPointIndex?:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesData","title":"ParallelCoordinatesData","summary":"The ParallelCoordinatesData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesData=ReadonlyArray<ParallelCoordinatesRowInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesDeclaration","title":"ParallelCoordinatesDeclaration","summary":"The ParallelCoordinatesDeclaration type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesDeclaration extends ParallelCoordinatesLineStyle {id:string;label:string;color:string|null;values:Record<string,number|null>}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLineStyle","title":"ParallelCoordinatesLineStyle","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesDiagnostics","title":"ParallelCoordinatesDiagnostics","summary":"The ParallelCoordinatesDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesDiagnostics {invalidRecords:number;invalidIds:number;invalidValues:number;duplicates:number;invalidDimensions:number;duplicateDimensions:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesDimensionInput","title":"ParallelCoordinatesDimensionInput","summary":"The ParallelCoordinatesDimensionInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesDimensionInput {\n  id:string;label?:string;\r\n  domain?:readonly[number,number];inverted?:boolean;\n  scale?:'linear'|'log';\n  tickCount?:number;\n  tickValues?:ReadonlyArray<number>;\n  tickFormat?:(value:number,axis:ParallelCoordinatesAxis)=>string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesEasing","title":"ParallelCoordinatesEasing","summary":"The ParallelCoordinatesEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesEasing=HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesEngineMode","title":"ParallelCoordinatesEngineMode","summary":"The ParallelCoordinatesEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesEngineMode=HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesEngineTier","title":"ParallelCoordinatesEngineTier","summary":"The ParallelCoordinatesEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesEngineTier=HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesHitDetail","title":"ParallelCoordinatesHitDetail","summary":"The ParallelCoordinatesHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesHitDetail {kind:'row';rowIndex:number;row:ParallelCoordinatesRow;dimensionId:string|null;value:number|null;cssX:number;cssY:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesLabelBox","title":"ParallelCoordinatesLabelBox","summary":"The ParallelCoordinatesLabelBox type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesLabelBox {x:number;y:number;width:number;height:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesLayoutResult","title":"ParallelCoordinatesLayoutResult","summary":"The ParallelCoordinatesLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesLayoutResult {width:number;height:number;axes:ParallelCoordinatesAxis[];lines:ParallelCoordinatesLine[];layout:'parallel-coordinates'}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesAxis","title":"ParallelCoordinatesAxis","description":""},{"path":"/docs/types/ParallelCoordinatesLine","title":"ParallelCoordinatesLine","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesLine","title":"ParallelCoordinatesLine","summary":"The ParallelCoordinatesLine type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesLine extends ParallelCoordinatesLineStyle {index:number;id:string;runs:ParallelCoordinatesVertex[][];opacity:number;passive?:boolean\n  paintOrder?:number;}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLineStyle","title":"ParallelCoordinatesLineStyle","description":""},{"path":"/docs/types/ParallelCoordinatesVertex","title":"ParallelCoordinatesVertex","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesLineModel","title":"ParallelCoordinatesLineModel","summary":"The ParallelCoordinatesLineModel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesLineModel {index:number;id:string;width:number;opacity:number;dash:number[];passive:boolean;paintOrder?:number;paths:ParallelCoordinatesLinePoint[][]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLinePoint","title":"ParallelCoordinatesLinePoint","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesLinePoint","title":"ParallelCoordinatesLinePoint","summary":"The ParallelCoordinatesLinePoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesLinePoint {x:number;y:number;axisIndex:number;dimensionId:string}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesLineStyle","title":"ParallelCoordinatesLineStyle","summary":"The ParallelCoordinatesLineStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesLineStyle {\n  lineWidth?:number;\n  lineOpacity?:number;\n  lineDash?:ReadonlyArray<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesRenderResult","title":"ParallelCoordinatesRenderResult","summary":"The ParallelCoordinatesRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesRenderResult {points:number;drawn:number;renderMs:number;parallelCoordinates?:{rows:number;segments:number;drawn:number;vertices:number;bytes:number;uploaded:number;full:boolean;version:number;activeRow:number;chunks:number;chunkVertices:number;capacity:number;cut:number}}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","summary":"The ParallelCoordinatesRow type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesRow extends ParallelCoordinatesDeclaration {index:number;origin:'data'|'stream'}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesDeclaration","title":"ParallelCoordinatesDeclaration","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","summary":"The ParallelCoordinatesRowInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesRowInput extends ParallelCoordinatesLineStyle {\n  id:string;label?:string;color?:string|null;\r\n  values:Readonly<Record<string,number|null|undefined>>;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLineStyle","title":"ParallelCoordinatesLineStyle","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesSelection","title":"ParallelCoordinatesSelection","summary":"The ParallelCoordinatesSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesSelection {rowIndex:number;row:ParallelCoordinatesRow|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRow","title":"ParallelCoordinatesRow","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesSelectionChangeEventDetail","title":"ParallelCoordinatesSelectionChangeEventDetail","summary":"The ParallelCoordinatesSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesSelectionChangeEventDetail extends ParallelCoordinatesSelection {by:ParallelCoordinatesSelectionSource}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesSelection","title":"ParallelCoordinatesSelection","description":""},{"path":"/docs/types/ParallelCoordinatesSelectionSource","title":"ParallelCoordinatesSelectionSource","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesSelectionSource","title":"ParallelCoordinatesSelectionSource","summary":"The ParallelCoordinatesSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesSelectionSource='pointer'|'keyboard'|'method'|'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParallelCoordinatesStreamEvent","title":"ParallelCoordinatesStreamEvent","summary":"The ParallelCoordinatesStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesStreamEvent {type:'push'|'pushBatch'|'shift'|'replace';count:number;entries:ParallelCoordinatesDeclaration[];replaced:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesDeclaration","title":"ParallelCoordinatesDeclaration","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesStreamSource","title":"ParallelCoordinatesStreamSource","summary":"The ParallelCoordinatesStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesStreamSource {\r\n  readonly length:number;readonly capacity:number;readonly dropped:number;\r\n  push(row:ParallelCoordinatesRowInput):void;pushBatch(rows:ParallelCoordinatesData):void;shift(count:number):void;replace(rows:ParallelCoordinatesData):void;\r\n  snapshot():ParallelCoordinatesDeclaration[];subscribe(listener:(event:ParallelCoordinatesStreamEvent)=>void):()=>void;\r\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesRowInput","title":"ParallelCoordinatesRowInput","description":""},{"path":"/docs/types/ParallelCoordinatesData","title":"ParallelCoordinatesData","description":""},{"path":"/docs/types/ParallelCoordinatesDeclaration","title":"ParallelCoordinatesDeclaration","description":""},{"path":"/docs/types/ParallelCoordinatesStreamEvent","title":"ParallelCoordinatesStreamEvent","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesUnavailableBehaviour","title":"ParallelCoordinatesUnavailableBehaviour","summary":"The ParallelCoordinatesUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParallelCoordinatesUnavailableBehaviour=HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/ParallelCoordinatesVertex","title":"ParallelCoordinatesVertex","summary":"The ParallelCoordinatesVertex type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParallelCoordinatesVertex {x:number;y:number;axisIndex:number;dimensionId:string;value:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoBarDatum","title":"ParetoBarDatum","summary":"The ParetoBarDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParetoBarDatum {\n  value: number;\n  category?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartAnimationType","title":"ParetoChartAnimationType","summary":"The ParetoChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartDatum","title":"ParetoChartDatum","summary":"The ParetoChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartEasing","title":"ParetoChartEasing","summary":"The ParetoChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartEngineMode","title":"ParetoChartEngineMode","summary":"The ParetoChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartEngineMode = 'auto' | ParetoChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParetoChartEngineTier","title":"ParetoChartEngineTier","description":""}]}]}]},{"path":"/docs/types/ParetoChartEngineTier","title":"ParetoChartEngineTier","summary":"The ParetoChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartLegendItemEventDetail","title":"ParetoChartLegendItemEventDetail","summary":"The ParetoChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParetoChartLegendItemEventDetail {\n  index: number;\n  seriesId: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartLegendPosition","title":"ParetoChartLegendPosition","summary":"The ParetoChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartPointerEventDetail","title":"ParetoChartPointerEventDetail","summary":"The ParetoChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParetoChartPointerEventDetail {\n  index: number;\n  sourceIndex: number;\n  category: string;\n  value: number;\n  cumulative: number;\n  cumulativePercent: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartRenderResult","title":"ParetoChartRenderResult","summary":"The ParetoChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParetoChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartStreamEvent","title":"ParetoChartStreamEvent","summary":"The ParetoChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ParetoChartStreamSource","title":"ParetoChartStreamSource","summary":"The ParetoChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ParetoChartStreamSource {\n  push(datum: ParetoBarDatum | number): void;\n  pushBatch(data: ReadonlyArray<ParetoBarDatum | number>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<ParetoBarDatum | number>): void;\n  snapshot(window?: number): ParetoBarDatum[];\n  latest(): ParetoBarDatum | undefined;\n  subscribe(listener: (event: ParetoChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParetoBarDatum","title":"ParetoBarDatum","description":""},{"path":"/docs/types/ParetoChartStreamEvent","title":"ParetoChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/ParetoChartUnavailableBehaviour","title":"ParetoChartUnavailableBehaviour","summary":"The ParetoChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/ParetoChartValues","title":"ParetoChartValues","summary":"The ParetoChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ParetoChartValues = Float32Array | ParetoChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParetoChartDatum","title":"ParetoChartDatum","description":""}]}]}]},{"path":"/docs/types/PictorialBarDatum","title":"PictorialBarDatum","summary":"The PictorialBarDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PictorialBarDatum {\n  value: number;\n  category?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartAnimationType","title":"PictorialChartAnimationType","summary":"The PictorialChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartDatum","title":"PictorialChartDatum","summary":"The PictorialChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartEasing","title":"PictorialChartEasing","summary":"The PictorialChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartEngineMode","title":"PictorialChartEngineMode","summary":"The PictorialChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartEngineMode = 'auto' | PictorialChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PictorialChartEngineTier","title":"PictorialChartEngineTier","description":""}]}]}]},{"path":"/docs/types/PictorialChartEngineTier","title":"PictorialChartEngineTier","summary":"The PictorialChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartPointerEventDetail","title":"PictorialChartPointerEventDetail","summary":"The PictorialChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PictorialChartPointerEventDetail {\n  index: number;\n  category: string;\n  value: number;\n  fraction: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartRenderResult","title":"PictorialChartRenderResult","summary":"The PictorialChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PictorialChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartStreamEvent","title":"PictorialChartStreamEvent","summary":"The PictorialChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PictorialChartStreamSource","title":"PictorialChartStreamSource","summary":"The PictorialChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PictorialChartStreamSource {\n  push(datum: PictorialBarDatum | number): void;\n  pushBatch(data: ReadonlyArray<PictorialBarDatum | number>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<PictorialBarDatum | number>): void;\n  snapshot(window?: number): PictorialBarDatum[];\n  latest(): PictorialBarDatum | undefined;\n  subscribe(listener: (event: PictorialChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PictorialBarDatum","title":"PictorialBarDatum","description":""},{"path":"/docs/types/PictorialChartStreamEvent","title":"PictorialChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/PictorialChartUnavailableBehaviour","title":"PictorialChartUnavailableBehaviour","summary":"The PictorialChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/PictorialChartValues","title":"PictorialChartValues","summary":"The PictorialChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PictorialChartValues = Float32Array | PictorialChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PictorialChartDatum","title":"PictorialChartDatum","description":""}]}]}]},{"path":"/docs/types/PieChartAnimationType","title":"PieChartAnimationType","summary":"The PieChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","summary":"The PieChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartDatum =\n  | number\n  | {\n      readonly name?: string;\n      readonly value: number;\n      readonly z?: number;\n      readonly color?: string;\n      readonly selected?: boolean;\n      readonly sliced?: boolean;\n      readonly visible?: boolean;\n      readonly id?: string | number;\n      readonly dataLabel?: PieChartPerPointDataLabel;\n    };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartPerPointDataLabel","title":"PieChartPerPointDataLabel","description":""}]}]}]},{"path":"/docs/types/PieChartEasing","title":"PieChartEasing","summary":"The PieChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartEngineMode","title":"PieChartEngineMode","summary":"The PieChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartEngineTier","title":"PieChartEngineTier","summary":"The PieChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartLabelContent","title":"PieChartLabelContent","summary":"The PieChartLabelContent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartLabelContent =\n  | 'name'\n  | 'value'\n  | 'percent'\n  | 'name-percent'\n  | 'name-value'\n  | ((slice: PieChartResolvedSlice) => string);","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartResolvedSlice","title":"PieChartResolvedSlice","description":""}]}]}]},{"path":"/docs/types/PieChartLabelMode","title":"PieChartLabelMode","summary":"The PieChartLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartLabelMode = 'none' | 'inside' | 'outside' | 'auto';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartLegendPosition","title":"PieChartLegendPosition","summary":"The PieChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartPaletteName","title":"PieChartPaletteName","summary":"The PieChartPaletteName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartPaletteName = 'tableau10' | 'tableau20' | 'observable10' | 'paired12' | 'set3_12';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartPerPointDataLabel","title":"PieChartPerPointDataLabel","summary":"The PieChartPerPointDataLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartPerPointDataLabel =\n  | string\n  | {\n      readonly text?: string;\n      readonly enabled?: boolean;\n      readonly color?: string;\n    };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartRenderResult","title":"PieChartRenderResult","summary":"The PieChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartRenderResult {\n  readonly slices: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartResolvedSlice","title":"PieChartResolvedSlice","summary":"The PieChartResolvedSlice type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartResolvedSlice {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly value: number;\n  readonly startAngle: number;\n  readonly endAngle: number;\n  readonly midAngle: number;\n  readonly sweep: number;\n  readonly percentage: number;\n  readonly color: string;\n  readonly visible: boolean;\n  readonly selected: boolean;\n  readonly sliced: boolean;\n  readonly z?: number;\n  readonly radius?: number;\n  readonly dataLabel?: { readonly text?: string; readonly enabled: boolean; readonly color?: string };\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartSelectedEventDetail","title":"PieChartSelectedEventDetail","summary":"The PieChartSelectedEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartSelectedEventDetail extends PieChartSliceEventDetail {\n  readonly selected: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","description":""}]}]}]},{"path":"/docs/types/PieChartSizeBy","title":"PieChartSizeBy","summary":"The PieChartSizeBy type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartSizeBy = 'area' | 'radius';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartSliceEventDetail","title":"PieChartSliceEventDetail","summary":"The PieChartSliceEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartSliceEventDetail {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly value: number;\n  readonly percentage: number;\n  readonly z?: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartStreamEvent","title":"PieChartStreamEvent","summary":"The PieChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartStreamSource","title":"PieChartStreamSource","summary":"The PieChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartStreamSource {\n  push(datum: PieChartDatum): void;\n  pushBatch(datums: ReadonlyArray<PieChartDatum>): void;\n  shift(count: number): void;\n  replace(datums: ReadonlyArray<PieChartDatum>): void;\n  snapshot(window?: number): PieChartDatum[];\n  subscribe(listener: (event: PieChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":""},{"path":"/docs/types/PieChartStreamEvent","title":"PieChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipActionEventDetail","title":"PieChartTooltipActionEventDetail","summary":"The PieChartTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartTooltipActionEventDetail extends PieChartTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipFormatContext","title":"PieChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipConnectorInput","title":"PieChartTooltipConnectorInput","summary":"The PieChartTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<PieChartTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipConnectorSpec","title":"PieChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipConnectorSpec","title":"PieChartTooltipConnectorSpec","summary":"The PieChartTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartTooltipFormatContext","title":"PieChartTooltipFormatContext","summary":"The PieChartTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartTooltipFormatContext {\n  index: number;\n  id: string;\n  name: string;\n  value: number;\n  percentage: number;\n  z?: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartTooltipInput","title":"PieChartTooltipInput","summary":"The PieChartTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | PieChartTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipObjectInput","title":"PieChartTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipObjectInput","title":"PieChartTooltipObjectInput","summary":"The PieChartTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipObjectInput = Omit<Partial<PieChartTooltipSpec>, 'connector'> & {\n  connector?: PieChartTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipSpec","title":"PieChartTooltipSpec","description":""},{"path":"/docs/types/PieChartTooltipConnectorInput","title":"PieChartTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipOpenMode","title":"PieChartTooltipOpenMode","summary":"The PieChartTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartTooltipShowEventDetail","title":"PieChartTooltipShowEventDetail","summary":"The PieChartTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: PieChartTooltipSide;\n  text: string;\n  html?: string;\n  context?: PieChartTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipSide","title":"PieChartTooltipSide","description":""},{"path":"/docs/types/PieChartTooltipFormatContext","title":"PieChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipSide","title":"PieChartTooltipSide","summary":"The PieChartTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartTooltipSpec","title":"PieChartTooltipSpec","summary":"The PieChartTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PieChartTooltipSpec {\n  show: boolean;\n  openMode: PieChartTooltipOpenMode;\n  trigger: PieChartTooltipTrigger;\n  side?: PieChartTooltipSide;\n  offset: number;\n  format?: (slice: PieChartResolvedSlice, context?: PieChartTooltipFormatContext) => string;\n  html?: (slice: PieChartResolvedSlice, context?: PieChartTooltipFormatContext) => string;\n  className?: string;\n  style?: PieChartTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: PieChartTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipOpenMode","title":"PieChartTooltipOpenMode","description":""},{"path":"/docs/types/PieChartTooltipTrigger","title":"PieChartTooltipTrigger","description":""},{"path":"/docs/types/PieChartTooltipSide","title":"PieChartTooltipSide","description":""},{"path":"/docs/types/PieChartResolvedSlice","title":"PieChartResolvedSlice","description":""},{"path":"/docs/types/PieChartTooltipFormatContext","title":"PieChartTooltipFormatContext","description":""},{"path":"/docs/types/PieChartTooltipStyle","title":"PieChartTooltipStyle","description":""},{"path":"/docs/types/PieChartTooltipConnectorSpec","title":"PieChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipStyle","title":"PieChartTooltipStyle","summary":"The PieChartTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipStyle = Record<string, PieChartTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartTooltipStyleValue","title":"PieChartTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/PieChartTooltipStyleValue","title":"PieChartTooltipStyleValue","summary":"The PieChartTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartTooltipTrigger","title":"PieChartTooltipTrigger","summary":"The PieChartTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PieChartUnavailableBehaviour","title":"PieChartUnavailableBehaviour","summary":"The PieChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/PieChartValues","title":"PieChartValues","summary":"The PieChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PieChartValues = ReadonlyArray<PieChartDatum>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PieChartDatum","title":"PieChartDatum","description":""}]}]}]},{"path":"/docs/types/PiecewiseVisualMapSnapshot","title":"PiecewiseVisualMapSnapshot","summary":"The PiecewiseVisualMapSnapshot type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PiecewiseVisualMapSnapshot extends PiecewiseVisualMapSpec {\n  selected: boolean[] | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PiecewiseVisualMapSpec","title":"PiecewiseVisualMapSpec","description":""}]}]}]},{"path":"/docs/types/PiecewiseVisualMapSpec","title":"PiecewiseVisualMapSpec","summary":"The PiecewiseVisualMapSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PiecewiseVisualMapSpec {\n  type: 'piecewise';\n  min: number;\n  max: number;\n  pieces: ReadonlyArray<VisualMapPiece>;\n  mode: VisualMapPiecewiseMode;\n  outOfRangeColor: string;\n  selectedMode: VisualMapSelectedMode;\n  precision: number | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapPiece","title":"VisualMapPiece","description":""},{"path":"/docs/types/VisualMapPiecewiseMode","title":"VisualMapPiecewiseMode","description":""},{"path":"/docs/types/VisualMapSelectedMode","title":"VisualMapSelectedMode","description":""}]}]}]},{"path":"/docs/types/Point","title":"Point","summary":"The Point type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"type Point=ParallelCoordinatesLinePoint;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ParallelCoordinatesLinePoint","title":"ParallelCoordinatesLinePoint","description":""}]}]}]},{"path":"/docs/types/PolarChartAnimationType","title":"PolarChartAnimationType","summary":"The PolarChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartData","title":"PolarChartData","summary":"The PolarChartData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartData = ReadonlyArray<PolarSeriesSpec> | ReadonlyArray<number | null | undefined>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarSeriesSpec","title":"PolarSeriesSpec","description":""}]}]}]},{"path":"/docs/types/PolarChartEasing","title":"PolarChartEasing","summary":"The PolarChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartEngineMode","title":"PolarChartEngineMode","summary":"The PolarChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartEngineTier","title":"PolarChartEngineTier","summary":"The PolarChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartLegendPosition","title":"PolarChartLegendPosition","summary":"The PolarChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartPaletteName","title":"PolarChartPaletteName","summary":"The PolarChartPaletteName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartPaletteName = 'tableau10' | 'tableau20' | 'observable10' | 'paired12' | 'set3_12';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartPointEventDetail","title":"PolarChartPointEventDetail","summary":"The PolarChartPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartPointEventDetail {\n  readonly categoryIndex: number;\n  readonly category: string;\n  readonly seriesIndex: number;\n  readonly seriesId: string;\n  readonly seriesName: string;\n  readonly value: number;\n  readonly categoryTotal: number;\n  readonly percentage: number;\n  readonly color: string;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartRenderResult","title":"PolarChartRenderResult","summary":"The PolarChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartRenderResult {\n  readonly segments: number;\n  readonly series: number;\n  readonly categories: number;\n  readonly renderMs: number;\n  readonly pro?: PolarProRenderStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarProRenderStats","title":"PolarProRenderStats","description":""}]}]}]},{"path":"/docs/types/PolarChartStackingMode","title":"PolarChartStackingMode","summary":"The PolarChartStackingMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartStackingMode = 'normal' | 'percent';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartStreamEvent","title":"PolarChartStreamEvent","summary":"The PolarChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartStreamSource","title":"PolarChartStreamSource","summary":"The PolarChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartStreamSource {\n  push(datum: PolarRoseRowDatum): void;\n  pushBatch(data: ReadonlyArray<PolarRoseRowDatum>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<PolarRoseRowDatum>): void;\n  snapshot(window?: number): PolarRoseRowDatum[];\n  latest(): PolarRoseRowDatum | undefined;\n  subscribe(listener: (event: PolarChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarRoseRowDatum","title":"PolarRoseRowDatum","description":""},{"path":"/docs/types/PolarChartStreamEvent","title":"PolarChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipActionEventDetail","title":"PolarChartTooltipActionEventDetail","summary":"The PolarChartTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartTooltipActionEventDetail extends PolarChartTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipFormatContext","title":"PolarChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipConnectorInput","title":"PolarChartTooltipConnectorInput","summary":"The PolarChartTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<PolarChartTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipConnectorSpec","title":"PolarChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipConnectorSpec","title":"PolarChartTooltipConnectorSpec","summary":"The PolarChartTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartTooltipFormatContext","title":"PolarChartTooltipFormatContext","summary":"The PolarChartTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartTooltipFormatContext {\n  categoryIndex: number;\n  category: string;\n  seriesIndex: number;\n  seriesId: string;\n  seriesName: string;\n  value: number;\n  categoryTotal: number;\n  percentage: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartTooltipInput","title":"PolarChartTooltipInput","summary":"The PolarChartTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | PolarChartTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipObjectInput","title":"PolarChartTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipObjectInput","title":"PolarChartTooltipObjectInput","summary":"The PolarChartTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipObjectInput = Omit<Partial<PolarChartTooltipSpec>, 'connector'> & {\n  connector?: PolarChartTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipSpec","title":"PolarChartTooltipSpec","description":""},{"path":"/docs/types/PolarChartTooltipConnectorInput","title":"PolarChartTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipOpenMode","title":"PolarChartTooltipOpenMode","summary":"The PolarChartTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartTooltipShowEventDetail","title":"PolarChartTooltipShowEventDetail","summary":"The PolarChartTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: PolarChartTooltipSide;\n  text: string;\n  html?: string;\n  context?: PolarChartTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipSide","title":"PolarChartTooltipSide","description":""},{"path":"/docs/types/PolarChartTooltipFormatContext","title":"PolarChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipSide","title":"PolarChartTooltipSide","summary":"The PolarChartTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartTooltipSpec","title":"PolarChartTooltipSpec","summary":"The PolarChartTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarChartTooltipSpec {\n  show: boolean;\n  openMode: PolarChartTooltipOpenMode;\n  trigger: PolarChartTooltipTrigger;\n  side?: PolarChartTooltipSide;\n  offset: number;\n  format?: (segment: PolarRoseSegment, context?: PolarChartTooltipFormatContext) => string;\n  html?: (segment: PolarRoseSegment, context?: PolarChartTooltipFormatContext) => string;\n  className?: string;\n  style?: PolarChartTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: PolarChartTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipOpenMode","title":"PolarChartTooltipOpenMode","description":""},{"path":"/docs/types/PolarChartTooltipTrigger","title":"PolarChartTooltipTrigger","description":""},{"path":"/docs/types/PolarChartTooltipSide","title":"PolarChartTooltipSide","description":""},{"path":"/docs/types/PolarRoseSegment","title":"PolarRoseSegment","description":""},{"path":"/docs/types/PolarChartTooltipFormatContext","title":"PolarChartTooltipFormatContext","description":""},{"path":"/docs/types/PolarChartTooltipStyle","title":"PolarChartTooltipStyle","description":""},{"path":"/docs/types/PolarChartTooltipConnectorSpec","title":"PolarChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipStyle","title":"PolarChartTooltipStyle","summary":"The PolarChartTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipStyle = Record<string, PolarChartTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PolarChartTooltipStyleValue","title":"PolarChartTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/PolarChartTooltipStyleValue","title":"PolarChartTooltipStyleValue","summary":"The PolarChartTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartTooltipTrigger","title":"PolarChartTooltipTrigger","summary":"The PolarChartTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartUnavailableBehaviour","title":"PolarChartUnavailableBehaviour","summary":"The PolarChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartUnavailableBehaviour = 'fallback' | 'throw';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarChartVariant","title":"PolarChartVariant","summary":"The PolarChartVariant type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PolarChartVariant = 'rose' | 'bar' | 'line';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarProRenderStats","title":"PolarProRenderStats","summary":"The PolarProRenderStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarProRenderStats {\n  readonly marks: number;\n  readonly drawn: number;\n  readonly rings: number;\n  readonly segments: number;\n  readonly instances: number;\n  readonly bytes: number;\n  readonly uploaded: number;\n  readonly full: boolean;\n  readonly version: number;\n  readonly activeIndex: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarRoseRowDatum","title":"PolarRoseRowDatum","summary":"The PolarRoseRowDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarRoseRowDatum {\n  category?: string;\n  values: ReadonlyArray<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarRoseSegment","title":"PolarRoseSegment","summary":"The PolarRoseSegment type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarRoseSegment {\n  readonly categoryIndex: number;\n  readonly category: string;\n  readonly seriesIndex: number;\n  readonly seriesId: string;\n  readonly seriesName: string;\n  readonly value: number;\n  readonly stackBase: number;\n  readonly stackTop: number;\n  readonly r0: number;\n  readonly r1: number;\n  readonly a0: number;\n  readonly a1: number;\n  readonly midAngle: number;\n  readonly color: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PolarSeriesSpec","title":"PolarSeriesSpec","summary":"The PolarSeriesSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface PolarSeriesSpec {\n  readonly data: ReadonlyArray<number | null | undefined>;\n  readonly id?: string | number;\n  readonly name?: string;\n  readonly color?: string;\n  readonly visible?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/PositionSide","title":"PositionSide","summary":"The PositionSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type PositionSide = 'long' | 'short';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartAnimationType","title":"RadarChartAnimationType","summary":"The RadarChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartData","title":"RadarChartData","summary":"The RadarChartData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartData = ReadonlyArray<RadarSeriesSpec> | ReadonlyArray<number | null | undefined>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarSeriesSpec","title":"RadarSeriesSpec","description":""}]}]}]},{"path":"/docs/types/RadarChartEasing","title":"RadarChartEasing","summary":"The RadarChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartEngineMode","title":"RadarChartEngineMode","summary":"The RadarChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartEngineTier","title":"RadarChartEngineTier","summary":"The RadarChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartLegendPosition","title":"RadarChartLegendPosition","summary":"The RadarChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","summary":"The RadarChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarChartPointerEventDetail {\n  readonly seriesIndex: number;\n  readonly seriesId: string;\n  readonly seriesName: string;\n  readonly categoryIndex: number;\n  readonly category: string;\n  readonly value: number | null;\n  readonly fraction: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartRenderResult","title":"RadarChartRenderResult","summary":"The RadarChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarChartRenderResult {\n  readonly points: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartSeriesActiveTrigger","title":"RadarChartSeriesActiveTrigger","summary":"The RadarChartSeriesActiveTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartSeriesActiveTrigger = 'hover' | 'click' | 'custom';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartStreamEvent","title":"RadarChartStreamEvent","summary":"The RadarChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartStreamSource","title":"RadarChartStreamSource","summary":"The RadarChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarChartStreamSource {\n  push(frame: RadarStreamFrame): void;\n  pushBatch(frames: ReadonlyArray<RadarStreamFrame>): void;\n  shift(count: number): void;\n  replace(frames: ReadonlyArray<RadarStreamFrame>): void;\n  snapshot(window?: number): RadarStreamFrame[];\n  latest(): RadarStreamFrame | undefined;\n  subscribe(listener: (event: RadarChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","description":""},{"path":"/docs/types/RadarChartStreamEvent","title":"RadarChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipActionEventDetail","title":"RadarChartTooltipActionEventDetail","summary":"The RadarChartTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarChartTooltipActionEventDetail extends RadarChartTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipFormatContext","title":"RadarChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipConnectorInput","title":"RadarChartTooltipConnectorInput","summary":"The RadarChartTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<RadarChartTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipConnectorSpec","title":"RadarChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipConnectorSpec","title":"RadarChartTooltipConnectorSpec","summary":"The RadarChartTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarChartTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartTooltipFormatContext","title":"RadarChartTooltipFormatContext","summary":"The RadarChartTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipFormatContext = RadarChartPointerEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipInput","title":"RadarChartTooltipInput","summary":"The RadarChartTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | RadarChartTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipObjectInput","title":"RadarChartTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipObjectInput","title":"RadarChartTooltipObjectInput","summary":"The RadarChartTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipObjectInput = Omit<Partial<RadarChartTooltipSpec>, 'connector'> & {\n  connector?: RadarChartTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipSpec","title":"RadarChartTooltipSpec","description":""},{"path":"/docs/types/RadarChartTooltipConnectorInput","title":"RadarChartTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipOpenMode","title":"RadarChartTooltipOpenMode","summary":"The RadarChartTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartTooltipShowEventDetail","title":"RadarChartTooltipShowEventDetail","summary":"The RadarChartTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarChartTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: RadarChartTooltipSide;\n  text: string;\n  html?: string;\n  context?: RadarChartTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipSide","title":"RadarChartTooltipSide","description":""},{"path":"/docs/types/RadarChartTooltipFormatContext","title":"RadarChartTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipSide","title":"RadarChartTooltipSide","summary":"The RadarChartTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartTooltipSpec","title":"RadarChartTooltipSpec","summary":"The RadarChartTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarChartTooltipSpec {\n  show: boolean;\n  openMode: RadarChartTooltipOpenMode;\n  trigger: RadarChartTooltipTrigger;\n  side?: RadarChartTooltipSide;\n  offset: number;\n  format?: (detail: RadarChartPointerEventDetail, context?: RadarChartTooltipFormatContext) => string;\n  html?: (detail: RadarChartPointerEventDetail, context?: RadarChartTooltipFormatContext) => string;\n  className?: string;\n  style?: RadarChartTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: RadarChartTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipOpenMode","title":"RadarChartTooltipOpenMode","description":""},{"path":"/docs/types/RadarChartTooltipTrigger","title":"RadarChartTooltipTrigger","description":""},{"path":"/docs/types/RadarChartTooltipSide","title":"RadarChartTooltipSide","description":""},{"path":"/docs/types/RadarChartPointerEventDetail","title":"RadarChartPointerEventDetail","description":""},{"path":"/docs/types/RadarChartTooltipFormatContext","title":"RadarChartTooltipFormatContext","description":""},{"path":"/docs/types/RadarChartTooltipStyle","title":"RadarChartTooltipStyle","description":""},{"path":"/docs/types/RadarChartTooltipConnectorSpec","title":"RadarChartTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipStyle","title":"RadarChartTooltipStyle","summary":"The RadarChartTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipStyle = Record<string, RadarChartTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartTooltipStyleValue","title":"RadarChartTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/RadarChartTooltipStyleValue","title":"RadarChartTooltipStyleValue","summary":"The RadarChartTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartTooltipTrigger","title":"RadarChartTooltipTrigger","summary":"The RadarChartTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarChartUnavailableBehaviour","title":"RadarChartUnavailableBehaviour","summary":"The RadarChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/RadarChartVariant","title":"RadarChartVariant","summary":"The RadarChartVariant type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarChartVariant = 'line' | 'area';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarGridShape","title":"RadarGridShape","summary":"The RadarGridShape type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarGridShape = 'polygon' | 'circle';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RadarSeriesSpec","title":"RadarSeriesSpec","summary":"The RadarSeriesSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RadarSeriesSpec {\n  readonly data: ReadonlyArray<number | null | undefined>;\n  readonly id?: string | number;\n  readonly name?: string;\n  readonly color?: string;\n  readonly variant?: RadarChartVariant;\n  readonly fillOpacity?: number;\n  readonly lineWidth?: number;\n  readonly pointColors?: ReadonlyArray<string | undefined>;\n  readonly visible?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RadarChartVariant","title":"RadarChartVariant","description":""}]}]}]},{"path":"/docs/types/RadarStreamFrame","title":"RadarStreamFrame","summary":"The RadarStreamFrame type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RadarStreamFrame = ReadonlyArray<number | null | undefined>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RegressionMethod","title":"RegressionMethod","summary":"The RegressionMethod type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type RegressionMethod = 'linear' | 'exponential' | 'logarithmic' | 'polynomial';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/RegressionOptions","title":"RegressionOptions","summary":"The RegressionOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface RegressionOptions {\n  method?: RegressionMethod;\n  dimensions?: readonly [string | number, string | number];\n  order?: number;\n  outputDimensions?: readonly [string, string];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/RegressionMethod","title":"RegressionMethod","description":""}]}]}]},{"path":"/docs/types/SampleMethod","title":"SampleMethod","summary":"The SampleMethod type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SampleMethod = 'lttb' | 'average' | 'max' | 'min' | 'sum' | 'first' | 'last';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SampleOptions","title":"SampleOptions","summary":"The SampleOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SampleOptions {\n  method?: SampleMethod;\n  target?: number;\n  dimension?: string | number;\n  xDimension?: string | number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SampleMethod","title":"SampleMethod","description":""}]}]}]},{"path":"/docs/types/SankeyAlign","title":"SankeyAlign","summary":"The SankeyAlign type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyAlign = 'left' | 'right' | 'center' | 'justify';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyAnimationType","title":"SankeyAnimationType","summary":"The SankeyAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/SankeyData","title":"SankeyData","summary":"The SankeyData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyData = SankeyGraphInput | ReadonlyArray<SankeyLinkInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyGraphInput","title":"SankeyGraphInput","description":""},{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":""}]}]}]},{"path":"/docs/types/SankeyDrawStats","title":"SankeyDrawStats","summary":"The SankeyDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyDrawStats {\n  nodes: number;\n  links: number;\n  drawn: number;\n  instances: number;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  nodeWidthPx: number;\n  nodePaddingPx: number;\n  columns: number;\n  curvature: number;\n  dim: number;\n  activeNode: number;\n  activeLink: number;\n  colored: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyEasing","title":"SankeyEasing","summary":"The SankeyEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/SankeyEngineMode","title":"SankeyEngineMode","summary":"The SankeyEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/SankeyEngineTier","title":"SankeyEngineTier","summary":"The SankeyEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/SankeyExtent","title":"SankeyExtent","summary":"The SankeyExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyExtent {\n  nodes: number;\n  links: number;\n  columns: number;\n  valueMax: number;\n  columnMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyGraphInput","title":"SankeyGraphInput","summary":"The SankeyGraphInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyGraphInput {\n  nodes?: ReadonlyArray<SankeyNodeInput>;\n  links: ReadonlyArray<SankeyLinkInput>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyNodeInput","title":"SankeyNodeInput","description":""},{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":""}]}]}]},{"path":"/docs/types/SankeyHitDetail","title":"SankeyHitDetail","summary":"The SankeyHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyHitDetail = SankeyNodeEventDetail | SankeyLinkEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":""},{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","description":""}]}]}]},{"path":"/docs/types/SankeyLabelMode","title":"SankeyLabelMode","summary":"The SankeyLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyLayoutResult","title":"SankeyLayoutResult","summary":"The SankeyLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyLayoutResult {\n  nodes: SankeyNodeRect[];\n  links: SankeyLinkRibbon[];\n  columns: number;\n  nodeWidth: number;\n  nodePadding: number;\n  scale: number;\n  iterations: number;\n  width: number;\n  height: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyNodeRect","title":"SankeyNodeRect","description":""},{"path":"/docs/types/SankeyLinkRibbon","title":"SankeyLinkRibbon","description":""}]}]}]},{"path":"/docs/types/SankeyLink","title":"SankeyLink","summary":"The SankeyLink type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyLink {\n  index: number;\n  source: number;\n  target: number;\n  sourceId: string;\n  targetId: string;\n  value: number;\n  color: string | null;\n  origin: 'data' | 'stream';\n  backward: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","summary":"The SankeyLinkEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyLinkEventDetail {\n  kind: 'link';\n  index: number;\n  source: string;\n  target: string;\n  sourceIndex: number;\n  targetIndex: number;\n  value: number;\n  selected: boolean;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","summary":"The SankeyLinkInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyLinkInput = SankeyLinkObject | SankeyLinkTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyLinkObject","title":"SankeyLinkObject","description":""},{"path":"/docs/types/SankeyLinkTuple","title":"SankeyLinkTuple","description":""}]}]}]},{"path":"/docs/types/SankeyLinkObject","title":"SankeyLinkObject","summary":"The SankeyLinkObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyLinkObject {\n  source: string;\n  target: string;\n  value: number;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyLinkRibbon","title":"SankeyLinkRibbon","summary":"The SankeyLinkRibbon type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyLinkRibbon {\n  index: number;\n  x0: number;\n  y0: number;\n  x1: number;\n  y1: number;\n  width: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyLinkTuple","title":"SankeyLinkTuple","summary":"The SankeyLinkTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyLinkTuple = readonly [source: string, target: string, value: number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyNode","title":"SankeyNode","summary":"The SankeyNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyNode {\n  index: number;\n  id: string;\n  label: string;\n  column: number;\n  row: number;\n  value: number;\n  inValue: number;\n  outValue: number;\n  color: string | null;\n  sourceLinks: number[];\n  targetLinks: number[];\n  declared: boolean;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","summary":"The SankeyNodeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyNodeEventDetail {\n  kind: 'node';\n  index: number;\n  id: string;\n  label: string;\n  column: number;\n  row: number;\n  value: number;\n  inValue: number;\n  outValue: number;\n  links: number;\n  sourceIds: string[];\n  targetIds: string[];\n  selected: boolean;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyNodeInput","title":"SankeyNodeInput","summary":"The SankeyNodeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyNodeInput = SankeyNodeObject | string;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyNodeObject","title":"SankeyNodeObject","description":""}]}]}]},{"path":"/docs/types/SankeyNodeLabel","title":"SankeyNodeLabel","summary":"The SankeyNodeLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyNodeLabel {\n  index: number;\n  text: string;\n  x: number;\n  y: number;\n  side: 'left' | 'right';\n  maxWidth?: number;\n  shown: boolean;\n  hiddenBy?: 'overlap' | 'mode' | 'viewport';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyNodeObject","title":"SankeyNodeObject","summary":"The SankeyNodeObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyNodeObject {\n  id: string;\n  label?: string;\n  color?: string;\n  column?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyNodeRect","title":"SankeyNodeRect","summary":"The SankeyNodeRect type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyNodeRect {\n  index: number;\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n  rank: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyRenderResult","title":"SankeyRenderResult","summary":"The SankeyRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  sankey?: SankeyDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyDrawStats","title":"SankeyDrawStats","description":""}]}]}]},{"path":"/docs/types/SankeySelection","title":"SankeySelection","summary":"The SankeySelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeySelection {\n  node: SankeyNodeEventDetail | null;\n  link: SankeyLinkEventDetail | null;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyNodeEventDetail","title":"SankeyNodeEventDetail","description":""},{"path":"/docs/types/SankeyLinkEventDetail","title":"SankeyLinkEventDetail","description":""}]}]}]},{"path":"/docs/types/SankeySelectionChangeEventDetail","title":"SankeySelectionChangeEventDetail","summary":"The SankeySelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeySelectionChangeEventDetail extends SankeySelection {\n  by: SankeySelectionSource;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeySelection","title":"SankeySelection","description":""},{"path":"/docs/types/SankeySelectionSource","title":"SankeySelectionSource","description":""}]}]}]},{"path":"/docs/types/SankeySelectionSource","title":"SankeySelectionSource","summary":"The SankeySelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeySelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SankeyStreamEvent","title":"SankeyStreamEvent","summary":"The SankeyStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: SankeyLinkInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":""}]}]}]},{"path":"/docs/types/SankeyStreamSource","title":"SankeyStreamSource","summary":"The SankeyStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SankeyStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(link: SankeyLinkInput): void;\n  pushBatch(links: ReadonlyArray<SankeyLinkInput>): void;\n  shift(count: number): void;\n  replace(links: ReadonlyArray<SankeyLinkInput>): void;\n  snapshot(): SankeyLinkInput[];\n  subscribe(listener: (event: SankeyStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SankeyLinkInput","title":"SankeyLinkInput","description":""},{"path":"/docs/types/SankeyStreamEvent","title":"SankeyStreamEvent","description":""}]}]}]},{"path":"/docs/types/SankeyUnavailableBehaviour","title":"SankeyUnavailableBehaviour","summary":"The SankeyUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SankeyUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/Scatter3DAxesOptions","title":"Scatter3DAxesOptions","summary":"The Scatter3DAxesOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DAxesOptions=Scene3DAxesOptions;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DAxesOptions","title":"Scene3DAxesOptions","description":""}]}]}]},{"path":"/docs/types/Scatter3DCameraChangeEventDetail","title":"Scatter3DCameraChangeEventDetail","summary":"The Scatter3DCameraChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DCameraChangeEventDetail=Scene3DCameraChangeEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraChangeEventDetail","title":"Scene3DCameraChangeEventDetail","description":""}]}]}]},{"path":"/docs/types/Scatter3DCrosshairDetail","title":"Scatter3DCrosshairDetail","summary":"The Scatter3DCrosshairDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DCrosshairDetail {cssX:number;cssY:number;dataX:number;dataY:number;dataZ:number;point:Scatter3DPoint;snapped:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DPoint","title":"Scatter3DPoint","description":""}]}]}]},{"path":"/docs/types/Scatter3DData","title":"Scatter3DData","summary":"The Scatter3DData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DData=ReadonlyArray<Scatter3DDatum|Scatter3DTuple>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":""},{"path":"/docs/types/Scatter3DTuple","title":"Scatter3DTuple","description":""}]}]}]},{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","summary":"The Scatter3DDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DDatum {\n id?:string|number;x:number|null;y:number|null;z:number|null;value?:number|null;\n radius?:number;color?:string;label?:string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scatter3DDiagnostics","title":"Scatter3DDiagnostics","summary":"The Scatter3DDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DDiagnostics {points:number;validPoints:number;missingCoordinates:number;invalidCoordinates:number;missingValues:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scatter3DDomain","title":"Scatter3DDomain","summary":"The Scatter3DDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DDomain=Scene3DDomain;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DDomain","title":"Scene3DDomain","description":""}]}]}]},{"path":"/docs/types/Scatter3DEasing","title":"Scatter3DEasing","summary":"The Scatter3DEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DEasing=HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/Scatter3DEngineMode","title":"Scatter3DEngineMode","summary":"The Scatter3DEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DEngineMode=HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/Scatter3DEngineTier","title":"Scatter3DEngineTier","summary":"The Scatter3DEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DEngineTier=HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/Scatter3DGeometry","title":"Scatter3DGeometry","summary":"The Scatter3DGeometry type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DGeometry extends Scene3DDataSpace {\n points:number;drawn:number;triangles:number;positions:Float32Array;normals:Float32Array;colors:Float32Array;indices:Uint32Array;\n pointIndices:Uint32Array;trianglePoints:Uint32Array;colorDomain:Scene3DDomain;bounds:Scene3DBounds;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DDataSpace","title":"Scene3DDataSpace","description":""},{"path":"/docs/types/Scene3DDomain","title":"Scene3DDomain","description":""},{"path":"/docs/types/Scene3DBounds","title":"Scene3DBounds","description":""}]}]}]},{"path":"/docs/types/Scatter3DHitDetail","title":"Scatter3DHitDetail","summary":"The Scatter3DHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DHitDetail {kind:'scatter3d';point:Scatter3DPoint;pointIndex:number;world:Scene3DVector;center:Scene3DVector;cssX:number;cssY:number;depth:number;triangle:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DPoint","title":"Scatter3DPoint","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""}]}]}]},{"path":"/docs/types/Scatter3DMarker","title":"Scatter3DMarker","summary":"The Scatter3DMarker type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DMarker='sphere'|'cube';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scatter3DPoint","title":"Scatter3DPoint","summary":"The Scatter3DPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DPoint extends Scatter3DDatum {index:number;key:string;valid:boolean;value:number|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":""}]}]}]},{"path":"/docs/types/Scatter3DRenderResult","title":"Scatter3DRenderResult","summary":"The Scatter3DRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DRenderResult {points:number;drawn:number;renderMs:number;scatter3d?:{triangles:number;vertices:number;chunks:number;drawCalls:number;uploadedBytes:number}}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scatter3DSelection","title":"Scatter3DSelection","summary":"The Scatter3DSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DSelection {point:Scatter3DPoint|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DPoint","title":"Scatter3DPoint","description":""}]}]}]},{"path":"/docs/types/Scatter3DSelectionChangeEventDetail","title":"Scatter3DSelectionChangeEventDetail","summary":"The Scatter3DSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DSelectionChangeEventDetail extends Scatter3DSelection {by:Scatter3DSelectionSource}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DSelection","title":"Scatter3DSelection","description":""},{"path":"/docs/types/Scatter3DSelectionSource","title":"Scatter3DSelectionSource","description":""}]}]}]},{"path":"/docs/types/Scatter3DSelectionSource","title":"Scatter3DSelectionSource","summary":"The Scatter3DSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DSelectionSource='pointer'|'keyboard'|'method'|'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scatter3DStreamEvent","title":"Scatter3DStreamEvent","summary":"The Scatter3DStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DStreamEvent {type:'push'|'pushBatch'|'shift'|'replace';count:number;replaced:number;entries:Scatter3DDatum[]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":""}]}]}]},{"path":"/docs/types/Scatter3DStreamSource","title":"Scatter3DStreamSource","summary":"The Scatter3DStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scatter3DStreamSource {\n readonly length:number;readonly capacity:number;readonly dropped:number;\n push(point:Scatter3DDatum):void;pushBatch(points:ReadonlyArray<Scatter3DDatum>):void;\n shift(count:number):void;replace(points:ReadonlyArray<Scatter3DDatum>):void;setCapacity(capacity:number):void;\n snapshot():Scatter3DDatum[];subscribe(listener:(event:Scatter3DStreamEvent)=>void):()=>void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scatter3DDatum","title":"Scatter3DDatum","description":""},{"path":"/docs/types/Scatter3DStreamEvent","title":"Scatter3DStreamEvent","description":""}]}]}]},{"path":"/docs/types/Scatter3DTuple","title":"Scatter3DTuple","summary":"The Scatter3DTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DTuple=readonly[number|null,number|null,number|null,(number|null)?];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scatter3DUnavailableBehaviour","title":"Scatter3DUnavailableBehaviour","summary":"The Scatter3DUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scatter3DUnavailableBehaviour=HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/ScatterChartAnimationType","title":"ScatterChartAnimationType","summary":"The ScatterChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartDatum","title":"ScatterChartDatum","summary":"The ScatterChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartDatum =\n  | number\n  | null\n  | undefined\n  | readonly [number, number | null | undefined]\n  | { x?: number; y: number | null | undefined; z?: number; name?: string; color?: string; size?: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartEasing","title":"ScatterChartEasing","summary":"The ScatterChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartEngineMode","title":"ScatterChartEngineMode","summary":"The ScatterChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartEngineMode = 'auto' | ScatterChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ScatterChartEngineTier","title":"ScatterChartEngineTier","description":""}]}]}]},{"path":"/docs/types/ScatterChartEngineTier","title":"ScatterChartEngineTier","summary":"The ScatterChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartLegendItemEventDetail","title":"ScatterChartLegendItemEventDetail","summary":"The ScatterChartLegendItemEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterChartLegendItemEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  label: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartLegendPosition","title":"ScatterChartLegendPosition","summary":"The ScatterChartLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartLegendPosition = 'top' | 'bottom' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartMarkerSymbol","title":"ScatterChartMarkerSymbol","summary":"The ScatterChartMarkerSymbol type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartMarkerSymbol = CartesianSeriesMarkerSymbol;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesMarkerSymbol","title":"CartesianSeriesMarkerSymbol","description":""}]}]}]},{"path":"/docs/types/ScatterChartRenderResult","title":"ScatterChartRenderResult","summary":"The ScatterChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterChartRenderResult {\n  points: number;\n  renderMs: number;\n  progressive?: { chunks: number; chunk: number; cancelled: boolean };\n  memo?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartSeries","title":"ScatterChartSeries","summary":"The ScatterChartSeries type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterChartSeries extends Omit<CartesianSeriesBase<ScatterChartValues>, 'values' | 'marker'> {\n  values?: ScatterChartValues;\n  marker?: ScatterChartMarkerSymbol | CartesianSeriesMarkerInput | 'none';\n  markerSize?: number;\n  colorMap?: ScatterColorMap;\n  sizeMap?: ScatterSizeMap;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianSeriesBase","title":"CartesianSeriesBase","description":""},{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","description":""},{"path":"/docs/types/ScatterChartMarkerSymbol","title":"ScatterChartMarkerSymbol","description":""},{"path":"/docs/types/CartesianSeriesMarkerInput","title":"CartesianSeriesMarkerInput","description":""},{"path":"/docs/types/ScatterColorMap","title":"ScatterColorMap","description":""},{"path":"/docs/types/ScatterSizeMap","title":"ScatterSizeMap","description":""}]}]}]},{"path":"/docs/types/ScatterChartSeriesActiveTrigger","title":"ScatterChartSeriesActiveTrigger","summary":"The ScatterChartSeriesActiveTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartSeriesActiveTrigger = 'hover' | 'click' | 'custom';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartSeriesStateOptions","title":"ScatterChartSeriesStateOptions","summary":"The ScatterChartSeriesStateOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterChartSeriesStateOptions {\n  enabled?: boolean;\n  inactive?: ScatterChartSeriesStateStyle;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ScatterChartSeriesStateStyle","title":"ScatterChartSeriesStateStyle","description":""}]}]}]},{"path":"/docs/types/ScatterChartSeriesStateStyle","title":"ScatterChartSeriesStateStyle","summary":"The ScatterChartSeriesStateStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterChartSeriesStateStyle {\n  opacity?: number;\n  markerSize?: number;\n  markerSizeScale?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartSeriesToggledEventDetail","title":"ScatterChartSeriesToggledEventDetail","summary":"The ScatterChartSeriesToggledEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterChartSeriesToggledEventDetail {\n  index: number;\n  seriesIndex: number;\n  seriesId?: string | number;\n  seriesName?: string;\n  disabled: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartStreamEvent","title":"ScatterChartStreamEvent","summary":"The ScatterChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartStreamSource","title":"ScatterChartStreamSource","summary":"The ScatterChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterChartStreamSource {\n  push(datum: ScatterChartDatum): void;\n  pushBatch(datums: ReadonlyArray<ScatterChartDatum>): void;\n  shift(count: number): void;\n  replace(datums: ReadonlyArray<ScatterChartDatum>): void;\n  snapshot(window?: number): ScatterChartDatum[];\n  subscribe(listener: (event: ScatterChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ScatterChartDatum","title":"ScatterChartDatum","description":""},{"path":"/docs/types/ScatterChartStreamEvent","title":"ScatterChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/ScatterChartUnavailableBehaviour","title":"ScatterChartUnavailableBehaviour","summary":"The ScatterChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartUnavailableBehaviour = 'fallback' | 'error';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterChartValues","title":"ScatterChartValues","summary":"The ScatterChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ScatterChartValues = ReadonlyArray<ScatterChartDatum>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ScatterChartDatum","title":"ScatterChartDatum","description":""}]}]}]},{"path":"/docs/types/ScatterColorMap","title":"ScatterColorMap","summary":"The ScatterColorMap type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterColorMap {\n  field?: 'z' | 'y' | string;\n  domain?: 'auto' | readonly [number, number];\n  stops: ReadonlyArray<ScatterColorMapStop | readonly [number, string]>;\n  fallback?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ScatterColorMapStop","title":"ScatterColorMapStop","description":""}]}]}]},{"path":"/docs/types/ScatterColorMapStop","title":"ScatterColorMapStop","summary":"The ScatterColorMapStop type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterColorMapStop {\n  offset: number;\n  color: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ScatterSizeMap","title":"ScatterSizeMap","summary":"The ScatterSizeMap type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ScatterSizeMap {\n  field?: 'z' | 'y' | string;\n  domain?: 'auto' | readonly [number, number];\n  radiusRange: readonly [number, number];\n  fallback?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scene3DAxesOptions","title":"Scene3DAxesOptions","summary":"The Scene3DAxesOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DAxesOptions {\n show?:boolean;gridLines?:boolean;tickCount?:number;xTitle?:string;yTitle?:string;zTitle?:string;\n color?:string;gridColor?:string;textColor?:string;format?:(value:number,axis:Scene3DAxis)=>string;\n tickValues?:Partial<Record<Scene3DAxis,ReadonlyArray<number>>>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DAxis","title":"Scene3DAxis","description":""}]}]}]},{"path":"/docs/types/Scene3DAxis","title":"Scene3DAxis","summary":"The Scene3DAxis type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scene3DAxis='x'|'y'|'z';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scene3DBounds","title":"Scene3DBounds","summary":"The Scene3DBounds type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DBounds { min: Scene3DVector; max: Scene3DVector }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""}]}]}]},{"path":"/docs/types/Scene3DCameraChangeEventDetail","title":"Scene3DCameraChangeEventDetail","summary":"The Scene3DCameraChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DCameraChangeEventDetail {camera:Scene3DCameraOptions;by:'pointer'|'wheel'|'keyboard'|'api'|'damping'|'auto';phase:'start'|'change'|'end';cancelled?:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":""}]}]}]},{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","summary":"The Scene3DCameraOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DCameraOptions {\n  projection?: Scene3DProjection;\n  position?: Scene3DVector;\n  target?: Scene3DVector;\n  up?: Scene3DVector;\n  fovY?: number;\n  height?: number;\n  zoom?: number;\n  near?: number;\n  far?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DProjection","title":"Scene3DProjection","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""}]}]}]},{"path":"/docs/types/Scene3DDataSpace","title":"Scene3DDataSpace","summary":"The Scene3DDataSpace type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DDataSpace {size:Scene3DVector;domains:Record<Scene3DAxis,Scene3DDomain>}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""},{"path":"/docs/types/Scene3DAxis","title":"Scene3DAxis","description":""},{"path":"/docs/types/Scene3DDomain","title":"Scene3DDomain","description":""}]}]}]},{"path":"/docs/types/Scene3DDirectionalLight","title":"Scene3DDirectionalLight","summary":"The Scene3DDirectionalLight type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DDirectionalLight extends Scene3DLightColor {\n  type:'directional';\n  direction:Scene3DVector;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DLightColor","title":"Scene3DLightColor","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""}]}]}]},{"path":"/docs/types/Scene3DDomain","title":"Scene3DDomain","summary":"The Scene3DDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scene3DDomain=readonly[number,number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scene3DLight","title":"Scene3DLight","summary":"The Scene3DLight type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scene3DLight = Scene3DDirectionalLight|Scene3DPointLight;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DDirectionalLight","title":"Scene3DDirectionalLight","description":""},{"path":"/docs/types/Scene3DPointLight","title":"Scene3DPointLight","description":""}]}]}]},{"path":"/docs/types/Scene3DLightColor","title":"Scene3DLightColor","summary":"The Scene3DLightColor type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DLightColor {color?: Scene3DRgb;intensity?: number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DRgb","title":"Scene3DRgb","description":""}]}]}]},{"path":"/docs/types/Scene3DLightingOptions","title":"Scene3DLightingOptions","summary":"The Scene3DLightingOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DLightingOptions {\n  ambient?:Scene3DLightColor;\n  lights?:ReadonlyArray<Scene3DLight>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DLightColor","title":"Scene3DLightColor","description":""},{"path":"/docs/types/Scene3DLight","title":"Scene3DLight","description":""}]}]}]},{"path":"/docs/types/Scene3DMaterialOptions","title":"Scene3DMaterialOptions","summary":"The Scene3DMaterialOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DMaterialOptions {\n  shading?: 'unlit'|'phong';\n  diffuse?: Scene3DRgb;\n  specular?: Scene3DRgb;\n  emissive?: Scene3DRgb;\n  shininess?: number;\n  normalMode?: 'smooth'|'flat';\n  twoSided?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DRgb","title":"Scene3DRgb","description":""}]}]}]},{"path":"/docs/types/Scene3DPointLight","title":"Scene3DPointLight","summary":"The Scene3DPointLight type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Scene3DPointLight extends Scene3DLightColor {\n  type:'point';position:Scene3DVector;\n  attenuation?: {constant?:number;linear?:number;quadratic?:number};\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DLightColor","title":"Scene3DLightColor","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""}]}]}]},{"path":"/docs/types/Scene3DProjection","title":"Scene3DProjection","summary":"The Scene3DProjection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scene3DProjection = 'perspective' | 'orthographic';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scene3DRgb","title":"Scene3DRgb","summary":"The Scene3DRgb type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scene3DRgb = readonly [number,number,number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","summary":"The Scene3DVector type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Scene3DVector = readonly [number, number, number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramAnimationType","title":"SpectrogramAnimationType","summary":"The SpectrogramAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/SpectrogramAppendSamplesResult","title":"SpectrogramAppendSamplesResult","summary":"The SpectrogramAppendSamplesResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramAppendSamplesResult {\n  frames: number;\n  pending: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramColumns","title":"SpectrogramColumns","summary":"The SpectrogramColumns type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramColumns {\n  frames: number;\n  bins: number;\n  values: ArrayLike<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramEasing","title":"SpectrogramEasing","summary":"The SpectrogramEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/SpectrogramEngineMode","title":"SpectrogramEngineMode","summary":"The SpectrogramEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/SpectrogramEngineTier","title":"SpectrogramEngineTier","summary":"The SpectrogramEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/SpectrogramFftInfo","title":"SpectrogramFftInfo","summary":"The SpectrogramFftInfo type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramFftInfo {\n  fftSize: number;\n  hop: number;\n  window: SpectrogramWindowKind;\n  bins: number;\n  sampleRate: number;\n  binHz: number;\n  frameSeconds: number;\n  coherentGain: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SpectrogramWindowKind","title":"SpectrogramWindowKind","description":""}]}]}]},{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","summary":"The SpectrogramFrame type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramFrame = ArrayLike<number>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramInput","title":"SpectrogramInput","summary":"The SpectrogramInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramInput = ReadonlyArray<SpectrogramFrame> | SpectrogramColumns;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","description":""},{"path":"/docs/types/SpectrogramColumns","title":"SpectrogramColumns","description":""}]}]}]},{"path":"/docs/types/SpectrogramLodMode","title":"SpectrogramLodMode","summary":"The SpectrogramLodMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramLodMode = HeatmapLodMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapLodMode","title":"HeatmapLodMode","description":""}]}]}]},{"path":"/docs/types/SpectrogramPointEventDetail","title":"SpectrogramPointEventDetail","summary":"The SpectrogramPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramPointEventDetail {\n  frame: number;\n  bin: number;\n  index: number;\n  time: number;\n  frequency: number;\n  value: number | null;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramRanges","title":"SpectrogramRanges","summary":"The SpectrogramRanges type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramRanges {\n  time: { start: number; end: number; hop: number };\n  frequency: { min: number; max: number; bins: number };\n  dropped: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramRenderResult","title":"SpectrogramRenderResult","summary":"The SpectrogramRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramRenderResult {\n  frames: number;\n  bins: number;\n  drawn: number;\n  renderMs: number;\n  plane?: HeatmapPlaneStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapPlaneStats","title":"HeatmapPlaneStats","description":""}]}]}]},{"path":"/docs/types/SpectrogramStreamEvent","title":"SpectrogramStreamEvent","summary":"The SpectrogramStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  frames: ReadonlyArray<SpectrogramFrame>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","description":""}]}]}]},{"path":"/docs/types/SpectrogramStreamSource","title":"SpectrogramStreamSource","summary":"The SpectrogramStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramStreamSource {\n  push(frame: SpectrogramFrame): void;\n  pushBatch(frames: ReadonlyArray<SpectrogramFrame>): void;\n  shift(count: number): void;\n  replace(frames: ReadonlyArray<SpectrogramFrame>): void;\n  snapshot(): SpectrogramFrame[];\n  latest(): SpectrogramFrame | undefined;\n  subscribe(listener: (event: SpectrogramStreamEvent) => void): () => void;\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SpectrogramFrame","title":"SpectrogramFrame","description":""},{"path":"/docs/types/SpectrogramStreamEvent","title":"SpectrogramStreamEvent","description":""}]}]}]},{"path":"/docs/types/SpectrogramUnavailableBehaviour","title":"SpectrogramUnavailableBehaviour","summary":"The SpectrogramUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/SpectrogramValueExtent","title":"SpectrogramValueExtent","summary":"The SpectrogramValueExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SpectrogramValueExtent {\n  min: number;\n  max: number;\n  finite: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramValueScale","title":"SpectrogramValueScale","summary":"The SpectrogramValueScale type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramValueScale = 'db' | 'linear';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SpectrogramWindowKind","title":"SpectrogramWindowKind","summary":"The SpectrogramWindowKind type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SpectrogramWindowKind = 'hann' | 'hamming' | 'blackman' | 'rect';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafAnimationType","title":"StemLeafAnimationType","summary":"The StemLeafAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafEasing","title":"StemLeafEasing","summary":"The StemLeafEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafEngineMode","title":"StemLeafEngineMode","summary":"The StemLeafEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafEngineTier","title":"StemLeafEngineTier","summary":"The StemLeafEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","summary":"The StemLeafPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafPointEventDetail {\n  readonly sourceIndex: number;\n  readonly value: number;\n  readonly stemLabel: string;\n  readonly digit: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafRenderResult","title":"StemLeafRenderResult","summary":"The StemLeafRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafRenderResult {\n  readonly points: number;\n  readonly rows: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafStreamDatum","title":"StemLeafStreamDatum","summary":"The StemLeafStreamDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafStreamDatum {\n  value: number;\n  category?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafStreamEvent","title":"StemLeafStreamEvent","summary":"The StemLeafStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafStreamSource","title":"StemLeafStreamSource","summary":"The StemLeafStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafStreamSource {\n  push(datum: StemLeafStreamDatum | number): void;\n  pushBatch(data: ReadonlyArray<StemLeafStreamDatum | number>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<StemLeafStreamDatum | number>): void;\n  snapshot(window?: number): StemLeafStreamDatum[];\n  latest(): StemLeafStreamDatum | undefined;\n  subscribe(listener: (event: StemLeafStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafStreamDatum","title":"StemLeafStreamDatum","description":""},{"path":"/docs/types/StemLeafStreamEvent","title":"StemLeafStreamEvent","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipActionEventDetail","title":"StemLeafTooltipActionEventDetail","summary":"The StemLeafTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafTooltipActionEventDetail extends StemLeafTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipFormatContext","title":"StemLeafTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipConnectorInput","title":"StemLeafTooltipConnectorInput","summary":"The StemLeafTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<StemLeafTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipConnectorSpec","title":"StemLeafTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipConnectorSpec","title":"StemLeafTooltipConnectorSpec","summary":"The StemLeafTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafTooltipFormatContext","title":"StemLeafTooltipFormatContext","summary":"The StemLeafTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafTooltipFormatContext {\n  sourceIndex: number;\n  value: number;\n  stemLabel: string;\n  digit: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafTooltipInput","title":"StemLeafTooltipInput","summary":"The StemLeafTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | StemLeafTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipObjectInput","title":"StemLeafTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipObjectInput","title":"StemLeafTooltipObjectInput","summary":"The StemLeafTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipObjectInput = Omit<Partial<StemLeafTooltipSpec>, 'connector'> & {\n  connector?: StemLeafTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipSpec","title":"StemLeafTooltipSpec","description":""},{"path":"/docs/types/StemLeafTooltipConnectorInput","title":"StemLeafTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipOpenMode","title":"StemLeafTooltipOpenMode","summary":"The StemLeafTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafTooltipShowEventDetail","title":"StemLeafTooltipShowEventDetail","summary":"The StemLeafTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: StemLeafTooltipSide;\n  text: string;\n  html?: string;\n  context?: StemLeafTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipSide","title":"StemLeafTooltipSide","description":""},{"path":"/docs/types/StemLeafTooltipFormatContext","title":"StemLeafTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipSide","title":"StemLeafTooltipSide","summary":"The StemLeafTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafTooltipSpec","title":"StemLeafTooltipSpec","summary":"The StemLeafTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StemLeafTooltipSpec {\n  show: boolean;\n  openMode: StemLeafTooltipOpenMode;\n  trigger: StemLeafTooltipTrigger;\n  side?: StemLeafTooltipSide;\n  offset: number;\n  format?: (leaf: StemLeafTooltipTarget, context?: StemLeafTooltipFormatContext) => string;\n  html?: (leaf: StemLeafTooltipTarget, context?: StemLeafTooltipFormatContext) => string;\n  className?: string;\n  style?: StemLeafTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: StemLeafTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipOpenMode","title":"StemLeafTooltipOpenMode","description":""},{"path":"/docs/types/StemLeafTooltipTrigger","title":"StemLeafTooltipTrigger","description":""},{"path":"/docs/types/StemLeafTooltipSide","title":"StemLeafTooltipSide","description":""},{"path":"/docs/types/StemLeafTooltipTarget","title":"StemLeafTooltipTarget","description":""},{"path":"/docs/types/StemLeafTooltipFormatContext","title":"StemLeafTooltipFormatContext","description":""},{"path":"/docs/types/StemLeafTooltipStyle","title":"StemLeafTooltipStyle","description":""},{"path":"/docs/types/StemLeafTooltipConnectorSpec","title":"StemLeafTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipStyle","title":"StemLeafTooltipStyle","summary":"The StemLeafTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipStyle = Record<string, StemLeafTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafTooltipStyleValue","title":"StemLeafTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipStyleValue","title":"StemLeafTooltipStyleValue","summary":"The StemLeafTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafTooltipTarget","title":"StemLeafTooltipTarget","summary":"The StemLeafTooltipTarget type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipTarget = StemLeafPointEventDetail;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StemLeafPointEventDetail","title":"StemLeafPointEventDetail","description":""}]}]}]},{"path":"/docs/types/StemLeafTooltipTrigger","title":"StemLeafTooltipTrigger","summary":"The StemLeafTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StemLeafUnavailableBehaviour","title":"StemLeafUnavailableBehaviour","summary":"The StemLeafUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/StemLeafValues","title":"StemLeafValues","summary":"The StemLeafValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StemLeafValues = Float32Array | ReadonlyArray<number | null | undefined>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockDrawing","title":"StockDrawing","summary":"The StockDrawing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockDrawing {\n  readonly id: string;\n  readonly tool: string;\n  readonly anchors: ReadonlyArray<DrawingAnchor>;\n  readonly style?: DrawingStyle;\n  readonly locked?: boolean;\n  readonly visible: boolean;\n  readonly meta?: Readonly<Record<string, string | number | boolean>>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingAnchor","title":"DrawingAnchor","description":""},{"path":"/docs/types/DrawingStyle","title":"DrawingStyle","description":""}]}]}]},{"path":"/docs/types/StockDrawingInput","title":"StockDrawingInput","summary":"The StockDrawingInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockDrawingInput {\n  readonly id?: string;\n  readonly tool: string;\n  readonly anchors: ReadonlyArray<{ time: number | string | Date; price: number }>;\n  readonly style?: DrawingStyle;\n  readonly locked?: boolean;\n  readonly visible?: boolean;\n  readonly meta?: Readonly<Record<string, string | number | boolean>>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DrawingStyle","title":"DrawingStyle","description":""}]}]}]},{"path":"/docs/types/StockFlagInput","title":"StockFlagInput","summary":"The StockFlagInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockFlagInput {\n  readonly time: number | string | Date;\n  readonly text: string;\n  readonly title?: string;\n  readonly shape?: StockFlagShape;\n  readonly position?: StockFlagPosition;\n  readonly color?: string;\n  readonly id?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/StockFlagShape","title":"StockFlagShape","description":""},{"path":"/docs/types/StockFlagPosition","title":"StockFlagPosition","description":""}]}]}]},{"path":"/docs/types/StockFlagPosition","title":"StockFlagPosition","summary":"The StockFlagPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StockFlagPosition = 'above' | 'below' | 'axis';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockFlagShape","title":"StockFlagShape","summary":"The StockFlagShape type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StockFlagShape = 'flag' | 'circle' | 'square';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockIndicatorInput","title":"StockIndicatorInput","summary":"The StockIndicatorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockIndicatorInput {\n  readonly kind: string;\n  readonly id?: string;\n  readonly params?: Readonly<Record<string, number | string>>;\n  readonly color?: string;\n  readonly linkedTo?: string;\n  readonly pane?: string;\n  readonly label?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockPositionInput","title":"StockPositionInput","summary":"The StockPositionInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockPositionInput {\n  readonly side: PositionSide;\n  readonly entryPrice: number;\n  readonly quantity: number;\n  readonly id?: string;\n  readonly label?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/PositionSide","title":"PositionSide","description":""}]}]}]},{"path":"/docs/types/StockRangeKey","title":"StockRangeKey","summary":"The StockRangeKey type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StockRangeKey = '1m' | '3m' | '6m' | 'ytd' | '1y' | 'all';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockResolution","title":"StockResolution","summary":"The StockResolution type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StockResolution = '1d' | '1w' | '1M';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockSeriesStyle","title":"StockSeriesStyle","summary":"The StockSeriesStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type StockSeriesStyle =\n  | 'candlestick' | 'hollow' | 'ohlc' | 'hlc' | 'hilo' | 'column-range'\n  | 'line' | 'area' | 'baseline' | 'hlc-area' | 'volume-candle';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockSessionInput","title":"StockSessionInput","summary":"The StockSessionInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockSessionInput {\n  readonly timezone?: string;\n  readonly sessions?: ReadonlyArray<string>;\n  readonly holidays?: ReadonlyArray<string>;\n  readonly closedWeekdays?: ReadonlyArray<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockTickInput","title":"StockTickInput","summary":"The StockTickInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockTickInput {\n  readonly timestamp: number | string | Date;\n  readonly close: number;\n  readonly open?: number;\n  readonly high?: number;\n  readonly low?: number;\n  readonly volume?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/StockTradeInput","title":"StockTradeInput","summary":"The StockTradeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface StockTradeInput {\n  readonly time: number | string | Date;\n  readonly side: TradeSide;\n  readonly price: number;\n  readonly quantity?: number;\n  readonly id?: string;\n  readonly label?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TradeSide","title":"TradeSide","description":""}]}]}]},{"path":"/docs/types/SunburstAnimationType","title":"SunburstAnimationType","summary":"The SunburstAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/SunburstArc","title":"SunburstArc","summary":"The SunburstArc type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstArc {\n  cx: number;\n  cy: number;\n  innerRadius: number;\n  outerRadius: number;\n  startAngle: number;\n  endAngle: number;\n  index: number;\n  id: string;\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n  depth: number;\n  opacity: number;\n  passive?: boolean;\n  paintOrder?:number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstData","title":"SunburstData","summary":"The SunburstData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstData = SunburstNodeInput | ReadonlyArray<SunburstNodeInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":""}]}]}]},{"path":"/docs/types/SunburstDrillChangeEventDetail","title":"SunburstDrillChangeEventDetail","summary":"The SunburstDrillChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstDrillChangeEventDetail { rootId: string | null; previousRootId: string | null; by: SunburstSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstSelectionSource","title":"SunburstSelectionSource","description":""}]}]}]},{"path":"/docs/types/SunburstEasing","title":"SunburstEasing","summary":"The SunburstEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/SunburstEngineMode","title":"SunburstEngineMode","summary":"The SunburstEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/SunburstEngineTier","title":"SunburstEngineTier","summary":"The SunburstEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/SunburstExtent","title":"SunburstExtent","summary":"The SunburstExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstExtent { nodes: number; leaves: number; total: number; depth: number; valueMax: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstHitDetail","title":"SunburstHitDetail","summary":"The SunburstHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstHitDetail {\n  kind: 'node';\n  nodeIndex: number;\n  node: SunburstNode;\n  cssX: number;\n  cssY: number;\n  value: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":""}]}]}]},{"path":"/docs/types/SunburstLabel","title":"SunburstLabel","summary":"The SunburstLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstLabel { index: number; id: string; text: string; x: number; y: number; width: number; height: number; shown: boolean; opacity: number; color: string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstLabelMode","title":"SunburstLabelMode","summary":"The SunburstLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstLayout","title":"SunburstLayout","summary":"The SunburstLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstLayout = 'partition';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstLayoutResult","title":"SunburstLayoutResult","summary":"The SunburstLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstLayoutResult {\n  nodes: SunburstArc[];\n  width: number;\n  height: number;\n  total: number;\n  rootId: string | null;\n  layout: SunburstLayout;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstArc","title":"SunburstArc","description":""},{"path":"/docs/types/SunburstLayout","title":"SunburstLayout","description":""}]}]}]},{"path":"/docs/types/SunburstNode","title":"SunburstNode","summary":"The SunburstNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstNode {\n  index: number;\n  id: string;\n  label: string;\n  color: string | null;\n  parent: number | null;\n  children: number[];\n  depth: number;\n  ownValue: number;\n  value: number;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","summary":"The SunburstNodeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstNodeInput {\n  id: string;\n  label?: string;\n  color?: string;\n  parent?: string | null;\n  value?: number;\n  children?: ReadonlyArray<SunburstNodeInput>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstRenderResult","title":"SunburstRenderResult","summary":"The SunburstRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  sunburst?: { nodes: number; drawn: number; vertices: number; bytes: number; uploaded: number; full: boolean; version: number; activeNode: number; chunks: number; chunkVertices: number; capacity: number; cut: number };\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstSelection","title":"SunburstSelection","summary":"The SunburstSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstSelection { nodeIndex: number; node: SunburstNode | null }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstNode","title":"SunburstNode","description":""}]}]}]},{"path":"/docs/types/SunburstSelectionChangeEventDetail","title":"SunburstSelectionChangeEventDetail","summary":"The SunburstSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstSelectionChangeEventDetail extends SunburstSelection { by: SunburstSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstSelection","title":"SunburstSelection","description":""},{"path":"/docs/types/SunburstSelectionSource","title":"SunburstSelectionSource","description":""}]}]}]},{"path":"/docs/types/SunburstSelectionSource","title":"SunburstSelectionSource","summary":"The SunburstSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstSelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SunburstStreamEvent","title":"SunburstStreamEvent","summary":"The SunburstStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: SunburstNodeInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":""}]}]}]},{"path":"/docs/types/SunburstStreamSource","title":"SunburstStreamSource","summary":"The SunburstStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SunburstStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(node: SunburstNodeInput): void;\n  pushBatch(nodes: ReadonlyArray<SunburstNodeInput>): void;\n  shift(count: number): void;\n  replace(nodes: ReadonlyArray<SunburstNodeInput>): void;\n  snapshot(): SunburstNodeInput[];\n  subscribe(listener: (event: SunburstStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/SunburstNodeInput","title":"SunburstNodeInput","description":""},{"path":"/docs/types/SunburstStreamEvent","title":"SunburstStreamEvent","description":""}]}]}]},{"path":"/docs/types/SunburstUnavailableBehaviour","title":"SunburstUnavailableBehaviour","summary":"The SunburstUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type SunburstUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/Surface3DAxesOptions","title":"Surface3DAxesOptions","summary":"The Surface3DAxesOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DAxesOptions=Scene3DAxesOptions;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DAxesOptions","title":"Scene3DAxesOptions","description":""}]}]}]},{"path":"/docs/types/Surface3DAxis","title":"Surface3DAxis","summary":"The Surface3DAxis type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DAxis = 'x'|'y'|'z';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Surface3DCameraChangeEventDetail","title":"Surface3DCameraChangeEventDetail","summary":"The Surface3DCameraChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DCameraChangeEventDetail {camera:Scene3DCameraOptions;by:'pointer'|'wheel'|'keyboard'|'api'|'damping'|'auto';phase:'start'|'change'|'end';cancelled?:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Scene3DCameraOptions","title":"Scene3DCameraOptions","description":""}]}]}]},{"path":"/docs/types/Surface3DCrosshairDetail","title":"Surface3DCrosshairDetail","summary":"The Surface3DCrosshairDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DCrosshairDetail {cssX:number;cssY:number;dataX:number;dataY:number;dataZ:number;point:Surface3DPoint;snapped:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DPoint","title":"Surface3DPoint","description":""}]}]}]},{"path":"/docs/types/Surface3DData","title":"Surface3DData","summary":"The Surface3DData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DData=Surface3DGrid|ReadonlyArray<Surface3DValues>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DGrid","title":"Surface3DGrid","description":""},{"path":"/docs/types/Surface3DValues","title":"Surface3DValues","description":""}]}]}]},{"path":"/docs/types/Surface3DDiagnostics","title":"Surface3DDiagnostics","summary":"The Surface3DDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DDiagnostics {missingHeights:number;invalidHeights:number;missingValues:number;invalidValues:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Surface3DDomain","title":"Surface3DDomain","summary":"The Surface3DDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DDomain=readonly[number,number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Surface3DDomains","title":"Surface3DDomains","summary":"The Surface3DDomains type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DDomains=Record<Surface3DAxis,Surface3DDomain>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DAxis","title":"Surface3DAxis","description":""},{"path":"/docs/types/Surface3DDomain","title":"Surface3DDomain","description":""}]}]}]},{"path":"/docs/types/Surface3DEasing","title":"Surface3DEasing","summary":"The Surface3DEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DEasing=HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/Surface3DEngineMode","title":"Surface3DEngineMode","summary":"The Surface3DEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DEngineMode=HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/Surface3DEngineTier","title":"Surface3DEngineTier","summary":"The Surface3DEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DEngineTier=HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/Surface3DGeometry","title":"Surface3DGeometry","summary":"The Surface3DGeometry type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DGeometry {\n  rows:number;columns:number;points:number;cells:number;triangles:number;\n  positions:Float32Array;normals:Float32Array;colors:Float32Array;indices:Uint32Array;\n  pointIndices:Uint32Array;cellIndices:Uint32Array;\n  domains:Surface3DDomains;colorDomain:Surface3DDomain;size:Scene3DVector;bounds:Scene3DBounds;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DDomains","title":"Surface3DDomains","description":""},{"path":"/docs/types/Surface3DDomain","title":"Surface3DDomain","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""},{"path":"/docs/types/Scene3DBounds","title":"Scene3DBounds","description":""}]}]}]},{"path":"/docs/types/Surface3DGrid","title":"Surface3DGrid","summary":"The Surface3DGrid type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DGrid {\n  x:Surface3DNumbers;y:Surface3DNumbers;\n  z:ReadonlyArray<Surface3DValues>;\n  values?:ReadonlyArray<Surface3DValues>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DNumbers","title":"Surface3DNumbers","description":""},{"path":"/docs/types/Surface3DValues","title":"Surface3DValues","description":""}]}]}]},{"path":"/docs/types/Surface3DHitDetail","title":"Surface3DHitDetail","summary":"The Surface3DHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DHitDetail {\n  kind:'surface';point:Surface3DPoint;cell:{row:number;column:number};triangle:number;\n  x:number;y:number;z:number;value:number|null;\n  world:Scene3DVector;cssX:number;cssY:number;depth:number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DPoint","title":"Surface3DPoint","description":""},{"path":"/docs/types/Scene3DVector","title":"Scene3DVector","description":""}]}]}]},{"path":"/docs/types/Surface3DNumbers","title":"Surface3DNumbers","summary":"The Surface3DNumbers type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DNumbers = ReadonlyArray<number>|Float32Array|Float64Array;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Surface3DPoint","title":"Surface3DPoint","summary":"The Surface3DPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DPoint {row:number;column:number;x:number;y:number;z:number;value:number|null;key:string}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Surface3DRenderResult","title":"Surface3DRenderResult","summary":"The Surface3DRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DRenderResult {\n  points:number;drawn:number;renderMs:number;\n  surface3d?:{rows:number;columns:number;cells:number;triangles:number;vertices:number;chunks:number;drawCalls:number;uploadedBytes:number};\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","summary":"The Surface3DRowInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DRowInput {y:number;z:Surface3DValues;values?:Surface3DValues}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DValues","title":"Surface3DValues","description":""}]}]}]},{"path":"/docs/types/Surface3DSelection","title":"Surface3DSelection","summary":"The Surface3DSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DSelection {point:Surface3DPoint|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DPoint","title":"Surface3DPoint","description":""}]}]}]},{"path":"/docs/types/Surface3DSelectionChangeEventDetail","title":"Surface3DSelectionChangeEventDetail","summary":"The Surface3DSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DSelectionChangeEventDetail extends Surface3DSelection {by:Surface3DSelectionSource}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DSelection","title":"Surface3DSelection","description":""},{"path":"/docs/types/Surface3DSelectionSource","title":"Surface3DSelectionSource","description":""}]}]}]},{"path":"/docs/types/Surface3DSelectionSource","title":"Surface3DSelectionSource","summary":"The Surface3DSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DSelectionSource='pointer'|'keyboard'|'method'|'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/Surface3DStreamEvent","title":"Surface3DStreamEvent","summary":"The Surface3DStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DStreamEvent {\n  type:'push'|'pushBatch'|'shift'|'replace';count:number;replaced:number;entries:Surface3DRowInput[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":""}]}]}]},{"path":"/docs/types/Surface3DStreamSource","title":"Surface3DStreamSource","summary":"The Surface3DStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface Surface3DStreamSource {\n  readonly length:number;readonly capacity:number;readonly dropped:number;readonly x:ReadonlyArray<number>;\n  push(row:Surface3DRowInput):void;pushBatch(rows:ReadonlyArray<Surface3DRowInput>):void;\n  shift(count:number):void;replace(rows:ReadonlyArray<Surface3DRowInput>):void;\n  setCapacity(capacity:number):void;\n  snapshot():Surface3DGrid;subscribe(listener:(event:Surface3DStreamEvent)=>void):()=>void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/Surface3DRowInput","title":"Surface3DRowInput","description":""},{"path":"/docs/types/Surface3DGrid","title":"Surface3DGrid","description":""},{"path":"/docs/types/Surface3DStreamEvent","title":"Surface3DStreamEvent","description":""}]}]}]},{"path":"/docs/types/Surface3DUnavailableBehaviour","title":"Surface3DUnavailableBehaviour","summary":"The Surface3DUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DUnavailableBehaviour=HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/Surface3DValues","title":"Surface3DValues","summary":"The Surface3DValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type Surface3DValues = ReadonlyArray<number|null|undefined>|Float32Array|Float64Array;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/SvgLayer","title":"SvgLayer","summary":"The SvgLayer type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface SvgLayer {\n  readonly markup: string;\n  readonly x: number;\n  readonly y: number;\n  readonly width: number;\n  readonly height: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverAnimationType","title":"ThemeRiverAnimationType","summary":"The ThemeRiverAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverAnimationType=HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/ThemeRiverAxesOptions","title":"ThemeRiverAxesOptions","summary":"The ThemeRiverAxesOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverAxesOptions {show?:boolean;gridLines?:boolean;tickCount?:number;xTitle?:string;yTitle?:string;color?:string;textColor?:string;gridColor?:string;xFormat?:(value:number)=>string;yFormat?:(value:number)=>string}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverBand","title":"ThemeRiverBand","summary":"The ThemeRiverBand type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverBand {key:string;id:ThemeRiverId;seriesIndex:number;color:ThemeRiverRgba;opacity:number;passive?:boolean;points:ThemeRiverBandPoint[]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":""},{"path":"/docs/types/ThemeRiverRgba","title":"ThemeRiverRgba","description":""},{"path":"/docs/types/ThemeRiverBandPoint","title":"ThemeRiverBandPoint","description":""}]}]}]},{"path":"/docs/types/ThemeRiverBandPoint","title":"ThemeRiverBandPoint","summary":"The ThemeRiverBandPoint type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverBandPoint {x:number;y0:number;y1:number;dataX:number;lower:number;upper:number;value:number|null;column:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverCrosshairDetail","title":"ThemeRiverCrosshairDetail","summary":"The ThemeRiverCrosshairDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverCrosshairDetail {cssX:number;cssY:number;dataX:number;dataY:number;seriesId:ThemeRiverId;value:number|null;snappedPointIndex?:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":""}]}]}]},{"path":"/docs/types/ThemeRiverData","title":"ThemeRiverData","summary":"The ThemeRiverData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverData {x:ReadonlyArray<number>;series:ReadonlyArray<ThemeRiverSeriesInput>}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverSeriesInput","title":"ThemeRiverSeriesInput","description":""}]}]}]},{"path":"/docs/types/ThemeRiverDiagnostics","title":"ThemeRiverDiagnostics","summary":"The ThemeRiverDiagnostics type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverDiagnostics {columns:number;series:number;points:number;missingValues:number;zeroValues:number}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverEasing","title":"ThemeRiverEasing","summary":"The ThemeRiverEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverEasing=HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/ThemeRiverEngineMode","title":"ThemeRiverEngineMode","summary":"The ThemeRiverEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverEngineMode=HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/ThemeRiverEngineTier","title":"ThemeRiverEngineTier","summary":"The ThemeRiverEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverEngineTier=HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","summary":"The ThemeRiverHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverHitDetail {kind:'band';seriesIndex:number;seriesId:ThemeRiverId;seriesName:string;columnIndex:number;dataX:number;value:number|null;lower:number;upper:number;cssX:number;cssY:number;interpolated:boolean}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":""}]}]}]},{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","summary":"The ThemeRiverId type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverId=string|number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverLayout","title":"ThemeRiverLayout","summary":"The ThemeRiverLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverLayout {width:number;height:number;xDomain:[number,number];yDomain:[number,number];offset:ThemeRiverOffset;order:number[];bands:ThemeRiverBand[];layout:'theme-river'}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverOffset","title":"ThemeRiverOffset","description":""},{"path":"/docs/types/ThemeRiverBand","title":"ThemeRiverBand","description":""}]}]}]},{"path":"/docs/types/ThemeRiverOffset","title":"ThemeRiverOffset","summary":"The ThemeRiverOffset type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverOffset='silhouette'|'zero'|'expand';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverOrder","title":"ThemeRiverOrder","summary":"The ThemeRiverOrder type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverOrder='input'|'reverse';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverRenderResult","title":"ThemeRiverRenderResult","summary":"The ThemeRiverRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverRenderResult {points:number;drawn:number;renderMs:number;themeRiver?:{series:number;columns:number;triangles:number;vertices:number;uploadedBytes:number;drawCalls:number}}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverRgba","title":"ThemeRiverRgba","summary":"The ThemeRiverRgba type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverRgba=readonly[number,number,number,number];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","summary":"The ThemeRiverRow type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverRow {x:number;values:ReadonlyArray<number|null>}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ThemeRiverSelection","title":"ThemeRiverSelection","summary":"The ThemeRiverSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverSelection {seriesId:ThemeRiverId;dataX:number;point:ThemeRiverHitDetail|null}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":""},{"path":"/docs/types/ThemeRiverHitDetail","title":"ThemeRiverHitDetail","description":""}]}]}]},{"path":"/docs/types/ThemeRiverSelectionChangeEventDetail","title":"ThemeRiverSelectionChangeEventDetail","summary":"The ThemeRiverSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverSelectionChangeEventDetail {selection:ThemeRiverSelection|null;by:'pointer'|'keyboard'|'method'|'data'}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverSelection","title":"ThemeRiverSelection","description":""}]}]}]},{"path":"/docs/types/ThemeRiverSeriesInput","title":"ThemeRiverSeriesInput","summary":"The ThemeRiverSeriesInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverSeriesInput {id:ThemeRiverId;name?:string;color?:string;values:ReadonlyArray<number|null>}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":""}]}]}]},{"path":"/docs/types/ThemeRiverStreamEvent","title":"ThemeRiverStreamEvent","summary":"The ThemeRiverStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverStreamEvent {type:'push'|'pushBatch'|'shift'|'replace';count:number;replaced:number;entries:ThemeRiverRow[]}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":""}]}]}]},{"path":"/docs/types/ThemeRiverStreamSource","title":"ThemeRiverStreamSource","summary":"The ThemeRiverStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ThemeRiverStreamSource {readonly length:number;readonly capacity:number;readonly dropped:number;readonly seriesIds:ReadonlyArray<ThemeRiverId>;push(row:ThemeRiverRow):void;pushBatch(rows:ReadonlyArray<ThemeRiverRow>):void;shift(count:number):void;replace(rows:ReadonlyArray<ThemeRiverRow>):void;setCapacity(capacity:number):void;snapshot():ThemeRiverRow[];subscribe(listener:(event:ThemeRiverStreamEvent)=>void):()=>void}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ThemeRiverId","title":"ThemeRiverId","description":""},{"path":"/docs/types/ThemeRiverRow","title":"ThemeRiverRow","description":""},{"path":"/docs/types/ThemeRiverStreamEvent","title":"ThemeRiverStreamEvent","description":""}]}]}]},{"path":"/docs/types/ThemeRiverUnavailableBehaviour","title":"ThemeRiverUnavailableBehaviour","summary":"The ThemeRiverUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ThemeRiverUnavailableBehaviour=HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/TilemapAnimationType","title":"TilemapAnimationType","summary":"The TilemapAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapColorAxisInput","title":"TilemapColorAxisInput","summary":"The TilemapColorAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapColorAxisInput =\n  | undefined\n  | null\n  | false\n  | true\n  | 'auto'\n  | TilemapColorAxisObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapColorAxisObjectInput","title":"TilemapColorAxisObjectInput","description":""}]}]}]},{"path":"/docs/types/TilemapColorAxisObjectInput","title":"TilemapColorAxisObjectInput","summary":"The TilemapColorAxisObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapColorAxisObjectInput {\n  readonly min?: number;\n  readonly max?: number;\n  readonly scheme?: TilemapSequentialSchemeName;\n  readonly minColor?: string;\n  readonly maxColor?: string;\n  readonly stops?: ReadonlyArray<readonly [number, string]>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapSequentialSchemeName","title":"TilemapSequentialSchemeName","description":""}]}]}]},{"path":"/docs/types/TilemapData","title":"TilemapData","summary":"The TilemapData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapData = ReadonlyArray<TilemapDatum>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":""}]}]}]},{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","summary":"The TilemapDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapDatum {\n  readonly x: number;\n  readonly y: number;\n  readonly name?: string;\n  readonly label?: string;\n  readonly value?: number;\n  readonly color?: string;\n  readonly id?: string | number;\n  readonly visible?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapEasing","title":"TilemapEasing","summary":"The TilemapEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapEngineMode","title":"TilemapEngineMode","summary":"The TilemapEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapEngineTier","title":"TilemapEngineTier","summary":"The TilemapEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapLegendPosition","title":"TilemapLegendPosition","summary":"The TilemapLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapPaletteName","title":"TilemapPaletteName","summary":"The TilemapPaletteName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapPaletteName = 'tableau10' | 'tableau20' | 'observable10' | 'paired12' | 'set3_12';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapPointEventDetail","title":"TilemapPointEventDetail","summary":"The TilemapPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapPointEventDetail {\n  readonly index: number;\n  readonly id: string;\n  readonly col: number;\n  readonly row: number;\n  readonly name: string;\n  readonly label?: string;\n  readonly value?: number;\n  readonly color: string;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapRenderResult","title":"TilemapRenderResult","summary":"The TilemapRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapRenderResult {\n  readonly tiles: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapResolvedTile","title":"TilemapResolvedTile","summary":"The TilemapResolvedTile type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapResolvedTile {\n  readonly index: number;\n  readonly id: string;\n  readonly col: number;\n  readonly row: number;\n  readonly name: string;\n  readonly label?: string;\n  readonly value?: number;\n  readonly color: string;\n  readonly explicitColor: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapSequentialSchemeName","title":"TilemapSequentialSchemeName","summary":"The TilemapSequentialSchemeName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapSequentialSchemeName =\n  | 'viridis' | 'inferno' | 'magma' | 'plasma' | 'cividis'\n  | 'blues' | 'greens' | 'oranges' | 'reds' | 'purples' | 'greys';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapStreamEvent","title":"TilemapStreamEvent","summary":"The TilemapStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapStreamSource","title":"TilemapStreamSource","summary":"The TilemapStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapStreamSource {\n  push(datum: TilemapDatum): void;\n  pushBatch(datums: ReadonlyArray<TilemapDatum>): void;\n  shift(count: number): void;\n  replace(datums: ReadonlyArray<TilemapDatum>): void;\n  snapshot(window?: number): TilemapDatum[];\n  subscribe(listener: (event: TilemapStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapDatum","title":"TilemapDatum","description":""},{"path":"/docs/types/TilemapStreamEvent","title":"TilemapStreamEvent","description":""}]}]}]},{"path":"/docs/types/TilemapTileShape","title":"TilemapTileShape","summary":"The TilemapTileShape type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTileShape = 'square' | 'hexagon' | 'circle' | 'diamond';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapTooltipActionEventDetail","title":"TilemapTooltipActionEventDetail","summary":"The TilemapTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapTooltipActionEventDetail extends TilemapTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipFormatContext","title":"TilemapTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/TilemapTooltipConnectorInput","title":"TilemapTooltipConnectorInput","summary":"The TilemapTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<TilemapTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipConnectorSpec","title":"TilemapTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/TilemapTooltipConnectorSpec","title":"TilemapTooltipConnectorSpec","summary":"The TilemapTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapTooltipFormatContext","title":"TilemapTooltipFormatContext","summary":"The TilemapTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapTooltipFormatContext {\n  index: number;\n  id: string;\n  name: string;\n  label?: string;\n  col: number;\n  row: number;\n  value?: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapTooltipInput","title":"TilemapTooltipInput","summary":"The TilemapTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | TilemapTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipObjectInput","title":"TilemapTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/TilemapTooltipObjectInput","title":"TilemapTooltipObjectInput","summary":"The TilemapTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipObjectInput = Omit<Partial<TilemapTooltipSpec>, 'connector'> & {\n  connector?: TilemapTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipSpec","title":"TilemapTooltipSpec","description":""},{"path":"/docs/types/TilemapTooltipConnectorInput","title":"TilemapTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/TilemapTooltipOpenMode","title":"TilemapTooltipOpenMode","summary":"The TilemapTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapTooltipShowEventDetail","title":"TilemapTooltipShowEventDetail","summary":"The TilemapTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: TilemapTooltipSide;\n  text: string;\n  html?: string;\n  context?: TilemapTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipSide","title":"TilemapTooltipSide","description":""},{"path":"/docs/types/TilemapTooltipFormatContext","title":"TilemapTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/TilemapTooltipSide","title":"TilemapTooltipSide","summary":"The TilemapTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapTooltipSpec","title":"TilemapTooltipSpec","summary":"The TilemapTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TilemapTooltipSpec {\n  show: boolean;\n  openMode: TilemapTooltipOpenMode;\n  trigger: TilemapTooltipTrigger;\n  side?: TilemapTooltipSide;\n  offset: number;\n  format?: (tile: TilemapResolvedTile, context?: TilemapTooltipFormatContext) => string;\n  html?: (tile: TilemapResolvedTile, context?: TilemapTooltipFormatContext) => string;\n  className?: string;\n  style?: TilemapTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: TilemapTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipOpenMode","title":"TilemapTooltipOpenMode","description":""},{"path":"/docs/types/TilemapTooltipTrigger","title":"TilemapTooltipTrigger","description":""},{"path":"/docs/types/TilemapTooltipSide","title":"TilemapTooltipSide","description":""},{"path":"/docs/types/TilemapResolvedTile","title":"TilemapResolvedTile","description":""},{"path":"/docs/types/TilemapTooltipFormatContext","title":"TilemapTooltipFormatContext","description":""},{"path":"/docs/types/TilemapTooltipStyle","title":"TilemapTooltipStyle","description":""},{"path":"/docs/types/TilemapTooltipConnectorSpec","title":"TilemapTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/TilemapTooltipStyle","title":"TilemapTooltipStyle","summary":"The TilemapTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipStyle = Record<string, TilemapTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TilemapTooltipStyleValue","title":"TilemapTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/TilemapTooltipStyleValue","title":"TilemapTooltipStyleValue","summary":"The TilemapTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapTooltipTrigger","title":"TilemapTooltipTrigger","summary":"The TilemapTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TilemapUnavailableBehaviour","title":"TilemapUnavailableBehaviour","summary":"The TilemapUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TilemapUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/TornadoChartAnimationType","title":"TornadoChartAnimationType","summary":"The TornadoChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoChartDatum","title":"TornadoChartDatum","summary":"The TornadoChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoChartEasing","title":"TornadoChartEasing","summary":"The TornadoChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoChartEngineMode","title":"TornadoChartEngineMode","summary":"The TornadoChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartEngineMode = 'auto' | TornadoChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TornadoChartEngineTier","title":"TornadoChartEngineTier","description":""}]}]}]},{"path":"/docs/types/TornadoChartEngineTier","title":"TornadoChartEngineTier","summary":"The TornadoChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoChartPointerEventDetail","title":"TornadoChartPointerEventDetail","summary":"The TornadoChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TornadoChartPointerEventDetail {\n  categoryIndex: number;\n  seriesIndex: number;\n  seriesName: string;\n  index: number;\n  category: string;\n  side: TornadoChartSide;\n  value: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TornadoChartSide","title":"TornadoChartSide","description":""}]}]}]},{"path":"/docs/types/TornadoChartRenderResult","title":"TornadoChartRenderResult","summary":"The TornadoChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TornadoChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoChartSide","title":"TornadoChartSide","summary":"The TornadoChartSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartSide = 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoChartStreamEvent","title":"TornadoChartStreamEvent","summary":"The TornadoChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoChartStreamSource","title":"TornadoChartStreamSource","summary":"The TornadoChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TornadoChartStreamSource {\n  push(datum: TornadoRowDatum): void;\n  pushBatch(data: ReadonlyArray<TornadoRowDatum>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<TornadoRowDatum>): void;\n  snapshot(window?: number): TornadoRowDatum[];\n  latest(): TornadoRowDatum | undefined;\n  subscribe(listener: (event: TornadoChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TornadoRowDatum","title":"TornadoRowDatum","description":""},{"path":"/docs/types/TornadoChartStreamEvent","title":"TornadoChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/TornadoChartUnavailableBehaviour","title":"TornadoChartUnavailableBehaviour","summary":"The TornadoChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/TornadoChartValues","title":"TornadoChartValues","summary":"The TornadoChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TornadoChartValues = Float32Array | TornadoChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TornadoChartDatum","title":"TornadoChartDatum","description":""}]}]}]},{"path":"/docs/types/TornadoDatum","title":"TornadoDatum","summary":"The TornadoDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TornadoDatum {\n  category: string;\n  values: ReadonlyArray<number | null | undefined>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TornadoRowDatum","title":"TornadoRowDatum","summary":"The TornadoRowDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TornadoRowDatum {\n  category?: string;\n  values: ReadonlyArray<number>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TradeSide","title":"TradeSide","summary":"The TradeSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TradeSide = 'buy' | 'sell';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapAnimationType","title":"TreemapAnimationType","summary":"The TreemapAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/TreemapData","title":"TreemapData","summary":"The TreemapData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapData = TreemapNodeInput | ReadonlyArray<TreemapNodeInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":""}]}]}]},{"path":"/docs/types/TreemapDrillChangeEventDetail","title":"TreemapDrillChangeEventDetail","summary":"The TreemapDrillChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapDrillChangeEventDetail { rootId: string | null; previousRootId: string | null; by: TreemapSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapSelectionSource","title":"TreemapSelectionSource","description":""}]}]}]},{"path":"/docs/types/TreemapEasing","title":"TreemapEasing","summary":"The TreemapEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/TreemapEngineMode","title":"TreemapEngineMode","summary":"The TreemapEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/TreemapEngineTier","title":"TreemapEngineTier","summary":"The TreemapEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/TreemapExtent","title":"TreemapExtent","summary":"The TreemapExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapExtent { nodes: number; leaves: number; total: number; depth: number; valueMax: number }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapHitDetail","title":"TreemapHitDetail","summary":"The TreemapHitDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapHitDetail {\n  kind: 'node';\n  nodeIndex: number;\n  node: TreemapNode;\n  cssX: number;\n  cssY: number;\n  value: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":""}]}]}]},{"path":"/docs/types/TreemapLabel","title":"TreemapLabel","summary":"The TreemapLabel type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapLabel { index: number; id: string; text: string; x: number; y: number; width: number; height: number; shown: boolean; opacity: number; color: string }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapLabelMode","title":"TreemapLabelMode","summary":"The TreemapLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapLabelMode = 'auto' | 'show' | 'hide';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapLayout","title":"TreemapLayout","summary":"The TreemapLayout type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapLayout = 'slice-dice' | 'squarify';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapLayoutResult","title":"TreemapLayoutResult","summary":"The TreemapLayoutResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapLayoutResult {\n  nodes: TreemapRect[];\n  width: number;\n  height: number;\n  total: number;\n  rootId: string | null;\n  layout: TreemapLayout;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapRect","title":"TreemapRect","description":""},{"path":"/docs/types/TreemapLayout","title":"TreemapLayout","description":""}]}]}]},{"path":"/docs/types/TreemapNode","title":"TreemapNode","summary":"The TreemapNode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapNode {\n  index: number;\n  id: string;\n  label: string;\n  color: string | null;\n  parent: number | null;\n  children: number[];\n  depth: number;\n  ownValue: number;\n  value: number;\n  origin: 'data' | 'stream';\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","summary":"The TreemapNodeInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapNodeInput {\n  id: string;\n  label?: string;\n  color?: string;\n  parent?: string | null;\n  value?: number;\n  children?: ReadonlyArray<TreemapNodeInput>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapRect","title":"TreemapRect","summary":"The TreemapRect type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapRect {\n  index: number;\n  id: string;\n  x: number;\n  y: number;\n  width: number;\n  height: number;\n  depth: number;\n  opacity: number;\n  passive?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapRenderResult","title":"TreemapRenderResult","summary":"The TreemapRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapRenderResult {\n  points: number;\n  drawn: number;\n  renderMs: number;\n  treemap?: { nodes: number; drawn: number; vertices: number; bytes: number; uploaded: number; full: boolean; version: number; activeNode: number; chunks: number; chunkVertices: number; capacity: number; cut: number };\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapSelection","title":"TreemapSelection","summary":"The TreemapSelection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapSelection { nodeIndex: number; node: TreemapNode | null }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapNode","title":"TreemapNode","description":""}]}]}]},{"path":"/docs/types/TreemapSelectionChangeEventDetail","title":"TreemapSelectionChangeEventDetail","summary":"The TreemapSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapSelectionChangeEventDetail extends TreemapSelection { by: TreemapSelectionSource }","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapSelection","title":"TreemapSelection","description":""},{"path":"/docs/types/TreemapSelectionSource","title":"TreemapSelectionSource","description":""}]}]}]},{"path":"/docs/types/TreemapSelectionSource","title":"TreemapSelectionSource","summary":"The TreemapSelectionSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapSelectionSource = 'pointer' | 'keyboard' | 'method' | 'data';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/TreemapStreamEvent","title":"TreemapStreamEvent","summary":"The TreemapStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: TreemapNodeInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":""}]}]}]},{"path":"/docs/types/TreemapStreamSource","title":"TreemapStreamSource","summary":"The TreemapStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface TreemapStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(node: TreemapNodeInput): void;\n  pushBatch(nodes: ReadonlyArray<TreemapNodeInput>): void;\n  shift(count: number): void;\n  replace(nodes: ReadonlyArray<TreemapNodeInput>): void;\n  snapshot(): TreemapNodeInput[];\n  subscribe(listener: (event: TreemapStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/TreemapNodeInput","title":"TreemapNodeInput","description":""},{"path":"/docs/types/TreemapStreamEvent","title":"TreemapStreamEvent","description":""}]}]}]},{"path":"/docs/types/TreemapUnavailableBehaviour","title":"TreemapUnavailableBehaviour","summary":"The TreemapUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type TreemapUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/VariwideChartAnimationType","title":"VariwideChartAnimationType","summary":"The VariwideChartAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideChartDatum","title":"VariwideChartDatum","summary":"The VariwideChartDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartDatum = number | null | undefined;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideChartEasing","title":"VariwideChartEasing","summary":"The VariwideChartEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideChartEngineMode","title":"VariwideChartEngineMode","summary":"The VariwideChartEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartEngineMode = 'auto' | VariwideChartEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VariwideChartEngineTier","title":"VariwideChartEngineTier","description":""}]}]}]},{"path":"/docs/types/VariwideChartEngineTier","title":"VariwideChartEngineTier","summary":"The VariwideChartEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartEngineTier = 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideChartPointerEventDetail","title":"VariwideChartPointerEventDetail","summary":"The VariwideChartPointerEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VariwideChartPointerEventDetail {\n  index: number;\n  category: string;\n  value: number;\n  weight: number;\n  color?: string;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideChartRenderResult","title":"VariwideChartRenderResult","summary":"The VariwideChartRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VariwideChartRenderResult {\n  points: number;\n  renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideChartStreamEvent","title":"VariwideChartStreamEvent","summary":"The VariwideChartStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideChartStreamSource","title":"VariwideChartStreamSource","summary":"The VariwideChartStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VariwideChartStreamSource {\n  push(datum: VariwideColumnDatum): void;\n  pushBatch(data: ReadonlyArray<VariwideColumnDatum>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<VariwideColumnDatum>): void;\n  snapshot(window?: number): VariwideColumnDatum[];\n  latest(): VariwideColumnDatum | undefined;\n  subscribe(listener: (event: VariwideChartStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VariwideColumnDatum","title":"VariwideColumnDatum","description":""},{"path":"/docs/types/VariwideChartStreamEvent","title":"VariwideChartStreamEvent","description":""}]}]}]},{"path":"/docs/types/VariwideChartUnavailableBehaviour","title":"VariwideChartUnavailableBehaviour","summary":"The VariwideChartUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/VariwideChartValues","title":"VariwideChartValues","summary":"The VariwideChartValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VariwideChartValues = Float32Array | VariwideChartDatum[];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VariwideChartDatum","title":"VariwideChartDatum","description":""}]}]}]},{"path":"/docs/types/VariwideColumnDatum","title":"VariwideColumnDatum","summary":"The VariwideColumnDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VariwideColumnDatum {\n  category?: string;\n  value: number;\n  weight: number;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VariwideDatum","title":"VariwideDatum","summary":"The VariwideDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VariwideDatum {\n  category: string;\n  value: VariwideChartDatum;\n  weight: VariwideChartDatum;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VariwideChartDatum","title":"VariwideChartDatum","description":""}]}]}]},{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","summary":"The VisualMapBinding type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapBinding = VisualMapSnapshot & {\n  dimension?: VisualMapDimension;\n  size?: VisualMapSizeSpec | null;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapSnapshot","title":"VisualMapSnapshot","description":""},{"path":"/docs/types/VisualMapDimension","title":"VisualMapDimension","description":""},{"path":"/docs/types/VisualMapSizeSpec","title":"VisualMapSizeSpec","description":""}]}]}]},{"path":"/docs/types/VisualMapColorInput","title":"VisualMapColorInput","summary":"The VisualMapColorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapColorInput = string | ReadonlyArray<string> | ReadonlyArray<readonly [number, string]>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapDimension","title":"VisualMapDimension","summary":"The VisualMapDimension type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapDimension = 'value' | 'x' | 'y' | 'z' | 'index' | (string & {});","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","summary":"The VisualMapExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapExtent {\n  min: number;\n  max: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","summary":"The VisualMapExtentRequest type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapExtentRequest {\n  dimension?: VisualMapDimension;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapDimension","title":"VisualMapDimension","description":""}]}]}]},{"path":"/docs/types/VisualMapPiece","title":"VisualMapPiece","summary":"The VisualMapPiece type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapPiece {\n  index: number;\n  min?: number;\n  max?: number;\n  value?: string | number;\n  label: string;\n  color: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapPieceInput","title":"VisualMapPieceInput","summary":"The VisualMapPieceInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapPieceInput {\n  min?: number;\n  max?: number;\n  value?: string | number;\n  label?: string;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapPiecewiseMode","title":"VisualMapPiecewiseMode","summary":"The VisualMapPiecewiseMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapPiecewiseMode = 'pieces' | 'split' | 'categories';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapRange","title":"VisualMapRange","summary":"The VisualMapRange type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapRange {\n  min: number;\n  max: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapRangeChangeEventDetail","title":"VisualMapRangeChangeEventDetail","summary":"The VisualMapRangeChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapRangeChangeEventDetail {\n  range: VisualMapRange | null;\n  source: VisualMapRangeChangeSource;\n  live: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapRange","title":"VisualMapRange","description":""},{"path":"/docs/types/VisualMapRangeChangeSource","title":"VisualMapRangeChangeSource","description":""}]}]}]},{"path":"/docs/types/VisualMapRangeChangeSource","title":"VisualMapRangeChangeSource","summary":"The VisualMapRangeChangeSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapRangeChangeSource = 'control' | 'api';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapSelectedMode","title":"VisualMapSelectedMode","summary":"The VisualMapSelectedMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapSelectedMode = 'multiple' | 'single';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapSelectionChangeEventDetail","title":"VisualMapSelectionChangeEventDetail","summary":"The VisualMapSelectionChangeEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapSelectionChangeEventDetail {\n  selected: boolean[];\n  index: number | null;\n  source: VisualMapRangeChangeSource;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapRangeChangeSource","title":"VisualMapRangeChangeSource","description":""}]}]}]},{"path":"/docs/types/VisualMapSizeSpec","title":"VisualMapSizeSpec","summary":"The VisualMapSizeSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapSizeSpec {\n  range: readonly [number, number];\n  dimension?: VisualMapDimension;\n  outOfRange?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapDimension","title":"VisualMapDimension","description":""}]}]}]},{"path":"/docs/types/VisualMapSnapshot","title":"VisualMapSnapshot","summary":"The VisualMapSnapshot type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapSnapshot = ContinuousVisualMapSnapshot | PiecewiseVisualMapSnapshot;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ContinuousVisualMapSnapshot","title":"ContinuousVisualMapSnapshot","description":""},{"path":"/docs/types/PiecewiseVisualMapSnapshot","title":"PiecewiseVisualMapSnapshot","description":""}]}]}]},{"path":"/docs/types/VisualMapStop","title":"VisualMapStop","summary":"The VisualMapStop type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapStop {\n  t: number;\n  color: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/VisualMapTargetElement","title":"VisualMapTargetElement","summary":"The VisualMapTargetElement type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface VisualMapTargetElement extends HTMLElement {\n  setVisualMap?: (binding: VisualMapBinding | null) => Promise<VisualMapBinding | null>;\n  getVisualMap?: () => Promise<VisualMapBinding | null>;\n  getVisualExtent?: (request?: VisualMapExtentRequest) => Promise<VisualMapExtent | null>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/VisualMapBinding","title":"VisualMapBinding","description":""},{"path":"/docs/types/VisualMapExtentRequest","title":"VisualMapExtentRequest","description":""},{"path":"/docs/types/VisualMapExtent","title":"VisualMapExtent","description":""}]}]}]},{"path":"/docs/types/VisualMapType","title":"VisualMapType","summary":"The VisualMapType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type VisualMapType = 'continuous' | 'piecewise';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferCorrelationMetric","title":"WaferCorrelationMetric","summary":"The WaferCorrelationMetric type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferCorrelationMetric = Exclude<WaferStackMetric, 'fail-count'>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferStackMetric","title":"WaferStackMetric","description":""}]}]}]},{"path":"/docs/types/WaferCorrelationResult","title":"WaferCorrelationResult","summary":"The WaferCorrelationResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferCorrelationResult {\n  readonly values: ReadonlyArray<WaferDieDatum>;\n  readonly metric: WaferCorrelationMetric;\n  readonly waferCountA: number;\n  readonly waferCountB: number;\n  readonly cellsCompared: number;\n  readonly meanDelta: number;\n  readonly maxAbsDelta: number;\n  readonly worseCells: number;\n  readonly betterCells: number;\n  readonly correlation: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":""},{"path":"/docs/types/WaferCorrelationMetric","title":"WaferCorrelationMetric","description":""}]}]}]},{"path":"/docs/types/WaferDefectData","title":"WaferDefectData","summary":"The WaferDefectData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferDefectData = ReadonlyArray<WaferDefectDatum>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferDefectDatum","title":"WaferDefectDatum","description":""}]}]}]},{"path":"/docs/types/WaferDefectDatum","title":"WaferDefectDatum","summary":"The WaferDefectDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferDefectDatum {\n  readonly x: number;\n  readonly y: number;\n  readonly class?: number | string;\n  readonly size?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","summary":"The WaferDieDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferDieDatum {\n  readonly col: number;\n  readonly row: number;\n  readonly bin?: number | string;\n  readonly value?: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferDieEventDetail","title":"WaferDieEventDetail","summary":"The WaferDieEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferDieEventDetail {\n  readonly col: number;\n  readonly row: number;\n  readonly status: DieStatus;\n  readonly ix: number;\n  readonly iy: number;\n  readonly ordinal: number;\n  readonly shotCol: number;\n  readonly shotRow: number;\n  readonly bin?: number | string;\n  readonly value?: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/DieStatus","title":"DieStatus","description":""}]}]}]},{"path":"/docs/types/WaferIndicator","title":"WaferIndicator","summary":"The WaferIndicator type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferIndicator = 'notch' | 'flat' | 'none';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapAnimationType","title":"WaferMapAnimationType","summary":"The WaferMapAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapData","title":"WaferMapData","summary":"The WaferMapData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapData = ReadonlyArray<WaferDieDatum>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":""}]}]}]},{"path":"/docs/types/WaferMapEasing","title":"WaferMapEasing","summary":"The WaferMapEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapEngineMode","title":"WaferMapEngineMode","summary":"The WaferMapEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapEngineTier","title":"WaferMapEngineTier","summary":"The WaferMapEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapLegendPosition","title":"WaferMapLegendPosition","summary":"The WaferMapLegendPosition type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapLegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'float';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapMode","title":"WaferMapMode","summary":"The WaferMapMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapMode = 'grid' | 'bin' | 'binary' | 'value';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapRenderResult","title":"WaferMapRenderResult","summary":"The WaferMapRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferMapRenderResult {\n  readonly dies: number;\n  readonly fullDies: number;\n  readonly partialDies: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapStreamEvent","title":"WaferMapStreamEvent","summary":"The WaferMapStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferMapStreamEvent {\n  readonly type: WaferMapStreamEventType;\n  readonly count: number;\n  readonly dies: ReadonlyArray<WaferDieDatum>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferMapStreamEventType","title":"WaferMapStreamEventType","description":""},{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":""}]}]}]},{"path":"/docs/types/WaferMapStreamEventType","title":"WaferMapStreamEventType","summary":"The WaferMapStreamEventType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapStreamEventType = 'push' | 'pushBatch' | 'shift' | 'replace';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferMapStreamSource","title":"WaferMapStreamSource","summary":"The WaferMapStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferMapStreamSource {\n  push(datum: WaferDieDatum): void;\n  pushBatch(data: WaferMapData): void;\n  shift(count: number): void;\n  replace(data: WaferMapData): void;\n  snapshot(): WaferDieDatum[];\n  latest(): WaferDieDatum | undefined;\n  subscribe(listener: (event: WaferMapStreamEvent) => void): () => void;\n  readonly length: number;\n  readonly capacity: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":""},{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":""},{"path":"/docs/types/WaferMapStreamEvent","title":"WaferMapStreamEvent","description":""}]}]}]},{"path":"/docs/types/WaferMapUnavailableBehaviour","title":"WaferMapUnavailableBehaviour","summary":"The WaferMapUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferMapUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/WaferOrientation","title":"WaferOrientation","summary":"The WaferOrientation type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferOrientation = 'down' | 'up' | 'left' | 'right';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferStackMetric","title":"WaferStackMetric","summary":"The WaferStackMetric type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferStackMetric = 'fail-count' | 'fail-rate' | 'mean-value';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferStackResult","title":"WaferStackResult","summary":"The WaferStackResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferStackResult {\n  readonly values: ReadonlyArray<WaferDieDatum>;\n  readonly metric: WaferStackMetric;\n  readonly waferCount: number;\n  readonly maxFail: number;\n  readonly repeatThreshold: number;\n  readonly systematicCells: ReadonlyArray<{ readonly col: number; readonly row: number; readonly failCount: number }>;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferDieDatum","title":"WaferDieDatum","description":""},{"path":"/docs/types/WaferStackMetric","title":"WaferStackMetric","description":""}]}]}]},{"path":"/docs/types/WaferStackWafer","title":"WaferStackWafer","summary":"The WaferStackWafer type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferStackWafer {\n  readonly id?: string | number;\n  readonly values: WaferMapData;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferMapData","title":"WaferMapData","description":""}]}]}]},{"path":"/docs/types/WaferValueAxisInput","title":"WaferValueAxisInput","summary":"The WaferValueAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaferValueAxisInput = boolean | 'auto' | WaferValueAxisObjectInput | undefined | null;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaferValueAxisObjectInput","title":"WaferValueAxisObjectInput","description":""}]}]}]},{"path":"/docs/types/WaferValueAxisObjectInput","title":"WaferValueAxisObjectInput","summary":"The WaferValueAxisObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferValueAxisObjectInput {\n  readonly min?: number;\n  readonly max?: number;\n  readonly scheme?: string;\n  readonly minColor?: string;\n  readonly maxColor?: string;\n  readonly stops?: ReadonlyArray<readonly [number, string]>;\n  readonly center?: number;\n  readonly reverse?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaferValueStats","title":"WaferValueStats","summary":"The WaferValueStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaferValueStats {\n  readonly count: number;\n  readonly min: number;\n  readonly max: number;\n  readonly mean: number;\n  readonly stdDev: number;\n  readonly median: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaterfallAnimationType","title":"WaterfallAnimationType","summary":"The WaterfallAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallAnimationType = HeatmapAnimationType;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapAnimationType","title":"HeatmapAnimationType","description":""}]}]}]},{"path":"/docs/types/WaterfallBar","title":"WaterfallBar","summary":"The WaterfallBar type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallBar {\n  index: number;\n  category: string;\n  kind: WaterfallBarKind;\n  value: number;\n  start: number;\n  end: number;\n  running: number;\n  direction: WaterfallDirection;\n  color: string | null;\n  source: 'data' | 'stream' | 'auto';\n  detected?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallBarKind","title":"WaterfallBarKind","description":""},{"path":"/docs/types/WaterfallDirection","title":"WaterfallDirection","description":""}]}]}]},{"path":"/docs/types/WaterfallBarKind","title":"WaterfallBarKind","summary":"The WaterfallBarKind type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallBarKind = 'delta' | 'total' | 'subtotal';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaterfallData","title":"WaterfallData","summary":"The WaterfallData type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallData = ReadonlyArray<WaterfallDatumInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","description":""}]}]}]},{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","summary":"The WaterfallDatumInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallDatumInput = WaterfallDatumObject | WaterfallDatumTuple;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallDatumObject","title":"WaterfallDatumObject","description":""},{"path":"/docs/types/WaterfallDatumTuple","title":"WaterfallDatumTuple","description":""}]}]}]},{"path":"/docs/types/WaterfallDatumObject","title":"WaterfallDatumObject","summary":"The WaterfallDatumObject type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallDatumObject {\n  category: string;\n  value?: number;\n  kind?: WaterfallBarKind;\n  color?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallBarKind","title":"WaterfallBarKind","description":""}]}]}]},{"path":"/docs/types/WaterfallDatumTuple","title":"WaterfallDatumTuple","summary":"The WaterfallDatumTuple type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallDatumTuple = readonly [category: string, value: number, kind?: WaterfallBarKind];","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallBarKind","title":"WaterfallBarKind","description":""}]}]}]},{"path":"/docs/types/WaterfallDirection","title":"WaterfallDirection","summary":"The WaterfallDirection type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallDirection = 'up' | 'down' | 'total';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaterfallDomain","title":"WaterfallDomain","summary":"The WaterfallDomain type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallDomain {\n  yMin: number;\n  yMax: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaterfallDrawStats","title":"WaterfallDrawStats","summary":"The WaterfallDrawStats type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallDrawStats {\n  bars: number;\n  drawn: number;\n  instances: number;\n  bytes: number;\n  uploaded: number;\n  full: boolean;\n  version: number;\n  pitchPx: number;\n  barPx: number;\n  connectors: boolean;\n  activeIndex: number;\n  colored: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaterfallEasing","title":"WaterfallEasing","summary":"The WaterfallEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallEasing = HeatmapEasing;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEasing","title":"HeatmapEasing","description":""}]}]}]},{"path":"/docs/types/WaterfallEngineMode","title":"WaterfallEngineMode","summary":"The WaterfallEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallEngineMode = HeatmapEngineMode;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineMode","title":"HeatmapEngineMode","description":""}]}]}]},{"path":"/docs/types/WaterfallEngineTier","title":"WaterfallEngineTier","summary":"The WaterfallEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallEngineTier = HeatmapEngineTier;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapEngineTier","title":"HeatmapEngineTier","description":""}]}]}]},{"path":"/docs/types/WaterfallExtent","title":"WaterfallExtent","summary":"The WaterfallExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallExtent {\n  bars: number;\n  deltas: number;\n  totals: number;\n  valueMin: number;\n  valueMax: number;\n  running: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaterfallLabelMode","title":"WaterfallLabelMode","summary":"The WaterfallLabelMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallLabelMode = 'value' | 'running' | 'both';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WaterfallPointEventDetail","title":"WaterfallPointEventDetail","summary":"The WaterfallPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallPointEventDetail {\n  index: number;\n  category: string;\n  kind: WaterfallBarKind;\n  value: number;\n  start: number;\n  end: number;\n  running: number;\n  direction: WaterfallDirection;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallBarKind","title":"WaterfallBarKind","description":""},{"path":"/docs/types/WaterfallDirection","title":"WaterfallDirection","description":""}]}]}]},{"path":"/docs/types/WaterfallRenderResult","title":"WaterfallRenderResult","summary":"The WaterfallRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallRenderResult {\n  bars: number;\n  drawn: number;\n  renderMs: number;\n  waterfall?: WaterfallDrawStats;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallDrawStats","title":"WaterfallDrawStats","description":""}]}]}]},{"path":"/docs/types/WaterfallStreamEvent","title":"WaterfallStreamEvent","summary":"The WaterfallStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallStreamEvent {\n  type: 'push' | 'pushBatch' | 'shift' | 'replace';\n  count: number;\n  entries: WaterfallDatumInput[];\n  replaced: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","description":""}]}]}]},{"path":"/docs/types/WaterfallStreamSource","title":"WaterfallStreamSource","summary":"The WaterfallStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WaterfallStreamSource {\n  readonly length: number;\n  readonly capacity: number;\n  readonly dropped: number;\n  push(datum: WaterfallDatumInput): void;\n  pushBatch(data: ReadonlyArray<WaterfallDatumInput>): void;\n  shift(count: number): void;\n  replace(data: ReadonlyArray<WaterfallDatumInput>): void;\n  snapshot(): WaterfallDatumInput[];\n  subscribe(listener: (event: WaterfallStreamEvent) => void): () => void;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WaterfallDatumInput","title":"WaterfallDatumInput","description":""},{"path":"/docs/types/WaterfallStreamEvent","title":"WaterfallStreamEvent","description":""}]}]}]},{"path":"/docs/types/WaterfallUnavailableBehaviour","title":"WaterfallUnavailableBehaviour","summary":"The WaterfallUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WaterfallUnavailableBehaviour = HeatmapUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/HeatmapUnavailableBehaviour","title":"HeatmapUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/WordCloudAnimationType","title":"WordCloudAnimationType","summary":"The WordCloudAnimationType type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudAnimationType = 'initial' | 'update';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","summary":"The WordCloudDatum type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudDatum =\n  | readonly [name: string, weight: number]\n  | {\n      readonly name: string;\n      readonly weight: number;\n      readonly color?: string;\n      readonly rotation?: number;\n      readonly visible?: boolean;\n      readonly id?: string | number;\n    };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudEasing","title":"WordCloudEasing","summary":"The WordCloudEasing type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudEasing = 'linear' | 'ease-out' | 'ease-in' | 'ease-in-out';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudEngineMode","title":"WordCloudEngineMode","summary":"The WordCloudEngineMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudEngineMode = 'auto' | 'standard' | 'pro';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudEngineTier","title":"WordCloudEngineTier","summary":"The WordCloudEngineTier type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudEngineTier = 'standard';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudPaletteName","title":"WordCloudPaletteName","summary":"The WordCloudPaletteName type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudPaletteName = 'tableau10' | 'tableau20' | 'observable10' | 'paired12' | 'set3_12';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudPointEventDetail","title":"WordCloudPointEventDetail","summary":"The WordCloudPointEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudPointEventDetail {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly weight: number;\n  readonly percentage: number;\n  readonly color: string;\n  readonly fontSize: number;\n  readonly rotation: number;\n  readonly cssX: number;\n  readonly cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudRenderResult","title":"WordCloudRenderResult","summary":"The WordCloudRenderResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudRenderResult {\n  readonly words: number;\n  readonly dropped: number;\n  readonly renderMs: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudResolvedWord","title":"WordCloudResolvedWord","summary":"The WordCloudResolvedWord type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudResolvedWord {\n  readonly index: number;\n  readonly id: string;\n  readonly name: string;\n  readonly weight: number;\n  readonly color: string;\n  readonly rotation?: number;\n  readonly visible: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudSpiral","title":"WordCloudSpiral","summary":"The WordCloudSpiral type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudSpiral = 'rectangular' | 'archimedean';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudStreamEvent","title":"WordCloudStreamEvent","summary":"The WordCloudStreamEvent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudStreamEvent =\n  | { type: 'push'; count: 1 }\n  | { type: 'pushBatch'; count: number }\n  | { type: 'shift'; count: number }\n  | { type: 'replace'; count: number };","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudStreamSource","title":"WordCloudStreamSource","summary":"The WordCloudStreamSource type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudStreamSource {\n  push(datum: WordCloudDatum): void;\n  pushBatch(datums: ReadonlyArray<WordCloudDatum>): void;\n  shift(count: number): void;\n  replace(datums: ReadonlyArray<WordCloudDatum>): void;\n  snapshot(window?: number): WordCloudDatum[];\n  subscribe(listener: (event: WordCloudStreamEvent) => void): () => void;\n  readonly length: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":""},{"path":"/docs/types/WordCloudStreamEvent","title":"WordCloudStreamEvent","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipActionEventDetail","title":"WordCloudTooltipActionEventDetail","summary":"The WordCloudTooltipActionEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudTooltipActionEventDetail extends WordCloudTooltipFormatContext {\n  action: string;\n  text: string;\n  html?: string;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipFormatContext","title":"WordCloudTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipConnectorInput","title":"WordCloudTooltipConnectorInput","summary":"The WordCloudTooltipConnectorInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipConnectorInput =\n  | undefined\n  | null\n  | boolean\n  | Partial<WordCloudTooltipConnectorSpec>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipConnectorSpec","title":"WordCloudTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipConnectorSpec","title":"WordCloudTooltipConnectorSpec","summary":"The WordCloudTooltipConnectorSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudTooltipConnectorSpec {\n  show: boolean;\n  color?: string;\n  width?: number;\n  dash?: number[];\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudTooltipFormatContext","title":"WordCloudTooltipFormatContext","summary":"The WordCloudTooltipFormatContext type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudTooltipFormatContext {\n  index: number;\n  id: string;\n  name: string;\n  weight: number;\n  percentage: number;\n  fontSize: number;\n  rotation: number;\n  cssX: number;\n  cssY: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudTooltipInput","title":"WordCloudTooltipInput","summary":"The WordCloudTooltipInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipInput =\n  | undefined\n  | null\n  | 'auto'\n  | 'off'\n  | boolean\n  | WordCloudTooltipObjectInput;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipObjectInput","title":"WordCloudTooltipObjectInput","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipObjectInput","title":"WordCloudTooltipObjectInput","summary":"The WordCloudTooltipObjectInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipObjectInput = Omit<Partial<WordCloudTooltipSpec>, 'connector'> & {\n  connector?: WordCloudTooltipConnectorInput;\n};","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipSpec","title":"WordCloudTooltipSpec","description":""},{"path":"/docs/types/WordCloudTooltipConnectorInput","title":"WordCloudTooltipConnectorInput","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipOpenMode","title":"WordCloudTooltipOpenMode","summary":"The WordCloudTooltipOpenMode type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipOpenMode = 'single' | 'multiple';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudTooltipShowEventDetail","title":"WordCloudTooltipShowEventDetail","summary":"The WordCloudTooltipShowEventDetail type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudTooltipShowEventDetail {\n  cssX: number;\n  cssY: number;\n  anchor: WordCloudTooltipSide;\n  text: string;\n  html?: string;\n  context?: WordCloudTooltipFormatContext;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipSide","title":"WordCloudTooltipSide","description":""},{"path":"/docs/types/WordCloudTooltipFormatContext","title":"WordCloudTooltipFormatContext","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipSide","title":"WordCloudTooltipSide","summary":"The WordCloudTooltipSide type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipSide = 'top' | 'right' | 'bottom' | 'left';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudTooltipSpec","title":"WordCloudTooltipSpec","summary":"The WordCloudTooltipSpec type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface WordCloudTooltipSpec {\n  show: boolean;\n  openMode: WordCloudTooltipOpenMode;\n  trigger: WordCloudTooltipTrigger;\n  side?: WordCloudTooltipSide;\n  offset: number;\n  format?: (word: WordCloudResolvedWord, context?: WordCloudTooltipFormatContext) => string;\n  html?: (word: WordCloudResolvedWord, context?: WordCloudTooltipFormatContext) => string;\n  className?: string;\n  style?: WordCloudTooltipStyle;\n  width?: number | string;\n  minWidth?: number | string;\n  maxWidth?: number | string;\n  padding?: number | string;\n  interactive: boolean;\n  hideOnLeave: boolean;\n  connector: WordCloudTooltipConnectorSpec;\n  draggable: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipOpenMode","title":"WordCloudTooltipOpenMode","description":""},{"path":"/docs/types/WordCloudTooltipTrigger","title":"WordCloudTooltipTrigger","description":""},{"path":"/docs/types/WordCloudTooltipSide","title":"WordCloudTooltipSide","description":""},{"path":"/docs/types/WordCloudResolvedWord","title":"WordCloudResolvedWord","description":""},{"path":"/docs/types/WordCloudTooltipFormatContext","title":"WordCloudTooltipFormatContext","description":""},{"path":"/docs/types/WordCloudTooltipStyle","title":"WordCloudTooltipStyle","description":""},{"path":"/docs/types/WordCloudTooltipConnectorSpec","title":"WordCloudTooltipConnectorSpec","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipStyle","title":"WordCloudTooltipStyle","summary":"The WordCloudTooltipStyle type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipStyle = Record<string, WordCloudTooltipStyleValue>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudTooltipStyleValue","title":"WordCloudTooltipStyleValue","description":""}]}]}]},{"path":"/docs/types/WordCloudTooltipStyleValue","title":"WordCloudTooltipStyleValue","summary":"The WordCloudTooltipStyleValue type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipStyleValue = string | number;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudTooltipTrigger","title":"WordCloudTooltipTrigger","summary":"The WordCloudTooltipTrigger type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudTooltipTrigger = 'hover' | 'click' | 'hover-click';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/WordCloudUnavailableBehaviour","title":"WordCloudUnavailableBehaviour","summary":"The WordCloudUnavailableBehaviour type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudUnavailableBehaviour = ChartUnavailableBehaviour;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ChartUnavailableBehaviour","title":"ChartUnavailableBehaviour","description":""}]}]}]},{"path":"/docs/types/WordCloudValues","title":"WordCloudValues","summary":"The WordCloudValues type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudValues = ReadonlyArray<WordCloudDatum>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/WordCloudDatum","title":"WordCloudDatum","description":""}]}]}]},{"path":"/docs/types/WordCloudWeightScale","title":"WordCloudWeightScale","summary":"The WordCloudWeightScale type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type WordCloudWeightScale = 'linear' | 'sqrt' | 'log';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/XAxisInput","title":"XAxisInput","summary":"The XAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"type XAxisInput = CartesianAxisInput | ReadonlyArray<CartesianAxisInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":""}]}]}]},{"path":"/docs/types/YAxisInput","title":"YAxisInput","summary":"The YAxisInput type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"type YAxisInput = CartesianAxisInput | ReadonlyArray<CartesianAxisInput>;","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/CartesianAxisInput","title":"CartesianAxisInput","description":""}]}]}]},{"path":"/docs/types/YieldZone","title":"YieldZone","summary":"The YieldZone type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface YieldZone {\n  readonly index: number;\n  readonly rInner: number;\n  readonly rOuter: number;\n  readonly pass: number;\n  readonly probed: number;\n  readonly yield: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/YieldZoneResult","title":"YieldZoneResult","summary":"The YieldZoneResult type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface YieldZoneResult {\n  readonly zones: ReadonlyArray<YieldZone>;\n  readonly waferCount: number;\n  readonly totalProbed: number;\n  readonly totalPass: number;\n  readonly overallYield: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/YieldZone","title":"YieldZone","description":""}]}]}]},{"path":"/docs/types/ZoomConnectAxes","title":"ZoomConnectAxes","summary":"The ZoomConnectAxes type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export type ZoomConnectAxes = 'x' | 'y' | 'xy';","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]},{"path":"/docs/types/ZoomConnectOptions","title":"ZoomConnectOptions","summary":"The ZoomConnectOptions type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ZoomConnectOptions {\n  axes?: ZoomConnectAxes;\n  crosshair?: boolean;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[{"path":"/docs/types/ZoomConnectAxes","title":"ZoomConnectAxes","description":""}]}]}]},{"path":"/docs/types/ZoomExtent","title":"ZoomExtent","summary":"The ZoomExtent type declaration and related types. Optional fields are marked with ?.","kind":"type","sections":[{"id":"declaration","title":"Type declaration","blocks":[{"kind":"code","source":"export interface ZoomExtent {\n  min: number;\n  max: number;\n}","language":"typescript"}]},{"id":"related","title":"Related types","blocks":[{"kind":"links","items":[]}]}]}]}