LCJS 4.0.1

Author: Snekw

.github/workflows/gh-pages-deploy.yml

@@ -2,28 +2,28 @@ name: Webpack build to GitHub Pages
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
 
-    - name: Use Node.js 16.x
-      uses: actions/setup-node@v1
-      with:
-        node-version: '16.x'
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: "16.x"
 
-    - name: Build
-      run: |
-        npm install
-        npm run build
+      - name: Build
+        run: |
+          npm install
+          npm run build
 
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./dist
-        publish_branch: gh-pages
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist
+          publish_branch: gh-pages

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 LightningChart Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,33 +1,33 @@
 # JavaScript OHLC Chart with Automatic Packing Resolution
 
-![JavaScript OHLC Chart with Automatic Packing Resolution](ohlcAutomaticPackingResolution.png)
+![JavaScript OHLC Chart with Automatic Packing Resolution](ohlcAutomaticPackingResolution-darkGold.png)
 
 This demo application belongs to the set of examples for LightningChart JS, data visualization library for JavaScript.
 
 LightningChart JS is entirely GPU accelerated and performance optimized charting library for presenting massive amounts of data. It offers an easy way of creating sophisticated and interactive charts and adding them to your website or web application.
 
 The demo can be used as an example or a seed project. Local execution requires the following steps:
 
-- Make sure that relevant version of [Node.js](https://nodejs.org/en/download/) is installed
-- Open the project folder in a terminal:
+-   Make sure that relevant version of [Node.js](https://nodejs.org/en/download/) is installed
+-   Open the project folder in a terminal:
 
-        npm install              # fetches dependencies
-        npm start                # builds an application and starts the development server
+          npm install              # fetches dependencies
+          npm start                # builds an application and starts the development server
 
-- The application is available at *http://localhost:8080* in your browser, webpack-dev-server provides hot reload functionality.
+-   The application is available at _http://localhost:8080_ in your browser, webpack-dev-server provides hot reload functionality.
 
 
 ## Description
 
 The examples purpose is to shed some light on the packing logic of OHLCSeriesWithAutomaticPacking and how it can be fit to users needs by usage of method: `setPackingResolution`.
 
-This class is a variant of OHLCSeries, which adds the automatic packing of XY-points to XOHLC-points. In a nutshell, when pushing points, it simply packages these points into 'XOHLC'-objects at certain intervals (which is controlled by the packing resolution property). 
+This class is a variant of OHLCSeries, which adds the automatic packing of XY-points to XOHLC-points. In a nutshell, when pushing points, it simply packages these points into 'XOHLC'-objects at certain intervals (which is controlled by the packing resolution property).
 
 By default, or if packing resolution is explicitly set to 'undefined', the used value will be automatically computed based on current pixel-size. This effectively means that any newly pushed points will never be able to be zoomed closer than the view at the time of packing.
 
 To ensure that the figures can be zoomed up to desired details, users can set an explicit value for the packing resolution, which will specify the minimum interval (in axis values) between two fully zoomed figures.
 
-[//]: # "IMPORTANT: The assets will not show before README.md is built - relative path is different!"
+[//]: # 'IMPORTANT: The assets will not show before README.md is built - relative path is different!'
 
 ![](./assets/ohlcPackingResolution.png)
 
@@ -45,26 +45,26 @@ To ensure that the figures can be zoomed up to desired details, users can set an
 
 If you notice an error in the example code, please open an issue on [GitHub][0] repository of the entire example.
 
-Official [API documentation][1] can be found on [Arction][2] website.
+Official [API documentation][1] can be found on [LightningChart][2] website.
 
 If the docs and other materials do not solve your problem as well as implementation help is needed, ask on [StackOverflow][3] (tagged lightningchart).
 
-If you think you found a bug in the LightningChart JavaScript library, please contact support@arction.com.
+If you think you found a bug in the LightningChart JavaScript library, please contact support@lightningchart.com.
 
-Direct developer email support can be purchased through a [Support Plan][4] or by contacting sales@arction.com.
+Direct developer email support can be purchased through a [Support Plan][4] or by contacting sales@lightningchart.com.
 
 [0]: https://github.com/Arction/
-[1]: https://www.arction.com/lightningchart-js-api-documentation/
-[2]: https://www.arction.com
+[1]: https://lightningchart.com/lightningchart-js-api-documentation/
+[2]: https://lightningchart.com
 [3]: https://stackoverflow.com/questions/tagged/lightningchart
-[4]: https://www.arction.com/support-services/
+[4]: https://lightningchart.com/support-services/
 
-© Arction Ltd 2009-2020. All rights reserved.
+© LightningChart Ltd 2009-2022. All rights reserved.
 
 
-[Axis tick strategies]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/globals.html#axistickstrategies
-[XY cartesian chart]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/classes/chartxy.html
-[OHLC series types]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/globals.html#ohlcseriestypes
-[Series with automatic packing]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/classes/ohlcserieswithautomaticpacking.html
+[Axis tick strategies]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/variables/AxisTickStrategies.html
+[XY cartesian chart]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/classes/ChartXY.html
+[OHLC series types]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/variables/OHLCSeriesTypes.html
+[Series with automatic packing]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/classes/OHLCSeriesWithAutomaticPacking.html
 [Progressive trace generator]: https://arction.github.io/xydata/classes/progressivetracegenerator.html
 

ohlcAutomaticPackingResolution-cyberSpace.png

@@ -4,7 +4,7 @@
     "build": "webpack --mode production",
     "start": "webpack serve"
   },
-  "license": "Custom",
+  "license": "MIT",
   "private": true,
   "main": "./src/index.js",
   "devDependencies": {
@@ -17,7 +17,7 @@
     "webpack-stream": "^7.0.0"
   },
   "dependencies": {
-    "@arction/lcjs": "^3.4.0",
+    "@arction/lcjs": "^4.0.1",
     "@arction/xydata": "^1.4.0"
   },
   "lightningChart": {

ohlcAutomaticPackingResolution-darkGold.png

@@ -4,90 +4,71 @@
 // Import LightningChartJS
 const lcjs = require('@arction/lcjs')
 
+// Import xydata
+const xydata = require('@arction/xydata')
+
 // Extract required parts from LightningChartJS.
-const {
-    lightningChart,
-    AxisTickStrategies,
-    OHLCSeriesTypes,
-    emptyLine,
-    Themes
-} = lcjs
+const { lightningChart, AxisTickStrategies, OHLCSeriesTypes, emptyLine, Themes } = lcjs
 
 // Import data-generator from 'xydata'-library.
-const {
-    createProgressiveTraceGenerator
-} = require('@arction/xydata')
+const { createProgressiveTraceGenerator } = xydata
 
 const dataSpan = 60 * 60 * 1000
 const dataFrequency = 1 * 1000
 
 // Decide on an origin for DateTime axis.
 const dateOrigin = new Date(2018, 0, 1)
 // Create charts and series for two different packing resolutions.
-const dashboard = lightningChart().Dashboard({numberOfColumns: 1, numberOfRows: 2})
+const dashboard = lightningChart().Dashboard({ numberOfColumns: 1, numberOfRows: 2 })
 const chartDefault = dashboard.createChartXY({
     columnIndex: 0,
     rowIndex: 0,
     // theme: Themes.darkGold
 })
 // Use DateTime TickStrategy with custom origin date.
-chartDefault
-    .getDefaultAxisX()
-    .setTickStrategy(
-        AxisTickStrategies.DateTime,
-        (tickStrategy) => tickStrategy.setDateOrigin(dateOrigin)
-    )
+chartDefault.getDefaultAxisX().setTickStrategy(AxisTickStrategies.DateTime, (tickStrategy) => tickStrategy.setDateOrigin(dateOrigin))
 
-chartDefault
-    .setTitle('Default packing resolution')
-    .setAutoCursor(cursor => {
-        cursor.disposeTickMarkerY()
-        cursor.setGridStrokeYStyle(emptyLine)
-    })
+chartDefault.setTitle('Default packing resolution').setAutoCursor((cursor) => {
+    cursor.setTickMarkerYVisible(false)
+    cursor.setGridStrokeYStyle(emptyLine)
+})
 // Preventing ResultTable from getting cut at the edge
 chartDefault.setPadding({
-    right: 42
+    right: 42,
 })
 
 // show title 'USD on Y axis
-chartDefault.getDefaultAxisY()
-    .setTitle('USD')
+chartDefault.getDefaultAxisY().setTitle('USD')
 
 const chartLow = dashboard.createChartXY({
     columnIndex: 0,
     rowIndex: 1,
     // theme: Themes.darkGold
 })
 // Use DateTime TickStrategy with custom origin date.
-chartLow
-    .getDefaultAxisX()
-    .setTickStrategy(
-        AxisTickStrategies.DateTime,
-        (tickStrategy) => tickStrategy.setDateOrigin(dateOrigin)
-    )
+chartLow.getDefaultAxisX().setTickStrategy(AxisTickStrategies.DateTime, (tickStrategy) => tickStrategy.setDateOrigin(dateOrigin))
 
-chartLow
-    .setTitle('Very small packing resolution')
-    .setAutoCursor(cursor => {
-        cursor.disposeTickMarkerY()
-        cursor.setGridStrokeYStyle(emptyLine)
-    })
+chartLow.setTitle('Very small packing resolution').setAutoCursor((cursor) => {
+    cursor.setTickMarkerYVisible(false)
+    cursor.setGridStrokeYStyle(emptyLine)
+})
 // Preventing ResultTable from getting cut at the edge
 chartLow.setPadding({
-    right: 42
+    right: 42,
 })
 
 // show title 'USD on Y axis
-chartLow.getDefaultAxisY()
-    .setTitle('USD')
+chartLow.getDefaultAxisY().setTitle('USD')
 
-const seriesDefault = chartDefault.addOHLCSeries(
-    // Specify type of OHLC-series for adding points
-    { seriesConstructor: OHLCSeriesTypes.AutomaticPacking }
-)
+const seriesDefault = chartDefault
+    .addOHLCSeries(
+        // Specify type of OHLC-series for adding points
+        { seriesConstructor: OHLCSeriesTypes.AutomaticPacking },
+    )
     .setName('Default packing resolution')
 
-const seriesLow = chartLow.addOHLCSeries({ seriesConstructor: OHLCSeriesTypes.AutomaticPacking })
+const seriesLow = chartLow
+    .addOHLCSeries({ seriesConstructor: OHLCSeriesTypes.AutomaticPacking })
     .setName('Very small packing resolution')
     // Set packing resolution that is equal to the minimum resolution between two points.
     // (essentially allows users to zoom to full resolution)
@@ -98,9 +79,12 @@ createProgressiveTraceGenerator()
     .setNumberOfPoints(dataSpan / dataFrequency)
     .generate()
     .toPromise()
-    .then((data) => data.map((p) => ({
-        x: p.x * dataFrequency, y: p.y
-    })))
+    .then((data) =>
+        data.map((p) => ({
+            x: p.x * dataFrequency,
+            y: p.y,
+        })),
+    )
     .then((data) => {
         seriesDefault.add(data)
         seriesLow.add(data)