pace-chart-lib 1.0.70 → 1.0.71

package/dist/Components/Charts/ChartsWithAxis/ChartsWithAxisTypes.types.d.ts

@@ -1,5 +1,6 @@
 import { TData } from "../Core/Common.types";
 import type { TDefaultChartFormatOptionsType } from "../Core/DefaultProperties.types";
+import type { TVfxOnElementClick, TVfxTooltipFormatter } from "../Core/VfxInteraction";
 export type TMargin = {
     top: number;
     left: number;
@@ -57,6 +58,9 @@ export type TChartProps = {
     isAdvancedAnalyticsWaterFall?: boolean;
     onDataLabelCoordinatesChange?: (coords: any[]) => void;
     addLocalFilterFromLib?: (clickedLegendData: any) => void;
+    tooltipFormatter?: TVfxTooltipFormatter;
+    onElementClick?: TVfxOnElementClick;
+    vfxPickModeActive?: boolean;
 };
 export type TChartJSON = {
     dimensionList: string[];

package/dist/Components/Charts/ChartsWithoutAxis/ChartsWithoutAxisTypes.types.d.ts

@@ -1,4 +1,5 @@
 import { TDefaultChartFormatOptionsType, TLegendEntry, TPieOfPieSeries, TSeries } from "../Core/Common.types";
+import type { TVfxOnElementClick } from "../Core/VfxInteraction";
 export interface IChartProps {
     chartId: string;
     data: {
@@ -10,6 +11,8 @@ export interface IChartProps {
     isReportEditable?: boolean;
     onDataLabelCoordinatesChange?: (coords: any[]) => void;
     addLocalFilterFromLib?: (clickedLegendData: any) => void;
+    onElementClick?: TVfxOnElementClick;
+    vfxPickModeActive?: boolean;
 }
 export interface IPieofPieChartProps {
     chartId: string;
@@ -42,6 +45,8 @@ export type TSankeyChartProps = {
     clientWidth: number;
     clientHeight: number;
     formatOptions: TDefaultChartFormatOptionsType;
+    onElementClick?: TVfxOnElementClick;
+    vfxPickModeActive?: boolean;
 };
 export type TNodePairs = {
     source: string;

package/dist/Components/Charts/Core/Common.types.d.ts

@@ -1,3 +1,4 @@
+import type { TVfxOnElementClick } from "./VfxInteraction";
 export declare enum staticLegendShape {
     rectangle = "rectangle",
     circle = "circle",
@@ -373,6 +374,8 @@ export type TBubbleChartProps = {
     legendEntries?: TLegendsFormatting[];
     formatOptions?: TDefaultChartFormatOptionsType;
     addLocalFilterFromLib?: (clickedLegendData: any) => void;
+    onElementClick?: TVfxOnElementClick;
+    vfxPickModeActive?: boolean;
 };
 export declare const referenceLineTypes: {
     None: string;
@@ -388,6 +391,8 @@ export type TScatterChartProps = {
     shapesList: TLegendsFormatting[];
     colorsList: TLegendsFormatting[];
     formatOptions: TDefaultChartFormatOptionsType;
+    onElementClick?: TVfxOnElementClick;
+    vfxPickModeActive?: boolean;
 };
 export declare enum commonColors {
     white = "#ffffff",

package/dist/Components/Charts/Core/CommonFunctions.d.ts

@@ -2,6 +2,7 @@ import * as d3 from "d3";
 import type { TChartJSON } from "../ChartsWithAxis/ChartsWithAxisTypes.types";
 import { TVennSeries } from "../ChartsWithoutAxis/ChartsWithoutAxisTypes.types";
 import { type TAnnotationObject, type TChartMargins, TData, type TDataPoint, type TDefaultChartFormatOptionsType, type TSeries, type TTextDimensions } from "./Common.types";
+import type { TVfxTooltipFormatter } from "./VfxInteraction";
 export declare const svgID = "scaling-svg-";
 export declare function getRandomColor(): {
     color: string;
@@ -51,7 +52,7 @@ export declare function calculateMaxLegendWidth(list: string[], formatOptions: T
  *
  * @returns {void} This function does not return a value; it appends and updates SVG marker elements in the DOM.
  */
-export declare function lineMarkers(lines: any, chartData: TSeries[], type: any, xScale: any, yScale: any, yScaleRight: any, tooltipHandle: any, formatOptions: TDefaultChartFormatOptionsType, chartJSON: TChartJSON, secondaryCustomYaxisMaxValue: number, secondaryCustomYaxisMinValue: number, customYaxisMinValue: number, customYaxisMaxValue: number, isNormalizedChart: boolean): void;
+export declare function lineMarkers(lines: any, chartData: TSeries[], type: any, xScale: any, yScale: any, yScaleRight: any, tooltipHandle: any, formatOptions: TDefaultChartFormatOptionsType, chartJSON: TChartJSON, secondaryCustomYaxisMaxValue: number, secondaryCustomYaxisMinValue: number, customYaxisMinValue: number, customYaxisMaxValue: number, isNormalizedChart: boolean, tooltipFormatter?: TVfxTooltipFormatter): void;
 export declare function Markershapes(Shape: any): d3.SymbolType;
 /**
  * Attaches hover interactions to the area chart elements to show markers and tooltips
@@ -92,7 +93,7 @@ export declare function getAutoNumberWithFormat(value: any): any;
  * @param chartFormatOptions -> rightpane format options;
  * @param event -> optional mouse event to track mouse;
  */
-export declare function showTooltipOnMouseMove(elements: any, chartFormatOptions: TDefaultChartFormatOptionsType, event?: MouseEvent, prop?: any): void;
+export declare function showTooltipOnMouseMove(elements: any, chartFormatOptions: TDefaultChartFormatOptionsType, event?: MouseEvent, prop?: any, customHTML?: string): void;
 export declare function hideTooltipOnMouseOut(): void;
 /**
  * Adds chart title to svg

package/dist/Components/Charts/Core/VfxInteraction.d.ts

@@ -0,0 +1,25 @@
+import { MutableRefObject } from "react";
+export declare enum VfxDataAttr {
+    SeriesId = "data-series-id",
+    DimValue = "data-dim-value"
+}
+export declare const VFX_TOOLTIP_FONT_SIZE = "11px";
+export declare const VFX_TOOLTIP_LINE_HEIGHT = "1.6";
+export type TVfxElementClickPayload = {
+    seriesId: string;
+    dimValue: string;
+    legendUniqueId: string;
+    seriesDisplayName: string;
+};
+export type TVfxOnElementClick = (payload: TVfxElementClickPayload) => void;
+export type TVfxTooltipFormatter = (dimensionValue: string, seriesProperties: any) => string | null;
+/**
+ * Returns a D3-compatible click handler that gates on vfxPickModeActive.
+ * Accepts a buildPayload fn so each chart controls what it puts in the event payload.
+ */
+export declare function makeVfxClickHandler(vfxPickModeActiveRef: MutableRefObject<boolean | undefined>, onElementClickRef: MutableRefObject<TVfxOnElementClick | undefined>, buildPayload: (_event: MouseEvent, datum: any) => TVfxElementClickPayload): (_event: MouseEvent, datum: any) => void;
+/**
+ * Resolves custom tooltip HTML from the project-side formatter.
+ * Returns undefined when no formatter is supplied or the formatter returns null.
+ */
+export declare function resolveCustomTooltipHTML(tooltipFormatter: TVfxTooltipFormatter | undefined, dimValue: string, seriesProperties: any): string | undefined;