@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.
88 lines (87 loc) • 3.58 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, DateFormats, LabelRotation } from '../../common/property-types';
import { Margin, Padding } from '../../common/property-types';
/**
* The yAxis.labels options.
*/
export interface YAxisLabels {
/**
* 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.
* You can split the text into multiple lines by using the line feed characters (`"\n"`).
*/
content?: (e: AxisLabelContentArgs) => string;
/**
* The culture to use when formatting date values.
* The specified culture must be loaded as demonstrated in the [Internationalization Overview]({% slug overview_intl %}).
*/
culture?: string;
/**
* The format for displaying the labels when the X values are dates. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
* Contains one placeholder (`"{0}"`) which represents the category value.
* The Chart selects the appropriate format for the current [`yAxis.baseUnit`]({% slug api_charts_yaxis %}#toc-baseunit). Setting the
* [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#toc-format) option overrides the date formats.
*/
dateFormats?: DateFormats;
/**
* 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 paddings.
*/
padding?: Padding | number;
/**
* The position of the axis labels. By default, labels are positioned next to the axis.
*/
position?: AxisLabelsPosition;
/**
* The rotation angle of the labels. By default, the labels are not rotated.
*/
rotation?: LabelRotation | number | 'auto';
/**
* The number of labels to skip.
*/
skip?: number;
/**
* The label rendering step—renders every `n`<sup>th</sup> label. By default, every label is rendered.
*/
step?: number;
/**
* If set to `true`, the Chart displays the Y-axis labels. By default, the Y-axis labels are visible.
*/
visible?: boolean;
/**
* A function that can be used to create a custom visual for the labels.
*/
visual?: (e: AxisLabelVisualArgs) => drawing.Element;
}