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,31 +1,35 @@
-# JavaScript OHLC Chart with Automatic Packing
+# JavaScript OHLC Series with Automatic Packing
 
-![JavaScript OHLC Chart with Automatic Packing](ohlcAutomaticPacking.png)
+![JavaScript OHLC Series with Automatic Packing](ohlcAutomaticPacking-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
 
 This example shows real-time OHLC-packing using a variant of OHLC-series.
 
+## LightningChart JS OHLC Series with Automatic Packing
+
+LightningChart JS includes a variant of the OHLC series which allows inputting close prices only which results in the corresponding OHLC data being automatically calculated.
+
 ```javascript
 const chart = lightningChart().ChartXY()
 const series = chart.addOHLCSeries(
     // Specify the type of OHLC-series for adding points
-    { seriesConstructor: OHLCSeriesTypes.AutomaticPacking }
+    { seriesConstructor: OHLCSeriesTypes.AutomaticPacking },
 )
 ```
 
@@ -38,16 +42,16 @@ series.add({ x: 50, y: 60 })
 // Multiple points at once.
 series.add([
     { x: 55, y: 60 },
-    { x: 60, y: 62},
-    { x: 65, y: 65}
+    { x: 60, y: 62 },
+    { x: 65, y: 65 },
 ])
 ```
 
 ## Packing logic
 
-Supplied points are packed by columns, within which the Y-values are mapped to open, high, low and close -values, which are used to draw *OHLCFigures*.
+Supplied points are packed by columns, within which the Y-values are mapped to open, high, low and close -values, which are used to draw _OHLCFigures_.
 
-[//]: # "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/ohlcPacking.png)
 
@@ -65,26 +69,26 @@ Supplied points are packed by columns, within which the Y-values are mapped to o
 
 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.
 
 
-[XY cartesian chart]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/classes/chartxy.html
-[Axis tick strategies]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/globals.html#axistickstrategies
-[Freeform line series]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/classes/lineseries.html
-[OHLC series]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/classes/chartxy.html#addohlcseries
-[OHLC series types]: https://www.arction.com/lightningchart-js-api-documentation/v3.4.0/globals.html#ohlcseriestypes
+[XY cartesian chart]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/classes/ChartXY.html
+[Axis tick strategies]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/variables/AxisTickStrategies.html
+[Freeform line series]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/classes/LineSeries.html
+[OHLC series]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/classes/ChartXY.html#addOHLCSeries
+[OHLC series types]: https://lightningchart.com/lightningchart-js-api-documentation/v4.0.0/variables/OHLCSeriesTypes.html
 

ohlcAutomaticPacking-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": {

ohlcAutomaticPacking-darkGold.png

@@ -4,20 +4,14 @@
 // Import LightningChartJS
 const lcjs = require('@arction/lcjs')
 
+// Import xydata
+const xydata = require('@arction/xydata')
+
 // Extract required parts from LightningChartJS.
-const {
-    lightningChart,
-    AxisTickStrategies,
-    AxisScrollStrategies,
-    OHLCSeriesTypes,
-    emptyLine,
-    Themes
-} = lcjs
+const { lightningChart, AxisTickStrategies, AxisScrollStrategies, OHLCSeriesTypes, emptyLine, Themes } = lcjs
 
 // Import data-generator from 'xydata'-library.
-const {
-    createProgressiveTraceGenerator
-} = require('@arction/xydata')
+const { createProgressiveTraceGenerator } = xydata
 
 // Decide on an origin for DateTime axis ( cur time - 5 minutes ).
 const fiveMinutesInMs = 5 * 60 * 1000
@@ -28,48 +22,40 @@ const chart = lightningChart().ChartXY({
     // theme: Themes.darkGold
 })
 // Use DateTime X-axis using previously defined origin.
-chart
-    .getDefaultAxisX()
-    .setTickStrategy(
-        AxisTickStrategies.DateTime,
-        (tickStrategy) => tickStrategy.setDateOrigin(dateOrigin)
-    )
+chart.getDefaultAxisX().setTickStrategy(AxisTickStrategies.DateTime, (tickStrategy) => tickStrategy.setDateOrigin(dateOrigin))
 
 // Set chart title and modify the padding of the chart.
-chart
-    .setTitle('Realtime OHLC and line')
-    .setPadding({
-        right: 42
-    })
+chart.setTitle('Realtime OHLC and line').setPadding({
+    right: 42,
+})
 // Modify AutoCursor to only show TickMarker and Gridline over X Axis.
-chart.setAutoCursor(cursor => {
-    cursor.disposeTickMarkerY()
+chart.setAutoCursor((cursor) => {
+    cursor.setTickMarkerYVisible(false)
     cursor.setGridStrokeYStyle(emptyLine)
 })
 
 // Configure X-axis to be progressive.
-chart.getDefaultAxisX()
+chart
+    .getDefaultAxisX()
     .setScrollStrategy(AxisScrollStrategies.progressive)
     // View fits 5 minutes.
-    .setInterval(0, fiveMinutesInMs)
+    .setInterval({ start: 0, end: fiveMinutesInMs, stopAxisAfter: false })
 
 // Show title 'USD' on Y axis.
-chart.getDefaultAxisY()
-    .setTitle('USD')
+chart.getDefaultAxisY().setTitle('USD')
 
 // Add underlying line series.
-const lineSeries = chart.addLineSeries()
+const lineSeries = chart
+    .addLineSeries()
     .setCursorEnabled(false)
-    .setStrokeStyle((strokeStyle) => strokeStyle
-        .setFillStyle(fill => fill.setA(70))
-        .setThickness(1)
-    )
+    .setStrokeStyle((strokeStyle) => strokeStyle.setFillStyle((fill) => fill.setA(70)).setThickness(1))
 
 // Add OHLC series with automatic packing (so we can feed it XY-points just like for the line series).
-const ohlcSeriesAutoPacking = chart.addOHLCSeries(
-    // Specify type of OHLC-series for adding points
-    { seriesConstructor: OHLCSeriesTypes.AutomaticPacking }
-)
+const ohlcSeriesAutoPacking = chart
+    .addOHLCSeries(
+        // Specify type of OHLC-series for adding points
+        { seriesConstructor: OHLCSeriesTypes.AutomaticPacking },
+    )
     // Set packing resolution to 100 ms so we can zoom to full resolution.
     .setPackingResolution(100)
 
@@ -85,10 +71,13 @@ createProgressiveTraceGenerator()
     .setNumberOfPoints(10000)
     .generate()
     .toPromise()
-    .then((data) => data.map((p) => ({
-        // Resolution = 100 ms.
-        x: p.x * 100, y: p.y
-    })))
+    .then((data) =>
+        data.map((p) => ({
+            // Resolution = 100 ms.
+            x: p.x * 100,
+            y: p.y,
+        })),
+    )
     .then((data) => {
         // Add 5 minutes worth of points immediately ( to simulate previous data ).
         add(data.splice(0, Math.round(5 * 60 * 10)))