@fluentui/react-charting 5.18.7 → 5.18.9

package/src/components/HorizontalBarChart/HorizontalBarChart.types.ts

@@ -4,7 +4,7 @@ import { ICalloutProps } from '@fluentui/react/lib/Callout';
 import { IRenderFunction, IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';
 
 /**
- * IHorizontalBarChartProps for HorizontalBarchart component.
+ * Horizontal Bar Chart properties
  * {@docCategory HorizontalBarChart}
  */
 export interface IHorizontalBarChartProps {
@@ -94,6 +94,10 @@ export interface IHorizontalBarChartProps {
   hideLabels?: boolean;
 }
 
+/**
+ * Horizontal Bar Chart style properties
+ * {@docCategory HorizontalBarChart}
+ */
 export interface IHorizontalBarChartStyleProps {
   /**
    * Theme (provided through customization.)
@@ -137,6 +141,10 @@ export interface IHorizontalBarChartStyleProps {
   hideLabels?: boolean;
 }
 
+/**
+ * Horizontal Bar Chart styles
+ * {@docCategory HorizontalBarChart}
+ */
 export interface IHorizontalBarChartStyles {
   /**
    * Styling for the root container
@@ -204,9 +212,13 @@ export interface IHorizontalBarChartStyles {
  * 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 enum HorizontalBarChartVariant {
   PartToWhole = 'part-to-whole',
   AbsoluteScale = 'absolute-scale',

package/src/components/HorizontalBarChartWithAxis/HorizontalBarChartWithAxis.types.ts

@@ -8,7 +8,7 @@ import {
 } from '../../index';
 
 /**
- * IHorizontalBarChartWithAxisProps for HorizontalBarchartWithAxis component.
+ * Horizontal Bar Chart with Axis properties
  * {@docCategory HorizontalBarChartWithAxis}
  */
 export interface IHorizontalBarChartWithAxisProps extends ICartesianChartProps {
@@ -72,6 +72,10 @@ export interface IHorizontalBarChartWithAxisProps extends ICartesianChartProps {
   showYAxisLables?: boolean;
 }
 
+/**
+ * Horizontal Bar Chart with Axis style properties
+ * {@docCategory HorizontalBarChartWithAxis}
+ */
 export interface IHorizontalBarChartWithAxisStyleProps extends ICartesianChartStyleProps {
   /**
    * color of the datapoint legend
@@ -79,6 +83,10 @@ export interface IHorizontalBarChartWithAxisStyleProps extends ICartesianChartSt
   legendColor?: string;
 }
 
+/**
+ * Horizontal Bar Chart with Axis styles
+ * {@docCategory HorizontalBarChartWithAxis}
+ */
 export interface IHorizontalBarChartWithAxisStyles extends ICartesianChartStyles {
   /**
    * Style for the chart label.

package/src/components/Legends/Legends.types.ts

@@ -6,11 +6,6 @@ import { IOverflowSetProps } from '@fluentui/react/lib/OverflowSet';
 import { IFocusZoneProps } from '@fluentui/react-focus';
 import { CustomPoints, Points } from '../../utilities/utilities';
 
-/**
- * @public
- * ILegendOverflowData interface.
- * {@docCategory Legends}
- */
 export interface ILegendOverflowData {
   primary: ILegend[];
 
@@ -19,7 +14,6 @@ export interface ILegendOverflowData {
 
 /**
  * @public
- * ILegendSubComponentStyles interface.
  * {@docCategory Legends}
  */
 export interface ILegendSubComponentStyles {
@@ -28,7 +22,7 @@ export interface ILegendSubComponentStyles {
 
 /**
  * @public
- * ILegendsStyles interface.
+ * Legends styles
  * {@docCategory Legends}
  */
 export interface ILegendsStyles {
@@ -85,7 +79,7 @@ export interface ILegendsStyles {
 
 /**
  * @public
- * ILegendsStyles interface.
+ * ILegend interface
  * {@docCategory Legends}
  */
 export interface ILegend {
@@ -140,6 +134,11 @@ export interface ILegend {
   nativeButtonProps?: React.ButtonHTMLAttributes<HTMLButtonElement>;
 }
 
+/**
+ * @public
+ * Legend style properties
+ * {@docCategory Legends}
+ */
 export interface ILegendStyleProps {
   theme?: ITheme;
   className?: string;
@@ -151,6 +150,11 @@ export interface ILegendStyleProps {
   isLineLegendInBarChart?: boolean;
 }
 
+/**
+ * @public
+ * Legend properties
+ * {@docCategory Legends}
+ */
 export interface ILegendsProps {
   /**
    * Prop that takes list of legends
@@ -223,8 +227,10 @@ export interface ILegendsProps {
 }
 
 /**
+ * @public
  * The shape for the legend
  * default: show the rect legend
  * triangle: show the triangle legend
+ * {@docCategory Legends}
  */
 export type LegendShape = 'default' | 'triangle' | keyof typeof Points | keyof typeof CustomPoints;

package/src/components/LineChart/LineChart.types.ts

@@ -18,7 +18,7 @@ import {
 export type { IChildProps, ILineChartPoints, IMargins, IBasestate, IRefArrayData };
 
 /**
- * ILineChartProps properties for line chart.
+ * Line Chart properties
  * {@docCategory LineChart}
  */
 export interface ILineChartProps extends ICartesianChartProps {
@@ -88,6 +88,10 @@ export interface ILineChartProps extends ICartesianChartProps {
    */
   enablePerfOptimization?: boolean;
 }
+
+/**
+ * {@docCategory LineChart}
+ */
 export interface IEventsAnnotationProps {
   events: IEventAnnotation[];
   strokeColor?: string;
@@ -97,10 +101,21 @@ export interface IEventsAnnotationProps {
   mergedLabel: (count: number) => string;
 }
 
+/**
+ * Line Chart styles
+ * {@docCategory LineChart}
+ */
 export interface ILineChartStyles extends ICartesianChartStyles {}
 
+/**
+ * Line Chart style properties
+ * {@docCategory LineChart}
+ */
 export interface ILineChartStyleProps extends ICartesianChartStyleProps {}
 
+/**
+ * {@docCategory LineChart}
+ */
 export interface IColorFillBarsProps {
   legend: string;
   color: string;
@@ -109,6 +124,9 @@ export interface IColorFillBarsProps {
   onLegendClick?: (selectedLegend: string | string[] | null) => void | undefined;
 }
 
+/**
+ * {@docCategory LineChart}
+ */
 export interface IColorFillBarData {
   startX: number | Date;
   endX: number | Date;

package/src/components/PieChart/PieChart.types.ts

@@ -5,7 +5,7 @@ export type { IDataPoint } from '../../types/IDataPoint';
 export interface IPieChart {}
 
 /**
- * IPieChartProps for Piechart component.
+ * Pie Chart properties
  * {@docCategory PieChart}
  */
 export interface IPieChartProps {
@@ -60,8 +60,17 @@ export interface IPieChartProps {
   culture?: string;
 }
 
+/**
+ * Pie Chart style properties
+ * {@docCategory PieChart}
+ */
 export type IPieChartStyleProps = Required<Pick<IPieChartProps, 'theme' | 'width' | 'height'>> &
   Pick<IPieChartProps, 'className'>;
+
+/**
+ * Pie Chart styles
+ * {@docCategory PieChart}
+ */
 export interface IPieChartStyles {
   /**
    *  Style for the root element.

package/src/components/SankeyChart/SankeyChart.types.ts

@@ -5,7 +5,7 @@ import { IChartProps } from '../../types/IDataPoint';
 export type { IChartProps, IDataPoint, ISankeyChartData } from '../../types/IDataPoint';
 
 /**
- * ISankeyChartProps for Sankeychart component.
+ * Sankey Chart properties
  * {@docCategory SankeyChart}
  */
 export interface ISankeyChartProps {
@@ -65,6 +65,10 @@ export interface ISankeyChartProps {
   borderColorsForNodes?: string[];
 }
 
+/**
+ * Sankey Chart style properties
+ * {@docCategory SankeyChart}
+ */
 export interface ISankeyChartStyleProps {
   theme: ITheme;
   className?: string;
@@ -73,6 +77,10 @@ export interface ISankeyChartStyleProps {
   pathColor?: string;
 }
 
+/**
+ * Sankey Chart styles
+ * {@docCategory SankeyChart}
+ */
 export interface ISankeyChartStyles {
   /**
    *  Style for the root element.

package/src/components/Sparkline/Sparkline.types.ts

@@ -6,8 +6,8 @@ import { ICartesianChartStyleProps } from '../CommonComponents/index';
 export interface ISparklineStyleProps extends ICartesianChartStyleProps {}
 
 /**
- * ISparklineProps for Sparkline component.
- * {@docCategory Sparkline}
+ * Sparkline properties
+ * {@docCategory SparklineChart}
  */
 export interface ISparklineProps {
   /**
@@ -59,6 +59,10 @@ export interface ISparklineProps {
   styles?: IStyleFunctionOrObject<ISparklineStyleProps, ISparklineStyles>;
 }
 
+/**
+ * Sparkline styles
+ * {@docCategory SparklineChart}
+ */
 export interface ISparklineStyles {
   inlineBlock?: IStyle;
   valueText?: IStyle;

package/src/components/StackedBarChart/MultiStackedBarChart.types.ts

@@ -7,7 +7,7 @@ import { IFocusZoneProps } from '@fluentui/react-focus';
 import { ILegendsProps } from '../Legends/index';
 
 /**
- * IMultiStackedBarChartProps for MultiStackedBarchart component.
+ * Multi Stacked Bar Chart properties
  * {@docCategory MultiStackedBarChart}
  */
 export interface IMultiStackedBarChartProps {
@@ -121,6 +121,10 @@ export interface IMultiStackedBarChartProps {
   hideLabels?: boolean;
 }
 
+/**
+ * Multi Stacked Bar Chart style properties
+ * {@docCategory MultiStackedBarChart}
+ */
 export interface IMultiStackedBarChartStyleProps {
   /**
    * Theme (provided through customization.)
@@ -168,6 +172,10 @@ export interface IMultiStackedBarChartStyleProps {
   hideLabels?: boolean;
 }
 
+/**
+ * Multi Stacked Bar Chart styles
+ * {@docCategory MultiStackedBarChart}
+ */
 export interface IMultiStackedBarChartStyles {
   /**
    * Styling for the root container
@@ -240,6 +248,9 @@ export interface IMultiStackedBarChartStyles {
   chartWrapper: IStyle;
 }
 
+/**
+ * {@docCategory MultiStackedBarChart}
+ */
 export enum MultiStackedBarChartVariant {
   PartToWhole = 'part-to-whole',
   AbsoluteScale = 'absolute-scale',

package/src/components/StackedBarChart/StackedBarChart.types.ts

@@ -9,7 +9,7 @@ export interface IStackedBarChart {}
 import { IChartProps, IChartDataPoint } from './index';
 
 /**
- * IStackedBarChartProps for StackedBarchart component.
+ * Stacked Bar Chart properties
  * {@docCategory StackedBarChart}
  */
 export interface IStackedBarChartProps {
@@ -136,6 +136,10 @@ export interface IStackedBarChartProps {
   culture?: string;
 }
 
+/**
+ * Stacked Bar Chart style properties
+ * {@docCategory StackedBarChart}
+ */
 export interface IStackedBarChartStyleProps {
   /**
    * Theme (provided through customization.)
@@ -203,6 +207,10 @@ export interface IStackedBarChartStyleProps {
   showTriangle?: boolean;
 }
 
+/**
+ * Stacked Bar Chart styles
+ * {@docCategory StackedBarChart}
+ */
 export interface IStackedBarChartStyles {
   /**
    *  Style for the root element.

package/src/components/TreeChart/TreeChart.types.ts

@@ -3,7 +3,6 @@ import { IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';
 import { IMargins } from '../../types/index';
 
 /**
- * ITreeChartDataPoint interface for Treechart component.
  * {@docCategory TreeChart}
  */
 export interface ITreeChartDataPoint {
@@ -33,6 +32,9 @@ export interface ITreeChartDataPoint {
   children?: Array<ITreeChartDataPoint>;
 }
 
+/**
+ * {@docCategory TreeChart}
+ */
 export enum NodesComposition {
   /**
    * NodeComposition enum val for long: number = 1
@@ -44,6 +46,9 @@ export enum NodesComposition {
   compact = 0,
 }
 
+/**
+ * {@docCategory TreeChart}
+ */
 export enum TreeTraverse {
   /**
    * TreeTraverse enum val for preOrder: number = 1
@@ -55,6 +60,10 @@ export enum TreeTraverse {
   levelOrder = 0,
 }
 
+/**
+ * Tree Chart properties
+ * {@docCategory TreeChart}
+ */
 export interface ITreeProps {
   /**
    * An object of chart data points for the Tree chart
@@ -103,6 +112,7 @@ export interface ITreeProps {
    */
   theme?: ITheme;
 }
+
 export interface ITreeState {
   /**
    * Width of SVG tree chart
@@ -164,6 +174,10 @@ export interface ITreeDataStructure {
   parentID: number;
 }
 
+/**
+ * Tree Chart style properties
+ * {@docCategory TreeChart}
+ */
 export interface ITreeStyleProps {
   /**
    * Theme (provided through customization.)
@@ -174,6 +188,11 @@ export interface ITreeStyleProps {
    */
   className?: string;
 }
+
+/**
+ * Tree Chart styles
+ * {@docCategory TreeChart}
+ */
 export interface ITreeStyles {
   /**
    *  Style for the root element.

package/src/components/VerticalBarChart/VerticalBarChart.types.ts

@@ -9,7 +9,7 @@ import {
 import { ILineChartLineOptions } from '../../types/index';
 
 /**
- * IVerticalBarChartProps for VerticalBarchart component.
+ * Vertical Bar Chart properties
  * {@docCategory VerticalBarChart}
  */
 export interface IVerticalBarChartProps extends ICartesianChartProps {
@@ -85,6 +85,10 @@ export interface IVerticalBarChartProps extends ICartesianChartProps {
   hideLabels?: boolean;
 }
 
+/**
+ * Vertical Bar Chart style properties
+ * {@docCategory VerticalBarChart}
+ */
 export interface IVerticalBarChartStyleProps extends ICartesianChartStyleProps {
   /**
    * color of the datapoint legend
@@ -92,6 +96,10 @@ export interface IVerticalBarChartStyleProps extends ICartesianChartStyleProps {
   legendColor?: string;
 }
 
+/**
+ * Vertical Bar Chart styles
+ * {@docCategory VerticalBarChart}
+ */
 export interface IVerticalBarChartStyles extends ICartesianChartStyles {
   /**
    * Style for the chart label.

package/src/components/VerticalStackedBarChart/VerticalStackedBarChart.types.ts

@@ -12,7 +12,7 @@ import {
 } from '../../index';
 
 /**
- * IVerticalStackedBarChartProps for VerticalStackedBarchart component.
+ * Vertical Stacked Bar Chart properties
  * {@docCategory VerticalStackedBarChart}
  */
 export interface IVerticalStackedBarChartProps extends ICartesianChartProps {
@@ -124,8 +124,16 @@ export interface IVerticalStackedBarChartProps extends ICartesianChartProps {
   hideLabels?: boolean;
 }
 
+/**
+ * Vertical Stacked Bar Chart style properties
+ * {@docCategory VerticalStackedBarChart}
+ */
 export interface IVerticalStackedBarChartStyleProps extends ICartesianChartStyleProps {}
 
+/**
+ * Vertical Stacked Bar Chart styles
+ * {@docCategory VerticalStackedBarChart}
+ */
 export interface IVerticalStackedBarChartStyles extends ICartesianChartStyles {
   /**
    * Style to change the opacity of bars in dataviz when we hover on a single bar or legends