@oliasoft-open-source/charts-library 5.10.0-beta-3 → 5.10.0-beta-4

package/dist/index.d.ts

@@ -329,7 +329,7 @@ export declare interface ICommonAnnotations {
     controlAnnotation?: boolean;
     enableDragAnnotation?: boolean;
     enableCalloutAnnotation?: boolean;
-    lineMarkersAnnotation?: ILineMarkersAnnotation;
+    verticalMarkersAnnotation?: IVerticalMarkersAnnotation;
     annotationsData?: ICommonAnnotationsData[];
     labelAnnotation?: ICommonAnnotation;
 }
@@ -483,7 +483,7 @@ export declare interface ICommonOptions {
     dragData?: ICommonDragData;
     annotations?: ICommonAnnotations;
     plugins?: {
-        lineMarkersPlugin?: {
+        verticalMarkersPlugin?: {
             enabled?: boolean;
         };
     };
@@ -771,8 +771,6 @@ export declare interface ILineLegend extends ICommonLegend {
     usePointStyle?: boolean;
 }
 
-export declare type ILineMarkersAnnotation = TLineMarkersOptions;
-
 export declare interface ILineRange {
     [key: string]: ILineChartRange;
 }
@@ -1004,36 +1002,14 @@ export declare interface IUnitOptions {
     setSelectedUnit: () => void;
 }
 
+export declare type IVerticalMarkersAnnotation = TVerticalMarkersOptions;
+
 export declare enum Key {
     Shift = "Shift"
 }
 
 export declare const LineChart: (props: ILineChartProps) => JSX_2.Element;
 
-export declare enum LineMarkerDirection {
-    Vertical = "vertical",
-    Horizontal = "horizontal"
-}
-
-export declare enum LineMarkerLabelPosition {
-    Left = "left",
-    Right = "right",
-    Top = "top",
-    Bottom = "bottom",
-    OnLine = "onLine"
-}
-
-export declare enum LineMarkerSide {
-    Left = "left",
-    Right = "right"
-}
-
-export declare enum LineMarkerTextAlign {
-    Left = "left",
-    Right = "right",
-    Center = "center"
-}
-
 export declare enum PanZoomMode {
     X = "x",
     Y = "y",
@@ -1083,109 +1059,58 @@ export declare type TGeneratedPieChartDatasets = IGeneratedPieChartDataset[];
 
 export declare type TGeneratedScatterChartDatasets = IGeneratedScatterChartDataset[];
 
-export declare type TLineMarkerDirection = LineMarkerDirection;
+export declare enum TooltipLabel {
+    Y = "yLabel",
+    X = "xLabel"
+}
+
+export declare type TPrimitive = string | number | boolean | null;
+
+export declare type TStickSide = 'left' | 'right';
 
-export declare type TLineMarkerItem = {
+export declare type TVerticalMarkerItem = {
     id?: string;
-    direction?: TLineMarkerDirection;
     xScaleID?: string;
     yScaleID?: string;
     xValue?: number;
-    yValue?: number;
     yStartValue?: number;
-    yEndValue?: number;
-    xStartValue?: number;
-    xEndValue?: number;
-    lengthPx?: number;
     value?: number;
     label?: string | string[];
     font?: string;
     labelOffsetPx?: number;
     stickToEdge?: boolean;
-    stickToGroup?: boolean;
     stickSide?: TStickSide;
-    groupOffsetPx?: number;
     reverse?: boolean;
     color?: string;
     opacity?: number;
     lineWidth?: number;
     lineDash?: number[];
-    startTick?: TLineMarkerTick;
-    endTick?: TLineMarkerTick;
-    extras?: TMarkerExtraItem[];
     display?: boolean;
 };
 
-export declare type TLineMarkerLabelPosition = LineMarkerLabelPosition;
-
-export declare type TLineMarkersOptions = {
+export declare type TVerticalMarkersOptions = {
     enabled?: boolean;
     itemGapPx?: number;
     edgePaddingPx?: number;
-    horizontalLineLengthPx?: number;
-    lineDirection?: TLineMarkerDirection;
-    labelCollisionPx?: number;
-    labelCollisionClusterXPx?: number;
-    enableLabelCollisionResolver?: boolean;
     stickToEdge?: boolean;
-    stickToGroup?: boolean;
     stickSide?: TStickSide;
     reverse?: boolean;
     xValue?: number;
-    yValue?: number;
-    yEndValue?: number;
-    xStartValue?: number;
-    xEndValue?: number;
-    lengthPx?: number;
     yStartValue?: number;
     color?: string;
     opacity?: number;
     lineWidth?: number;
     lineDash?: number[];
-    startTick?: TLineMarkerTick;
-    endTick?: TLineMarkerTick;
-    items?: TLineMarkerItem[];
+    items?: TVerticalMarkerItem[];
 };
 
-export declare type TLineMarkerTextAlign = LineMarkerTextAlign;
-
-export declare type TLineMarkerTick = {
-    enabled?: boolean;
+export declare type TVerticalMarkerTick = {
     label?: string | string[];
     color?: string;
     font?: string;
     labelOffsetPx?: number;
-    labelPosition?: TLineMarkerLabelPosition;
-    side?: TStickSide;
-    reverse?: boolean;
-    sizePx?: number;
 };
 
-export declare type TMarkerExtraItem = {
-    id?: string;
-    display?: boolean;
-    yScaleID?: string;
-    yValue?: number;
-    value?: number;
-    lengthPx?: number;
-    side?: TStickSide;
-    reverse?: boolean;
-    color?: string;
-    opacity?: number;
-    lineWidth?: number;
-    lineDash?: number[];
-    tick?: TLineMarkerTick;
-};
-
-export declare enum TooltipLabel {
-    Y = "yLabel",
-    X = "xLabel"
-}
-
-export declare type TPrimitive = string | number | boolean | null;
-
-export declare type TStickSide = LineMarkerSide;
-
 export declare type UnusedParameter = unknown;
 
 export { }
@@ -1198,19 +1123,63 @@ declare module 'chart.js' {
 }
 
 
+/**
+ * Vertical Markers Plugin
+ *
+ * This plugin draws vertical helper lines on top of the chart.
+ * with a small triangle end cap ("boot") and a text label.
+ *
+ * Where to configure:
+ * - Enable switch: options.plugins.verticalMarkersPlugin.enabled
+ * - Data and style: options.annotations.verticalMarkersAnnotation
+ *
+ * Global props (verticalMarkersAnnotation):
+ * - enabled: Turn markers on or off.
+ * - items: List of marker objects to draw.
+ * - itemGapPx: Space in pixels between marker lines.
+ * - edgePaddingPx: Distance from chart left/right edge when sticky mode is used.
+ * - stickToEdge: If true, use chart edge as base X position.
+ * - stickSide: Which edge to use in sticky mode: 'left' or 'right'.
+ * - xValue: Optional base X value from the X scale (used instead of edge).
+ * - yStartValue: Optional start Y value for all lines (if not set, start from top;
+ *   if reverse is true, start from bottom).
+ * - reverse: If true, lines go from bottom to top. If false, top to bottom.
+ * - color: Default line and triangle color.
+ * - opacity: Default line opacity.
+ * - lineWidth: Default line width.
+ * - lineDash: Default dash pattern for lines.
+ *
+ * Item props (each object in items):
+ * - value: Required Y value where the marker line ends and triangle is placed.
+ * - label: Optional text near the triangle.
+ * - display: Show or hide this item.
+ * - stickToEdge: Per-item override of global stickToEdge.
+ * - stickSide: Per-item override of global stickSide.
+ * - xValue: Per-item override of global xValue.
+ * - yStartValue: Per-item override of global yStartValue.
+ * - reverse: Per-item override of global reverse.
+ * - color: Per-item override of global color.
+ * - opacity: Per-item override of global opacity.
+ * - lineWidth: Per-item override of global lineWidth.
+ * - lineDash: Per-item override of global lineDash.
+ * - font: Optional label font.
+ * - labelOffsetPx: Optional label offset in pixels.
+ * - xScaleID: Optional custom X scale id for xValue conversion.
+ * - yScaleID: Optional custom Y scale id for value conversion.
+ */
 declare module 'chart.js' {
     interface PluginOptionsByType<TType extends ChartType> {
-        calloutConnectorPlugin?: {
-            enableCalloutAnnotation?: boolean;
-        };
+        verticalMarkersPlugin?: {
+            enabled?: boolean;
+        } | TVerticalMarkersOptions;
     }
 }
 
 
 declare module 'chart.js' {
     interface PluginOptionsByType<TType extends ChartType> {
-        lineMarkersPlugin?: {
-            enabled?: boolean;
-        } | TLineMarkersOptions;
+        calloutConnectorPlugin?: {
+            enableCalloutAnnotation?: boolean;
+        };
     }
 }