@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.
102 lines (101 loc) • 4.77 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 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 { ConfigurationService } from '../../common/configuration.service';
import { AxisLabelContentArgs, AxisLabelVisualArgs, Border, DateFormats, LabelRotation } from '../../common/property-types';
import { AxisLabelsPosition } from '../../common/property-types';
import { Margin, Padding } from '../../common/property-types';
import { YAxisLabels } from '../../common/property-types';
import { SettingsComponent } from '../../common/settings.component';
import * as i0 from "@angular/core";
/**
* Represents the Y-axis labels configuration.
*/
export declare class YAxisLabelsComponent extends SettingsComponent implements YAxisLabels {
configurationService: ConfigurationService;
/**
* Specifies the background color of the labels.
*/
background: string;
/**
* Specifies the border configuration of the labels.
*/
border: Border;
/**
* Specifies the text color of the labels.
*/
color: string;
/**
* Specifies a function that returns the content of the labels.
*/
content: (e: AxisLabelContentArgs) => string;
/**
* Specifies the culture used for formatting the labels.
*/
culture: string;
/**
* Specifies the date formats for displaying the labels.
*/
dateFormats: DateFormats;
/**
* Specifies the font style of the labels.
* @default '12px sans-serif'
*/
font: string;
/**
* Specifies 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.
* @default '{0}'
*/
format: string;
/**
* Specifies the margin of the labels. A numeric value sets all margins.
* @default 0
*/
margin: Margin | number;
/**
* Determines whether 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.
* @default false
*/
mirror: boolean;
/**
* Specifies the padding of the labels. A numeric value sets all paddings.
* @default 0
*/
padding: Padding | number;
/**
* Specifies the position of the axis labels. By default, labels are positioned next to the axis.
* @default 'onAxis'
*/
position: AxisLabelsPosition;
/**
* Specifies the rotation angle of the labels. By default, the labels are not rotated.
* @default 0
*/
rotation: LabelRotation | number | 'auto';
/**
* Specifies the number of labels to skip.
* @default 0
*/
skip: number;
/**
* Specifies the label rendering step—renders every `n`<sup>th</sup> label. By default, every label is rendered.
* @default 1
*/
step: number;
/**
* Determines whether the Chart displays the Y-axis labels. By default, the Y-axis labels are visible.
* @default true
*/
visible: boolean;
/**
* Specifies a function that returns a custom visual for the labels.
*/
visual: (e: AxisLabelVisualArgs) => drawing.Element;
constructor(configurationService: ConfigurationService);
static ɵfac: i0.ɵɵFactoryDeclaration<YAxisLabelsComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<YAxisLabelsComponent, "kendo-chart-y-axis-item-labels", never, { "background": { "alias": "background"; "required": false; }; "border": { "alias": "border"; "required": false; }; "color": { "alias": "color"; "required": false; }; "content": { "alias": "content"; "required": false; }; "culture": { "alias": "culture"; "required": false; }; "dateFormats": { "alias": "dateFormats"; "required": false; }; "font": { "alias": "font"; "required": false; }; "format": { "alias": "format"; "required": false; }; "margin": { "alias": "margin"; "required": false; }; "mirror": { "alias": "mirror"; "required": false; }; "padding": { "alias": "padding"; "required": false; }; "position": { "alias": "position"; "required": false; }; "rotation": { "alias": "rotation"; "required": false; }; "skip": { "alias": "skip"; "required": false; }; "step": { "alias": "step"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "visual": { "alias": "visual"; "required": false; }; }, {}, never, never, true, never>;
}