@mui/x-charts
Version:
The community edition of MUI X Charts components.
42 lines • 1.42 kB
TypeScript
import * as React from 'react';
import { type BarLabelOwnerState } from "./BarLabel.types.js";
export declare const BarLabelComponent: import("@emotion/styled").StyledComponent<import("@mui/system").MUIStyledCommonProps<import("@mui/material/styles").Theme>, Pick<React.SVGTextElementAttributes<SVGTextElement>, keyof React.SVGTextElementAttributes<SVGTextElement>>, {}>;
export type BarLabelProps = Omit<React.SVGProps<SVGTextElement>, 'ref' | 'id' | 'x' | 'y' | 'width' | 'height'> & BarLabelOwnerState & {
/**
* The x-coordinate of the stack this bar label belongs to.
*/
xOrigin: number;
/**
* The y-coordinate of the stack this bar label belongs to.
*/
yOrigin: number;
/**
* Position in the x-axis of the bar this label belongs to.
*/
x: number;
/**
* Position in the y-axis of the bar this label belongs to.
*/
y: number;
/**
* Width of the bar this label belongs to.
*/
width: number;
/**
* Height of the bar this label belongs to.
*/
height: number;
/**
* The placement of the bar label.
* It controls whether the label is rendered in the center or outside the bar.
* @default 'center'
*/
placement?: 'center' | 'outside';
/** If true, the bar label is hidden. */
hidden?: boolean;
};
declare function BarLabel(inProps: BarLabelProps): React.JSX.Element;
declare namespace BarLabel {
var propTypes: any;
}
export { BarLabel };