gifted-charts-core 0.0.21 → 0.0.22

package/src/utils/types.ts

@@ -1,14 +1,15 @@
-import { ColorValue } from "react-native";
-import { chartTypes, yAxisSides } from "./constants";
-import { lineDataItem } from "../LineChart/types";
+import { type ColorValue } from 'react-native'
+import { type chartTypes, type yAxisSides } from './constants'
+import { type lineDataItem } from '../LineChart/types'
+import { type barDataItem, type stackDataItem } from '../BarChart/types'
 
-export type RuleType = "solid" | "dashed" | "dotted" | string;
+export type RuleType = 'solid' | 'dashed' | 'dotted' | string
 
-export type RuleTypes = {
-  SOLID: RuleType;
-  DASHED: RuleType;
-  DOTTED: RuleType;
-};
+export interface RuleTypes {
+  SOLID: RuleType
+  DASHED: RuleType
+  DOTTED: RuleType
+}
 
 export enum CurveType {
   CUBIC,
@@ -21,345 +22,345 @@ export enum EdgePosition {
   BEFORE_DATA_POINT,
 }
 
-export type RulesConfig = {
-  rulesLength?: number;
-  rulesColor?: ColorValue;
-  rulesThickness?: number;
-  rulesType?: RuleType;
-  dashWidth?: number;
-  dashGap?: number;
-};
-
-export type PointerEvents = "box-none" | "none" | "box-only" | "auto";
-
-export type secondaryYAxisType = {
-  noOfSections?: number;
-  maxValue?: number;
-  mostNegativeValue?: number;
-  stepValue?: number;
-  stepHeight?: number;
-  showFractionalValues?: boolean;
-  roundToDigits?: number;
-  noOfSectionsBelowXAxis?: number;
-
-  showYAxisIndices?: boolean;
-  yAxisIndicesHeight?: number;
-  yAxisIndicesWidth?: number;
-  yAxisIndicesColor?: ColorValue;
-
-  yAxisSide?: yAxisSides;
-  yAxisOffset?: number;
-  yAxisThickness?: number;
-  yAxisColor?: ColorValue;
-  yAxisLabelContainerStyle?: any;
-  yAxisLabelTexts?: Array<string> | undefined;
-  yAxisTextStyle?: any;
-  yAxisTextNumberOfLines?: number;
-  yAxisLabelWidth?: number;
-  hideYAxisText?: boolean;
-  yAxisLabelPrefix?: string;
-  yAxisLabelSuffix?: string;
-  hideOrigin?: boolean;
-  formatYLabel?: (label: string) => string;
-};
-
-export type secondaryLineConfigType = {
-  zIndex?: number;
-  curved?: boolean;
-  curvature?: number;
-  curveType?: CurveType;
-  areaChart?: boolean;
-  color?: ColorValue;
-  thickness?: number;
-  zIndex1?: number;
-  strokeDashArray?: Array<number>;
-  startIndex?: number;
-  endIndex?: number;
-  hideDataPoints?: boolean;
-  dataPointsHeight?: number;
-  dataPointsWidth?: number;
-  dataPointsRadius?: number;
-  dataPointsColor?: string;
-  dataPointsShape?: string;
-  showValuesAsDataPointsText?: boolean;
-  startFillColor?: string;
-  endFillColor?: string;
-  startOpacity?: number;
-  endOpacity?: number;
-  textFontSize?: number;
-  textColor?: string;
-  showArrow?: boolean;
-  arrowConfig?: arrowConfigType;
-  isSecondary?: boolean;
-};
-
-export type referenceConfigType = {
-  thickness?: number;
-  width?: number;
-  color?: ColorValue | String | any;
-  type?: String;
-  dashWidth?: number;
-  dashGap?: number;
-  labelText?: String;
-  labelTextStyle?: any;
-  zIndex?: number;
-};
-
-export type arrowConfigType = {
-  length: number;
-  width: number;
-  strokeWidth: number;
-  strokeColor: string;
-  fillColor: string;
-  showArrowBase: boolean;
-};
-
-export type horizSectionPropTypes = {
-  width: number | undefined;
-  horizSections: Array<any>;
-  noOfSectionsBelowXAxis: number;
-  totalWidth: number;
-  endSpacing: number;
-  yAxisSide: yAxisSides;
-  horizontalRulesStyle: any;
-  noOfSections: number;
-  stepHeight: number;
-  yAxisLabelWidth: number;
-  yAxisLabelContainerStyle: any;
-  yAxisThickness: number;
-  trimYAxisAtTop: boolean;
-  yAxisColor: string;
-  yAxisExtraHeight: number;
-  xAxisThickness: number;
-  xAxisColor: string;
-  xAxisLength: number;
-  xAxisType: RuleType;
-  dashWidth: number;
-  dashGap: number;
-  rulesConfigArray: Array<RulesConfig>;
-  backgroundColor: string;
-  hideRules: boolean;
-  rulesLength: number;
-  rulesType: RuleType;
-  rulesThickness: number;
-  rulesColor: string;
-  spacing: number;
-  showYAxisIndices: boolean;
-  yAxisIndicesHeight: number;
-  yAxisIndicesWidth: number;
-  yAxisIndicesColor: string;
-
-  hideOrigin: boolean;
-  hideYAxisText: boolean;
-  showFractionalValues: boolean;
-  yAxisTextNumberOfLines: number;
-  yAxisLabelPrefix: string;
-  yAxisLabelSuffix: string;
-  yAxisTextStyle: any;
-  rotateYAxisTexts: number | undefined;
-  rtl: boolean;
-
-  containerHeight: number;
-  overflowTop: number;
-  maxValue: number;
-
-  referenceLinesConfig: any;
-
-  yAxisLabelTexts: Array<string> | undefined;
-  yAxisOffset: number | undefined;
-
-  horizontal: boolean;
-  yAxisAtTop: boolean;
-
-  stepValue: number;
-  roundToDigits: number | undefined;
-
-  secondaryData: Array<any> | undefined;
-  secondaryYAxis: secondaryYAxisType | null;
-  formatYLabel?: (label: string) => string;
-  onlyReferenceLines?: boolean;
-  renderReferenceLines?: boolean;
-};
-
-type HorizSectionObject = {
-  value: string;
-};
-
-export type HorizSectionsType = Array<HorizSectionObject>;
-
-export type BarAndLineChartsWrapperTypes = {
-  chartType: chartTypes;
-  containerHeight: number;
-  noOfSectionsBelowXAxis: number;
-  stepHeight: number;
-  labelsExtraHeight: number;
-  yAxisLabelWidth: number;
-  horizontal: boolean;
-  rtl: boolean;
-  shiftX: number;
-  shiftY: number;
-  scrollRef?: any;
-  yAxisAtTop: boolean;
-  initialSpacing: number;
-  data: Array<any>;
-  stackData: Array<any> | undefined;
-  secondaryData: Array<any> | undefined;
-  barWidth: number | undefined;
-  xAxisThickness: number;
-  totalWidth: number;
-  disableScroll: boolean;
-  showScrollIndicator: boolean;
-  scrollToEnd: boolean;
-  scrollToIndex: number | undefined;
-  scrollAnimation: boolean;
-  indicatorColor: "black" | "default" | "white" | undefined;
-  setSelectedIndex: any;
-  spacing: number;
-  showLine: boolean;
-  lineConfig: any;
-  lineConfig2: any;
-  maxValue: number;
-  lineData: Array<any>;
-  lineData2: Array<any>;
-  animatedWidth?: any;
-  lineBehindBars: boolean;
-  points: string | Array<any>;
-  points2: string | Array<any>;
-  arrowPoints: any;
-  renderChartContent?: any;
-  remainingScrollViewProps?: any;
-
-  width: number | undefined;
-  horizSections: HorizSectionsType;
-  endSpacing: number;
-  horizontalRulesStyle: any;
-  noOfSections: number;
-  showFractionalValues: boolean;
-  axesAndRulesProps: any;
-
-  yAxisLabelTexts: Array<string> | undefined;
-  yAxisOffset: number | undefined;
-  rotateYAxisTexts: number | undefined;
-  hideAxesAndRules: boolean | undefined;
-
-  showXAxisIndices: boolean;
-  xAxisIndicesHeight: number;
-  xAxisIndicesWidth: number;
-  xAxisIndicesColor: ColorValue;
-
-  pointerConfig?: Pointer;
-  getPointerProps: any;
-  pointerIndex: number;
-  pointerX: number;
-  pointerY: number;
-
-  scrollEventThrottle: number;
-
-  onEndReached?: () => void;
-  onStartReached?: () => void;
-  endReachedOffset: number;
-};
-
-export type Pointer = {
-  height?: number;
-  width?: number;
-  radius?: number;
-  pointerColor?: ColorValue;
-  pointer1Color?: ColorValue;
-  pointer2Color?: ColorValue;
-  pointer3Color?: ColorValue;
-  pointer4Color?: ColorValue;
-  pointer5Color?: ColorValue;
-  secondaryPointerColor?: ColorValue;
-  pointerComponent?: Function;
-  showPointerStrip?: boolean;
-  pointerStripWidth?: number;
-  pointerStripHeight?: number;
-  pointerStripColor?: ColorValue;
-  pointerStripUptoDataPoint?: boolean;
-  pointerLabelComponent?: Function;
-  stripOverPointer?: boolean;
-  autoAdjustPointerLabelPosition?: boolean;
-  shiftPointerLabelX?: number;
-  shiftPointerLabelY?: number;
-  pointerLabelWidth?: number;
-  pointerLabelHeight?: number;
-  pointerVanishDelay?: number;
-  activatePointersOnLongPress?: boolean;
-  activatePointersDelay?: number;
-  initialPointerIndex?: number;
-  initialPointerAppearDelay?: number;
-  persistPointer?: boolean;
-  hidePointer1?: boolean;
-  hidePointer2?: boolean;
-  hidePointer3?: boolean;
-  hidePointer4?: boolean;
-  hidePointer5?: boolean;
-  hideSecondaryPointer?: boolean;
-  strokeDashArray?: Array<number>;
-  barTouchable?: boolean;
-  pointerEvents?: PointerEvents;
-  stripBehindBars?: boolean;
-  resetPointerOnDataChange?: boolean;
-};
-
-export type HighlightedRange = {
-  from: number;
-  to: number;
-  color?: string | ColorValue;
-  thickness?: number;
-  strokeDashArray?: Array<number>;
-};
-
-export type LineSegment = {
-  startIndex: number;
-  endIndex: number;
-  color?: string | ColorValue;
-  thickness?: number;
-  strokeDashArray?: Array<number>;
-};
-
-export type LineSvgProps = {
-  d: string;
-  fill: string;
-  stroke: string | ColorValue;
-  strokeWidth: number;
-  strokeDasharray?: Array<number>;
-};
-
-export type LineProperties = {
-  d: string;
-  color: string | ColorValue;
-  strokeWidth: number;
-  strokeDashArray?: Array<number>;
-};
-
-export type DataSet = {
-  data: Array<lineDataItem>;
-  zIndex?: number;
-  thickness?: number;
-  strokeDashArray?: Array<number>;
-  areaChart?: boolean;
-  stepChart?: boolean;
-  startIndex?: number;
-  endIndex?: number;
-  color?: string;
-  hideDataPoints?: boolean;
-  dataPointsHeight?: number;
-  dataPointsWidth?: number;
-  dataPointsRadius?: number;
-  dataPointsColor?: string;
-  dataPointsShape?: string;
-  startFillColor?: string;
-  endFillColor?: string;
-  startOpacity?: number;
-  endOpacity?: number;
-  textFontSize?: number;
-  textColor?: string;
-  showArrow?: boolean;
-  arrowConfig?: arrowConfigType;
-  curved?: boolean;
-  curvature?: number;
-  curveType?: CurveType;
-  lineSegments?: Array<LineSegment>;
-};
+export interface RulesConfig {
+  rulesLength?: number
+  rulesColor?: ColorValue
+  rulesThickness?: number
+  rulesType?: RuleType
+  dashWidth?: number
+  dashGap?: number
+}
+
+export type PointerEvents = 'box-none' | 'none' | 'box-only' | 'auto'
+
+export interface secondaryYAxisType {
+  noOfSections?: number
+  maxValue?: number
+  mostNegativeValue?: number
+  stepValue?: number
+  stepHeight?: number
+  showFractionalValues?: boolean
+  roundToDigits?: number
+  noOfSectionsBelowXAxis?: number
+
+  showYAxisIndices?: boolean
+  yAxisIndicesHeight?: number
+  yAxisIndicesWidth?: number
+  yAxisIndicesColor?: ColorValue
+
+  yAxisSide?: yAxisSides
+  yAxisOffset?: number
+  yAxisThickness?: number
+  yAxisColor?: ColorValue
+  yAxisLabelContainerStyle?: any
+  yAxisLabelTexts?: string[] | undefined
+  yAxisTextStyle?: any
+  yAxisTextNumberOfLines?: number
+  yAxisLabelWidth?: number
+  hideYAxisText?: boolean
+  yAxisLabelPrefix?: string
+  yAxisLabelSuffix?: string
+  hideOrigin?: boolean
+  formatYLabel?: (label: string) => string
+}
+
+export interface secondaryLineConfigType {
+  zIndex?: number
+  curved?: boolean
+  curvature?: number
+  curveType?: CurveType
+  areaChart?: boolean
+  color?: ColorValue
+  thickness?: number
+  zIndex1?: number
+  strokeDashArray?: number[]
+  startIndex?: number
+  endIndex?: number
+  hideDataPoints?: boolean
+  dataPointsHeight?: number
+  dataPointsWidth?: number
+  dataPointsRadius?: number
+  dataPointsColor?: string
+  dataPointsShape?: string
+  showValuesAsDataPointsText?: boolean
+  startFillColor?: string
+  endFillColor?: string
+  startOpacity?: number
+  endOpacity?: number
+  textFontSize?: number
+  textColor?: string
+  showArrow?: boolean
+  arrowConfig?: arrowConfigType
+  isSecondary?: boolean
+}
+
+export interface referenceConfigType {
+  thickness?: number
+  width?: number
+  color?: ColorValue | string | any
+  type?: string
+  dashWidth?: number
+  dashGap?: number
+  labelText?: string
+  labelTextStyle?: any
+  zIndex?: number
+}
+
+export interface arrowConfigType {
+  length: number
+  width: number
+  strokeWidth: number
+  strokeColor: string
+  fillColor: string
+  showArrowBase: boolean
+}
+
+export interface horizSectionPropTypes {
+  width: number | undefined
+  horizSections: any[]
+  noOfSectionsBelowXAxis: number
+  totalWidth: number
+  endSpacing: number
+  yAxisSide: yAxisSides
+  horizontalRulesStyle: any
+  noOfSections: number
+  stepHeight: number
+  yAxisLabelWidth: number
+  yAxisLabelContainerStyle: any
+  yAxisThickness: number
+  trimYAxisAtTop: boolean
+  yAxisColor: string
+  yAxisExtraHeight: number
+  xAxisThickness: number
+  xAxisColor: string
+  xAxisLength: number
+  xAxisType: RuleType
+  dashWidth: number
+  dashGap: number
+  rulesConfigArray: RulesConfig[]
+  backgroundColor: string
+  hideRules: boolean
+  rulesLength: number
+  rulesType: RuleType
+  rulesThickness: number
+  rulesColor: string
+  spacing: number
+  showYAxisIndices: boolean
+  yAxisIndicesHeight: number
+  yAxisIndicesWidth: number
+  yAxisIndicesColor: string
+
+  hideOrigin: boolean
+  hideYAxisText: boolean
+  showFractionalValues: boolean
+  yAxisTextNumberOfLines: number
+  yAxisLabelPrefix: string
+  yAxisLabelSuffix: string
+  yAxisTextStyle: any
+  rotateYAxisTexts: number | undefined
+  rtl: boolean
+
+  containerHeight: number
+  overflowTop: number
+  maxValue: number
+
+  referenceLinesConfig: any
+
+  yAxisLabelTexts: string[] | undefined
+  yAxisOffset: number | undefined
+
+  horizontal: boolean
+  yAxisAtTop: boolean
+
+  stepValue: number
+  roundToDigits: number | undefined
+
+  secondaryData: any[] | undefined
+  secondaryYAxis: secondaryYAxisType | null
+  formatYLabel?: (label: string) => string
+  onlyReferenceLines?: boolean
+  renderReferenceLines?: boolean
+}
+
+interface HorizSectionObject {
+  value: string
+}
+
+export type HorizSectionsType = HorizSectionObject[]
+
+export interface BarAndLineChartsWrapperTypes {
+  chartType: chartTypes
+  containerHeight: number
+  noOfSectionsBelowXAxis: number
+  stepHeight: number
+  labelsExtraHeight: number
+  yAxisLabelWidth: number
+  horizontal: boolean
+  rtl: boolean
+  shiftX: number
+  shiftY: number
+  scrollRef?: any
+  yAxisAtTop: boolean
+  initialSpacing: number
+  data: any[]
+  stackData: any[] | undefined
+  secondaryData: any[] | undefined
+  barWidth: number | undefined
+  xAxisThickness: number
+  totalWidth: number
+  disableScroll: boolean
+  showScrollIndicator: boolean
+  scrollToEnd: boolean
+  scrollToIndex: number | undefined
+  scrollAnimation: boolean
+  indicatorColor: 'black' | 'default' | 'white' | undefined
+  setSelectedIndex: any
+  spacing: number
+  showLine: boolean
+  lineConfig: any
+  lineConfig2: any
+  maxValue: number
+  lineData?: Array<lineDataItem | barDataItem | stackDataItem>
+  lineData2?: Array<lineDataItem | barDataItem | stackDataItem>
+  animatedWidth?: any
+  lineBehindBars: boolean
+  points: string | any[]
+  points2: string | any[]
+  arrowPoints: any
+  renderChartContent?: any
+  remainingScrollViewProps?: any
+
+  width: number | undefined
+  horizSections: HorizSectionsType
+  endSpacing: number
+  horizontalRulesStyle: any
+  noOfSections: number
+  showFractionalValues: boolean
+  axesAndRulesProps: any
+
+  yAxisLabelTexts: string[] | undefined
+  yAxisOffset: number | undefined
+  rotateYAxisTexts: number | undefined
+  hideAxesAndRules: boolean | undefined
+
+  showXAxisIndices: boolean
+  xAxisIndicesHeight: number
+  xAxisIndicesWidth: number
+  xAxisIndicesColor: ColorValue
+
+  pointerConfig?: Pointer
+  getPointerProps: any
+  pointerIndex: number
+  pointerX: number
+  pointerY: number
+
+  scrollEventThrottle: number
+
+  onEndReached?: () => void
+  onStartReached?: () => void
+  endReachedOffset: number
+}
+
+export interface Pointer {
+  height?: number
+  width?: number
+  radius?: number
+  pointerColor?: ColorValue
+  pointer1Color?: ColorValue
+  pointer2Color?: ColorValue
+  pointer3Color?: ColorValue
+  pointer4Color?: ColorValue
+  pointer5Color?: ColorValue
+  secondaryPointerColor?: ColorValue
+  pointerComponent?: Function
+  showPointerStrip?: boolean
+  pointerStripWidth?: number
+  pointerStripHeight?: number
+  pointerStripColor?: ColorValue
+  pointerStripUptoDataPoint?: boolean
+  pointerLabelComponent?: Function
+  stripOverPointer?: boolean
+  autoAdjustPointerLabelPosition?: boolean
+  shiftPointerLabelX?: number
+  shiftPointerLabelY?: number
+  pointerLabelWidth?: number
+  pointerLabelHeight?: number
+  pointerVanishDelay?: number
+  activatePointersOnLongPress?: boolean
+  activatePointersDelay?: number
+  initialPointerIndex?: number
+  initialPointerAppearDelay?: number
+  persistPointer?: boolean
+  hidePointer1?: boolean
+  hidePointer2?: boolean
+  hidePointer3?: boolean
+  hidePointer4?: boolean
+  hidePointer5?: boolean
+  hideSecondaryPointer?: boolean
+  strokeDashArray?: number[]
+  barTouchable?: boolean
+  pointerEvents?: PointerEvents
+  stripBehindBars?: boolean
+  resetPointerOnDataChange?: boolean
+}
+
+export interface HighlightedRange {
+  from: number
+  to: number
+  color?: string | ColorValue
+  thickness?: number
+  strokeDashArray?: number[]
+}
+
+export interface LineSegment {
+  startIndex: number
+  endIndex: number
+  color?: string | ColorValue
+  thickness?: number
+  strokeDashArray?: number[]
+}
+
+export interface LineSvgProps {
+  d: string
+  fill: string
+  stroke: string | ColorValue
+  strokeWidth: number
+  strokeDasharray?: number[]
+}
+
+export interface LineProperties {
+  d: string
+  color: string | ColorValue
+  strokeWidth: number
+  strokeDashArray?: number[]
+}
+
+export interface DataSet {
+  data: lineDataItem[]
+  zIndex?: number
+  thickness?: number
+  strokeDashArray?: number[]
+  areaChart?: boolean
+  stepChart?: boolean
+  startIndex?: number
+  endIndex?: number
+  color?: string
+  hideDataPoints?: boolean
+  dataPointsHeight?: number
+  dataPointsWidth?: number
+  dataPointsRadius?: number
+  dataPointsColor?: string
+  dataPointsShape?: string
+  startFillColor?: string
+  endFillColor?: string
+  startOpacity?: number
+  endOpacity?: number
+  textFontSize?: number
+  textColor?: string
+  showArrow?: boolean
+  arrowConfig?: arrowConfigType
+  curved?: boolean
+  curvature?: number
+  curveType?: CurveType
+  lineSegments?: LineSegment[]
+}