openalgo-charts 2.1.3 → 2.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
**A from-scratch, dependency-free HTML5-canvas charting engine for OpenAlgo.**
|
|
6
6
|
|
|
7
|
-
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, 67.
|
|
7
|
+
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, 67.10 KB Brotli for the base engine, and a one-call widget tier that adds the toolbar, drawing rail, dialogs and shortcuts.
|
|
8
8
|
|
|
9
9
|
[](https://www.npmjs.com/package/openalgo-charts)
|
|
10
10
|
[](./LICENSE)
|
|
11
|
-
[](#size-budget)
|
|
12
|
+
[](#develop)
|
|
13
13
|
[](#principles)
|
|
14
14
|
|
|
15
15
|
[**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,11 +43,13 @@ Every chart in the [live gallery](https://marketcalls.github.io/openalgo-charts/
|
|
|
43
43
|
|
|
44
44
|
## Install
|
|
45
45
|
|
|
46
|
-
Current version: **2.1.
|
|
46
|
+
Current version: **2.1.4**.
|
|
47
47
|
|
|
48
|
-
This patch
|
|
49
|
-
|
|
50
|
-
|
|
48
|
+
This patch restores time-and-price mouse and pen panning by default, including
|
|
49
|
+
market-profile and orderflow charts. Horizontal-only panning remains optional.
|
|
50
|
+
Saved horizontal preferences stay intact; choose **Axes > Mouse drag > Time and price**
|
|
51
|
+
to change one. Time-axis direction, Reset view and default visible bars are unchanged. See the
|
|
52
|
+
[2.1.4 changelog](./CHANGELOG.md#214) and
|
|
51
53
|
[OpenAlgo compatibility guide](https://marketcalls.github.io/openalgo-charts/docs/openalgo-compatibility/).
|
|
52
54
|
|
|
53
55
|
```bash
|
|
@@ -69,7 +71,7 @@ in front of npm rather than being places you upload to. A chart is one HTML file
|
|
|
69
71
|
```html
|
|
70
72
|
<div id="chart" style="width:100vw;height:100vh"></div>
|
|
71
73
|
<script type="module">
|
|
72
|
-
import { createChart } from 'https://unpkg.com/openalgo-charts@2.1.
|
|
74
|
+
import { createChart } from 'https://unpkg.com/openalgo-charts@2.1.4/dist/openalgo-charts.mjs';
|
|
73
75
|
const chart = createChart(document.getElementById('chart'), { timezone: 'Asia/Kolkata' });
|
|
74
76
|
chart.addSeries('candlestick').setData(bars);
|
|
75
77
|
</script>
|
|
@@ -108,7 +110,7 @@ Import only what you use. Each tier is a separate bundle that registers into the
|
|
|
108
110
|
|
|
109
111
|
| Import | Contents | Brotli |
|
|
110
112
|
|---|---|---|
|
|
111
|
-
| `openalgo-charts` | Engine, 13 chart types, panes & scales, primitives, registries, chart state, chart linking, bar cache, interval registry, trading overlay, SVG export, render backend port, OpenAlgo feeds | 67.
|
|
113
|
+
| `openalgo-charts` | Engine, 13 chart types, panes & scales, primitives, registries, chart state, chart linking, bar cache, interval registry, trading overlay, SVG export, render backend port, OpenAlgo feeds | 67.10 KB |
|
|
112
114
|
| `openalgo-charts/indicators` | 102 built-in indicators, the `registerIndicator` contract for your own, and the Tier-2 (external-data) contract | 27.36 KB |
|
|
113
115
|
| `openalgo-charts/draw` | 51 drawing tools + a headless drawing controller, clipboard, settings schema, level palette, freehand geometry and SVG icons | 25.82 KB |
|
|
114
116
|
| `openalgo-charts/transform` | Heikin Ashi, Renko, Range bars, Line Break, Point & Figure, Kagi | 2.66 KB |
|
|
@@ -117,7 +119,7 @@ Import only what you use. Each tier is a separate bundle that registers into the
|
|
|
117
119
|
| `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 |
|
|
118
120
|
| `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 | 36.01 KB |
|
|
119
121
|
|
|
120
|
-
Everything together is **187.
|
|
122
|
+
Everything together is **187.89 KB Brotli**; a widget terminal (base + draw + indicators + widget, what one `createWidget` call loads) is 156.28 KB. Figures are the measured `size-limit` output. The trade tier is listed as its delta over the base, so loading base + trade costs 74.71 KB.
|
|
121
123
|
|
|
122
124
|
## What's built
|
|
123
125
|
|
|
@@ -409,16 +411,16 @@ Enforced in CI by [`size-limit`](./.size-limit.json). Nothing is excluded, becau
|
|
|
409
411
|
|
|
410
412
|
| Bundle | Limit | Actual |
|
|
411
413
|
|---|---|---|
|
|
412
|
-
| Base engine | 68 KB | 67.
|
|
413
|
-
| Base + trade | 75 KB | 74.
|
|
414
|
+
| Base engine | 68 KB | 67.10 KB |
|
|
415
|
+
| Base + trade | 75 KB | 74.71 KB |
|
|
414
416
|
| Indicators tier | 30 KB | 27.36 KB |
|
|
415
417
|
| Draw tier | 26 KB | 25.82 KB |
|
|
416
418
|
| Transform tier | 5 KB | 2.66 KB |
|
|
417
419
|
| Profile tier | 15 KB | 14.96 KB |
|
|
418
420
|
| WebGL2 tier | 7 KB | 6.38 KB |
|
|
419
421
|
| Widget tier | 37 KB | 36.01 KB |
|
|
420
|
-
| Widget terminal (base + draw + indicators + widget) | 157 KB | 156.
|
|
421
|
-
| **Everything** | **188 KB** | **187.
|
|
422
|
+
| Widget terminal (base + draw + indicators + widget) | 157 KB | 156.28 KB |
|
|
423
|
+
| **Everything** | **188 KB** | **187.89 KB** |
|
|
422
424
|
|
|
423
425
|
## Documentation
|
|
424
426
|
|
|
@@ -458,10 +460,12 @@ python server.py --fixture # no yfinance, no network: deterministic synthetic
|
|
|
458
460
|
|
|
459
461
|
## Develop
|
|
460
462
|
|
|
463
|
+
See [Contributing](./CONTRIBUTING.md) for setup, targeted checks, documentation updates and the release workflow.
|
|
464
|
+
|
|
461
465
|
```bash
|
|
462
466
|
npm install # install dev toolchain
|
|
463
467
|
npm run typecheck # strict TypeScript check
|
|
464
|
-
npm test # unit tests (vitest) -
|
|
468
|
+
npm test # unit tests (vitest) - 4209 across 181 files
|
|
465
469
|
npm run build # Rollup -> dist/ (minified ESM per tier + types)
|
|
466
470
|
npm run size # size-limit (Brotli) against the budget
|
|
467
471
|
npm run e2e # Playwright Chromium smoke tests
|
|
@@ -478,7 +482,7 @@ npm run verify # lint + typecheck + test + build + demo tests + dts + size +
|
|
|
478
482
|
|
|
479
483
|
## Status & limitations
|
|
480
484
|
|
|
481
|
-
Version **2.1.
|
|
485
|
+
Version **2.1.4**. All engine build phases are implemented. Upgrading a 1.9.x host: [Migrating to 2.0](./docs/migrating-to-2.md).
|
|
482
486
|
|
|
483
487
|
Known gaps, stated plainly:
|
|
484
488
|
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** Library version string. Matches package.json (including locally prepared releases). */
|
|
2
|
-
declare const VERSION = "2.1.
|
|
2
|
+
declare const VERSION = "2.1.4";
|
|
3
3
|
/** Returns the current library version. */
|
|
4
4
|
declare function version(): string;
|
|
5
5
|
|
|
@@ -3342,7 +3342,7 @@ interface ExportSvgOptions {
|
|
|
3342
3342
|
}
|
|
3343
3343
|
/** Preferences for pointer panning and the view restored by reset. */
|
|
3344
3344
|
interface ChartNavigationOptions {
|
|
3345
|
-
/** Mouse and pen plot drags. Touch gestures retain two-axis panning. Default:
|
|
3345
|
+
/** Mouse and pen plot drags. Touch gestures retain two-axis panning. Default: both. */
|
|
3346
3346
|
mousePan: 'horizontal' | 'both';
|
|
3347
3347
|
/** Latest bars to show initially and on reset. 0 fits all loaded bars (default). */
|
|
3348
3348
|
defaultVisibleBars: number;
|