@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.
156 lines (155 loc) • 6.66 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 { OnDestroy } from '@angular/core';
import { IntlService } from '@progress/kendo-angular-intl';
import { CollectionItemComponent } from '../common/collection-item.component';
import { CollectionService } from '../common/collection.service';
import { ConfigurationService } from '../common/configuration.service';
import { AxisLine, AxisTicks, BaseUnit, GridLines, PlotBand, WeekStartDay } from '../common/property-types';
import { XAxis, XAxisCrosshair, XAxisLabels, XAxisNotes, XAxisTitle } from '../common/property-types';
import * as i0 from "@angular/core";
/**
* Represents the Kendo UI for Angular Chart X Axis Item component
* ([see example]({% slug api_charts_xaxiscomponent %})).
*
* @example
* ```html
* <kendo-chart>
* <kendo-chart-x-axis>
* <kendo-chart-x-axis-item>
* <kendo-chart-x-axis-item-title text="X Axis Title"></kendo-chart-x-axis-item-title>
* </kendo-chart-x-axis-item>
* </kendo-chart-x-axis>
* </kendo-chart>
* ```
*
* @remarks
* Supported children components are: {@link XAxisCrosshairComponent}, {@link XAxisLabelsComponent}, {@link XAxisNotesComponent}, and {@link XAxisTitleComponent}.
*/
export declare class XAxisItemComponent extends CollectionItemComponent implements XAxis, OnDestroy {
protected configurationService: ConfigurationService;
protected collectionService: CollectionService;
protected intl: IntlService;
/**
* Specifies the value or array of values at which the axis crosses with another axis.
*/
axisCrossingValue: any | any[];
/**
* Specifies the background color of the axis.
*/
background: string;
/**
* Specifies the base time unit for the axis.
*/
baseUnit: BaseUnit;
/**
* Specifies the categories for the axis.
*/
categories?: any[];
/**
* Specifies the color of the axis.
*/
color: string;
/**
* Specifies the configuration of the axis line.
*/
line: AxisLine;
/**
* Specifies the configuration of the major grid lines.
*/
majorGridLines: GridLines;
/**
* Specifies the configuration of the major ticks.
*/
majorTicks: AxisTicks;
/**
* Specifies the interval between major divisions.
*/
majorUnit: number;
/**
* Specifies the maximum value of the axis.
*/
max: any;
/**
* Specifies the minimum value of the axis.
*/
min: any;
/**
* Specifies the configuration of the minor grid lines.
*/
minorGridLines: GridLines;
/**
* Specifies the configuration of the minor ticks.
*/
minorTicks: AxisTicks;
/**
* Specifies the interval between minor divisions.
*/
minorUnit: number;
/**
* Specifies the unique name of the axis.
*/
name: string;
/**
* Determines whether the Chart prevents the automatic axis range from snapping to zero.
*/
narrowRange: boolean;
/**
* Specifies the name of the pane that the axis renders in.
*/
pane: string;
/**
* Specifies the plot bands configuration.
*/
plotBands: PlotBand[];
/**
* Determines whether the axis direction is reversed.
*/
reverse: boolean;
/**
* Specifies the start angle for radar and polar axes.
*/
startAngle: number;
/**
* Specifies the axis type.
*
* The options are `numeric` for a numeric axis, `date` for a specialized axis for displaying chronological data, and `log` for a logarithmic axis.
*
* If the series X value is of the `date` type, the Chart automatically switches to a date axis.
* To avoid this behavior, set the `type`.
* @default 'numeric'
*/
type: 'numeric' | 'log' | 'date';
/**
* Determines whether the Chart displays the X axis. By default, the X axis is visible.
* @default true
*/
visible: boolean;
/**
* Specifies the first day of the week.
*/
weekStartDay: WeekStartDay;
/**
* Specifies the configuration of the crosshair.
*/
crosshair: XAxisCrosshair;
/**
* Specifies the configuration of the labels.
*/
labels: XAxisLabels;
/**
* Specifies the configuration of the notes.
*/
notes: XAxisNotes;
/**
* Specifies the configuration of the title.
*/
title: XAxisTitle;
private intlSubscription;
constructor(configurationService: ConfigurationService, collectionService: CollectionService, intl: IntlService, localeId: string);
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<XAxisItemComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<XAxisItemComponent, "kendo-chart-x-axis-item", never, { "axisCrossingValue": { "alias": "axisCrossingValue"; "required": false; }; "background": { "alias": "background"; "required": false; }; "baseUnit": { "alias": "baseUnit"; "required": false; }; "categories": { "alias": "categories"; "required": false; }; "color": { "alias": "color"; "required": false; }; "line": { "alias": "line"; "required": false; }; "majorGridLines": { "alias": "majorGridLines"; "required": false; }; "majorTicks": { "alias": "majorTicks"; "required": false; }; "majorUnit": { "alias": "majorUnit"; "required": false; }; "max": { "alias": "max"; "required": false; }; "min": { "alias": "min"; "required": false; }; "minorGridLines": { "alias": "minorGridLines"; "required": false; }; "minorTicks": { "alias": "minorTicks"; "required": false; }; "minorUnit": { "alias": "minorUnit"; "required": false; }; "name": { "alias": "name"; "required": false; }; "narrowRange": { "alias": "narrowRange"; "required": false; }; "pane": { "alias": "pane"; "required": false; }; "plotBands": { "alias": "plotBands"; "required": false; }; "reverse": { "alias": "reverse"; "required": false; }; "startAngle": { "alias": "startAngle"; "required": false; }; "type": { "alias": "type"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "weekStartDay": { "alias": "weekStartDay"; "required": false; }; "crosshair": { "alias": "crosshair"; "required": false; }; "labels": { "alias": "labels"; "required": false; }; "notes": { "alias": "notes"; "required": false; }; "title": { "alias": "title"; "required": false; }; }, {}, never, never, true, never>;
}