@progress/kendo-angular-charts 13.2.0-develop.5 → 13.2.0-develop.7

package/chart/axis-defaults/crosshair.component.d.ts

@@ -13,9 +13,26 @@ import * as i0 from "@angular/core";
 export declare class AxisDefaultsCrosshairComponent extends SettingsComponent implements AxisDefaultsCrosshair {
     configurationService: ConfigurationService;
     color: string;
+    /**
+     * The dash type of the crosshair.
+     * @default 'solid'
+     */
     dashType: DashType;
+    /**
+     * The opacity of the crosshair. By default, the crosshair is opaque.
+     * @default 1
+     */
     opacity: number;
+    /**
+     * If set to `true`, the Chart displays the axis crosshair.
+     * By default, the axis crosshair is not visible.
+     * @default false
+     */
     visible: boolean;
+    /**
+     * The width of the crosshair in pixels.
+     * @default 1
+     */
     width: number;
     tooltip: AxisDefaultsCrosshairTooltip;
     constructor(configurationService: ConfigurationService);

package/chart/axis-defaults/crosshair.tooltip.component.d.ts

@@ -17,9 +17,27 @@ export declare class AxisDefaultsCrosshairTooltipComponent extends SettingsCompo
     background: string;
     border: Border;
     color: string;
+    /**
+     * The tooltip font.
+     * @default '12px, sans-serif'
+     */
     font: string;
+    /**
+     * The format for displaying the tooltip. 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;
+    /**
+     * The padding of the crosshair tooltip. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the axis crosshair tooltip.
+     * By default, the axis crosshair tooltip is not visible.
+     * @default false
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<AxisDefaultsCrosshairTooltipComponent, never>;

package/chart/axis-defaults/labels.component.d.ts

@@ -14,14 +14,55 @@ import * as i0 from "@angular/core";
 export declare class AxisDefaultsLabelsComponent extends SettingsComponent implements AxisDefaultsLabels {
     configurationService: ConfigurationService;
     content: (e: AxisLabelContentArgs) => string;
+    /**
+     * The font style of the labels.
+     * @default '12px, sans-serif'
+     */
     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.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the labels. A numeric value sets all margins.
+     * @default 0
+     */
     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.
+     * @default false
+     */
     mirror: boolean;
+    /**
+     * The padding of the labels. A numeric value sets all paddings.
+     * @default 0
+     */
     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.
+     * @default 0
+     */
     rotation: LabelRotation | number | 'auto';
+    /**
+     * The number of labels to skip. By default, no labels are skipped.
+     * @default 0
+     */
     skip: number;
+    /**
+     * The label-rendering step&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     * @default 1
+     */
     step: number;
+    /**
+     * If set to `true`, the Chart displays the axis labels. By default, the axis labels are visible.
+     * @default true
+     */
     visible: boolean;
     visual: (e: AxisLabelVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);

package/chart/axis-defaults/title.component.d.ts

@@ -16,12 +16,36 @@ export declare class AxisDefaultsTitleComponent extends SettingsComponent implem
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font style of the title.
+     * @default 'bold 16px, sans-serif'
+     */
     font: string;
+    /**
+     * The margin of the title. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The padding of the title. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * The position of the title.
+     * @default 'center'
+     */
     position: AxisTitlePosition;
+    /**
+     * The rotation angle of the title. By default, the title is not rotated.
+     * @default 0
+     */
     rotation: number;
     text: string;
+    /**
+     * If set to `true`, the Chart displays the axis title. By default, the axis title is visible.
+     * @default true
+     */
     visible: boolean;
     visual: (e: TitleVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);

package/chart/axis-defaults.component.d.ts

@@ -24,11 +24,30 @@ export declare class AxisDefaultsComponent extends SettingsComponent implements
     majorTicks: AxisTicks;
     minorGridLines: GridLines;
     minorTicks: AxisTicks;
+    /**
+     * If set to `true`, the Chart prevents the axis range from snapping to zero.
+     * Setting it to `false`, forces the axis range to snap to zero.
+     * @default false
+     */
     narrowRange: boolean;
     pane: string;
     plotBands: PlotBand[];
+    /**
+     * If set to `true`, the axis direction is reversed. By default, categories are listed from left to
+     * right and from bottom to top.
+     * @default false
+     */
     reverse: boolean;
+    /**
+     * The angle (degrees) of the first category on the axis.
+     * Angles increase clockwise with zero to the left. Negative values are acceptable.
+     * @default 90
+     */
     startAngle: number;
+    /**
+     * If set to `true`, the Chart displays the axis.
+     * @default true
+     */
     visible: boolean;
     crosshair: AxisDefaultsCrosshair;
     labels: AxisDefaultsLabels;

package/chart/category-axis-item/crosshair.component.d.ts

@@ -13,9 +13,26 @@ import * as i0 from "@angular/core";
 export declare class CategoryAxisCrosshairComponent extends SettingsComponent implements CategoryAxisCrosshair {
     configurationService: ConfigurationService;
     color: string;
+    /**
+     * The dash type of the crosshair.
+     * @default 'solid'
+     */
     dashType: DashType;
+    /**
+     * The opacity of the crosshair. By default, the crosshair is opaque.
+     * @default 1
+     */
     opacity: number;
+    /**
+     * If set to `true`, the Chart displays the category axis crosshair.
+     * By default, the category axis crosshair is not visible.
+     * @default false
+     */
     visible: boolean;
+    /**
+     * The width of the crosshair in pixels.
+     * @default 1
+     */
     width: number;
     tooltip: CategoryAxisCrosshairTooltip;
     constructor(configurationService: ConfigurationService);

package/chart/category-axis-item/crosshair.tooltip.component.d.ts

@@ -16,9 +16,27 @@ export declare class CategoryAxisCrosshairTooltipComponent extends SettingsCompo
     background: string;
     border: Border;
     color: string;
+    /**
+     * The tooltip font.
+     * @default '12px, sans-serif'
+     */
     font: string;
+    /**
+     * The format used to display the tooltip. 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;
+    /**
+     * The padding of the crosshair tooltip. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the category axis crosshair tooltip.
+     * By default, the category axis crosshair tooltip is not visible.
+     * @default false
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisCrosshairTooltipComponent, never>;

package/chart/category-axis-item/labels.component.d.ts

@@ -20,16 +20,74 @@ export declare class CategoryAxisLabelsComponent extends SettingsComponent imple
     color: string;
     content: (e: AxisLabelContentArgs) => string;
     culture: string;
+    /**
+     * The format for displaying the labels of the date category axis.
+     * The `{0}` placeholder represents the category value.
+     * The Chart selects the appropriate format for the current [`categoryAxis.baseUnit`]({% slug api_charts_categoryaxis %}#toc-baseunit) option.
+     * Setting the [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#toc-format) option overrides the date formats.
+     * For more information, refer to the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     *
+     * For Radar Charts, the feature is not supported. Use [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#toc-format) instead.
+     * @default 'M/d'
+     */
     dateFormats: DateFormats;
+    /**
+     * The font style of the labels.
+     * @default '12px, sans-serif'
+     */
     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.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the labels. A numeric value sets all margins.
+     * @default 0
+     */
     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.
+     * @default false
+     */
     mirror: boolean;
+    /**
+     * The padding of the labels. A numeric value sets all paddings.
+     * @default 0
+     */
     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.
+     * @default 'onAxis'
+     */
     position: AxisLabelsPosition;
+    /**
+     * 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.
+     * @default 0
+     */
     rotation: LabelRotation | number | 'auto';
+    /**
+     * The number of labels to skip. By default, no labels are skipped.
+     * @default 0
+     */
     skip: number;
+    /**
+     * The rendering step of the label&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     * @default 1
+     */
     step: number;
+    /**
+     * If set to `true`, the Chart displays the category axis labels.
+     * By default, the category axis labels are visible.
+     * @default true
+     */
     visible: boolean;
     visual: (e: AxisLabelVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);

package/chart/category-axis-item/notes.label.component.d.ts

@@ -16,10 +16,32 @@ export declare class CategoryAxisNotesLabelComponent extends SettingsComponent i
     border: Border;
     color: string;
     content: (e: AxisNoteContentArgs) => string;
+    /**
+     * The font style of the label.
+     * @default '12px, sans-serif'
+     */
     font: string;
+    /**
+     * The format for displaying the notes label. 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;
+    /**
+     * The position of the label.
+     * @default "inside"
+     */
     position: NoteLabelPosition;
+    /**
+     * The rotation angle of the label. By default, the label is not rotated.
+     * @default 0
+     */
     rotation: number;
+    /**
+     * If set to `true`, the Chart displays the category notes label.
+     * By default, the category notes label is visible.
+     * @default true
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisNotesLabelComponent, never>;

package/chart/category-axis-item/title.component.d.ts

@@ -16,12 +16,37 @@ export declare class CategoryAxisTitleComponent extends SettingsComponent implem
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font style of the title.
+     * @default 'bold 16px, sans-serif'
+     */
     font: string;
+    /**
+     * The margin of the title. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The padding of the title. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * The position of the title.
+     * @default 'center'
+     */
     position: AxisTitlePosition;
+    /**
+     * The rotation angle of the title. By default, the title is not rotated.
+     * @default 0
+     */
     rotation: number;
     text: string;
+    /**
+     * If set to `true`, the Chart displays the category axis title.
+     * By default, the category axis title is visible.
+     * @default true
+     */
     visible: boolean;
     visual: (e: TitleVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);

package/chart/category-axis-item.component.d.ts

@@ -28,19 +28,57 @@ export declare class CategoryAxisItemComponent extends CollectionItemComponent i
     majorGridLines: GridLines;
     majorTicks: AxisTicks;
     max: any;
+    /**
+     * The maximum number of groups (categories) to display when
+     * [`categoryAxis.baseUnit`]({% slug api_charts_categoryaxis %}#toc-baseunit) is set to `"fit"` or
+     * [`categoryAxis.baseUnitStep`]({% slug api_charts_categoryaxis %}#toc-baseunitstep) is set to `"auto"`.
+     * @default 10
+     */
     maxDateGroups: number;
     maxDivisions: number;
     min: any;
     minorGridLines: GridLines;
     minorTicks: AxisTicks;
+    /**
+     * The unique axis name. Used to associate a series with a category axis,
+     * which utilizes the [`series.categoryAxis`]({% slug api_charts_series %}#toc-categoryaxis) option.
+     * @default 'primary'
+     */
     name: string;
     pane: string;
     plotBands: PlotBand[];
+    /**
+     * If set to `true`, the category axis direction is reversed.
+     * By default, categories are listed from left to right and from bottom to top.
+     * @default false
+     */
     reverse: boolean;
+    /**
+     * If set to `true`, the Chart rounds the first and last date to the nearest base unit.
+     * @default true
+     */
     roundToBaseUnit: boolean;
+    /**
+     * The angle (degrees) of the first category on the axis.
+     * Angles increase clockwise with zero to the left. Negative values are acceptable.
+     * @default 90
+     */
     startAngle: number;
+    /**
+     * The category axis type.
+     * The supported values include `category` for a discrete category axis and `date` for a specialized axis for displaying chronological data.
+     * @default 'category'
+     */
     type: 'category' | 'date';
+    /**
+     * If set to `true`, the Chart displays the category axis. By default, the category axis is visible.
+     * @default true
+     */
     visible: boolean;
+    /**
+     * The week start day when the `baseUnit` is set to `"weeks"`.
+     * @default 'Sunday'
+     */
     weekStartDay: WeekStartDay;
     crosshair: CategoryAxisCrosshair;
     labels: CategoryAxisLabels;

package/chart/chart-area.component.d.ts

@@ -14,11 +14,31 @@ import * as i0 from "@angular/core";
  */
 export declare class ChartAreaComponent extends SettingsComponent implements ChartArea {
     configurationService: ConfigurationService;
+    /**
+     * The background color of the Chart area. Accepts a valid CSS color string, including hex and rgb.
+     * @default 'white'
+     */
     background: string;
     border: Border;
+    /**
+     * The height of the Chart area.
+     * @default 400
+     */
     height: number;
+    /**
+     * The margin of the Chart area. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The background opacity of the Chart area. By default, the background is opaque.
+     * @default 1
+     */
     opacity: number;
+    /**
+     * The width of the Chart area.
+     * @default 600
+     */
     width: number;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<ChartAreaComponent, never>;

package/chart/legend.component.d.ts

@@ -12,18 +12,64 @@ import * as i0 from "@angular/core";
  */
 export declare class LegendComponent extends SettingsComponent implements Legend {
     configurationService: ConfigurationService;
+    /**
+     * The legend is horizontally aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"top"` or `"bottom"`.
+     * The legend is vertically aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"left"` or `"right"`.
+     * @default 'center'
+     */
     align: 'start' | 'center' | 'end';
+    /**
+     * The background color of the legend. Accepts a valid CSS color string, including hex and rgb.
+     * @default 'white'
+     */
     background: string;
     border: Border;
     height: number;
     labels: LegendLabels;
+    /**
+     * The margin of the Chart legend. A numeric value sets all paddings.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The X offset of the Chart legend. The offset is relative to the default position of the legend.
+     * For example, a value of `20` moves the legend 20 pixels to the right of its initial position.
+     * Negative values move the legend to the left of its current position.
+     * @default 0
+     */
     offsetX: number;
+    /**
+     * The Y offset of the chart legend. The offset is relative to the current position of the legend.
+     * For example, a value of `20` moves the legend 20 pixels down from its initial position.
+     * Negative values move the legend upwards from its current position.
+     * @default 0
+     */
     offsetY: number;
+    /**
+     * The orientation of the legend items.
+     * @default 'vertical'
+     */
     orientation: 'vertical' | 'horizontal';
+    /**
+     * The padding of the Chart legend. A numeric value sets all paddings.
+     * @default 5
+     */
     padding: Padding | number;
+    /**
+     * The positions of the Chart legend.
+     * Setting the legend position to `custom` allows you to position the legend using the [`legend.offsetX`](slug:api_charts_legend#toc-offsetx) and [`legend.offsetY`](slug:api_charts_legend#toc-offsety) options.
+     * @default 'right'
+     */
     position: 'top' | 'bottom' | 'left' | 'right' | 'custom';
+    /**
+     * If set to `true`, the legend items are reversed.
+     * @default false
+     */
     reverse: boolean;
+    /**
+     * If set to `true`, the Chart displays the legend. By default, the Chart legend is visible.
+     * @default true
+     */
     visible: boolean;
     width: number;
     markers: LegendMarkers;

package/chart/pane/title.component.d.ts

@@ -16,10 +16,28 @@ export declare class PanesTitleComponent extends SettingsComponent implements Pa
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font style of the title.
+     * @default '700 18px sans-serif'
+     */
     font: string;
+    /**
+     * The margin of the title. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The position of the title.
+     *
+     * The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
+     * @default 'center'
+     */
     position: 'left' | 'right' | 'center';
     text: string;
+    /**
+     * If set to `true`, the Chart displays the pane title.
+     * @default true
+     */
     visible: boolean;
     visual: (e: any) => drawing.Element;
     constructor(configurationService: ConfigurationService);

package/chart/pane-defaults/title.component.d.ts

@@ -15,9 +15,27 @@ export declare class PaneDefaultsTitleComponent extends SettingsComponent implem
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font style of the title.
+     * @default '16px sans-serif'
+     */
     font: string;
+    /**
+     * The margin of the title. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The position of the title.
+     *
+     * The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
+     * @default 'center'
+     */
     position: 'left' | 'right' | 'center';
+    /**
+     * If set to `true`, the Chart displays the pane title.
+     * @default true
+     */
     visible: boolean;
     visual: (e: any) => drawing.Element;
     constructor(configurationService: ConfigurationService);

package/chart/pane-defaults.component.d.ts

@@ -16,7 +16,15 @@ export declare class PaneDefaultsComponent extends SettingsComponent implements
     border: Border;
     clip: boolean;
     height: number;
+    /**
+     * The margin of the pane. A numeric value sets all margins.
+     * @default 0
+     */
     margin: Margin | number;
+    /**
+     * The padding of the pane. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
     title: PaneDefaultsTitle;
     constructor(configurationService: ConfigurationService);