recharts
Version:
React charts
34 lines (33 loc) • 1.61 kB
TypeScript
import { ErrorBarDirection } from '../cartesian/ErrorBar';
import { DataKey } from '../util/types';
import { GraphicalItemId } from './graphicalItemsSlice';
/**
* ErrorBars have lot more settings but all the others are scoped to the component itself.
* Only some of them required to be reported to the global store because XAxis and YAxis need to know
* if the error bar is contributing to extending the axis domain.
*/
export type ErrorBarsSettings = {
/**
* The direction is only used in Scatter chart, and decided based on ChartLayout in other charts.
*/
direction: ErrorBarDirection;
/**
* The dataKey decides which property from the data will each individual ErrorBar use.
* If it so happens that the ErrorBar data are bigger than the axis domain,
* the error bar data will stretch the axis domain.
*/
dataKey: DataKey<any>;
};
export type ErrorBarsState = Record<GraphicalItemId, ReadonlyArray<ErrorBarsSettings>>;
export declare const addErrorBar: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<{
itemId: GraphicalItemId;
errorBar: ErrorBarsSettings;
}, "errorBars/addErrorBar">, replaceErrorBar: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<{
itemId: GraphicalItemId;
prev: ErrorBarsSettings;
next: ErrorBarsSettings;
}, "errorBars/replaceErrorBar">, removeErrorBar: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<{
itemId: GraphicalItemId;
errorBar: ErrorBarsSettings;
}, "errorBars/removeErrorBar">;
export declare const errorBarReducer: import("redux").Reducer<ErrorBarsState>;