@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.
63 lines (62 loc) • 2.54 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, AxisLabelVisualArgs, LabelRotation, Margin, Padding } from '../../common/property-types';
/**
* The configuration options for the axis label
* ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
*/
export interface AxisDefaultsLabels {
/**
* The function which returns the label content.
* The text can be split 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 paddings.
*/
padding?: Padding | number;
/**
* The rotation angle of the labels. By default, the labels are not rotated.
* If the axis is horizontal, can be set to `"auto"`.
* In this case, the labels are 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—renders every n<sup>th</sup> label. By default, every label is rendered.
*/
step?: number;
/**
* If set to `true`, the Chart displays the axis labels. By default, the axis labels are visible.
*/
visible?: boolean;
/**
* A function that for creating a custom visual for the labels.
*/
visual?: (e: AxisLabelVisualArgs) => drawing.Element;
}