@fluentui/react-charting 5.17.12 → 5.18.1

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

@@ -6,16 +6,31 @@ 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[];
 
   overflow?: ILegend[];
 }
 
+/**
+ * @public
+ * ILegendSubComponentStyles interface.
+ * {@docCategory Legends}
+ */
 export interface ILegendSubComponentStyles {
   hoverCardStyles: IStyleFunctionOrObject<IHoverCardStyleProps, IHoverCardStyles>;
 }
 
+/**
+ * @public
+ * ILegendsStyles interface.
+ * {@docCategory Legends}
+ */
 export interface ILegendsStyles {
   /**
    * Style set for the root of the legend component
@@ -68,6 +83,11 @@ export interface ILegendsStyles {
   subComponentStyles: ILegendSubComponentStyles;
 }
 
+/**
+ * @public
+ * ILegendsStyles interface.
+ * {@docCategory Legends}
+ */
 export interface ILegend {
   /**
    * Defines the title of the legend

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

@@ -16,6 +16,11 @@ import {
 } from '../CommonComponents/index';
 
 export type { IChildProps, ILineChartPoints, IMargins, IBasestate, IRefArrayData };
+
+/**
+ * ILineChartProps properties for line chart.
+ * {@docCategory LineChart}
+ */
 export interface ILineChartProps extends ICartesianChartProps {
   /**
    * Data to render in the chart.

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

@@ -4,6 +4,10 @@ import { IDataPoint } from '../../types/IDataPoint';
 export type { IDataPoint } from '../../types/IDataPoint';
 export interface IPieChart {}
 
+/**
+ * IPieChartProps for Piechart component.
+ * {@docCategory PieChart}
+ */
 export interface IPieChartProps {
   /**
    * Data to render in the chart.

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

@@ -4,6 +4,10 @@ import { IChartProps } from '../../types/IDataPoint';
 
 export type { IChartProps, IDataPoint, ISankeyChartData } from '../../types/IDataPoint';
 
+/**
+ * ISankeyChartProps for Sankeychart component.
+ * {@docCategory SankeyChart}
+ */
 export interface ISankeyChartProps {
   /**
    * Data to render in the chart.

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

@@ -5,6 +5,10 @@ import { ICartesianChartStyleProps } from '../CommonComponents/index';
 
 export interface ISparklineStyleProps extends ICartesianChartStyleProps {}
 
+/**
+ * ISparklineProps for Sparkline component.
+ * {@docCategory Sparkline}
+ */
 export interface ISparklineProps {
   /**
    * An array of chart data points for the Sparkline chart

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

@@ -6,6 +6,10 @@ import { IOverflowSetProps } from '@fluentui/react/lib/OverflowSet';
 import { IFocusZoneProps } from '@fluentui/react-focus';
 import { ILegendsProps } from '../Legends/index';
 
+/**
+ * IMultiStackedBarChartProps for MultiStackedBarchart component.
+ * {@docCategory MultiStackedBarChart}
+ */
 export interface IMultiStackedBarChartProps {
   /**
    * An array of chart data points for the multistacked bar chart

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

@@ -8,6 +8,10 @@ import { ILegendsProps } from '../Legends/index';
 export interface IStackedBarChart {}
 import { IChartProps, IChartDataPoint } from './index';
 
+/**
+ * IStackedBarChartProps for StackedBarchart component.
+ * {@docCategory StackedBarChart}
+ */
 export interface IStackedBarChartProps {
   /**
    * Data to render in the chart.

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

@@ -1,6 +1,10 @@
 import { IStyle, ITheme } from '@fluentui/react/lib/Styling';
 import { IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';
 
+/**
+ * ITreeChartDataPoint interface for Treechart component.
+ * {@docCategory TreeChart}
+ */
 export interface ITreeChartDataPoint {
   /**
    * Node main text

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

@@ -8,6 +8,10 @@ import {
 } from '../../index';
 import { ILineChartLineOptions } from '../../types/index';
 
+/**
+ * IVerticalBarChartProps for VerticalBarchart component.
+ * {@docCategory VerticalBarChart}
+ */
 export interface IVerticalBarChartProps extends ICartesianChartProps {
   /**
    * Data to render in the chart.
@@ -91,43 +95,43 @@ export interface IVerticalBarChartStyleProps extends ICartesianChartStyleProps {
 export interface IVerticalBarChartStyles extends ICartesianChartStyles {
   /**
    * Style for the chart label.
-   * @deprecated
+   * @deprecated This style cannot be customized anymore
    */
   chartLabel?: IStyle;
 
   /**
    * Style for the line representing the domain of the x-axis.
-   * @deprecated
+   * @deprecated This style cannot be customized anymore
    */
   xAxisDomain?: IStyle;
 
   /**
    * Style for the lines representing the ticks along the x-axis.
-   * @deprecated
+   * @deprecated This style cannot be customized anymore
    */
   xAxisTicks?: IStyle;
 
   /**
    * Style for the text labeling each tick along the x-axis.
-   * @deprecated
+   * @deprecated This style cannot be customized anymore
    */
   xAxisText?: IStyle;
 
   /**
    * Style for the line representing the domain of the y-axis.
-   * @deprecated
+   * @deprecated This style cannot be customized anymore
    */
   yAxisDomain?: IStyle;
 
   /**
    * Style for the lines representing the ticks along the y-axis.
-   * @deprecated
+   * @deprecated This style cannot be customized anymore
    */
   yAxisTicks?: IStyle;
 
   /**
    * Style for the text labeling each tick along the y-axis.
-   * @deprecated
+   * @deprecated This style cannot be customized anymore
    */
   yAxisText?: IStyle;
 

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

@@ -11,6 +11,10 @@ import {
   IVSChartDataPoint,
 } from '../../index';
 
+/**
+ * IVerticalStackedBarChartProps for VerticalStackedBarchart component.
+ * {@docCategory VerticalStackedBarChart}
+ */
 export interface IVerticalStackedBarChartProps extends ICartesianChartProps {
   /**
    * Data to render in the chart.