跳到主要内容

ui/build/chart/chart-utils

ui/build/chart/chart-utils

Type Aliases

ChartConfig

type ChartConfig = { [k in string]: { icon?: Component; label?: string } & ({ color?: string; theme?: never } | { color?: never; theme: Record<keyof typeof THEMES, string> }) };

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:8


ChartDisplayConfig

type ChartDisplayConfig = typeof ChartDisplayConfigSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:30


ChartDisplayConfigEntry

type ChartDisplayConfigEntry = typeof ChartDisplayConfigEntrySchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:25


ChartDisplaySpec

type ChartDisplaySpec = CartesianChartSpec | DonutChartSpec;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:75


ChartDisplayValue

type ChartDisplayValue = string | number | null;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:20


ChartDisplayValueFormat

type ChartDisplayValueFormat = typeof ChartDisplayValueFormatSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:37

Variables

THEMES

const THEMES: object;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:4

Type Declaration

dark
readonly dark: ".dark";

light
readonly light: "";

Functions

getPayloadConfigFromPayload()

function getPayloadConfigFromPayload(
   config,
   payload,
   key):
  | { label?: string | undefined; icon?: Component<{}, {}, string> | undefined; } & ({ color?: string | undefined; theme?: undefined; } | { color?: undefined; theme: Record<"light" | "dark", string>; })
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:76

Parameters

Parameter Type
config ChartConfig
payload TooltipSeries
key string

Returns

| { label?: string | undefined; icon?: Component<{}, {}, string> | undefined; } & ({ color?: string | undefined; theme?: undefined; } | { color?: undefined; theme: Record<"light" | "dark", string>; }) | undefined


setChartContext()

function setChartContext(value): ChartContextValue;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:89

Parameters

Parameter Type
value ChartContextValue

Returns

ChartContextValue


useChart()

function useChart(): ChartContextValue;

Defined in: apps/website/.api-docs-entry/ui/build/chart/chart-utils.d.ts:90

Returns

ChartContextValue