Skip to content

Dariush-Hassani/react-candlestick-chart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

112 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-candlestick-chart

High performance, lightweight and interactive candlestick chart using the canvas tag, D3 and React.

Installation

npm i react-candlestick-chart

Demo

To discover all features, capabilities and source code, check out Live Demo

alt text

Basic Usage

import CandlestickChart from "react-candlestick-chart"; function App() { return ( <CandlestickChart data={data} id={"chart1"} width={1000} height={400} decimal={2} scrollZoom={{ enable: true, max: 20, }} rangeSelector={{ enable: true, height: 150, initialRange: { type: "month", value: 1 }, }} /> ); }

Props

data - required

data: any; example: [ { date: "2018-10-23", //or 1540166400000 or "2018-10-22 03:30" open: 182.47, high: 183.01, low: 177.39, close: 179.93, //position is optional position: { positionType: "long", // or "short" sl: 170, //stop loss tp: 190, // take profit positionValue: 180, }, }, { date: "2018-10-24", open: 180.82, high: 181.4, low: 177.56, close: 178.75, }, ];

id - required

id: string;

width - required

width: number;

height - required

height: number;

decimal? - optional

decimal for price axis.

decimal?: number; // default value = 0

scrollZoom? - optional

scrollZoom?: { enable: boolean; max: number; }; /* default value : {  enable: false,  max: 1 } */

rangeSelector? - optional

rangeSelector?: { enable: boolean; height: number; initialRange?: { type: "month" | "day" | "hour" | "percent" | "milliseconds"; value: number; }; }; /* default value : {  enable: false;  height: 0;  initialRange?: {  type: "percent";  value: 100;  }; } */

responsiveBreakPoint? - optional

responsiveBreakPoint?: number; // default value = 400 (px)

enableResetButton? - optional

enableResetButton?: boolean; // default value = true

dataViewerTexts? - optional

dataViewerTexts? : { shortPosition?: string; longPosition?: string; stopLoss?: string; takeProfit?: string; open?: string; high?: string; low?: string; close?: string; } /* default value: {  shortPosition: "Short",  longPosition: "Long",  stopLoss: "sl",  takeProfit: "tp",  open: "O",  high: "H",  low: "L",  close: "C", } */

dataViewerColors? - optional

dataViewerColors? : { shortPositionLabel?: string; shortPositionData?: string; longPositionLabel?: string; longPositionData?: string; stopLossLabel?: string; stopLossData?: string; takeProfitLabel?: string; takeProfitData?: string; openLabel?: string; openDataUp?: string; openDataDown?: string; highLabel?: string; highDataUp?: string; highDataDown?: string; lowLabel?: string; lowDataUp?: string; lowDataDown?: string; closeLabel?: string; closeDataUp?: string; closeDataDown?: string; } /* default value: {  shortPositionLabel: "#b2b5be",  shortPositionData:"#fff",  longPositionLabel:"#b2b5be",  longPositionData: "#fff",  stopLossLabel:"#b2b5be",  stopLossData:"#F9DB04",  takeProfitLabel:"#b2b5be",  takeProfitData:"#04F5F9",  openLabel:"#b2b5be",  openDataUp:"#089981",  openDataDown:"#e13443",  highLabel:"#b2b5be",  highDataUp:"#089981",  highDataDown:"#e13443",  lowLabel:"#b2b5be",  lowDataUp:"#089981",  lowDataDown:"#e13443",  closeLabel:"#b2b5be",  closeDataUp:"#089981",  closeDataDown:"#e13443", } */

ColorPalette? - optional

ColorPalette? : { background?: string; grid?: string; tick?: string; selectorLine?: string; selectorLabelBackground?: string; selectorLabelText?: string; greenCandle?: string; redCandle?: string; longPosition?: string; shortPosition?: string; sl?: string; tp?: string; RSChartStroke?: string; RSChartOverlay?: string; RSChartOverlayResize?: string; resetButtonColor?: string; } /* default value: {  background:"#161b26",  grid:"#222631",  tick:"#b2b5be",  selectorLine:"rgba(178,181,190,0.5)",  selectorLabelBackground:"#2a2e39",  selectorLabelText:"#b2b5be",  greenCandle:"#089981",  redCandle:"#e13443",  longPosition:"#fff",  shortPosition:"#fff",  sl:"#F9DB04",  tp:"#04F5F9",  RSChartStroke:"#04F5F9",  RSChartOverlay:"#000",  RSChartOverlayResize:"#e13443",  resetButtonColor:"#04F5F9", } */

License

ISC

Releases

No releases published

Packages