41 lines
1.3 KiB
TypeScript
41 lines
1.3 KiB
TypeScript
import { ChartsReferenceLineClasses } from "./chartsReferenceLineClasses.js";
|
|
import { ChartsTextStyle } from "../ChartsText/index.js";
|
|
import { AxisId } from "../models/axis.js";
|
|
export type CommonChartsReferenceLineProps = {
|
|
/**
|
|
* The alignment if the label is in the chart drawing area.
|
|
* @default 'middle'
|
|
*/
|
|
labelAlign?: 'start' | 'middle' | 'end';
|
|
/**
|
|
* The label to display along the reference line.
|
|
*/
|
|
label?: string;
|
|
/**
|
|
* Additional space around the label in px.
|
|
* Can be a number or an object `{ x, y }` to distinguish space with the reference line and space with axes.
|
|
* @default 5
|
|
*/
|
|
spacing?: number | {
|
|
x?: number;
|
|
y?: number;
|
|
};
|
|
/**
|
|
* The id of the axis used for the reference value.
|
|
* @default The `id` of the first defined axis.
|
|
*/
|
|
axisId?: AxisId;
|
|
/**
|
|
* The style applied to the label.
|
|
*/
|
|
labelStyle?: ChartsTextStyle;
|
|
/**
|
|
* The style applied to the line.
|
|
*/
|
|
lineStyle?: React.CSSProperties;
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
*/
|
|
classes?: Partial<ChartsReferenceLineClasses>;
|
|
};
|
|
export declare const ReferenceLineRoot: import("@emotion/styled").StyledComponent<import("@mui/system").MUIStyledCommonProps<import("@mui/material/styles").Theme>, import("react").SVGProps<SVGGElement>, {}>; |