Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arction/lcjs-example-0700-markers

A demo application showcasing LightningChart JS markers.
https://github.com/arction/lcjs-example-0700-markers

charting-library chartxy-marker demo example javascript lcjs lightningchart-js marker performance point-marker typescript visualization webgl xy-chart

Last synced: about 3 hours ago
JSON representation

A demo application showcasing LightningChart JS markers.

Awesome Lists containing this project

README 

        
# JavaScript Markers



![JavaScript Markers](markers-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:



          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.



## Description



This example shows usage of different Markers of the ChartXY environment.

Markers are custom UI-elements that can be used to draw custom cursors from user side. There are two types of Markers:



## ChartMarker



This type of Marker is placed along two arbitrary axes belonging to a ChartXY. It is positioned with axis values, and will look exactly like an AutoCursor. It also has the same capabilities as one - only difference being that it isn't automatically positioned and hidden when needed, users have full power over this logic.



## SeriesMarker



SeriesMarkers are a part of certain series (line-series, OHLC, ...?), that can be created using series-method: _addMarker_. Once again, the SeriesMarker doesn't look any different from other Markers, the only logic which it adds is that it automatically latches to the nearest data-point of its owning series, from its current location (which can be set using method: _setPosition_)



## API Links



* [XY cartesian chart]

* [Auto cursor modes]

* [Line series]

* [Marker XY builder]

* [UI backgrounds]

* [RGBA color factory]

* [UIDirections]

* [Point marker]

* [Result table]

* [ChartXY marker]

* [Visibility modes for Markers]



## Support



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 [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 [email protected].



Direct developer email support can be purchased through a [Support Plan][4] or by contacting [email protected].



[0]: https://github.com/Arction/

[1]: https://lightningchart.com/lightningchart-js-api-documentation/

[2]: https://lightningchart.com

[3]: https://stackoverflow.com/questions/tagged/lightningchart

[4]: https://lightningchart.com/support-services/



© LightningChart Ltd 2009-2022. All rights reserved.



[XY cartesian chart]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/classes/ChartXY.html

[Auto cursor modes]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/enums/AutoCursorModes.html

[Line series]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/classes/LineSeries.html

[Marker XY builder]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/variables/MarkerBuilders.html

[UI backgrounds]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/variables/UIBackgrounds.html

[RGBA color factory]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/functions/ColorRGBA.html

[UIDirections]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/enums/UIDirections.html

[Point marker]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/interfaces/PointMarker.html

[Result table]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/interfaces/ResultTable.html

[ChartXY marker]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/classes/ChartMarkerXY.html

[Visibility modes for Markers]: https://lightningchart.com/js-charts/api-documentation/v6.1.0/enums/UIVisibilityModes.html