ag-grid-enterprise
Version:
AG Grid Enterprise Features
85 lines • 3.77 kB
TypeScript
import type { AgAxisLabelFormatterParams, FontStyle, FontWeight } from '../../chart/agChartOptions';
import type { Flag } from '../../chart/label';
export declare class AxisLabel {
enabled: boolean;
/** If set to `false`, axis labels will not be wrapped on multiple lines. */
autoWrap: boolean;
/** Used to constrain the width of the label when `autoWrap` is `true`, if the label text width exceeds the `maxWidth`, it will be wrapped on multiple lines automatically. If `maxWidth` is omitted, a default width constraint will be applied. */
maxWidth?: number;
/** Used to constrain the height of the multiline label, if the label text height exceeds the `maxHeight`, it will be truncated automatically. If `maxHeight` is omitted, a default height constraint will be applied. */
maxHeight?: number;
fontStyle?: FontStyle;
fontWeight?: FontWeight;
fontSize: number;
fontFamily: string;
/**
* The padding between the labels and the ticks.
*/
padding: number;
/**
* Minimum gap in pixels between the axis labels before being removed to avoid collisions.
*/
minSpacing: number;
/**
* The color of the labels.
* Use `undefined` rather than `rgba(0, 0, 0, 0)` to make labels invisible.
*/
color?: string;
/**
* Custom label rotation in degrees.
* Labels are rendered perpendicular to the axis line by default.
* Or parallel to the axis line, if the {@link parallel} is set to `true`.
* The value of this config is used as the angular offset/deflection
* from the default rotation.
*/
rotation?: number;
/**
* If specified and axis labels may collide, they are rotated to reduce collisions. If the
* `rotation` property is specified, it takes precedence.
*/
autoRotate: boolean | undefined;
/**
* Rotation angle to use when autoRotate is applied.
*/
autoRotateAngle: number;
/**
* Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide.
*/
avoidCollisions: boolean;
/**
* By default labels and ticks are positioned to the left of the axis line.
* `true` positions the labels to the right of the axis line.
* However, if the axis is rotated, it's easier to think in terms
* of this side or the opposite side, rather than left and right.
* We use the term `mirror` for conciseness, although it's not
* true mirroring - for example, when a label is rotated, so that
* it is inclined at the 45 degree angle, text flowing from north-west
* to south-east, ending at the tick to the left of the axis line,
* and then we set this config to `true`, the text will still be flowing
* from north-west to south-east, _starting_ at the tick to the right
* of the axis line.
*/
mirrored: boolean;
/**
* The side of the axis line to position the labels on.
* -1 = left (default)
* 1 = right
*/
getSideFlag(): Flag;
/**
* Labels are rendered perpendicular to the axis line by default.
* Setting this config to `true` makes labels render parallel to the axis line
* and center aligns labels' text at the ticks.
*/
parallel: boolean;
/**
* In case {@param value} is a number, the {@param fractionDigits} parameter will
* be provided as well. The `fractionDigits` corresponds to the number of fraction
* digits used by the tick step. For example, if the tick step is `0.0005`,
* the `fractionDigits` is 4.
*/
formatter?: (params: AgAxisLabelFormatterParams) => string;
format: string | undefined;
getFont(): string;
}
//# sourceMappingURL=axisLabel.d.ts.map