All files / src/components/StackedBarChart MultiStackedBarChart.types.ts

100% Statements 3/3
100% Branches 2/2
100% Functions 1/1
100% Lines 3/3

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          23x 23x 23x    
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';
import { IOverflowSetProps } from '@fluentui/react/lib/OverflowSet';
import { IFocusZoneProps } from '@fluentui/react-focus';
import { ILegendsProps } from '../Legends/index';
 
/**
 * Multi Stacked Bar Chart properties
 * {@docCategory MultiStackedBarChart}
 */
export interface IMultiStackedBarChartProps {
  /**
   * An array of chart data points for the multistacked 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.
   * This property is applicable only if there are 1 or 2 datapoints.
   */
  hideRatio?: boolean[];
 
  /**
   * Do not show the legend at the bottom of chart
   *
   * @default false
   */
  hideLegend?: boolean;
 
  /**
   * Do not show tooltips in chart
   *
   * @default false
   */
  hideTooltip?: boolean;
 
  /**
   * Call to provide customized styling that will layer on top of the variant rules.
   */
  styles?: IStyleFunctionOrObject<IMultiStackedBarChartStyleProps, IMultiStackedBarChartStyles>;
 
  /**
   * Url that the data-viz needs to redirect to upon clicking on it
   */
  href?: string;
 
  /**
   * If this value is set to true the denominator will not be shown for the ratio above the chart
   * This prop is applicable only if hide ratio is false and there are exactly 2 datapoints.
   */
  hideDenominator?: boolean[];
 
  /**
   * overflow props for legend
   */
  legendsOverflowProps?: Partial<IOverflowSetProps>;
 
  /**
   * text for overflow legends string
   */
  legendsOverflowText?: string;
 
  /**
   * focus zone props in hover card for legends
   */
  focusZonePropsForLegendsInHoverCard?: IFocusZoneProps;
 
  /**
   * props for the legends in the chart
   */
  legendProps?: Partial<ILegendsProps>;
 
  /**
   * Define a custom callout renderer for a data point
   */
  onRenderCalloutPerDataPoint?: IRenderFunction<IChartDataPoint>;
 
  /**
   * props for the callout in the chart
   */
  calloutProps?: Partial<ICalloutProps>;
 
  /**
   * The prop used to define the culture to localized the numbers
   */
  culture?: string;
 
  /**
   * Prop to define the variant of MultiStackedBarChart to render
   * @default MultiStackedBarChartVariant.PartToWhole
   */
  variant?: MultiStackedBarChartVariant;
 
  /**
   * Prop to hide the bar labels
   * @default false
   */
  hideLabels?: boolean;
}
 
/**
 * Multi Stacked Bar Chart style properties
 * {@docCategory MultiStackedBarChart}
 */
export interface IMultiStackedBarChartStyleProps {
  /**
   * Theme (provided through customization.)
   */
  theme: ITheme;
 
  /**
   * Additional CSS class(es) to apply to the StackedBarChart.
   */
  className?: string;
 
  /**
   * Width of the chart.
   */
  width?: number;
 
  /**
   * barHeight for each chart
   */
  barHeight?: number;
 
  /**
   * color of the datapoint legend
   */
  legendColor?: string;
 
  /**
   * prop to check if the chart is selcted or hovered upon to determine opacity
   */
  shouldHighlight?: boolean;
 
  /**
   * prop to check to decide cursor type
   */
  href?: string;
 
  /**
   * Prop to define the variant of MultiStackedBarChart to render
   */
  variant?: MultiStackedBarChartVariant;
 
  /**
   * Prop to hide the bar labels
   */
  hideLabels?: boolean;
}
 
/**
 * Multi Stacked Bar Chart styles
 * {@docCategory MultiStackedBarChart}
 */
export interface IMultiStackedBarChartStyles {
  /**
   * Styling for the root container
   */
  root: IStyle;
 
  /**
   * Styling for the root container of each chart in the multistacked bar chart
   */
  singleChartRoot: IStyle;
 
  /**
   * Styling for each item in the container
   */
  items: IStyle;
 
  /**
   * Styling for each svg in the multistacked bar chart
   */
  chart: IStyle;
 
  /**
   * Styling for chart title of the stacked bar chart
   */
  chartTitle: IStyle;
 
  /**
   * Style for left side text of the chart title
   */
  chartTitleLeft: IStyle;
 
  /**
   * Style to change the opacity of bars in dataviz when we hover on a single bar or legends
   */
  opacityChangeOnHover: IStyle;
 
  /**
   * Style for the chart ratio numerator
   */
  ratioNumerator: IStyle;
 
  /**
   * Style for the chart ratio denominator
   */
  ratioDenominator: IStyle;
 
  /**
   * Style to change the opacity of placeholder data point when we hover a single bar or legend
   */
  placeHolderOnHover: IStyle;
 
  /**
   * Style for the legends container
   */
  legendContainer: IStyle;
 
  /**
   * Style for stacked bar chart with no data
   */
  noData: IStyle;
 
  /**
   * Style for the bar labels
   */
  barLabel: IStyle;
 
  /**
   * Style for the div containing the chart
   */
  chartWrapper: IStyle;
}
 
/**
 * {@docCategory MultiStackedBarChart}
 */
export enum MultiStackedBarChartVariant {
  PartToWhole = 'part-to-whole',
  AbsoluteScale = 'absolute-scale',
}