scichart 6.0.0-alpha.196 → 6.0.1

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.
Files changed (16) hide show
  1. package/README.md +61 -25
  2. package/_glue/scichart.browser.js +1 -1
  3. package/_glue/scichart.browser.mjs +1 -1
  4. package/_wasm/scichart-64.wasm +0 -0
  5. package/_wasm/scichart-nosimd.wasm +0 -0
  6. package/_wasm/scichart.wasm +0 -0
  7. package/cjs/Core/BuildStamp.js +2 -2
  8. package/cjs/Core/WebGlHelper.js +4 -0
  9. package/cjs/Core/WebGpuHelper.js +4 -0
  10. package/esm/Core/BuildStamp.js +2 -2
  11. package/esm/Core/WebGlHelper.js +4 -0
  12. package/esm/Core/WebGpuHelper.js +4 -0
  13. package/index.min.js +1 -1
  14. package/index.min.mjs +1 -1
  15. package/package.json +1 -1
  16. package/types/Core/BuildStamp.d.ts +1 -1
package/README.md CHANGED
@@ -1,14 +1,14 @@
1
1
  # SciChart.js: High Performance JavaScript Chart Library
2
2
 
3
- > **SciChart.JS v5**
3
+ > **SciChart.JS v6**
4
4
  >
5
5
  > Find out what's new in every Major and Minor release at the [Change Log here](https://www.scichart.com/changelog/scichart-js/)
6
6
 
7
7
  > **Documentation**
8
8
  >
9
- > Find out our [Documentation web-site here](https://www.scichart.com/documentation/js/v5/intro)
9
+ > Find out our [Documentation web-site here](https://www.scichart.com/documentation/js/v6/intro)
10
10
 
11
- SciChart.js is a High Performance [JavaScript Chart library](https://www.scichart.com/javascript-chart-features/). Leveraging WebGL and WebAssembly to achieve incredible big-data and real-time performance.
11
+ SciChart.js is a High Performance [JavaScript Chart library](https://www.scichart.com/javascript-chart-features/). Leveraging WebGL, WebGPU and WebAssembly to achieve incredible big-data and real-time performance.
12
12
  Fast and able to draw millions of datapoints in realtime, our charts will never cause your app to slow down again!
13
13
 
14
14
  ## Why SciChart?
@@ -26,17 +26,28 @@ Fast and able to draw millions of datapoints in realtime, our charts will never
26
26
 
27
27
  # Releases
28
28
 
29
- In SciChart.js v5 release we’ve focused mostly on performance. Our userbase has demanding requirements from F1 to medical dashboards, IoT telemetry in industrial, aerospace and defense applications and as a result, our team has worked hard over the past few months to make this the leanest, fastest and most feature rich version of SciChart yet.
29
+ SciChart.js v6 is the first release supporting WebGPU which sagnificantly improves multichart scenarious like dashboards. Our userbase has demanding requirements from F1 to medical dashboards, IoT telemetry in industrial, aerospace and defense applications, and v6 answers them with:
30
+
31
+ - **WebGPU rendering** — a brand new renderer, selected automatically on Apple Silicon Macs, with WebGL used everywhere else.
32
+ - **A tree-shakeable package** — `scichart` now ships dual ES-module and CommonJS builds, so bundlers drop the parts of the library you don't use.
33
+ - **One modular WebAssembly engine** — 2D and 3D are now a single wasm module, and the 3D engine is fetched lazily, so 2D-only pages never pay for it.
34
+ - **wasm64 (Memory64) binaries** — optional builds that lift the 4GB memory ceiling for very large datasets.
35
+ - **`TableDataSeries`** — the renamed and extended `XyNDataSeries`, now with string-column support.
30
36
 
31
37
  - [Latest Changes](https://www.scichart.com/changelog/scichart-js/)
32
- - [Financial Drawing Tools v5.2 Release notes](https://www.scichart.com/scichart-js-v5-2-released/) | [Breaking Changes](https://www.scichart.com/documentation/js/v5/whats-new/breaking-changes-v5.1-v5.2/)
33
- - [v5.0 Release notes](https://www.scichart.com/scichart-js-v5-released/) | [Breaking Changes](https://www.scichart.com/documentation/js/v5/whats-new/breaking-changes-v4-v5/)
34
- - [v4.0 Release notes](https://www.scichart.com/scichart-js-v4-0-released/) | [Breaking Changes](https://www.scichart.com/documentation/js/v5/whats-new/breaking-changes-v3-v4/)
38
+ - [v6.0 Release notes](https://www.scichart.com/scichart-js-v6-released/) | [Breaking Changes](https://www.scichart.com/documentation/js/v6/whats-new/breaking-changes-v5.2-v6.0/)
39
+ - [Financial Drawing Tools v5.2 Release notes](https://www.scichart.com/scichart-js-v5-2-released/) | [Breaking Changes](https://www.scichart.com/documentation/js/v6/whats-new/breaking-changes-v5.1-v5.2/)
40
+ - [v5.0 Release notes](https://www.scichart.com/scichart-js-v5-released/) | [Breaking Changes](https://www.scichart.com/documentation/js/v6/whats-new/breaking-changes-v4-v5/)
41
+ - [v4.0 Release notes](https://www.scichart.com/scichart-js-v4-0-released/) | [Breaking Changes](https://www.scichart.com/documentation/js/v6/whats-new/breaking-changes-v3-v4/)
35
42
  - [v3.5 Release notes](https://www.scichart.com/scichart-js-v3-5-released/)
36
43
  - [Older Releases](https://www.scichart.com/category/scichart-js/)
37
44
 
38
45
  We release often and if you want to report a bug, request a feature or give general feedback [contact us](https://scichart.com/contact-us)!
39
46
 
47
+ ## Upgrading to v6
48
+
49
+ Read the [v5 to v6 Breaking Changes](https://www.scichart.com/documentation/js/v6/whats-new/breaking-changes-v5.2-v6.0/) first. Most apps need two changes: the WebAssembly copy step is now a single `_wasm` directory copy (the separate `scichart2d.wasm` / `scichart3d.wasm` files are gone), and a `SciChart3DSurface.configure()` call should be deleted because `SciChartSurface.configure()` now configures both engines.
50
+
40
51
  ## License
41
52
 
42
53
  > SciChart.js is commercial software which ships with a free community edition for personal, non-commercial, educational or blogger/tutorial use.
@@ -52,19 +63,19 @@ We release often and if you want to report a bug, request a feature or give gene
52
63
  ## Demo Application
53
64
 
54
65
  - We've published over 100 [JavaScript Chart Demos](https://www.scichart.com/demo/react) with ~100 examples you can try in browser.
55
- - You can clone the repo for the demo app at Github: [github.com/ABTSoftware/SciChart.JS.Examples](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x)
66
+ - You can clone the repo for the demo app at Github: [github.com/ABTSoftware/SciChart.JS.Examples](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x)
56
67
  - Or, checkout our boilerplates for various popular Js frameworks:
57
- - [Vanilla JS](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/javascript)
58
- - [React](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/scichart-react) with [scichart-react](https://www.npmjs.com/package/scichart-react) which significantly simplifies wrapping scichart in a react component
59
- - [React + Typescript](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/react-typescript)
60
- - [React + Vite](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/react-vite)
61
- - [Vue.js](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/vue)
62
- - [Angular](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/angular)
63
- - [Next.js](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/next)
64
- - [Nuxt](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/nuxt)
65
- - [Svelte + Vite](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/svelte-vite)
66
- - [Svelte + Rollup](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/svelte-rollup)
67
- - [Electron](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v5.x/BoilerPlates/electron)
68
+ - [Vanilla JS](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/javascript)
69
+ - [React](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/scichart-react) with [scichart-react](https://www.npmjs.com/package/scichart-react) which significantly simplifies wrapping scichart in a react component
70
+ - [React + Typescript](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/react-typescript)
71
+ - [React + Vite](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/react-vite)
72
+ - [Vue.js](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/vue)
73
+ - [Angular](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/angular)
74
+ - [Next.js](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/next)
75
+ - [Nuxt](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/nuxt)
76
+ - [Svelte + Vite](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/svelte-vite)
77
+ - [Svelte + Rollup](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/svelte-rollup)
78
+ - [Electron](https://github.com/ABTSoftware/SciChart.JS.Examples/tree/dev_v6.x/BoilerPlates/electron)
68
79
 
69
80
  # Getting Started
70
81
 
@@ -80,9 +91,9 @@ We release often and if you want to report a bug, request a feature or give gene
80
91
 
81
92
  ### Onboarding
82
93
 
83
- - [Tutorials](https://www.scichart.com/documentation/js/v5/get-started/tutorials-js-npm-webpack/tutorial-01-setting-up-npm-project-with-scichart-js/)
94
+ - [Tutorials](https://www.scichart.com/documentation/js/v6/get-started/tutorials-js-npm-webpack/tutorial-01-setting-up-npm-project-with-scichart-js/)
84
95
  - [Getting Started Guide](https://scichart.com/getting-started/scichart-javascript/)
85
- - [Documentation](https://www.scichart.com/documentation/js/v5/intro)
96
+ - [Documentation](https://www.scichart.com/documentation/js/v6/intro)
86
97
  - [CodePen, JSFiddle support](https://www.scichart.com/blog/codepen-codesandbox-and-jsfiddle-support-in-scichart-js/)
87
98
 
88
99
  ### Support
@@ -99,7 +110,7 @@ We release often and if you want to report a bug, request a feature or give gene
99
110
 
100
111
  > **Tutorial**
101
112
  >
102
- > See [full npm + Webpack tutorial here](https://www.scichart.com/documentation/js/v5/get-started/tutorials-js-npm-webpack/tutorial-01-setting-up-npm-project-with-scichart-js/)
113
+ > See [full npm + Webpack tutorial here](https://www.scichart.com/documentation/js/v6/get-started/tutorials-js-npm-webpack/tutorial-01-setting-up-npm-project-with-scichart-js/)
103
114
 
104
115
  SciChart.js can be loaded as an ES6 module with Babel or TypeScript transpiler.
105
116
 
@@ -148,7 +159,32 @@ initSciChart();
148
159
  </html>
149
160
  ```
150
161
 
151
- 4. **Run it `npm start`**. As a result you will see a simple line chart.
162
+ 4. **Serve the WebAssembly files.** SciChart.js ships its WebAssembly binaries in `node_modules/scichart/_wasm/`. Copy that whole directory next to your bundle, e.g. with webpack:
163
+
164
+ ```javascript
165
+ new CopyPlugin({
166
+ patterns: [{ from: "node_modules/scichart/_wasm/", to: "" }]
167
+ });
168
+ ```
169
+
170
+ Or skip the copy step entirely and load them from our CDN by calling `SciChartSurface.useWasmFromCDN()` before you create a chart.
171
+
172
+ 5. **Run it `npm start`**. As a result you will see a simple line chart.
173
+
174
+ ### Tree-shaking
175
+
176
+ v6 ships dual ES-module and CommonJS builds, so bundlers that honour the `exports` and `sideEffects` fields drop the parts of SciChart.js you never import - including the 3D engine, which is a separate WebAssembly module fetched only when you create a 3D chart.
177
+
178
+ Your bundler has to see ES-module syntax for this to work. TypeScript projects that emit CommonJS get the non-shakeable build, so set:
179
+
180
+ ```jsonc
181
+ {
182
+ "compilerOptions": {
183
+ "module": "esnext",
184
+ "moduleResolution": "bundler"
185
+ }
186
+ }
187
+ ```
152
188
 
153
189
  ## Quick Start with Browser Bundle (Iife bundle)
154
190
 
@@ -156,7 +192,7 @@ initSciChart();
156
192
 
157
193
  > **Tutorial**
158
194
  >
159
- > See the full [browser bundle tutorial here](https://www.scichart.com/documentation/js/v5/get-started/tutorials-cdn/tutorial-01-using-cdn/)
195
+ > See the full [browser bundle tutorial here](https://www.scichart.com/documentation/js/v6/get-started/tutorials-cdn/tutorial-01-using-cdn/)
160
196
 
161
197
  If your environment does not include a bundler like Parcel or Webpack, you can still load SciChart.js using the browser bundle module from [jsDelivr](https://www.jsdelivr.com/package/npm/scichart)
162
198
 
@@ -164,7 +200,7 @@ If your environment does not include a bundler like Parcel or Webpack, you can s
164
200
 
165
201
  ```html
166
202
  <!-- Include specific version into index.html -->
167
- <script src="https://cdn.jsdelivr.net/npm/scichart@5.0.0-beta.149/index.min.js" crossorigin="anonymous"></script>
203
+ <script src="https://cdn.jsdelivr.net/npm/scichart@6.0.0-alpha.196/index.min.js" crossorigin="anonymous"></script>
168
204
  ```
169
205
 
170
206
  2. **Create scichart-example.js file with a simple chart**