prop-types.ts

/**
 * Copyright (c) 2020, 2021, 2022, 2023, 2024 Visa, Inc.
 *
 * This source code is licensed under the MIT license
 * https://github.com/visa/visa-chart-components/blob/master/LICENSE
 *
 **/
export interface IBoxModelType {
  top: number;
  right: number;
  bottom: number;
  left: number;
}

export interface ISubTitleType {
  text?: string;
  keywordsHighlight?: IKeywordsHighlightType[];
}
export interface IDataLabelType {
  visible: boolean;
  placement?: string;
  labelAccessor?: string;
  displayOnly?: string | string[];
  format?: string;
  collisionHideOnly?: boolean;
  collisionPlacement?: string;
}

export interface ISizeConfigType {
  sizeAccessor?: string;
  minValueOverride?: string | number;
  maxValueOverride?: string | number;
  minSizeOverride?: string | number;
  maxSizeOverride?: string | number;
  dualEncodeColor?: boolean;
  format?: string;
}

export interface IAxisType {
  visible: boolean;
  gridVisible?: boolean;
  label?: string;
  format?: string;
  tickInterval?: number;
  unit?: string;
  placement?: string;
  scales?: string;
  onlyTickExtents?: boolean;
  centerBaseline?: boolean;
}

export interface ILegendType {
  visible: boolean;
  labels?: string | string[];
  interactive?: boolean;
  format?: string;
  type?: string;
}
export interface IHoverStyleType {
  color?: string;
  strokeWidth?: string | number;
}

export interface IClickStyleType {
  color?: string;
  strokeWidth?: string | number;
}
export interface IAnimationConfig {
  disabled?: boolean;
}
export interface IKeyConfig {
  disabled?: boolean;
}

export interface IKeywordsHighlightType {
  text: string;
  color: string;
  mode?: 'text' | 'background';
  index?: number;
}

export interface ILocalizationType {
  language?: string | object;
  numeralLocale?: string | object;
  skipValidation?: boolean;
  overwrite?: boolean;
}

export interface IAccessibilityType {
  longDescription?: string;
  executiveSummary?: string;
  purpose?: string;
  contextExplanation?: string;
  title?: string;
  elementDescriptionAccessor?: string;
  statisticalNotes?: string;
  structureNotes?: string;
  includeDataKeyNames?: boolean;
  hideDataTableButton?: boolean;
  disableValidation?: boolean;
  elementsAreInterface?: any;
  onChangeFunc?: any;
  hideTextures?: boolean;
  hideStrokes?: boolean;
  showSmallLabels?: boolean;
  showExperimentalTextures?: boolean;
  keyboardNavConfig?: IKeyConfig;
}

export interface IReferenceStyleType {
  color?: string;
  strokeWidth?: string;
  opacity?: number;
  dashed?: string;
}

export interface ITooltipLabelType {
  labelAccessor: string[];
  labelTitle?: string[];
  format: any[];
}

export interface IFocusStyleType {
  key?: string;
  sizeFromBar?: number;
}
export interface IBarStyleType {
  opacity?: number;
  width?: number;
  colorRule?: string;
}
export interface IMarkerStyleType {
  visible: boolean;
  type?: string;
  sizeFromBar?: number;
}
export interface ISeriesLabelType {
  visible: boolean;
  placement?: string;
  label?: string | string[];
  format?: string;
  collisionHideOnly?: boolean;
  collisionPlacement?: string;
}

export interface IDifferenceLabelType {
  visible: boolean;
  placement?: string;
  calculation?: string;
  format?: any;
  collisionHideOnly?: boolean;
  collisionPlacement?: string;
}

export interface IMapMarkerStyleType {
  visible: boolean;
  fill?: boolean;
  blend?: boolean;
  radius?: number;
  radiusRange?: string | number[];
  opacity?: number;
  color?: string;
  strokeWidth?: number;
}
export interface ICountryStyleType {
  fill: boolean;
  opacity?: number;
  color?: string;
  strokeWidth?: number;
}
export interface ISecondaryLinesType {
  keys: string[];
  showDataLabel: boolean;
  showSeriesLabel: boolean;
  opacity: number;
}

export interface INodeConfigType {
  fill: boolean;
  width: number;
  padding: number;
  alignment: string;
  compare: boolean;
}

export interface ILinkConfigType {
  visible: boolean;
  fillMode: string;
  opacity: number;
}