@candleview/core 2.9.5 → 2.9.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +76 -29
  2. package/dist/index.d.ts +1337 -250
  3. package/dist/index.js +708 -650
  4. package/dist/index.mjs +43129 -41376
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  <p align="center">
2
2
  <picture>
3
- <source media="(prefers-color-scheme: dark)" srcset="../assets/logo/logo_imgtxt_dark_en.png">
4
- <source media="(prefers-color-scheme: light)" srcset="../assets/logo/logo_imgtxt_light_en.png">
5
- <img src="../assets/logo/logo_imgtxt_light_en.png" alt="Portal" width="300">
3
+ <source media="(prefers-color-scheme: dark)" srcset="./assets/logo/logo_imgtxt_dark_en.png">
4
+ <source media="(prefers-color-scheme: light)" srcset="./assets/logo/logo_imgtxt_light_en.png">
5
+ <img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/logo/logo_imgtxt_light_en.png" alt="Portal" width="300">
6
6
  </picture>
7
7
  </p>
8
8
  <h4 align="center">
@@ -14,11 +14,11 @@ A time-series data visualization and charting engine designed specifically for t
14
14
  <a href="https://github.com/0xhappyboy/candleview/stargazers"><img src="https://img.shields.io/github/stars/0xhappyboy/candleview.svg?style=flat&labelColor=1C2C2E&color=FFD700&logo=github&logoColor=white&label=stars" alt="GitHub stars"></a>
15
15
  <a href="https://github.com/0xhappyboy/candleview/issues"><img src="https://img.shields.io/github/issues/0xhappyboy/candleview.svg?style=flat&labelColor=1C2C2E&color=FF6B6B&logo=github&logoColor=white&label=issues" alt="GitHub issues"></a>
16
16
  <a href="https://github.com/0xhappyboy/candleview/network/members"><img src="https://img.shields.io/github/forks/0xhappyboy/candleview.svg?style=flat&labelColor=1C2C2E&color=42A5F5&logo=github&logoColor=white&label=forks" alt="GitHub forks"></a>
17
- <a href="https://www.npmjs.com/package/@candleview/core"><img src="https://img.shields.io/npm/v/candleview.svg?style=flat&labelColor=1C2C2E&color=FF5722&logo=npm&logoColor=white&label=npm%20version" alt="npm version"></a>
17
+ <a href="https://www.npmjs.com/package/candleview"><img src="https://img.shields.io/npm/v/candleview.svg?style=flat&labelColor=1C2C2E&color=FF5722&logo=npm&logoColor=white&label=npm%20version" alt="npm version"></a>
18
18
  <a href="https://github.com/0xhappyboy/candleview/releases"><img src="https://img.shields.io/github/v/tag/0xhappyboy/candleview.svg?style=flat&labelColor=1C2C2E&color=9C27B0&logo=github&logoColor=white&label=latest%20release" alt="GitHub release"></a>
19
- <a href="https://github.com/0xhappyboy/candleview/actions"><img src="https://img.shields.io/github/actions/workflow/status/0xhappyboy/candleview/release.yml?style=flat&labelColor=1C2C2E&color=4CAF50&logo=githubactions&logoColor=white&label=build" alt="Build Status"></a><a href="https://www.npmjs.com/package/@candleview/core"><img src="https://img.shields.io/npm/dt/candleview?style=flat&labelColor=1C2C2E&color=00BCD4&logo=npm&logoColor=white&label=total%20downloads" alt="npm downloads"></a>
20
- <a href="https://www.npmjs.com/package/@candleview/core"><img src="https://img.shields.io/npm/dm/candleview?style=flat&labelColor=1C2C2E&color=00BCD4&logo=npm&logoColor=white&label=downloads/month" alt="npm downloads"></a>
21
- <a href="https://www.npmjs.com/package/@candleview/core"><img src="https://img.shields.io/npm/dw/candleview?style=flat&labelColor=1C2C2E&color=00BCD4&logo=npm&logoColor=white&label=downloads/week" alt="npm downloads"></a>
19
+ <a href="https://github.com/0xhappyboy/candleview/actions"><img src="https://img.shields.io/github/actions/workflow/status/0xhappyboy/candleview/release.yml?style=flat&labelColor=1C2C2E&color=4CAF50&logo=githubactions&logoColor=white&label=build" alt="Build Status"></a><a href="https://www.npmjs.com/package/candleview"><img src="https://img.shields.io/npm/dt/candleview?style=flat&labelColor=1C2C2E&color=00BCD4&logo=npm&logoColor=white&label=total%20downloads" alt="npm downloads"></a>
20
+ <a href="https://www.npmjs.com/package/candleview"><img src="https://img.shields.io/npm/dm/candleview?style=flat&labelColor=1C2C2E&color=00BCD4&logo=npm&logoColor=white&label=downloads/month" alt="npm downloads"></a>
21
+ <a href="https://www.npmjs.com/package/candleview"><img src="https://img.shields.io/npm/dw/candleview?style=flat&labelColor=1C2C2E&color=00BCD4&logo=npm&logoColor=white&label=downloads/week" alt="npm downloads"></a>
22
22
  <a href="https://twitter.com/intent/follow?screen_name=candleview"><img src="https://img.shields.io/twitter/follow/candleview" alt="CandleView" /></a>
23
23
  </p>
24
24
  <p align="center">
@@ -65,6 +65,53 @@ const chart = new CandleView({ parent: document.getElementById("wrapper") });
65
65
  const chart = new CandleView({ parentSelector: "#wrapper" });
66
66
  ```
67
67
 
68
+ ### Basic Configuration
69
+
70
+ ```typescript
71
+ const candleView = new CandleView({
72
+ container: document.getElementById("chart"), // Container DOM element
73
+ title: "AAPL - Daily Chart", // Chart title
74
+ data: candleData, // Candlestick data points array
75
+ theme: "dark", // Theme: "dark" | "light"
76
+ locale: "en", // Language: "en" | "zh-cn"
77
+ showTopPanel: true, // Show top toolbar panel
78
+ showLeftPanel: true, // Show left toolbar panel
79
+ chartType: MainChartType.Candle, // Main chart type, e.g. candlestick chart
80
+ activeTimeframe: TimeframeEnum.ONE_HOUR, // Active time period, e.g. 1 hour
81
+ currentTimezone: TimezoneEnum.NEW_YORK, // Current timezone
82
+ onToolSelect: (tool) => {
83
+ console.log("Tool selected:", tool);
84
+ },
85
+ onTimeframeChange: (timeframe) => {
86
+ console.log("Timeframe changed:", timeframe);
87
+ },
88
+ onChartTypeChange: (type) => {
89
+ console.log("Chart type changed:", type);
90
+ },
91
+ onMainChartIndicatorSelect: (indicator) => {
92
+ console.log("Main chart indicator selected:", indicator);
93
+ },
94
+ onSubChartIndicatorSelect: (indicators) => {
95
+ console.log("Sub-chart indicators selected:", indicators);
96
+ },
97
+ onThemeToggle: (theme) => {
98
+ console.log("Theme toggled:", theme);
99
+ },
100
+ onCameraClick: () => {
101
+ console.log("Screenshot button clicked");
102
+ },
103
+ onFullscreenClick: () => {
104
+ console.log("Fullscreen button clicked");
105
+ },
106
+ onTimezoneSelect: (timezone) => {
107
+ console.log("Timezone changed:", timezone);
108
+ },
109
+ onTimeframeChangeCallback: (candleView, timeframe) => {
110
+ console.log("Timeframe changed (callback):", timeframe);
111
+ },
112
+ });
113
+ ```
114
+
68
115
  ### JavaScript
69
116
 
70
117
  ```typescript
@@ -137,7 +184,7 @@ const interval = setInterval(() => {
137
184
  }, 1000);
138
185
  ```
139
186
 
140
- <img src="../assets/real_time_data_demo.gif" alt="CandleView Static Mark" width="100%">
187
+ <img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/real_time_data_demo.gif" alt="CandleView Static Mark" width="100%">
141
188
 
142
189
  ## Static Mark
143
190
 
@@ -335,15 +382,15 @@ console.log(`Current mark count: ${count}`);
335
382
  chart.clearAllStaticMarks();
336
383
  ```
337
384
 
338
- <img src="../assets/static_mark_demo.gif" alt="CandleView Static Mark" width="100%">
385
+ <img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/static_mark_demo.gif" alt="CandleView Static Mark" width="100%">
339
386
 
340
387
  ## Multi Panel Performance
341
388
 
342
- <img src="../assets/candleview-multi-panel-2.gif" alt="CandleView Multi Panel" width="100%">
389
+ <img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/candleview-multi-panel-2.gif" alt="CandleView Multi Panel" width="100%">
343
390
 
344
391
  ## Technical Indicators In The Sub Chart.
345
392
 
346
- <img src="../assets/sub-chart.gif" width="100%">
393
+ <img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/sub-chart.gif" width="100%">
347
394
 
348
395
  ## Preview
349
396
 
@@ -361,8 +408,8 @@ chart.clearAllStaticMarks();
361
408
  </td>
362
409
  </tr>
363
410
  <tr>
364
- <td align="center"><img src="../assets/fibonacci/fibonacci-arc.gif" width="100%"></td>
365
- <td align="center"><img src="../assets/fibonacci/fibonacci-channel.gif" width="100%"></td>
411
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-arc.gif" width="100%"></td>
412
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-channel.gif" width="100%"></td>
366
413
  </tr>
367
414
  <tr>
368
415
  <td align="left">
@@ -373,8 +420,8 @@ chart.clearAllStaticMarks();
373
420
  </td>
374
421
  </tr>
375
422
  <tr>
376
- <td align="center"><img src="../assets/fibonacci/fibonacci-fan.gif" width="100%"></td>
377
- <td align="center"><img src="../assets/fibonacci/fibonacci-price-extension.gif" width="100%"></td>
423
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-fan.gif" width="100%"></td>
424
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-price-extension.gif" width="100%"></td>
378
425
  </tr>
379
426
  <tr>
380
427
  <td align="left">
@@ -385,8 +432,8 @@ chart.clearAllStaticMarks();
385
432
  </td>
386
433
  </tr>
387
434
  <tr>
388
- <td align="center"><img src="../assets/fibonacci/fibonacci-spiral.gif" width="100%"></td>
389
- <td align="center"><img src="../assets/fibonacci/fibonacci-time-expansion.gif" width="100%"></td>
435
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-spiral.gif" width="100%"></td>
436
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-time-expansion.gif" width="100%"></td>
390
437
  </tr>
391
438
  <tr>
392
439
  <td align="left">
@@ -397,8 +444,8 @@ chart.clearAllStaticMarks();
397
444
  </td>
398
445
  </tr>
399
446
  <tr>
400
- <td align="center"><img src="../assets/fibonacci/fibonacci-wedge.gif" width="100%"></td>
401
- <td align="center"><img src="../assets/fibonacci/fibonacci-retracement.gif" width="100%"></td>
447
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-wedge.gif" width="100%"></td>
448
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-retracement.gif" width="100%"></td>
402
449
  </tr>
403
450
  <tr>
404
451
  <td align="left">
@@ -409,8 +456,8 @@ chart.clearAllStaticMarks();
409
456
  </td>
410
457
  </tr>
411
458
  <tr>
412
- <td align="center"><img src="../assets/fibonacci/fibonacci-time-zoon.gif" width="100%"></td>
413
- <td align="center"><img src="../assets/fibonacci/fibonacci-circle.gif" width="100%"></td>
459
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-time-zoon.gif" width="100%"></td>
460
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/fibonacci/fibonacci-circle.gif" width="100%"></td>
414
461
  </tr>
415
462
  </table>
416
463
 
@@ -425,8 +472,8 @@ chart.clearAllStaticMarks();
425
472
  <h4>Fan</h4>
426
473
  </tr>
427
474
  <tr>
428
- <td align="center"><img src="../assets/gann/gann-box.gif" width="100%"></td>
429
- <td align="center"><img src="../assets/gann/gann-fan.gif" width="100%"></td>
475
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/gann/gann-box.gif" width="100%"></td>
476
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/gann/gann-fan.gif" width="100%"></td>
430
477
  </tr>
431
478
  <tr>
432
479
  <td align="left">
@@ -434,13 +481,13 @@ chart.clearAllStaticMarks();
434
481
  </td>
435
482
  </tr>
436
483
  <tr>
437
- <td align="center"><img src="../assets/gann//gann-rectangle.gif" width="100%"></td>
484
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/gann//gann-rectangle.gif" width="100%"></td>
438
485
  </tr>
439
486
  </table>
440
487
 
441
488
  #### Mark
442
489
 
443
- <img src="../assets/mark.gif" width="100%">
490
+ <img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/mark.gif" width="100%">
444
491
 
445
492
  ### Theme
446
493
 
@@ -454,8 +501,8 @@ chart.clearAllStaticMarks();
454
501
  </td>
455
502
  </tr>
456
503
  <tr>
457
- <td align="center"><img src="../assets/preview_theme_dark.png" width="400"></td>
458
- <td align="center"><img src="../assets/preview_theme_light.png" width="400"></td>
504
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/preview_theme_dark.png" width="400"></td>
505
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/preview_theme_light.png" width="400"></td>
459
506
  </tr>
460
507
  </table>
461
508
 
@@ -471,8 +518,8 @@ chart.clearAllStaticMarks();
471
518
  </td>
472
519
  </tr>
473
520
  <tr>
474
- <td align="center"><img src="../assets/preview_i18n_en.png" width="400"></td>
475
- <td align="center"><img src="../assets/preview_i18n_zh-CN.png" width="400"></td>
521
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/preview_i18n_en.png" width="400"></td>
522
+ <td align="center"><img src="https://raw.githubusercontent.com/0xhappyboy/candleview/main/assets/preview_i18n_zh-CN.png" width="400"></td>
476
523
  </tr>
477
524
  </table>
478
525