Circle V2 API Docs
    Preparing search index...

    Function useChart

    • Type Parameters

      • T = any

      Parameters

      • props: UseChartProps<T>

      Returns {
          color: (key: ChartColor) => any;
          data: T[];
          formatDate: (options?: DateTimeFormatOptions) => (value: string) => string;
          formatNumber: (options?: NumberFormatOptions) => (value: number) => string;
          getMax: (key: keyof T) => number;
          getMin: (key: keyof T) => number;
          getPayloadTotal: <T_1 extends { value?: string }>(
              payload: T_1[] | undefined,
          ) => number | undefined;
          getSeries: (item: unknown) => SeriesItem<T> | undefined;
          getSeriesOpacity: (
              name: string | undefined,
              fallback?: number,
          ) => number | undefined;
          getTotal: (key: keyof T) => number;
          getValuePercent: (
              key: keyof T,
              value: number,
              domain?: ValueDomain,
          ) => number;
          groupBy: (key: keyof T) => T[][];
          highlightedSeries: string | null;
          id: string;
          isHighlightedSeries: (name: string | undefined) => boolean;
          key: <K extends string | number | symbol>(prop: K | undefined) => K;
          series: SeriesItem<T>[];
          setHighlightedSeries: Dispatch<SetStateAction<string | null>>;
          size: (key: ChartSize | undefined) => any;
          spacing: (key: ChartSpacing | undefined) => any;
      }