@progress/kendo-angular-charts
Version:
Kendo UI Charts for Angular - A comprehensive package for creating beautiful and interactive data visualization. Every chart type, stock charts, and sparklines are included.
84 lines (83 loc) • 3.65 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2024 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { drawing } from '@progress/kendo-drawing';
import { AxisLabelContentArgs, AxisLabelsPosition, AxisLabelVisualArgs, Border, LabelRotation, Margin } from '../../common/property-types';
import { Padding } from '../../common/property-types';
/**
* The configuration options of the value axis labels.
*/
export interface ValueAxisLabels {
/**
* The background color of the labels. Accepts a valid CSS color string, including HEX and RGB.
*/
background?: string;
/**
* The border of the labels.
*/
border?: Border;
/**
* The text color of the labels. Accepts a valid CSS color string, including HEX and RGB.
*/
color?: string;
/**
* The function which returns the label content.
* The function argument contains a `value` field which defines the label value.
* You can split the text into multiple lines by using the line feed characters (`"\n"`).
*/
content?: (e: AxisLabelContentArgs) => string;
/**
* The font style of the labels.
*/
font?: string;
/**
* The format for displaying the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
* Contains one placeholder (`"{0}"`) which represents the category value.
*/
format?: string;
/**
* The margin of the labels. A numeric value sets all margins.
*/
margin?: Margin | number;
/**
* If set to `true`, the Chart mirrors the axis labels and ticks. If the labels are normally on the
* left side of the axis, the mirroring of the axis renders them to the right.
*/
mirror?: boolean;
/**
* The padding of the labels. A numeric value sets all margins.
*/
padding?: Padding | number;
/**
* The position of the axis labels. By default, labels are positioned next to the axis.
* When `position` is set to `end`, the labels are placed at the end of the crossing axis, usually at the top or right end of the Chart unless the crossing axis has been reversed.
* Alternatively, when the `position` property is set to `start`, the axis labels will be positioned at the beginning of the crossing axis, typically located at the left or bottom end of the Chart, unless the crossing axis has been reversed.
*/
position?: AxisLabelsPosition;
/**
* The rotation angle (in degrees) of the labels. By default, the labels are not rotated. Angles
* increase clockwise and zero is to the left. Negative values are acceptable. Can be set to `"auto"` if
* the axis is horizontal. In this case, the labels will be rotated only if the slot size is not
* sufficient for the entire labels.
*/
rotation?: LabelRotation | number | 'auto';
/**
* The number of labels to skip. By default, no labels are skipped.
*/
skip?: number;
/**
* The label rendering step.
* Every n<sup>th</sup> label is rendered where `n` is the step.
*/
step?: number;
/**
* If set to `true`, the Chart displays the value axis labels.
* By default, the category axis labels are visible.
*/
visible?: boolean;
/**
* A function for creating custom visuals for the labels.
*/
visual?: (e: AxisLabelVisualArgs) => drawing.Element;
}