All files / src/components/GaugeChart GaugeChart.types.ts

100% Statements 6/6
100% Branches 4/4
100% Functions 2/2
100% Lines 6/6

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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292                                                                      24x 24x 24x           24x 24x 24x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
import { IStyle, ITheme } from '@fluentui/react/lib/Styling';
import { IStyleFunctionOrObject } from '@fluentui/react/lib/Utilities';
import { ILegendsProps } from '../Legends/index';
import { IAccessibilityProps } from '../../types/index';
import { ICalloutProps } from '@fluentui/react/lib/Callout';
 
/**
 * Gauge Chart segment interface.
 * {@docCategory GaugeChart}
 */
export interface IGaugeChartSegment {
  /**
   * Legend text for a segment
   */
  legend: string;
 
  /**
   * Size of the segment
   */
  size: number;
 
  /**
   * Color of the segment
   */
  color?: string;
 
  /**
   * Accessibility data for the segment
   */
  accessibilityData?: IAccessibilityProps;
}
 
/**
 * {@docCategory GaugeChart}
 */
export enum GaugeValueFormat {
  Percentage = 'percentage',
  Fraction = 'fraction',
}
 
/**
 * {@docCategory GaugeChart}
 */
export enum GaugeChartVariant {
  SingleSegment = 'single-segment',
  MultipleSegments = 'multiple-segments',
}
 
/**
 * Gauge Chart properties
 * {@docCategory GaugeChart}
 */
export interface IGaugeChartProps {
  /**
   * Width of the chart
   */
  width?: number;
 
  /**
   * Height of the chart
   */
  height?: number;
 
  /**
   * Title of the chart
   */
  chartTitle?: string;
 
  /**
   * Current value of the gauge
   */
  chartValue: number;
 
  /**
   * Sections of the gauge
   */
  segments: IGaugeChartSegment[];
 
  /**
   * Minimum value of the gauge
   * @defaultvalue 0
   */
  minValue?: number;
 
  /**
   * Maximum value of the gauge
   */
  maxValue?: number;
 
  /**
   * Additional text to display below the chart value
   */
  sublabel?: string;
 
  /**
   * Hide the min and max values of the gauge
   * @defaultvalue false
   */
  hideMinMax?: boolean;
 
  /**
   * Format of the chart value
   * @defaultvalue GaugeValueFormat.Percentage
   */
  chartValueFormat?: GaugeValueFormat | ((sweepFraction: [number, number]) => string);
 
  /**
   * Decides whether to show/hide legends
   * @defaultvalue false
   */
  hideLegend?: boolean;
 
  /*
   * Props for the legends in the chart
   */
  legendProps?: Partial<ILegendsProps>;
 
  /**
   * Do not show tooltips in chart
   * @defaultvalue false
   */
  hideTooltip?: boolean;
 
  /**
   * Additional CSS class(es) to apply to the chart
   */
  className?: string;
 
  /**
   * Theme (provided through customization)
   */
  theme?: ITheme;
 
  /**
   * Call to provide customized styling that will layer on top of the variant rules
   */
  styles?: IStyleFunctionOrObject<IGaugeChartStyleProps, IGaugeChartStyles>;
 
  /**
   * Defines the culture to localize the numbers and dates
   */
  culture?: string;
 
  /**
   * Props for the callout in the chart
   */
  calloutProps?: Partial<ICalloutProps>;
 
  /**
   * Specifies the variant of GaugeChart to be rendered
   * @defaultvalue GaugeChartVariant.MultipleSegments
   */
  variant?: GaugeChartVariant;
}
 
/**
 * Gauge Chart style properties
 * {@docCategory GaugeChart}
 */
export interface IGaugeChartStyleProps {
  /**
   * Theme (provided through customization)
   */
  theme: ITheme;
 
  /**
   * Font size of the chart value
   */
  chartValueSize?: number;
 
  /**
   * Width of the chart
   */
  chartWidth?: number;
 
  /**
   * Height of the chart
   */
  chartHeight?: number;
 
  /**
   * Additional CSS class(es) to apply to the chart
   */
  className?: string;
 
  /**
   * Color of the line
   */
  lineColor?: string;
 
  /**
   * Boolean flag which determines if shape is drawn in callout
   */
  toDrawShape?: boolean;
}
 
/**
 * Gauge Chart styles
 * {@docCategory GaugeChart}
 */
export interface IGaugeChartStyles {
  /**
   * Styles for the root element
   */
  root?: IStyle;
 
  /**
   * Styles for the chart
   */
  chart?: IStyle;
 
  /**
   * Styles for the min and max values
   */
  limits?: IStyle;
 
  /**
   * Styles for the chart value
   */
  chartValue?: IStyle;
 
  /**
   * Styles for the sublabel
   */
  sublabel?: IStyle;
 
  /**
   * Styles for the needle
   */
  needle?: IStyle;
 
  /**
   * Styles for the chart title
   */
  chartTitle?: IStyle;
 
  /**
   * Styles for the segments
   */
  segment?: IStyle;
 
  /**
   * Styles for the legends container
   */
  legendsContainer?: IStyle;
 
  /**
   * Styles for callout root-content
   */
  calloutContentRoot?: IStyle;
 
  /**
   * Styles for callout x-content
   */
  calloutContentX?: IStyle;
 
  /**
   * Styles for callout y-content
   */
  calloutContentY?: IStyle;
 
  /**
   * Styles for description message
   */
  descriptionMessage?: IStyle;
 
  /**
   * Styles for callout Date time container
   */
  calloutDateTimeContainer?: IStyle;
 
  /**
   * Styles for callout info container
   */
  calloutInfoContainer?: IStyle;
 
  /**
   * Styles for callout block container
   */
  calloutBlockContainer?: IStyle;
 
  /**
   * Styles for callout legend text
   */
  calloutlegendText?: IStyle;
 
  /**
   * Styles for the shape object in the callout
   */
  shapeStyles?: IStyle;
}