@progress/kendo-angular-charts 13.2.0-develop.6 → 13.2.0-develop.8

package/chart/pane.component.d.ts

@@ -12,57 +12,16 @@ import * as i0 from "@angular/core";
  * The configuration component for a Chart pane.
  *
  * @example
- * ```ts
- * import { Component } from '@angular/core';
- *
- * _@Component({
- *   selector: 'my-app',
- *   template: `
- *       <kendo-chart>
- *         <kendo-chart-panes>
- *             <kendo-chart-pane name="top" background="pink" [border]="{ color: 'black', dashtype: 'dash', width: 2 }">
- *               <!--            ^^^^^^^^^^
- *                   Unique ID for the pane.
- *               -->
- *             </kendo-chart-pane>
- *             <kendo-chart-pane name="bottom" [height]="150" title="Bottom pane">
- *               <!--                          ^^^^^^^^^^^^^^
- *                   Note that the binding is required,
- *                   otherwise the property will be
- *                   bound to a '100' string.
- *               -->
- *             </kendo-chart-pane>
- *         </kendo-chart-panes>
- *
- *         <kendo-chart-value-axis>
- *             <kendo-chart-value-axis-item name="top">
- *               <!--                       ^^^^^^^^^^
- *                   Unique ID for the axis.
- *                   No need to set a pane as it will use the first,
- *                   'top' pane by default.
- *               -->
- *             </kendo-chart-value-axis-item>
- *             <kendo-chart-value-axis-item name="bottom"
- *                                          pane="bottom">
- *               <!--                       ^^^^^^^^^^^^^
- *                   Move the axis to the bottom pane.
- *               -->
- *             </kendo-chart-value-axis-item>
- *         </kendo-chart-value-axis>
- *         <kendo-chart-series>
- *           <kendo-chart-series-item [data]="seriesData[0]">
- *               <!-- Will use the first, 'top' value axis by default. -->
- *           </kendo-chart-series-item>
- *           <kendo-chart-series-item type="line" [data]="seriesData[1]" axis="bottom">
- *               <!-- Plot this series to the 'bottom' axis.              ^^^^^^^^^^^^^ -->
- *           </kendo-chart-series-item>
- *         </kendo-chart-series>
- *       </kendo-chart>
- *   `
- * })
- * export class AppComponent {
- *   public seriesData: number[][] = [[1, 2, 3, 5], [0, 1, 0, 1]];
- * }
+ * ```html
+ * <kendo-chart>
+ *   <kendo-chart-panes>
+ *     <kendo-chart-pane
+ *         name="top"
+ *         background="pink"
+ *         [border]="{ color: 'black', dashType: 'dash', width: 2 }">
+ *     </kendo-chart-pane>
+ *   </kendo-chart-panes>
+ * </kendo-chart>
  * ```
  */
 export declare class PaneComponent extends CollectionItemComponent implements Pane {
@@ -72,8 +31,16 @@ export declare class PaneComponent extends CollectionItemComponent implements Pa
     border: Border;
     clip: boolean;
     height: number;
+    /**
+     * The margin of the pane. A numeric value sets all margins.
+     * @default 0
+     */
     margin: Margin | number;
     name: string;
+    /**
+     * The padding of the pane. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
     title: string | PanesTitle;
     constructor(configurationService: ConfigurationService, collectionService: CollectionService);

package/chart/panes.component.d.ts

@@ -11,38 +11,14 @@ import * as i0 from "@angular/core";
  * A collection of one or more pane configuration components.
  *
  * @example
- * ```ts
- * import { Component } from '@angular/core';
- *
- * _@Component({
- *   selector: 'my-app',
- *   template: `
- *     <kendo-chart>
- *       <kendo-chart-panes>
- *         <kendo-chart-pane name="topPane">
- *         </kendo-chart-pane>
- *         <kendo-chart-pane name="bottomPane">
- *         </kendo-chart-pane>
- *       </kendo-chart-panes>
- *       <kendo-chart-value-axis>
- *         <kendo-chart-value-axis-item pane="topPane">
- *         </kendo-chart-value-axis-item>
- *         <kendo-chart-value-axis-item name="bottomAxis" pane="bottomPane">
- *         </kendo-chart-value-axis-item>
- *       </kendo-chart-value-axis>
- *       <kendo-chart-series>
- *         <kendo-chart-series-item type="line" [data]="[1, 2, 3]">
- *         </kendo-chart-series-item>
- *         <kendo-chart-series-item type="line" [data]="[1, 2, 3, 4]"
- *                                  axis="bottomAxis">
- *         </kendo-chart-series-item>
- *       </kendo-chart-series>
- *     </kendo-chart>
- *   `
- * })
- * class AppComponent {
- * }
- *
+ * ```html
+ * <kendo-chart>
+ *   <kendo-chart-panes>
+ *     <kendo-chart-pane name="topPane"></kendo-chart-pane>
+ *     <kendo-chart-pane name="bottomPane"></kendo-chart-pane>
+ *   </kendo-chart-panes>
+ *   ...
+ * </kendo-chart>
  * ```
  */
 export declare class PanesComponent extends CollectionComponent {

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

@@ -14,10 +14,28 @@ import * as i0 from "@angular/core";
  */
 export declare class PlotAreaComponent extends SettingsComponent implements PlotArea {
     configurationService: ConfigurationService;
+    /**
+     * The background color of the Chart plot area.
+     * Accepts a valid CSS color string, including HEX and RGB.
+     * @default 'white'
+     */
     background: string;
     border: Border;
+    /**
+     * The margin of the plot area. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The background opacity of the plot area. By default, the background is opaque.
+     * @default 1
+     */
     opacity: number;
+    /**
+     * The padding of the plot area. A numeric value sets all paddings.
+     * The default padding for the Pie, Donut, Radar, and Polar Charts is proportional of the Chart size.
+     * @default 5
+     */
     padding: Padding | number;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<PlotAreaComponent, never>;

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

@@ -17,10 +17,30 @@ export declare class SeriesDefaultsLabelsComponent extends SettingsComponent imp
     border: Border;
     color: string;
     content: (e: SeriesLabelsContentArgs) => string;
+    /**
+     * The font style of the labels.
+     * @default '12px sans-serif'
+     */
     font: string;
+    /**
+     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the labels. A numeric value sets all margins.
+     * @default 0
+     */
     margin: Margin | number;
+    /**
+     * The padding of the labels. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the series labels.
+     * @default false
+     */
     visible: boolean;
     visual: (e: SeriesLabelsVisualArgs) => drawing.Element;
     from: SeriesDefaultsLabelsFrom;

package/chart/series-defaults/labels.from.component.d.ts

@@ -16,10 +16,30 @@ export declare class SeriesDefaultsLabelsFromComponent extends SettingsComponent
     border: Border;
     color: string;
     content: (e: SeriesLabelsContentArgs) => string;
+    /**
+     * The font style of the from labels.
+     * @default '12px sans-serif'
+     */
     font: string;
+    /**
+     * The format of the `from` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) of `IntlService`.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the `from` labels. A numeric value sets all margins.
+     * @default 0
+     */
     margin: Margin | number;
+    /**
+     * The padding of the `from` labels. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the series `from` labels.
+     * @default false
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsLabelsFromComponent, never>;

package/chart/series-defaults/labels.to.component.d.ts

@@ -16,10 +16,30 @@ export declare class SeriesDefaultsLabelsToComponent extends SettingsComponent i
     border: Border;
     color: string;
     content: (e: SeriesLabelsContentArgs) => string;
+    /**
+     * The font style of the `to` labels.
+     * @default '12px sans-serif"'
+     */
     font: string;
+    /**
+     * The format of the `to` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the `to` labels. A numeric value sets all margins.
+     * @default 0
+     */
     margin: Margin | number;
+    /**
+     * The padding of the `to` labels. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the `to` labels of the series.
+     * @default false
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsLabelsToComponent, never>;

package/chart/series-defaults/notes.icon.component.d.ts

@@ -15,7 +15,15 @@ export declare class SeriesDefaultsNotesIconComponent extends SettingsComponent
     background: string;
     border: Border;
     size: number;
+    /**
+     * The shape of the notes icon.
+     * @default 'circle'
+     */
     type: MarkerType;
+    /**
+     * The visibility of the notes icon.
+     * @default true
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsNotesIconComponent, never>;

package/chart/series-defaults/notes.label.component.d.ts

@@ -16,10 +16,31 @@ export declare class SeriesDefaultsNotesLabelComponent extends SettingsComponent
     border: Border;
     color: string;
     content: (e: SeriesNoteContentArgs) => 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 axis value.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The position of the labels.
+     * @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 [`seriesDefaults`]({% slug api_charts_seriesdefaults %}) notes label.
+     * @default true
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsNotesLabelComponent, never>;

package/chart/series-defaults/tooltip.component.d.ts

@@ -15,9 +15,21 @@ export declare class SeriesDefaultsTooltipComponent extends SettingsComponent im
     background: string;
     border: Border;
     color: string;
+    /**
+     * The tooltip font.
+     * @default '12px sans serif'
+     */
     font: string;
     format: string;
+    /**
+     * The padding of the tooltip. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the series tooltip.
+     * @default false
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsTooltipComponent, never>;

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

@@ -15,10 +15,26 @@ import * as i0 from "@angular/core";
 export declare class SeriesDefaultsComponent extends SettingsComponent implements SeriesDefaults {
     configurationService: ConfigurationService;
     border: Border;
+    /**
+     * The distance between category clusters.
+     * @default 1.5
+     */
     gap: number;
     highlight: SeriesHighlight;
     overlay: Overlay;
+    /**
+     * The space between the Chart series as a proportion of the series width.
+     * The `spacing` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
+     * and `"waterfall"`.
+     * @default 0.4
+     */
     spacing: number;
+    /**
+     * A Boolean value which indicates if the series has to be stacked.
+     * The stack option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
+     * `"verticalLine"`, `"verticalArea"`, `"radarLine"`, `"radarArea"`, and `"radarColumn"`.
+     * @default false
+     */
     stack: boolean | string | SeriesStack;
     type: SeriesType;
     visual: (e: SeriesVisualArgs) => drawing.Element;

package/chart/series-item/error-bars.component.d.ts

@@ -15,6 +15,10 @@ import * as i0 from "@angular/core";
 export declare class SeriesErrorBarsComponent extends SettingsComponent implements SeriesErrorBars {
     configurationService: ConfigurationService;
     color: string;
+    /**
+    * If set to `false`, the caps of the error bars are not displayed. By default, the caps are visible.
+    * @default true
+    */
     endCaps: boolean;
     line: ErrorBarLine;
     value: string;

package/chart/series-item/extremes.component.d.ts

@@ -17,7 +17,15 @@ export declare class SeriesExtremesComponent extends SettingsComponent implement
     background: string;
     border: Border;
     rotation: number;
+    /**
+    * The extremes size in pixels.
+    * @default 6
+    */
     size: number;
+    /**
+    * The shape of the series extremes.
+    * @default 'circle'
+    */
     type: MarkerType;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesExtremesComponent, never>;

package/chart/series-item/highlight.component.d.ts

@@ -19,6 +19,10 @@ export declare class SeriesHighlightComponent extends SettingsComponent implemen
     markers: MarkersHighlight;
     opacity: number;
     toggle: (e: HighlightToggleArgs) => void;
+    /**
+    * If set to `true`, the Chart highlights the series when the user hovers over it with the mouse.
+    * @default true
+    */
     visible: boolean;
     visual: (e: HighlightVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);

package/chart/series-item/labels.component.d.ts

@@ -19,16 +19,41 @@ export declare class SeriesLabelsComponent extends SettingsComponent implements
     border: Border;
     color: string;
     content: (e: SeriesLabelsContentArgs) => string;
+    /**
+     * The distance between the labels when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
+     * @default 35
+     */
     distance: number;
+    /**
+     * The font style of the labels.
+     * @default '12px sans-serif'
+     */
     font: string;
+    /**
+     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of the `IntlService`.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the labels. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The padding of the labels. A numeric value sets all paddings.
+     * Bar and Column series always apply full padding and ignore this setting.
+     * @default 0
+     */
     padding: Padding | number;
     /**
      * The position of the labels.
      */
     position: SeriesLabelsPosition;
     rotation: number;
+    /**
+     * If set to `true`, the Chart displays the series labels.
+     * @default false
+     */
     visible: boolean;
     visual: (e: SeriesLabelsVisualArgs) => drawing.Element;
     from: SeriesLabelsFrom;

package/chart/series-item/labels.from.component.d.ts

@@ -16,11 +16,31 @@ export declare class SeriesLabelsFromComponent extends SettingsComponent impleme
     border: Border;
     color: string;
     content: (e: SeriesLabelsContentArgs) => string;
+    /**
+     * The font style of the `from` labels.
+     * @default '12px sans-serif'
+     */
     font: string;
+    /**
+     * The format of the `from` labels. Uses the `IntlService` [`format`]({% slug api_intl_intlservice %}#toc-format) method.
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the `from` labels. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The padding of the `from` labels. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
     position: 'center' | 'insideBase' | 'insideEnd' | 'outsideEnd';
+    /**
+     * If set to `true`, the Chart displays the series `from` labels.
+     * @default false
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesLabelsFromComponent, never>;

package/chart/series-item/labels.to.component.d.ts

@@ -16,11 +16,31 @@ export declare class SeriesLabelsToComponent extends SettingsComponent implement
     border: Border;
     color: string;
     content: (e: SeriesLabelsContentArgs) => string;
+    /**
+     * The font style of the `to` labels.
+     * @default '12px sans-serif'
+     */
     font: string;
+    /**
+     * The format of the `to` labels. Uses [IntlService format]({% slug api_intl_intlservice %}#toc-format).
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The margin of the `to` labels. A numeric value sets all margins.
+     * @default 5
+     */
     margin: Margin | number;
+    /**
+     * The padding of the `to` labels. A numeric value sets all paddings.
+     * @default 0
+     */
     padding: Padding | number;
     position: 'center' | 'insideBase' | 'insideEnd' | 'outsideEnd';
+    /**
+     * If set to `true`, the Chart displays the series `to` labels.
+     * @default false
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesLabelsToComponent, never>;

package/chart/series-item/markers.component.d.ts

@@ -78,8 +78,20 @@ export declare class SeriesMarkersComponent extends SettingsComponent implements
     background: string;
     border: Border;
     rotation: number;
+    /**
+     * The marker size in pixels.
+     * @default 6
+     */
     size: number;
+    /**
+     * The shape of the series markers.
+     * @default 'cirlce'
+     */
     type: MarkerType;
+    /**
+     * If set to `true`, the Chart displays the series markers.
+     * @default true
+     */
     visible: boolean;
     visual: (e: MarkersVisualArgs) => drawing.Element;
     from: SeriesMarkers;

package/chart/series-item/notes.icon.component.d.ts

@@ -15,7 +15,17 @@ export declare class SeriesNotesIconComponent extends SettingsComponent implemen
     background: string;
     border: Border;
     size: number;
+    /**
+     * The icon shape.
+     *
+     * @default 'circle'
+     */
     type: MarkerType;
+    /**
+     * The visibility of the notes icon.
+     *
+     * @default true
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesNotesIconComponent, never>;

package/chart/series-item/notes.label.component.d.ts

@@ -16,10 +16,36 @@ export declare class SeriesNotesLabelComponent extends SettingsComponent impleme
     border: Border;
     color: string;
     content: (e: SeriesNoteContentArgs) => 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 axis value.
+     *
+     * @default '{0}'
+     */
     format: string;
+    /**
+     * The position of the labels.
+     *
+     * @default 'inside'
+     */
     position: NoteLabelPosition;
+    /**
+     * The rotation angle of the label.
+     *
+     * @default 0
+     */
     rotation: number;
+    /**
+     * If set to `true`, the Chart displays the series notes label.
+     *
+     * @default true
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesNotesLabelComponent, never>;

package/chart/series-item/outliers.component.d.ts

@@ -17,7 +17,17 @@ export declare class SeriesOutliersComponent extends SettingsComponent implement
     background: string;
     border: Border;
     rotation: number;
+    /**
+     * The marker size in pixels.
+     *
+     * @default 6
+     */
     size: number;
+    /**
+     * The outliers shape.
+     *
+     * @default 'circle'
+     */
     type: MarkerType;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesOutliersComponent, never>;

package/chart/series-item/tooltip.component.d.ts

@@ -17,9 +17,17 @@ export declare class SeriesTooltipComponent extends SettingsComponent implements
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font of the tooltip.
+     * @default '12px sans-serif'
+     */
     font: string;
     format: string;
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the series tooltip.
+     * @default false
+     */
     visible: boolean;
     seriesTooltipTemplate: TemplateRef<any>;
     constructor(configurationService: ConfigurationService);