@fluentui/react-charting 5.23.63 → 5.23.65

package/lib-commonjs/utilities/utilities.d.ts

@@ -0,0 +1,418 @@
+import { Axis as D3Axis } from 'd3-axis';
+import { TimeLocaleDefinition as d3TimeLocaleDefinition } from 'd3-time-format';
+import { IAccessibilityProps, IEventsAnnotationProps, ILineChartPoints, IDataPoint, IVerticalStackedBarDataPoint, IVerticalBarChartDataPoint, IHorizontalBarChartWithAxisDataPoint } from '../index';
+export type NumericAxis = D3Axis<number | {
+    valueOf(): number;
+}>;
+export type StringAxis = D3Axis<string>;
+export declare enum ChartTypes {
+    AreaChart = 0,
+    LineChart = 1,
+    VerticalBarChart = 2,
+    VerticalStackedBarChart = 3,
+    GroupedVerticalBarChart = 4,
+    HeatMapChart = 5,
+    HorizontalBarChartWithAxis = 6
+}
+export declare enum XAxisTypes {
+    NumericAxis = 0,
+    DateAxis = 1,
+    StringAxis = 2
+}
+export declare enum YAxisType {
+    NumericAxis = 0,
+    DateAxis = 1,
+    StringAxis = 2
+}
+export interface IWrapLabelProps {
+    node: SVGSVGElement | null;
+    xAxis: NumericAxis | StringAxis;
+    noOfCharsToTruncate: number;
+    showXAxisLablesTooltip: boolean;
+}
+export interface IRotateLabelProps {
+    node: SVGSVGElement | null;
+    xAxis: NumericAxis | StringAxis;
+}
+export interface IAxisData {
+    yAxisDomainValues: number[];
+}
+export interface IMargins {
+    /**
+     * left margin for the chart.
+     * @default 40
+     */
+    left?: number;
+    /**
+     * Right margin for the chart.
+     * @default 20
+     */
+    right?: number;
+    /**
+     * Top margin for the chart.
+     * @default 20
+     */
+    top?: number;
+    /**
+     * Bottom margin for the chart.
+     * @default 35
+     */
+    bottom?: number;
+}
+export interface IDomainNRange {
+    dStartValue: number | Date;
+    dEndValue: number | Date;
+    rStartValue: number;
+    rEndValue: number;
+}
+export interface IXAxisParams {
+    domainNRangeValues: IDomainNRange;
+    xAxisElement?: SVGSVGElement | null;
+    xAxisCount?: number;
+    showRoundOffXTickValues?: boolean;
+    xAxistickSize?: number;
+    tickPadding?: number;
+    xAxisPadding?: number;
+    xAxisInnerPadding?: number;
+    xAxisOuterPadding?: number;
+    margins: IMargins;
+    containerHeight: number;
+    containerWidth: number;
+    hideTickOverlap?: boolean;
+}
+export interface ITickParams {
+    tickValues?: Date[] | number[] | string[];
+    tickFormat?: string;
+}
+export interface IYAxisParams {
+    yMinMaxValues?: {
+        startValue: number;
+        endValue: number;
+    };
+    maxOfYVal?: number;
+    margins: IMargins;
+    containerWidth: number;
+    containerHeight: number;
+    yAxisElement?: SVGSVGElement | null;
+    yAxisTickFormat?: any;
+    yAxisTickCount: number;
+    yMaxValue?: number;
+    yMinValue?: number;
+    tickPadding?: number;
+    eventAnnotationProps?: IEventsAnnotationProps;
+    eventLabelHeight?: number;
+    yAxisPadding?: number;
+}
+/**
+ * Create Numeric X axis
+ * @export
+ * @param {IXAxisParams} xAxisParams
+ */
+export declare function createNumericXAxis(xAxisParams: IXAxisParams, tickParams: ITickParams, chartType: ChartTypes, culture?: string): {
+    xScale: import("d3-scale").ScaleLinear<number, number, never>;
+    tickValues: string[];
+};
+/**
+ * Creating Date x axis of the Chart
+ * @export
+ * @param {IXAxisParams} xAxisParams
+ * @param {ITickParams} tickParams
+ */
+export declare function createDateXAxis(xAxisParams: IXAxisParams, tickParams: ITickParams, culture?: string, options?: Intl.DateTimeFormatOptions, timeFormatLocale?: d3TimeLocaleDefinition, customDateTimeFormatter?: (dateTime: Date) => string, useUTC?: boolean): {
+    xScale: import("d3-scale").ScaleTime<number, number, never>;
+    tickValues: string[];
+};
+/**
+ * Create String X axis
+ * Currently using for only Vetical stacked bar chart and grouped vertical bar chart
+ * @export
+ * @param {IXAxisParams} xAxisParams
+ * @param {ITickParams} tickParams
+ * @param {string[]} dataset
+ * @returns
+ */
+export declare function createStringXAxis(xAxisParams: IXAxisParams, tickParams: ITickParams, dataset: string[], culture?: string): {
+    xScale: import("d3-scale").ScaleBand<string>;
+    tickValues: string[];
+};
+/**
+ * This method used for creating data points for the y axis.
+ * @export
+ * @param {number} maxVal
+ * @param {number} minVal
+ * @param {number} splitInto
+ * @param {boolean} isIntegralDataset
+ * @returns {number[]}
+ */
+export declare function prepareDatapoints(maxVal: number, minVal: number, splitInto: number, isIntegralDataset: boolean, roundedTicks?: boolean): number[];
+export declare function createYAxisForHorizontalBarChartWithAxis(yAxisParams: IYAxisParams, isRtl: boolean): import("d3-scale").ScaleLinear<number, number, never>;
+export declare function createNumericYAxis(yAxisParams: IYAxisParams, isRtl: boolean, axisData: IAxisData, isIntegralDataset: boolean, useSecondaryYScale?: boolean, supportNegativeData?: boolean, roundedTicks?: boolean): import("d3-scale").ScaleLinear<number, number, never>;
+/**
+ * Creating String Y axis of the chart for Horizontal Bar Chart With Axis
+ * @param yAxisParams
+ * @param dataPoints
+ * @param isRtl
+ */
+export declare const createStringYAxisForHorizontalBarChartWithAxis: (yAxisParams: IYAxisParams, dataPoints: string[], isRtl: boolean, barWidth: number) => import("d3-scale").ScaleBand<string>;
+/**
+ * Creating String Y axis of the chart for other chart except Horizontal Bar Chart With Axis
+ * @param yAxisParams
+ * @param dataPoints
+ * @param isRtl
+ */
+export declare const createStringYAxis: (yAxisParams: IYAxisParams, dataPoints: string[], isRtl: boolean) => import("d3-scale").ScaleBand<string>;
+/**
+ * For area chart and line chart, while displaying stackCallout, Need to form a callout data object.
+ * This methos creates an object for those 2 charts.
+ * @param values
+ */
+export declare function calloutData(values: (ILineChartPoints & {
+    index?: number;
+})[]): {
+    x: number;
+    values: {
+        legend: string;
+        y: number;
+        color: string;
+        xAxisCalloutData?: string | undefined;
+        yAxisCalloutData?: string | {
+            [id: string]: number;
+        } | undefined;
+        callOutAccessibilityData?: IAccessibilityProps | undefined;
+        index?: number | undefined;
+    }[];
+}[];
+export declare function getUnique(arr: {
+    x: number | Date | string;
+    values: {
+        legend: string;
+        y: number;
+    }[];
+}[], comp: string | number): {
+    x: number | Date | string;
+    values: {
+        legend: string;
+        y: number;
+    }[];
+}[];
+/**
+ * This function takes two paramerter
+ * 1. an array of strings
+ * 2. a string value
+ * if the value is not present in the given array then it will return the new
+ * array by appending the value to the present arrray.
+ *
+ * if the value is already present in  the given array then it will return the new
+ * array by deleteing the value from the the array
+ * @param array
+ * @param value
+ */
+export declare function silceOrAppendToArray(array: string[], value: string): string[];
+/**
+ * This method used for wrapping of x axis labels (tick values).
+ * It breaks down given text value by space separated and calculates the total height needed to display all the words.
+ * That value = removal value. This value needs to be remove from total svg height, svg will shrink and
+ * total text will be displayed.
+ * @export
+ * @param {IWrapLabelProps} wrapLabelProps
+ * @returns
+ */
+export declare function createWrapOfXLabels(wrapLabelProps: IWrapLabelProps): number | undefined;
+/**
+ * This method used for wrapping of y axis labels (tick values).
+ */
+export declare function createYAxisLabels(node: SVGElement | null, yAxis: any, noOfCharsToTruncate: number, truncateLabel: boolean, isRtl: boolean): void;
+export declare const wrapContent: (content: string, id: string, maxWidth: number) => boolean;
+/**
+ * Calculates the width of the longest axis label in pixels
+ */
+export declare const calculateLongestLabelWidth: (labels: (string | number)[], query?: string) => number;
+/**
+ * This method displays a tooltip to the x axis lables(tick values)
+ * when prop 'showXAxisLablesTooltip' enables to the respected chart.
+ * On hover of the truncated word(at x axis labels tick), a tooltip will be appeared.
+ */
+export declare function tooltipOfXAxislabels(xAxistooltipProps: any): null | undefined;
+/**
+ * Find the axis type of line chart and area chart from given data
+ * @param points
+ */
+export declare function getXAxisType(points: ILineChartPoints[]): boolean;
+/**
+ * Calculates Domain and range values for Numeric X axis.
+ * This method calculates Area cart and line chart.
+ * @export
+ * @param {ILineChartPoints[]} points
+ * @param {IMargins} margins
+ * @param {number} width
+ * @param {boolean} isRTL
+ * @returns {IDomainNRange}
+ */
+export declare function domainRangeOfNumericForAreaChart(points: ILineChartPoints[], margins: IMargins, width: number, isRTL: boolean): IDomainNRange;
+/**
+ * Calculates Domain and range values for Numeric X axis.
+ * This method calculates Horizontal Chart with Axis
+ * @export
+ * @param {ILineChartPoints[]} points
+ * @param {IMargins} margins
+ * @param {number} width
+ * @param {boolean} isRTL
+ * @returns {IDomainNRange}
+ */
+export declare function domainRangeOfNumericForHorizontalBarChartWithAxis(points: IHorizontalBarChartWithAxisDataPoint[], margins: IMargins, containerWidth: number, isRTL: boolean, shiftX: number): IDomainNRange;
+/**
+ * Calculates Range values of x Axis string axis
+ * For String axis, we need to give domain values (Not start and end array values)
+ * So sending 0 as domain values. Domain will be handled at creation of string axis
+ * For charts stacked bar chart, grouped vertical bar chart, HeatMapChart and Vertical bar chart
+ * @export
+ * @param {IMargins} margins
+ * @param {number} width
+ * @param {boolean} isRTL
+ * @returns {IDomainNRange}
+ */
+export declare function domainRangeOfXStringAxis(margins: IMargins, width: number, isRTL: boolean): IDomainNRange;
+/**
+ * Calculate domain and range values to the Vertical stacked bar chart - For Numeric axis
+ * @export
+ * @param {IDataPoint[]} points
+ * @param {IMargins} margins
+ * @param {number} width
+ * @param {boolean} isRTL
+ * @param {number} barWidth
+ * @returns {IDomainNRange}
+ */
+export declare function domainRangeOfVSBCNumeric(points: IDataPoint[], margins: IMargins, width: number, isRTL: boolean, barWidth: number): IDomainNRange;
+/**
+ * Calculates Domain and range values for Date X axis.
+ * This method calculates Bar chart.
+ * @export
+ * @param {IVerticalBarChartDataPoint[]} points
+ * @param {IMargins} margins
+ * @param {number} width
+ * @param {boolean} isRTL
+ * @param {Date[] | number[]} tickValues
+ * @returns {IDomainNRange}
+ */
+export declare function domainRangeOfDateForAreaLineVerticalBarChart(points: ILineChartPoints[] | IVerticalBarChartDataPoint[] | IVerticalStackedBarDataPoint[], margins: IMargins, width: number, isRTL: boolean, tickValues: Date[] | undefined, chartType: ChartTypes, barWidth?: number): IDomainNRange;
+/**
+ * Calculate domain and range values to the Vertical bar chart - For Numeric axis
+ * @export
+ * @param {IDataPoint[]} points
+ * @param {IMargins} margins
+ * @param {number} containerWidth
+ * @param {boolean} isRTL
+ * @param {number} barWidth
+ * @returns {IDomainNRange}
+ */
+export declare function domainRageOfVerticalNumeric(points: IDataPoint[], margins: IMargins, containerWidth: number, isRTL: boolean, barWidth: number): IDomainNRange;
+/**
+ * Calculating start and ending values of the Area chart and LineChart
+ * @export
+ * @param {ILineChartPoints[]} points
+ * @returns {{ startValue: number; endValue: number }}
+ */
+export declare function findNumericMinMaxOfY(points: ILineChartPoints[]): {
+    startValue: number;
+    endValue: number;
+};
+/**
+ * Find the minimum and maximum values of the vertical stacked bar chart y axis data point. Used for create y axis.
+ * @export
+ * @param {IDataPoint[]} dataset
+ * @returns {{ startValue: number; endValue: number }}
+ */
+export declare function findVSBCNumericMinMaxOfY(dataset: IDataPoint[]): {
+    startValue: number;
+    endValue: number;
+};
+/**
+ * Fins the min and max values of the vertical bar chart y axis data point.
+ * @export
+ * @param {IVerticalBarChartDataPoint[]} points
+ * @returns {{ startValue: number; endValue: number }}
+ */
+export declare function findVerticalNumericMinMaxOfY(points: IVerticalBarChartDataPoint[]): {
+    startValue: number;
+    endValue: number;
+};
+/**
+ * Fins the min and max values of the vertical bar chart y axis data point.
+ * @export
+ * @param {IVerticalBarChartDataPoint[]} points
+ * @returns {{ startValue: number; endValue: number }}
+ */
+export declare function findHBCWANumericMinMaxOfY(points: IHorizontalBarChartWithAxisDataPoint[], yAxisType: YAxisType | undefined): {
+    startValue: number;
+    endValue: number;
+};
+/**
+ * @param p string or number or Date
+ *
+ * This function takes the single data point of the x-aixs
+ * and decides what is the x-axis
+ */
+export declare const getTypeOfAxis: (p: string | number | Date, isXAxis: boolean) => XAxisTypes | YAxisType;
+/**
+ * we need to make sure that if we add any property to this, then
+ * we need to also add that in  pointTypes below and vise-versa
+ */
+export declare enum Points {
+    circle = 0,
+    square = 1,
+    triangle = 2,
+    diamond = 3,
+    pyramid = 4,
+    hexagon = 5,
+    pentagon = 6,
+    octagon = 7
+}
+export declare enum CustomPoints {
+    dottedLine = 0
+}
+export type PointTypes = {
+    [key in number]: {
+        /**
+         * For certian shapes like pentagon, hexagon and octagon.
+         * the width of the bouding box increase by the time of the
+         * length of the side, so when we want to render a pentagon
+         * having each side of length 7 units we need to decrease it's
+         * units by width ratio so that the bounding box width of the pentagon
+         * stays as 7
+         */
+        widthRatio: number;
+    };
+};
+/**
+ * we need to make sure that if we add any property to this, then
+ * we need to also add that in enum Point and vise-versa
+ */
+export declare const pointTypes: PointTypes;
+/**
+ * @param accessibleData accessible data
+ * @param role string to define role of tag
+ * @param isDataFocusable boolean
+ * function returns the accessibility data object
+ */
+export declare const getAccessibleDataObject: (accessibleData?: IAccessibilityProps, role?: string, isDataFocusable?: boolean) => {
+    role: string;
+    'data-is-focusable': boolean;
+    'aria-label': string | undefined;
+    'aria-labelledby': string | undefined;
+    'aria-describedby': string | undefined;
+};
+type LocaleStringDataProps = number | string | Date | undefined;
+export declare const convertToLocaleString: (data: LocaleStringDataProps, culture?: string) => LocaleStringDataProps;
+export declare function rotateXAxisLabels(rotateLabelProps: IRotateLabelProps): number | undefined;
+export declare function wrapTextInsideDonut(selectorClass: string, maxWidth: number): void;
+export declare function formatValueWithSIPrefix(value: number): string;
+export declare const getBarWidth: (barWidthProp: number | 'default' | 'auto' | undefined, maxBarWidthProp: number | undefined, adjustedValue?: number) => number;
+export declare const getScalePadding: (prop: number | undefined, shorthandProp?: number, defaultValue?: number) => number;
+export declare const isScalePaddingDefined: (prop: number | undefined, shorthandProp?: number) => boolean;
+export declare const formatDate: (date: Date, useUTC?: boolean) => string;
+export declare function getSecureProps(props?: Record<string, any>): Record<string, any>;
+export declare function areArraysEqual(arr1?: string[], arr2?: string[]): boolean;
+export declare function resolveCSSVariables(chartContainer: HTMLElement, styleRules: string): string;
+export declare function copyStyle(properties: string[] | Record<string, string>, fromEl: Element, toEl: Element): void;
+export declare const createMeasurementSpan: (text: string | number, className: string, parentElement?: HTMLElement | null) => HTMLElement;
+export {};