hyperprop-charting-library 0.1.129 → 0.1.131
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.
- package/dist/hyperprop-charting-library.cjs +381 -62
- package/dist/hyperprop-charting-library.d.ts +26 -1
- package/dist/hyperprop-charting-library.js +381 -62
- package/dist/index.cjs +381 -62
- package/dist/index.d.cts +26 -1
- package/dist/index.d.ts +26 -1
- package/dist/index.js +381 -62
- package/docs/API.md +9 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -191,6 +191,27 @@ interface IndicatorRenderContext {
|
|
|
191
191
|
candleSpacing: number;
|
|
192
192
|
upColor: string;
|
|
193
193
|
downColor: string;
|
|
194
|
+
/** Grid styling of the main chart, so separate panes can match it. */
|
|
195
|
+
grid?: {
|
|
196
|
+
color: string;
|
|
197
|
+
opacity: number;
|
|
198
|
+
horizontalLines: boolean;
|
|
199
|
+
};
|
|
200
|
+
}
|
|
201
|
+
/** Emitted when a pane-legend control (hover buttons) is clicked. */
|
|
202
|
+
interface IndicatorPaneActionEvent {
|
|
203
|
+
id: string;
|
|
204
|
+
type: string;
|
|
205
|
+
action: "settings" | "remove" | "source" | "visibility";
|
|
206
|
+
/** New visibility after an eye toggle (only set for action "visibility"). */
|
|
207
|
+
visible?: boolean;
|
|
208
|
+
}
|
|
209
|
+
/** Emitted while/after dragging a pane divider to resize an indicator pane. */
|
|
210
|
+
interface IndicatorPaneHeightChangeEvent {
|
|
211
|
+
id: string;
|
|
212
|
+
paneHeightRatio: number;
|
|
213
|
+
/** True while the divider is still being dragged, false on release. */
|
|
214
|
+
dragging: boolean;
|
|
194
215
|
}
|
|
195
216
|
interface IndicatorPaneAxisOptions {
|
|
196
217
|
min: number;
|
|
@@ -501,6 +522,10 @@ interface ChartInstance {
|
|
|
501
522
|
updateOrderLine: (id: string, patch: Partial<OrderLineOptions>) => void;
|
|
502
523
|
removeOrderLine: (id: string) => void;
|
|
503
524
|
onOrderAction: (handler: ((event: OrderActionEvent) => void) | null) => void;
|
|
525
|
+
/** Pane-legend hover controls: settings / remove / source / eye clicks. */
|
|
526
|
+
onIndicatorPaneAction: (handler: ((event: IndicatorPaneActionEvent) => void) | null) => void;
|
|
527
|
+
/** Pane divider drag-resize; fires live while dragging and once on release. */
|
|
528
|
+
onIndicatorPaneHeightChange: (handler: ((event: IndicatorPaneHeightChangeEvent) => void) | null) => void;
|
|
504
529
|
onChartClick: (handler: ((event: ChartClickEvent) => void) | null) => void;
|
|
505
530
|
onCrosshairMove: (handler: ((event: CrosshairMoveEvent) => void) | null) => void;
|
|
506
531
|
onCrosshairPriceAction: (handler: ((event: CrosshairPriceActionEvent) => void) | null) => void;
|
|
@@ -572,4 +597,4 @@ interface ViewportState {
|
|
|
572
597
|
}
|
|
573
598
|
declare function createChart(element: HTMLElement, options?: ChartOptions): ChartInstance;
|
|
574
599
|
|
|
575
|
-
export { type AxisOptions, type BuiltInIndicatorInfo, type ChartClickEvent, type ChartInstance, type ChartOptions, type ChartType, type CrosshairMoveEvent, type CrosshairOptions, type CrosshairPriceActionEvent, type DashPatternOptions, type DrawingDefaults, type DrawingHoverEvent, type DrawingObjectOptions, type DrawingPoint, type DrawingSelectEvent, type DrawingToolType, FIB_DEFAULT_PALETTE, type GridOptions, type IndicatorInstanceOptions, type IndicatorPane, type IndicatorPaneAxisOptions, type IndicatorPaneGuideLine, type IndicatorPaneRenderInfo, type IndicatorPaneValue, type IndicatorPaneValueLabel, type IndicatorPlugin, type IndicatorRenderContext, type LabelsOptions, type OhlcDataPoint, type OrderActionButton, type OrderActionEvent, type OrderLineOptions, POSITION_DEFAULT_COLORS, type PriceLineOptions, type TickerLineOptions, type TradeMarkerOptions, type ViewportState, type WatermarkOptions, createChart };
|
|
600
|
+
export { type AxisOptions, type BuiltInIndicatorInfo, type ChartClickEvent, type ChartInstance, type ChartOptions, type ChartType, type CrosshairMoveEvent, type CrosshairOptions, type CrosshairPriceActionEvent, type DashPatternOptions, type DrawingDefaults, type DrawingHoverEvent, type DrawingObjectOptions, type DrawingPoint, type DrawingSelectEvent, type DrawingToolType, FIB_DEFAULT_PALETTE, type GridOptions, type IndicatorInstanceOptions, type IndicatorPane, type IndicatorPaneActionEvent, type IndicatorPaneAxisOptions, type IndicatorPaneGuideLine, type IndicatorPaneHeightChangeEvent, type IndicatorPaneRenderInfo, type IndicatorPaneValue, type IndicatorPaneValueLabel, type IndicatorPlugin, type IndicatorRenderContext, type LabelsOptions, type OhlcDataPoint, type OrderActionButton, type OrderActionEvent, type OrderLineOptions, POSITION_DEFAULT_COLORS, type PriceLineOptions, type TickerLineOptions, type TradeMarkerOptions, type ViewportState, type WatermarkOptions, createChart };
|
package/dist/index.d.ts
CHANGED
|
@@ -191,6 +191,27 @@ interface IndicatorRenderContext {
|
|
|
191
191
|
candleSpacing: number;
|
|
192
192
|
upColor: string;
|
|
193
193
|
downColor: string;
|
|
194
|
+
/** Grid styling of the main chart, so separate panes can match it. */
|
|
195
|
+
grid?: {
|
|
196
|
+
color: string;
|
|
197
|
+
opacity: number;
|
|
198
|
+
horizontalLines: boolean;
|
|
199
|
+
};
|
|
200
|
+
}
|
|
201
|
+
/** Emitted when a pane-legend control (hover buttons) is clicked. */
|
|
202
|
+
interface IndicatorPaneActionEvent {
|
|
203
|
+
id: string;
|
|
204
|
+
type: string;
|
|
205
|
+
action: "settings" | "remove" | "source" | "visibility";
|
|
206
|
+
/** New visibility after an eye toggle (only set for action "visibility"). */
|
|
207
|
+
visible?: boolean;
|
|
208
|
+
}
|
|
209
|
+
/** Emitted while/after dragging a pane divider to resize an indicator pane. */
|
|
210
|
+
interface IndicatorPaneHeightChangeEvent {
|
|
211
|
+
id: string;
|
|
212
|
+
paneHeightRatio: number;
|
|
213
|
+
/** True while the divider is still being dragged, false on release. */
|
|
214
|
+
dragging: boolean;
|
|
194
215
|
}
|
|
195
216
|
interface IndicatorPaneAxisOptions {
|
|
196
217
|
min: number;
|
|
@@ -501,6 +522,10 @@ interface ChartInstance {
|
|
|
501
522
|
updateOrderLine: (id: string, patch: Partial<OrderLineOptions>) => void;
|
|
502
523
|
removeOrderLine: (id: string) => void;
|
|
503
524
|
onOrderAction: (handler: ((event: OrderActionEvent) => void) | null) => void;
|
|
525
|
+
/** Pane-legend hover controls: settings / remove / source / eye clicks. */
|
|
526
|
+
onIndicatorPaneAction: (handler: ((event: IndicatorPaneActionEvent) => void) | null) => void;
|
|
527
|
+
/** Pane divider drag-resize; fires live while dragging and once on release. */
|
|
528
|
+
onIndicatorPaneHeightChange: (handler: ((event: IndicatorPaneHeightChangeEvent) => void) | null) => void;
|
|
504
529
|
onChartClick: (handler: ((event: ChartClickEvent) => void) | null) => void;
|
|
505
530
|
onCrosshairMove: (handler: ((event: CrosshairMoveEvent) => void) | null) => void;
|
|
506
531
|
onCrosshairPriceAction: (handler: ((event: CrosshairPriceActionEvent) => void) | null) => void;
|
|
@@ -572,4 +597,4 @@ interface ViewportState {
|
|
|
572
597
|
}
|
|
573
598
|
declare function createChart(element: HTMLElement, options?: ChartOptions): ChartInstance;
|
|
574
599
|
|
|
575
|
-
export { type AxisOptions, type BuiltInIndicatorInfo, type ChartClickEvent, type ChartInstance, type ChartOptions, type ChartType, type CrosshairMoveEvent, type CrosshairOptions, type CrosshairPriceActionEvent, type DashPatternOptions, type DrawingDefaults, type DrawingHoverEvent, type DrawingObjectOptions, type DrawingPoint, type DrawingSelectEvent, type DrawingToolType, FIB_DEFAULT_PALETTE, type GridOptions, type IndicatorInstanceOptions, type IndicatorPane, type IndicatorPaneAxisOptions, type IndicatorPaneGuideLine, type IndicatorPaneRenderInfo, type IndicatorPaneValue, type IndicatorPaneValueLabel, type IndicatorPlugin, type IndicatorRenderContext, type LabelsOptions, type OhlcDataPoint, type OrderActionButton, type OrderActionEvent, type OrderLineOptions, POSITION_DEFAULT_COLORS, type PriceLineOptions, type TickerLineOptions, type TradeMarkerOptions, type ViewportState, type WatermarkOptions, createChart };
|
|
600
|
+
export { type AxisOptions, type BuiltInIndicatorInfo, type ChartClickEvent, type ChartInstance, type ChartOptions, type ChartType, type CrosshairMoveEvent, type CrosshairOptions, type CrosshairPriceActionEvent, type DashPatternOptions, type DrawingDefaults, type DrawingHoverEvent, type DrawingObjectOptions, type DrawingPoint, type DrawingSelectEvent, type DrawingToolType, FIB_DEFAULT_PALETTE, type GridOptions, type IndicatorInstanceOptions, type IndicatorPane, type IndicatorPaneActionEvent, type IndicatorPaneAxisOptions, type IndicatorPaneGuideLine, type IndicatorPaneHeightChangeEvent, type IndicatorPaneRenderInfo, type IndicatorPaneValue, type IndicatorPaneValueLabel, type IndicatorPlugin, type IndicatorRenderContext, type LabelsOptions, type OhlcDataPoint, type OrderActionButton, type OrderActionEvent, type OrderLineOptions, POSITION_DEFAULT_COLORS, type PriceLineOptions, type TickerLineOptions, type TradeMarkerOptions, type ViewportState, type WatermarkOptions, createChart };
|