apexcharts 6.4.0 → 6.6.0

package/README.md

@@ -24,7 +24,7 @@
 
 ## Why ApexCharts
 
-- **17+ chart types** out of the box: line, area, bar, column, pie, donut, radar, heatmap, treemap, candlestick, boxplot, violin, funnel, pyramid, gauge and more
+- **18+ chart types** out of the box: line, area, bar, column, pie, donut, radar, heatmap, treemap, candlestick, boxplot, violin, funnel, pyramid, gauge, unit (dot / pictogram / waffle / beeswarm) and more
 - **SSR support** for Next.js, Nuxt, SvelteKit, Astro, and other meta-frameworks: render real SVG on the server, hydrate on the client
 - **Tree-shakable**: import only the chart types and features you need; typical bundles are 30-60% smaller than the full build
 - **TypeScript-first**: full type definitions ship with the package, no `@types/*` install needed
@@ -89,6 +89,7 @@ Browse [100+ ready-to-use samples](https://apexcharts.com/javascript-chart-demos
 - [Pie](https://apexcharts.com/javascript-chart-demos/pie-charts/) · [Donut](https://apexcharts.com/javascript-chart-demos/pie-charts/) · [Polar Area](https://apexcharts.com/javascript-chart-demos/polar-area-charts/) · [Radial Bar / Gauge](https://apexcharts.com/javascript-chart-demos/radialbar-charts/)
 - [Radar](https://apexcharts.com/javascript-chart-demos/radar-charts/) · [Heatmap](https://apexcharts.com/javascript-chart-demos/heatmap-charts/) · [Treemap](https://apexcharts.com/javascript-chart-demos/treemap-charts/)
 - [Funnel](https://apexcharts.com/javascript-chart-demos/funnel-charts/)
+- [Unit / Pictogram / Beeswarm](samples/vanilla-js/unit/) · [Waffle](samples/vanilla-js/waffle/) (premium)
 
 Combine any of the above as [mixed/combo charts](https://apexcharts.com/javascript-chart-demos/mixed-charts/), [stacked variants](https://apexcharts.com/javascript-chart-demos/column-charts/stacked/), [sparklines](https://apexcharts.com/javascript-chart-demos/sparklines/), or [synchronized multi-chart layouts](https://apexcharts.com/javascript-chart-demos/line-charts/syncing-charts/).
 
@@ -149,6 +150,7 @@ import 'apexcharts/line'
 import 'apexcharts/bar'
 // import 'apexcharts/area'
 // import 'apexcharts/scatter'
+// import 'apexcharts/unit'         // dot / pictogram / waffle / beeswarm (premium; 'waffle' aliases this)
 
 // Optional features
 import 'apexcharts/features/legend'
@@ -158,21 +160,59 @@ import 'apexcharts/features/toolbar'      // zoom/pan toolbar
 // import 'apexcharts/features/keyboard'     // keyboard navigation
 // import 'apexcharts/features/drilldown'    // hierarchical drill-down
 // import 'apexcharts/features/morph'        // animated chart-type morphs
-// import 'apexcharts/features/history'      // undo/redo
-// import 'apexcharts/features/perspectives' // shareable view state
-// import 'apexcharts/features/storyboard'   // scrollytelling (includes perspectives)
+// import 'apexcharts/features/history'      // undo/redo (premium)
+// import 'apexcharts/features/perspectives' // shareable view state (premium)
+// import 'apexcharts/features/storyboard'   // scrollytelling, incl. perspectives (premium)
 // import 'apexcharts/features/facet'        // design tokens + OS themes
 // import 'apexcharts/features/weave'        // plugin platform
 // import 'apexcharts/features/marks'        // custom series types
-// import 'apexcharts/features/link'         // crossfilter / linked views
-// import 'apexcharts/features/ink'          // on-chart annotation editing
-// import 'apexcharts/features/measure'      // measure/delta ruler
-// import 'apexcharts/features/context-menu' // right-click context menu
+// import 'apexcharts/features/link'         // crossfilter / linked views (premium)
+// import 'apexcharts/features/ink'          // on-chart annotation editing (premium)
+// import 'apexcharts/features/measure'      // measure/delta ruler (premium)
+// import 'apexcharts/features/context-menu' // right-click context menu (premium)
 // import 'apexcharts/features/renderer-canvas' // canvas series renderer
 ```
 
 See the [tree-shaking guide](https://apexcharts.com/docs/tree-shaking/) for the complete list of entry points.
 
+## Premium features & licensing
+
+Most of ApexCharts is free and open source. A small set of advanced features are **premium** and require a license key:
+
+| Feature | Enabled by |
+|---|---|
+| Unit chart type (dot / pictogram / waffle / beeswarm) | `chart.type: 'unit'` / `chart.type: 'waffle'` |
+| Storyboard (scrollytelling) | `chart.storyboard.bind(...)` |
+| Linked views / crossfilter | `chart.link.enabled` / `chart.link.dimension` / `ApexCharts.crossfilter()` |
+| Ink layer (on-chart annotation editing) | `chart.ink.enabled` |
+| Measure / delta ruler | `chart.measure.enabled` |
+| Context menu (right-click) | `chart.contextMenu.enabled` |
+| Perspectives (shareable view state) | `chart.perspectives.apply()` / `.save()` / `ApexCharts.perspectives.decode()` |
+| History (undo/redo) | `chart.history.enabled` |
+
+Without a valid key these features still work (**trial mode**), but the chart shows an "APEXCHARTS" watermark. A valid key removes it. Every other chart type and feature is free and never watermarked; the `unit` chart type (listed above, aliased by `waffle`) is the one premium chart type.
+
+```js
+import ApexCharts from 'apexcharts'
+
+// Set once, before rendering. Applies to every chart on the page.
+ApexCharts.setLicense('APEX-xxxxxxxx')
+```
+
+Alternatives to `setLicense`:
+
+```js
+// Global variable (used when setLicense was not called):
+window.Apex = { license: 'APEX-xxxxxxxx' }
+
+// Per-chart override (most specific wins):
+new ApexCharts(el, { chart: { license: 'APEX-xxxxxxxx' /* ... */ } })
+```
+
+Precedence per chart: `chart.license` -> `ApexCharts.setLicense()` -> `window.Apex.license` -> unlicensed (trial). The watermark is re-evaluated on every render, so a late `setLicense(validKey)` followed by `chart.update()` clears it.
+
+Keys are **shared across the whole ApexCharts family** (apexgantt, apextree, apexsankey, apex-grid-enterprise, apexstock), so one customer key works everywhere. Get a license at [apexcharts.com/pricing](https://apexcharts.com/pricing).
+
 ## Browser support
 
 ApexCharts works in all modern evergreen browsers (Chrome, Firefox, Safari, Edge). For server-side rendering, Node.js 18+ is required.