openalgo-charts 2.1.7 → 2.1.8

package/README.md

@@ -4,12 +4,12 @@
 
 **A from-scratch, dependency-free HTML5-canvas charting engine for OpenAlgo.**
 
-Professional interactive charts, 102 built-in indicators plus your own custom ones, 51 drawing tools, order flow, market replay, linked chart grids, on-chart trading, vector SVG export and an optional WebGL2 backend. Eight lazy-loaded tiers, zero runtime dependencies, 73.31 KB Brotli for the base engine, and a one-call widget tier that adds the toolbar, drawing rail, dialogs and shortcuts.
+Professional interactive charts, 102 built-in indicators plus your own custom ones, 51 drawing tools, order flow, market replay, linked chart grids, on-chart trading, vector SVG export and an optional WebGL2 backend. Eight lazy-loaded tiers, zero runtime dependencies, 74.00 KB Brotli for the base engine, and a one-call widget tier that adds the toolbar, drawing rail, dialogs and shortcuts.
 
 [![npm version](https://img.shields.io/npm/v/openalgo-charts.svg?color=cb3837&label=npm)](https://www.npmjs.com/package/openalgo-charts)
 [![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
-[![bundle](https://img.shields.io/badge/brotli-73.31%20KB%20base%20%C2%B7%20197.58%20KB%20all%20tiers-brightgreen.svg)](#size-budget)
-[![tests](https://img.shields.io/badge/tests-4337%20passing-brightgreen.svg)](#develop)
+[![bundle](https://img.shields.io/badge/brotli-74.00%20KB%20base%20%C2%B7%20201.15%20KB%20all%20tiers-brightgreen.svg)](#size-budget)
+[![tests](https://img.shields.io/badge/tests-4376%20passing-brightgreen.svg)](#develop)
 [![dependencies](https://img.shields.io/badge/runtime%20deps-0-brightgreen.svg)](#principles)
 
 [**Documentation**](https://marketcalls.github.io/openalgo-charts/)  ·  [**Live examples**](https://marketcalls.github.io/openalgo-charts/examples)  ·  [**Getting started**](./docs/getting-started.md)  ·  [**Migrating to 2.0**](./docs/migrating-to-2.md)  ·  [**Architecture**](./ARCHITECTURE.md)
@@ -43,14 +43,14 @@ Every chart in the [live gallery](https://marketcalls.github.io/openalgo-charts/
 
 ## Install
 
-Current version: **2.1.7**.
+Current version: **2.1.8**.
 
-This release adds a searchable Objects panel and shared object-management API for
-drawings, indicators and host-registered profiles. Dialogs fit narrow chart panes,
-and indicator visibility survives settings changes and layout restoration.
-See the [Objects guide](https://marketcalls.github.io/openalgo-charts/docs/objects/),
-the [2.1.7 changelog](./CHANGELOG.md#217) and
-[OpenAlgo compatibility guide](https://marketcalls.github.io/openalgo-charts/docs/openalgo-compatibility/).
+This release adds proportional wheel and trackpad navigation, horizontal wheel pan,
+price-axis wheel scaling and smooth autoscale transitions. The packaged widget now
+provides responsive mobile controls that share its drawings, objects and dialogs.
+See the [interaction guide](https://marketcalls.github.io/openalgo-charts/docs/interactions/),
+the [mobile guide](https://marketcalls.github.io/openalgo-charts/docs/mobile/) and
+the [2.1.8 changelog](./CHANGELOG.md#218).
 
 ```bash
 npm install openalgo-charts
@@ -71,7 +71,7 @@ in front of npm rather than being places you upload to. A chart is one HTML file
 ```html
 <div id="chart" style="width:100vw;height:100vh"></div>
 <script type="module">
-  import { createChart } from 'https://unpkg.com/openalgo-charts@2.1.7/dist/openalgo-charts.mjs';
+  import { createChart } from 'https://unpkg.com/openalgo-charts@2.1.8/dist/openalgo-charts.mjs';
   const chart = createChart(document.getElementById('chart'), { timezone: 'Asia/Kolkata' });
   chart.addSeries('candlestick').setData(bars);
 </script>
@@ -94,6 +94,7 @@ const widget = createWidget('#terminal', {
   feed: new OpenAlgoDataFeed({ baseUrl: 'http://127.0.0.1:5000', apiKey: 'YOUR_KEY' }),
   symbol: 'RELIANCE', exchange: 'NSE', interval: '5m',
   theme: 'dark',
+  mobile: 'auto', // compact controls at 640 CSS px or less, or on a coarse pointer
   persist: true,
   onOrder: (order) => broker.place(order),   // the right-click menu offers order entry only when this is set
 });
@@ -102,7 +103,7 @@ widget.chart;   // the Chart underneath, every base API available
 widget.draw;    // the DrawingController the rail drives
 ```
 
-`openalgo-charts/widget` is the eighth tier and the only one that builds DOM: a top bar (symbol search, interval pills, chart type, Indicators, capture, settings, theme), the drawing rail with pins and flyouts, a status line, toasts, a right-click menu, a keymap with a `?` panel, and optional layout persistence. Every dialog is generated from a schema the engine already ships (`chartSettingsSchema`, the indicator descriptor, `drawingSettingsSchema`), so no control exists without something behind it, and the chrome takes its colours from the active `ChartTheme` through `--oac-` tokens, so `setTheme` recolours canvas and chrome together. It drives the engine only through the public API, and the build proves it: the ESLint tier ACL and `npm run shake` keep it out of every other bundle, and importing the module touches no DOM, so it can sit in code that also runs on a server. The guide is [`docs/widget.md`](./docs/widget.md).
+`openalgo-charts/widget` is the eighth tier and the only one that builds DOM: a top bar (symbol search, interval pills, chart type, Indicators, capture, settings, theme), the drawing rail with pins and flyouts, a status line, responsive mobile header and bottom controls, toasts, a right-click menu, a keymap with a `?` panel, and optional layout persistence. Every dialog is generated from a schema the engine already ships (`chartSettingsSchema`, the indicator descriptor, `drawingSettingsSchema`), so no control exists without something behind it, and the chrome takes its colours from the active `ChartTheme` through `--oac-` tokens, so `setTheme` recolours canvas and chrome together. It drives the engine only through the public API, and the build proves it: the ESLint tier ACL and `npm run shake` keep it out of every other bundle, and importing the module touches no DOM, so it can sit in code that also runs on a server. The guide is [`docs/widget.md`](./docs/widget.md).
 
 ## Tiers
 
@@ -110,16 +111,16 @@ Import only what you use. Each tier is a separate bundle that registers into the
 
 | Import | Contents | Brotli |
 |---|---|---|
-| `openalgo-charts` | Engine, 13 chart types, panes &amp; scales, primitives, registries, chart state, chart linking, bar cache, interval registry, trading overlay, SVG export, render backend port, OpenAlgo feeds | 73.31 KB |
+| `openalgo-charts` | Engine, 13 chart types, panes &amp; scales, primitives, registries, chart state, chart linking, bar cache, interval registry, trading overlay, SVG export, render backend port, OpenAlgo feeds | 74.00 KB |
 | `openalgo-charts/indicators` | 102 built-in indicators, the `registerIndicator` contract for your own, and the Tier-2 (external-data) contract | 28.05 KB |
 | `openalgo-charts/draw` | 51 drawing tools + a headless drawing controller, clipboard, settings schema, level palette, freehand geometry and SVG icons | 25.90 KB |
 | `openalgo-charts/transform` | Heikin Ashi, Renko, Range bars, Line Break, Point &amp; Figure, Kagi | 2.66 KB |
 | `openalgo-charts/profile` | Volume Profile, Market Profile (TPO) with compact pixel letters, Footprint, order flow | 14.96 KB |
 | `openalgo-charts/trade` | Order / position / bracket tools + DOM ladder | 7.61 KB |
 | `openalgo-charts/webgl` | WebGL2 series backend: batched, analytically anti-aliased GPU rendering of the standard chart types behind `renderer: 'auto'`, with a session-long fallback to the 2D path | 6.38 KB |
-| `openalgo-charts/widget` | The chart with its chrome in one call: `createWidget` adds a top bar, the drawing rail, a status line, the settings and indicator dialogs, drawing properties, a right-click menu, a keymap with a `?` panel and optional layout persistence. The only tier that ships DOM | 38.72 KB |
+| `openalgo-charts/widget` | The chart with its chrome in one call: `createWidget` adds a top bar, the drawing rail, a status line, the settings and indicator dialogs, drawing properties, a right-click menu, a keymap with a `?` panel and optional layout persistence. The only tier that ships DOM | 41.59 KB |
 
-Everything together is **197.58 KB Brotli**; a widget terminal (base + draw + indicators + widget, what one `createWidget` call loads) is 165.97 KB. Figures are the measured `size-limit` output. The trade tier is listed as its delta over the base, so loading base + trade costs 80.92 KB.
+Everything together is **201.15 KB Brotli**; a widget terminal (base + draw + indicators + widget, what one `createWidget` call loads) is 169.54 KB. Figures are the measured `size-limit` output. The trade tier is listed as its delta over the base, so loading base + trade costs 81.61 KB.
 
 ## What's built
 
@@ -411,16 +412,16 @@ Enforced in CI by [`size-limit`](./.size-limit.json). Nothing is excluded, becau
 
 | Bundle | Limit | Actual |
 |---|---|---|
-| Base engine | 74 KB | 73.31 KB |
-| Base + trade | 82 KB | 80.92 KB |
+| Base engine | 75 KB | 74.00 KB |
+| Base + trade | 83 KB | 81.61 KB |
 | Indicators tier | 30 KB | 28.05 KB |
 | Draw tier | 26 KB | 25.90 KB |
 | Transform tier | 5 KB | 2.66 KB |
 | Profile tier | 15 KB | 14.96 KB |
 | WebGL2 tier | 7 KB | 6.38 KB |
-| Widget tier | 40 KB | 38.72 KB |
-| Widget terminal (base + draw + indicators + widget) | 168 KB | 165.97 KB |
-| **Everything** | **200 KB** | **197.58 KB** |
+| Widget tier | 42 KB | 41.59 KB |
+| Widget terminal (base + draw + indicators + widget) | 170 KB | 169.54 KB |
+| **Everything** | **202 KB** | **201.15 KB** |
 
 ## Documentation
 
@@ -465,7 +466,7 @@ See [Contributing](./CONTRIBUTING.md) for setup, targeted checks, documentation
 ```bash
 npm install        # install dev toolchain
 npm run typecheck  # strict TypeScript check
-npm test           # unit tests (vitest) - 4337 across 193 files
+npm test           # unit tests (vitest) - 4376 across 196 files
 npm run build      # Rollup -> dist/ (minified ESM per tier + types)
 npm run size       # size-limit (Brotli) against the budget
 npm run e2e        # Playwright Chromium smoke tests
@@ -482,7 +483,7 @@ npm run verify     # lint + typecheck + test + build + demo tests + dts + size +
 
 ## Status &amp; limitations
 
-Version **2.1.7**. All engine build phases are implemented. Upgrading a 1.9.x host: [Migrating to 2.0](./docs/migrating-to-2.md).
+Version **2.1.8**. All engine build phases are implemented. Upgrading a 1.9.x host: [Migrating to 2.0](./docs/migrating-to-2.md).
 
 Known gaps, stated plainly:
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /** Library version string. Matches package.json (including locally prepared releases). */
-declare const VERSION = "2.1.7";
+declare const VERSION = "2.1.8";
 /** Returns the current library version. */
 declare function version(): string;
 
@@ -261,6 +261,8 @@ declare class PriceScale {
      * scale to manual mode so autoscale stops overriding it.
      */
     scaleAroundCenter(factor: number): void;
+    /** Scale around a screen coordinate, retaining its price in every scale mode. */
+    scaleAtY(y: number, factor: number): void;
     /**
      * Pan the visible range vertically by `dy` media px (dragging the plot up/down).
      * Works in transformed space so it's correct for log scales, and respects
@@ -276,7 +278,7 @@ declare class PriceScale {
      * percent span. Log is the one that pads in price space and shows it, which
      * is long-standing behaviour and left alone here.
      */
-    autoscale(low: number, high: number): void;
+    autoscale(low: number, high: number, progress?: number): boolean;
     /**
      * The baseline actually in force, or null when this mode does not rebase or
      * the value it was given cannot carry one.
@@ -374,6 +376,8 @@ declare class TimeScale {
     get width(): number;
     get barSpacing(): number;
     setBarSpacing(value: number): void;
+    /** Bound a pending zoom target without changing the displayed viewport. */
+    constrainBarSpacing(value: number): number;
     get rightOffset(): number;
     setRightOffset(value: number): void;
     /** Logical index of the latest bar; the right edge anchors to baseIndex+rightOffset. */
@@ -1430,7 +1434,7 @@ declare class Pane {
     setScaleHeights(plotHeight: number): void;
     private _layout;
     /** Autoscale each active price scale from its own series (independent axes). */
-    autoscale(ctx: PaneRenderContext): void;
+    autoscale(ctx: PaneRenderContext, progress?: number): boolean;
     private _autoscaleScale;
     /**
      * Hold every locked scale's price-per-bar ratio against the geometry it is
@@ -3438,6 +3442,8 @@ interface ChartOptions {
      * instruments. Off restores the single-frame step.
      */
     animZoom?: boolean;
+    /** Ease automatic price ranges during navigation. Defaults to animZoom (true). */
+    animAutoscale?: boolean;
     /**
      * What a wheel zoom holds still: the bar under the cursor, or the right edge
      * (the latest bar). Default `'cursor'`, which is what the chart has always
@@ -3865,13 +3871,17 @@ declare class Chart {
     private _lastDragT;
     private _dragVelocity;
     private _kineticHandle;
+    private _kineticEpoch;
     private _zoomHandle;
     /** The glide in flight, so a second wheel tick folds into it (see ZoomGlide.add). */
     private _zoomGlide;
     private _zoomGlideStart;
     private _zoomGlideApplied;
-    private _zoomGlideX;
     private readonly _animZoom;
+    private readonly _animAutoscale;
+    private _autoscaleTime;
+    private _autoscaleFrames;
+    private _navigationEpoch;
     private readonly _zoomAnchor;
     private readonly _doubleClick;
     private readonly _firstDataId;
@@ -4721,6 +4731,8 @@ declare class Chart {
     /** One zoom step, applied now. Shared by the instant path and each glide frame. */
     private _applyZoom;
     private _startZoomGlide;
+    private _beginAutoscaleMotion;
+    private _stopNavigationMotion;
     private _stopZoomGlide;
     /**
      * Restore the preferred visible bar count and re-enable