Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@devexperts/dxcharts-lite

Package Overview
Dependencies
Maintainers
12
Versions
26
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@devexperts/dxcharts-lite

DXCharts Lite

  • 2.5.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
5.7K
increased by18.36%
Maintainers
12
Weekly downloads
 
Created
Source

devexperts-logo

DXCharts Lite - one of the most powerful financial charting tools

DXcharts Lite is a modern solution made for visualization financial data with full variety of charts.
It's been created and tempered as a part of big tradings apps with millions of users.
Now it's grown enough to be recognized as independent product capable to support any from your needs
as a simple widget for blog and as a part of big enterprise solution for trading.

License: MPL 2.0   PRs: Welcome   Version


4 charts example


Overview

Get started with DXCharts Lite, install the library and configure it as you want.

Quick-start

Installation

Install library to your project:

npm install @devexperts/dxcharts-lite

Your package.json after installation:

"dependencies": {
	"@devexperts/dxcharts-lite": "1.0.0",
	...
}

Create chart

If you use webpack or any other bundler - import createChart method and pass element where the chart will be rendered as a first argument.

export const createChartInstance = () => {
	const container = document.getElementById('chart_container');
	const chartInstance = DXChart.createChart(container);
	return chartInstance;
};

createChart - method, that creates a new chart instance using ChartBootstrap class and returns it.

Method accepts 2 parameters:

  • element - The HTML element where the chart will be rendered
  • config (optional) - instance of ChartConfig

Also, please, set width: 100% and height: 100% for parent container by default chart is auto-resizing to parent you can change it by setting fixedSize in config

Now you should have empty chart on screen.

Set data

Let's pass in some data i.e. Candles. You can use bundled function to generate some mock data. Import generateCandlesData and call it to generate candles.

export const generateMockData = () => {
	const candles = generateCandlesData();
	chart.setData({ candles });
};

Now you should see chart just like image below:

Basic chart

HTML-markup

Here is full quick-start code example:

<html>
	<head>
		<script src="https://www.unpkg.com/@devexperts/dxcharts-lite@2.0.1/dist/dxchart.min.js"></script>
		<script type="importmap">
			{
				"imports": {
					"@devexperts/dxcharts-lite/": "https://www.unpkg.com/@devexperts/dxcharts-lite@2.0.1/"
				}
			}
		</script>
	</head>
	<body>
		<div id="chart_container"></div>
	</body>
	<script type="module">
		import generateCandlesData from '@devexperts/dxcharts-lite/dist/chart/utils/candles-generator.utils';

		// create chart instance, pass parent container as 1st argument
		const container = document.getElementById('chart_container');
		const chart = DXChart.createChart(container);
		// create and set candles data
		const candles = generateCandlesData();
		chart.setData({ candles });
	</script>
</html>

Configuration

You can configure chart with ChartConfig object. It is optional.

ChartConfig is used to set initial properties for chart instance. Below you can see full table of it, and other options, that ChartConfig consists of.

API

Every chart component has an API allowing change a lot of params on the fly. Change appearance at runtime. Subscribe on different events in chart (like HOVER on candle)

Here are the links of the main components:

Examples

We have created a lot of examples with different chart configuration. You can find them here.

Demo

To show you how it's beautiful, we have created Demo version, based on DXCharts Lite. Feel all power of our library!

Keywords

FAQs

Package last updated on 08 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc