@fluentui/react-charting 5.23.63 → 5.23.64

package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.d.ts

@@ -0,0 +1,198 @@
+import { IChartProps, IChartDataPoint } from './index';
+import { IStyle, ITheme } from '@fluentui/react/lib/Styling';
+import { ICalloutProps } from '@fluentui/react/lib/Callout';
+import { IRenderFunction, IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';
+/**
+ * Horizontal Bar Chart properties
+ * {@docCategory HorizontalBarChart}
+ */
+export interface IHorizontalBarChartProps {
+    /**
+     * An array of chart data points for the Horizontal bar chart
+     */
+    data?: IChartProps[];
+    /**
+     * Width of bar chart
+     */
+    width?: number;
+    /**
+     * Height of bar chart
+     * @default 15
+     */
+    barHeight?: number;
+    /**
+     * Additional CSS class(es) to apply to the StackedBarChart.
+     */
+    className?: string;
+    /**
+     * Theme (provided through customization.)
+     */
+    theme?: ITheme;
+    /**
+     * This property tells whether to show ratio on top of stacked bar chart or not.
+     */
+    hideRatio?: boolean[];
+    /**
+     * Do not show tooltips in chart
+     *
+     * @default false
+     */
+    hideTooltip?: boolean;
+    /**
+     * This property tells how to show data text on top right of bar chart.
+     * If barChartCustomData props added, then this props will be overrided.
+     * @default 'default'
+     */
+    chartDataMode?: ChartDataMode;
+    /**
+     * Call to provide customized styling that will layer on top of the variant rules.
+     */
+    styles?: IStyleFunctionOrObject<IHorizontalBarChartStyleProps, IHorizontalBarChartStyles>;
+    /**
+     * Define a custom callout renderer for a horizontal bar
+     */
+    onRenderCalloutPerHorizontalBar?: IRenderFunction<IChartDataPoint>;
+    /**
+     * props for the callout in the chart
+     */
+    calloutProps?: Partial<ICalloutProps>;
+    /**
+     * Custom text to the chart (right side of the chart)
+     * IChartProps will be available as props to the method prop.
+     * If this method not given, default values (IHorizontalDataPoint \{x,y\})
+     * will be used to display the data/text based on given chartModeData prop.
+     */
+    barChartCustomData?: IRenderFunction<IChartProps>;
+    /**
+     * The prop used to define the culture to localized the numbers
+     */
+    culture?: string;
+    /**
+     * Prop to define the variant of HorizontalBarChart to render
+     * @default HorizontalBarChartVariant.PartToWhole
+     */
+    variant?: HorizontalBarChartVariant;
+    /**
+     * Prop to hide the bar labels
+     * @default false
+     */
+    hideLabels?: boolean;
+    /**
+     * @default false
+     * The prop used to enable gradient fill color for the chart.
+     */
+    enableGradient?: boolean;
+    /**
+     * @default false
+     * The prop used to enable rounded corners for the chart.
+     */
+    roundCorners?: boolean;
+}
+/**
+ * Horizontal Bar Chart style properties
+ * {@docCategory HorizontalBarChart}
+ */
+export interface IHorizontalBarChartStyleProps {
+    /**
+     * Theme (provided through customization.)
+     */
+    theme: ITheme;
+    /**
+     * Additional CSS class(es) to apply to the StackedBarChart.
+     */
+    className?: string;
+    /**
+     * Width of the chart.
+     */
+    width: number | undefined;
+    /**
+     * line color for callout
+     */
+    color?: string;
+    /**
+     * Height of bar chart
+     * @default 15
+     */
+    barHeight?: number;
+    /**
+     * prop to check if benchmark data is provided
+     */
+    showTriangle?: boolean;
+    /**
+     * Prop to define the variant of HorizontalBarChart to render
+     */
+    variant?: HorizontalBarChartVariant;
+    /**
+     * Prop to hide the bar labels
+     */
+    hideLabels?: boolean;
+}
+/**
+ * Horizontal Bar Chart styles
+ * {@docCategory HorizontalBarChart}
+ */
+export interface IHorizontalBarChartStyles {
+    /**
+     * Styling for the root container
+     */
+    root: IStyle;
+    /**
+     * Styling for each item in the container
+     */
+    items: IStyle;
+    /**
+     * Style for the chart.
+     */
+    chart: IStyle;
+    /**
+     * Style for the chart Title.
+     */
+    chartTitle: IStyle;
+    /**
+     * Style for the bars.
+     */
+    barWrapper: IStyle;
+    /**
+     * Style for left side text of the chart title
+     */
+    chartTitleLeft: IStyle;
+    /**
+     * Style for right side text of the chart title
+     */
+    chartTitleRight: IStyle;
+    /**
+     * Style for the chart data text denominator.
+     */
+    chartDataTextDenominator: IStyle;
+    /**
+     * Style for the benchmark container
+     */
+    benchmarkContainer: IStyle;
+    /**
+     * Style for the benchmark triangle
+     */
+    triangle: IStyle;
+    /**
+     * Style for the bar labels
+     */
+    barLabel: IStyle;
+    /**
+     * Style for the div containing the chart
+     */
+    chartWrapper: IStyle;
+}
+/**
+ * Chart data mode for chart data text
+ * default: show the datapoint.x value
+ * fraction: show the fraction of datapoint.x/datapoint.y
+ * percentage: show the percentage of (datapoint.x/datapoint.y)%
+ * {@docCategory HorizontalBarChart}
+ */
+export type ChartDataMode = 'default' | 'fraction' | 'percentage';
+/**
+ * {@docCategory HorizontalBarChart}
+ */
+export declare enum HorizontalBarChartVariant {
+    PartToWhole = "part-to-whole",
+    AbsoluteScale = "absolute-scale"
+}

package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.js

@@ -0,0 +1,14 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.HorizontalBarChartVariant = void 0;
+    /**
+     * {@docCategory HorizontalBarChart}
+     */
+    var HorizontalBarChartVariant;
+    (function (HorizontalBarChartVariant) {
+        HorizontalBarChartVariant["PartToWhole"] = "part-to-whole";
+        HorizontalBarChartVariant["AbsoluteScale"] = "absolute-scale";
+    })(HorizontalBarChartVariant || (exports.HorizontalBarChartVariant = HorizontalBarChartVariant = {}));
+});
+//# sourceMappingURL=HorizontalBarChart.types.js.map

package/lib-amd/components/HorizontalBarChart/HorizontalBarChart.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HorizontalBarChart.types.js","sourceRoot":"../src/","sources":["components/HorizontalBarChart/HorizontalBarChart.types.ts"],"names":[],"mappings":";;;;IAsOA;;OAEG;IACH,IAAY,yBAGX;IAHD,WAAY,yBAAyB;QACnC,0DAA6B,CAAA;QAC7B,6DAAgC,CAAA;IAClC,CAAC,EAHW,yBAAyB,yCAAzB,yBAAyB,QAGpC","sourcesContent":["import { IChartProps, IChartDataPoint } from './index';\nimport { IStyle, ITheme } from '@fluentui/react/lib/Styling';\nimport { ICalloutProps } from '@fluentui/react/lib/Callout';\nimport { IRenderFunction, IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';\n\n/**\n * Horizontal Bar Chart properties\n * {@docCategory HorizontalBarChart}\n */\nexport interface IHorizontalBarChartProps {\n  /**\n   * An array of chart data points for the Horizontal bar chart\n   */\n  data?: IChartProps[];\n\n  /**\n   * Width of bar chart\n   */\n  width?: number;\n\n  /**\n   * Height of bar chart\n   * @default 15\n   */\n  barHeight?: number;\n\n  /**\n   * Additional CSS class(es) to apply to the StackedBarChart.\n   */\n  className?: string;\n\n  /**\n   * Theme (provided through customization.)\n   */\n  theme?: ITheme;\n\n  /**\n   * This property tells whether to show ratio on top of stacked bar chart or not.\n   */\n  hideRatio?: boolean[];\n\n  /**\n   * Do not show tooltips in chart\n   *\n   * @default false\n   */\n  hideTooltip?: boolean;\n\n  /**\n   * This property tells how to show data text on top right of bar chart.\n   * If barChartCustomData props added, then this props will be overrided.\n   * @default 'default'\n   */\n  chartDataMode?: ChartDataMode;\n\n  /**\n   * Call to provide customized styling that will layer on top of the variant rules.\n   */\n  styles?: IStyleFunctionOrObject<IHorizontalBarChartStyleProps, IHorizontalBarChartStyles>;\n\n  /**\n   * Define a custom callout renderer for a horizontal bar\n   */\n  onRenderCalloutPerHorizontalBar?: IRenderFunction<IChartDataPoint>;\n\n  /**\n   * props for the callout in the chart\n   */\n  calloutProps?: Partial<ICalloutProps>;\n\n  /**\n   * Custom text to the chart (right side of the chart)\n   * IChartProps will be available as props to the method prop.\n   * If this method not given, default values (IHorizontalDataPoint \\{x,y\\})\n   * will be used to display the data/text based on given chartModeData prop.\n   */\n  barChartCustomData?: IRenderFunction<IChartProps>;\n\n  /**\n   * The prop used to define the culture to localized the numbers\n   */\n  culture?: string;\n\n  /**\n   * Prop to define the variant of HorizontalBarChart to render\n   * @default HorizontalBarChartVariant.PartToWhole\n   */\n  variant?: HorizontalBarChartVariant;\n\n  /**\n   * Prop to hide the bar labels\n   * @default false\n   */\n  hideLabels?: boolean;\n\n  /**\n   * @default false\n   * The prop used to enable gradient fill color for the chart.\n   */\n  enableGradient?: boolean;\n\n  /**\n   * @default false\n   * The prop used to enable rounded corners for the chart.\n   */\n  roundCorners?: boolean;\n}\n\n/**\n * Horizontal Bar Chart style properties\n * {@docCategory HorizontalBarChart}\n */\nexport interface IHorizontalBarChartStyleProps {\n  /**\n   * Theme (provided through customization.)\n   */\n  theme: ITheme;\n\n  /**\n   * Additional CSS class(es) to apply to the StackedBarChart.\n   */\n  className?: string;\n\n  /**\n   * Width of the chart.\n   */\n  width: number | undefined;\n\n  /**\n   * line color for callout\n   */\n  color?: string;\n\n  /**\n   * Height of bar chart\n   * @default 15\n   */\n  barHeight?: number;\n\n  /**\n   * prop to check if benchmark data is provided\n   */\n  showTriangle?: boolean;\n\n  /**\n   * Prop to define the variant of HorizontalBarChart to render\n   */\n  variant?: HorizontalBarChartVariant;\n\n  /**\n   * Prop to hide the bar labels\n   */\n  hideLabels?: boolean;\n}\n\n/**\n * Horizontal Bar Chart styles\n * {@docCategory HorizontalBarChart}\n */\nexport interface IHorizontalBarChartStyles {\n  /**\n   * Styling for the root container\n   */\n  root: IStyle;\n\n  /**\n   * Styling for each item in the container\n   */\n  items: IStyle;\n\n  /**\n   * Style for the chart.\n   */\n  chart: IStyle;\n\n  /**\n   * Style for the chart Title.\n   */\n  chartTitle: IStyle;\n\n  /**\n   * Style for the bars.\n   */\n  barWrapper: IStyle;\n\n  /**\n   * Style for left side text of the chart title\n   */\n  chartTitleLeft: IStyle;\n\n  /**\n   * Style for right side text of the chart title\n   */\n  chartTitleRight: IStyle;\n\n  /**\n   * Style for the chart data text denominator.\n   */\n  chartDataTextDenominator: IStyle;\n\n  /**\n   * Style for the benchmark container\n   */\n  benchmarkContainer: IStyle;\n\n  /**\n   * Style for the benchmark triangle\n   */\n  triangle: IStyle;\n\n  /**\n   * Style for the bar labels\n   */\n  barLabel: IStyle;\n\n  /**\n   * Style for the div containing the chart\n   */\n  chartWrapper: IStyle;\n}\n\n/**\n * Chart data mode for chart data text\n * default: show the datapoint.x value\n * fraction: show the fraction of datapoint.x/datapoint.y\n * percentage: show the percentage of (datapoint.x/datapoint.y)%\n * {@docCategory HorizontalBarChart}\n */\nexport type ChartDataMode = 'default' | 'fraction' | 'percentage';\n\n/**\n * {@docCategory HorizontalBarChart}\n */\nexport enum HorizontalBarChartVariant {\n  PartToWhole = 'part-to-whole',\n  AbsoluteScale = 'absolute-scale',\n}\n"]}

package/lib-amd/components/HorizontalBarChart/index.d.ts

@@ -0,0 +1,3 @@
+export * from './HorizontalBarChart';
+export * from './HorizontalBarChart.types';
+export * from '../../types/index';

package/lib-amd/components/HorizontalBarChart/index.js

@@ -0,0 +1,8 @@
+define(["require", "exports", "tslib", "./HorizontalBarChart", "./HorizontalBarChart.types", "../../types/index"], function (require, exports, tslib_1, HorizontalBarChart_1, HorizontalBarChart_types_1, index_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    tslib_1.__exportStar(HorizontalBarChart_1, exports);
+    tslib_1.__exportStar(HorizontalBarChart_types_1, exports);
+    tslib_1.__exportStar(index_1, exports);
+});
+//# sourceMappingURL=index.js.map

package/lib-amd/components/HorizontalBarChart/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"../src/","sources":["components/HorizontalBarChart/index.ts"],"names":[],"mappings":";;;IAAA,oDAAqC;IACrC,0DAA2C;IAC3C,uCAAkC","sourcesContent":["export * from './HorizontalBarChart';\nexport * from './HorizontalBarChart.types';\nexport * from '../../types/index';\n"]}

package/lib-amd/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.base.d.ts

@@ -0,0 +1,76 @@
+import * as React from 'react';
+import { IAccessibilityProps, IBasestate, IHorizontalBarChartWithAxisDataPoint, IChart, IImageExportOptions } from '../../types/IDataPoint';
+import { IYValueHover } from '../CommonComponents/CartesianChart.types';
+import { IHorizontalBarChartWithAxisProps } from './HorizontalBarChartWithAxis.types';
+export interface IHorizontalBarChartWithAxisState extends IBasestate {
+    selectedLegendTitle: string;
+    dataPointCalloutProps?: IHorizontalBarChartWithAxisDataPoint;
+    /**
+     * data point of x, where rectangle is hovered or focused
+     */
+    activeXdataPoint: number | null;
+    YValueHover: IYValueHover[];
+    hoverXValue?: string | number | null;
+    callOutAccessibilityData?: IAccessibilityProps;
+    tooltipElement?: any;
+    selectedLegends: string[];
+}
+export declare class HorizontalBarChartWithAxisBase extends React.Component<IHorizontalBarChartWithAxisProps, IHorizontalBarChartWithAxisState> implements IChart {
+    private _points;
+    private _barHeight;
+    private _colors;
+    private _classNames;
+    private _refArray;
+    private _calloutId;
+    private margins;
+    private _isRtl;
+    private _bars;
+    private _yAxisLabels;
+    private _xMax;
+    private _tooltipId;
+    private _xAxisType;
+    private _yAxisType;
+    private _calloutAnchorPoint;
+    private _cartesianChartRef;
+    private _legendsRef;
+    constructor(props: IHorizontalBarChartWithAxisProps);
+    componentDidUpdate(prevProps: IHorizontalBarChartWithAxisProps): void;
+    render(): JSX.Element;
+    get chartContainer(): HTMLElement | null;
+    toImage: (opts?: IImageExportOptions) => Promise<string>;
+    private _getDomainNRangeValues;
+    private _adjustProps;
+    private _getMargins;
+    private _renderContentForOnlyBars;
+    private _renderCallout;
+    private _getCustomizedCallout;
+    private _getGraphData;
+    private _createColors;
+    private _refCallback;
+    private _getCalloutContentForBar;
+    private _onBarHover;
+    private _onBarLeave;
+    private _handleChartMouseLeave;
+    private _onBarFocus;
+    private _getScales;
+    private _createNumericBars;
+    private _tooltipOfYAxislabels;
+    private _createStringBars;
+    private _closeCallout;
+    private _onLegendHover;
+    private _onLegendLeave;
+    private _getLegendData;
+    private _isLegendSelected;
+    /**
+     * This function checks if the given legend is highlighted or not.
+     * A legend can be highlighted in 2 ways:
+     * 1. selection: if the user clicks on it
+     * 2. hovering: if there is no selected legend and the user hovers over it
+     */
+    private _isLegendHighlighted;
+    private _getHighlightedLegend;
+    private _onLegendSelectionChange;
+    private _getAxisData;
+    private _getAriaLabel;
+    private _getChartTitle;
+}