@syncfusion/ej2-angular-charts 26.2.14 → 27.1.48

package/src/accumulation-chart/series.directive.d.ts

@@ -13,200 +13,218 @@ export declare class AccumulationSeriesDirective extends ComplexBase<Accumulatio
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Specify the type of the series in accumulation chart.
+     * Specifies the type of series in the accumulation chart.
      * @default 'Pie'
      */
     type: any;
     /**
-     * Options for customizing the animation for series.
+     * Options for customizing the animation of the series.
+     * By default, animation is enabled with a duration of 1000 milliseconds (about 1 second). It can be disabled by setting enable to `false`.
+     * The following properties are supported in animation:
+     * * enable: If set to true, the series is animated on initial loading.
+     * * duration: The duration of the animation in milliseconds.
+     * * delay: The delay before the animation starts, in milliseconds.
      */
     animation: any;
+    /**
+     * When set to true, a different pattern is applied to each slice of the pie.
+     * @default false
+     */
+    applyPattern: any;
     /**
      * Options for customizing the border of the series.
      */
     border: any;
     /**
-     * Defines the pattern of dashes and gaps to the series border.
+     * Option for customizing the border radius.
+     * @default 0
+     */
+    borderRadius: any;
+    /**
+     * Defines the pattern of dashes and gaps for the series border.
      * @default '0'
      */
     dashArray: any;
     /**
-     * The data label for the series.
+     * The data label property can be used to show the data label and customize its position and styling.
      */
     dataLabel: any;
     /**
-     * Specifies the dataSource for the series. It can be an array of JSON objects or an instance of DataManager.
+     * Specifies the data source for the series. It can be an array of JSON objects, or an instance of DataManager.
      *
      * @default ''
      */
     dataSource: any;
     /**
-     * Options to customize the empty points in series.
+     * Customization options for the appearance of empty points in the series, where `null` or `undefined` values are considered as empty points.
      */
     emptyPointSettings: any;
     /**
-     * To enable or disable tooltip for a series.
+     * Controls whether the tooltip for the accumulation chart series is enabled or disabled. Set to true to display tooltips on hover, or false to hide them.
      * @default true
      */
     enableTooltip: any;
     /**
-     * End angle for a series.
+     * Specifies the ending angle for the series, in degrees.
      * @default null
      */
     endAngle: any;
     /**
-     * If set true, series points will be exploded on mouse click or touch.
+     * If set to true, series points will explode on mouse click or touch.
      * @default false
      */
     explode: any;
     /**
-     * If set true, all the points in the series will get exploded on load.
+     * If set to true, all the points in the series will explode on load.
      * @default false
      */
     explodeAll: any;
     /**
-     * Index of the point, to be exploded on load.
+     * Index of the point in the series to be exploded on initial load.
      * @default null
      * @aspdefaultvalueignore
      * @blazordefaultvalue Double.NaN
      */
     explodeIndex: any;
     /**
-     * Distance of the point from the center, which takes values in both pixels and percentage.
+     * Specifies the distance of the point from the center, which can be defined in both pixels and percentage.
      * @default '30%'
      */
     explodeOffset: any;
     /**
-     * Defines the distance between the segments of a funnel/pyramid series. The range will be from 0 to 1
+     * Defines the distance between the segments of a funnel or pyramid series.
+     * The range is from 0 to 1.
      * @default 0
      */
     gapRatio: any;
     /**
-     * AccumulationSeries y values less than groupMode are combined into single slice named others.
+     * In the accumulation series, y-values less than `groupMode` are combined into a single slice named 'others'.
      * @default Value
      */
     groupMode: any;
     /**
-     * AccumulationSeries y values less than groupTo are combined into single slice named others.
+     * The y-values of the accumulation series that are less than `groupTo` are combined into a single slice named 'others'.
      * @default null
      */
     groupTo: any;
     /**
-     * Defines the height of the funnel/pyramid with respect to the chart area.
+     * Defines the height of the funnel or pyramid series relative to the chart area.
      * @default '80%'
      */
     height: any;
     /**
-     * When the innerRadius value is greater than 0 percentage, a donut will appear in pie series. It takes values only in percentage.
+     * When the `innerRadius` value is greater than 0%, a donut shape will appear in the pie series. It accepts only percentage values.
      * @default '0'
      */
     innerRadius: any;
     /**
-     * The URL for the Image that is to be displayed as a Legend icon.  It requires  `legendShape` value to be an `Image`.
+     * The URL for the image to be displayed as a legend icon.
+     * > Note that `legendShape` must be set to `Image`.
      * @default ''
      */
     legendImageUrl: any;
     /**
-     * The shape of the legend. Each series has its own legend shape. They are:
-     * * Circle - Renders a circle.
-     * * Rectangle - Renders a rectangle.
-     * * Triangle - Renders a triangle.
-     * * Diamond - Renders a diamond.
-     * * Cross - Renders a cross.
-     * * HorizontalLine - Renders a horizontalLine.
-     * * VerticalLine - Renders a verticalLine.
-     * * Pentagon - Renders a pentagon.
-     * * InvertedTriangle - Renders a invertedTriangle.
-     * * SeriesType -Render a legend shape based on series type.
-     * * Image -Render a image.   *
+     * Specifies the shape of the legend icon for each data point.
+     * Available shapes for legend:
+     * * Circle - Renders a circular icon.
+     * * Rectangle - Renders a rectangular icon.
+     * * Triangle - Renders a triangular icon.
+     * * Diamond - Renders a diamond-shaped icon.
+     * * Cross - Renders a cross-shaped icon.
+     * * HorizontalLine - Renders a horizontal line icon.
+     * * VerticalLine - Renders a vertical line icon.
+     * * Pentagon - Renders a pentagon-shaped icon.
+     * * InvertedTriangle - Renders an inverted triangle-shaped icon.
+     * * SeriesType - Uses the default icon shape based on the series type.
+     * * Image - Renders a custom image for the legend icon.
      * @default 'SeriesType'
      */
     legendShape: any;
     /**
-     * Specifies the series name.
+     * The `name` property allows for setting a name for the series.
      * @default ''
      */
     name: any;
     /**
-     * Defines the height of the funnel neck with respect to the chart area.
+     * Defines the height of the funnel neck relative to the chart area.
      * @default '20%'
      */
     neckHeight: any;
     /**
-     * Defines the width of the funnel neck with respect to the chart area.
+     * Defines the width of the funnel neck relative to the chart area.
      * @default '20%'
      */
     neckWidth: any;
     /**
-     * The opacity of the series.
+     * Sets the opacity of the series, with a value between 0 and 1 where 0 is fully transparent and 1 is fully opaque.
      * @default 1.
      */
     opacity: any;
     /**
-     * Palette for series points.
+     * The `palettes` array defines a set of colors used for rendering the accumulation chart's points. Each color in the array is applied to each point in order.
      * @default []
      */
     palettes: any;
     /**
-     * The DataSource field that contains the color value of point
-     * It is applicable for series
+     * The data source field that contains the color value of a point.
+     * It is applicable for series.
      * @default ''
      */
     pointColorMapping: any;
     /**
-     * Defines how the values have to be reflected, whether through height/surface of the segments.
+     * Defines how the values are represented, either through the height or surface area of the segments.
      * @default 'Linear'
      */
     pyramidMode: any;
     /**
-     * Specifies Query to select data from dataSource. This property is applicable only when the dataSource is `ej.DataManager`.
+     * Specifies a query to select data from the data source. This property is applicable only when the data source is an `ej.DataManager`.
      * @default null
      */
     query: any;
     /**
-     * Radius of the pie series and its values in percentage.
+     * Specifies the radius of the pie series as a percentage of the chart's size.
      * @default null
      */
     radius: any;
     /**
-     * Custom style for the selected series or points.
+     * The `selectionStyle` property is used to specify custom CSS styles for the selected series or points.
      * @default null
      */
     selectionStyle: any;
     /**
-     * Start angle for a series.
+     * Specifies the starting angle for the series, in degrees.
      * @default 0
      */
     startAngle: any;
     /**
-     * The provided value will be considered as a Tooltip Mapping name.
+     * The data source field that contains the value to be displayed in the tooltip.
      * @default ''
      */
     tooltipMappingName: any;
     /**
-     * Specifies the series visibility.
+     * If set to true, the series will be visible. If set to false, the series will be hidden.
      * @default true
      */
     visible: any;
     /**
-     * Defines the width of the funnel/pyramid with respect to the chart area.
+     * Defines the width of the funnel or pyramid series relative to the chart area.
      * @default '80%'
      */
     width: any;
     /**
-     * The DataSource field which contains the x value.
+     * The data source field that contains the x value.
      * @default ''
      */
     xName: any;
     /**
-     * The DataSource field which contains the y value.
+     * The data source field that contains the y value.
      * @default ''
      */
     yName: any;
     dataLabel_template: any;
     constructor(viewContainerRef: ViewContainerRef);
     static ɵfac: i0.ɵɵFactoryDeclaration<AccumulationSeriesDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AccumulationSeriesDirective, "e-accumulation-series-collection>e-accumulation-series", never, { "animation": "animation"; "border": "border"; "dashArray": "dashArray"; "dataLabel": "dataLabel"; "dataSource": "dataSource"; "emptyPointSettings": "emptyPointSettings"; "enableTooltip": "enableTooltip"; "endAngle": "endAngle"; "explode": "explode"; "explodeAll": "explodeAll"; "explodeIndex": "explodeIndex"; "explodeOffset": "explodeOffset"; "gapRatio": "gapRatio"; "groupMode": "groupMode"; "groupTo": "groupTo"; "height": "height"; "innerRadius": "innerRadius"; "legendImageUrl": "legendImageUrl"; "legendShape": "legendShape"; "name": "name"; "neckHeight": "neckHeight"; "neckWidth": "neckWidth"; "opacity": "opacity"; "palettes": "palettes"; "pointColorMapping": "pointColorMapping"; "pyramidMode": "pyramidMode"; "query": "query"; "radius": "radius"; "selectionStyle": "selectionStyle"; "startAngle": "startAngle"; "tooltipMappingName": "tooltipMappingName"; "type": "type"; "visible": "visible"; "width": "width"; "xName": "xName"; "yName": "yName"; }, {}, ["dataLabel_template"]>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AccumulationSeriesDirective, "e-accumulation-series-collection>e-accumulation-series", never, { "animation": "animation"; "applyPattern": "applyPattern"; "border": "border"; "borderRadius": "borderRadius"; "dashArray": "dashArray"; "dataLabel": "dataLabel"; "dataSource": "dataSource"; "emptyPointSettings": "emptyPointSettings"; "enableTooltip": "enableTooltip"; "endAngle": "endAngle"; "explode": "explode"; "explodeAll": "explodeAll"; "explodeIndex": "explodeIndex"; "explodeOffset": "explodeOffset"; "gapRatio": "gapRatio"; "groupMode": "groupMode"; "groupTo": "groupTo"; "height": "height"; "innerRadius": "innerRadius"; "legendImageUrl": "legendImageUrl"; "legendShape": "legendShape"; "name": "name"; "neckHeight": "neckHeight"; "neckWidth": "neckWidth"; "opacity": "opacity"; "palettes": "palettes"; "pointColorMapping": "pointColorMapping"; "pyramidMode": "pyramidMode"; "query": "query"; "radius": "radius"; "selectionStyle": "selectionStyle"; "startAngle": "startAngle"; "tooltipMappingName": "tooltipMappingName"; "type": "type"; "visible": "visible"; "width": "width"; "xName": "xName"; "yName": "yName"; }, {}, ["dataLabel_template"]>;
 }
 /**
  * AccumulationSeries Array Directive

package/src/chart/annotations.directive.d.ts

@@ -11,69 +11,73 @@ export declare class AnnotationDirective extends ComplexBase<AnnotationDirective
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Specifies the coordinate units of the annotation. They are
-     * * Pixel - Annotation renders based on x and y pixel value.
-     * * Point - Annotation renders based on x and y axis value.
+     * Specifies the coordinate units of the annotation.
+     * The options are:
+     * * Pixel - Renders the annotation based on x and y pixel values.
+     * * Point - Renders the annotation based on x and y axis values.
      * @default 'Pixel'
      */
     coordinateUnits: any;
     /**
-     * Information about annotation for assistive technology.
+     * A description for the annotation that provides additional information about its content for screen readers.
      * @default null
      */
     description: any;
     /**
-     * Specifies the alignment of the annotation. They are
-     * * Near - Align the annotation element as left side.
-     * * Far - Align the annotation element as right side.
-     * * Center - Align the annotation element as mid point.
+     * Specifies the alignment of the annotation.
+     * The options are:
+     * * Near - Aligns the annotation element to the left side.
+     * * Far - Aligns the annotation element to the right side.
+     * * Center - Aligns the annotation element to the midpoint.
      * @default 'Center'
      * @deprecated
      */
     horizontalAlignment: any;
     /**
-     * Specifies the regions of the annotation. They are
-     * * Chart - Annotation renders based on chart coordinates.
-     * * Series - Annotation renders based on series coordinates.
+     * Specifies the regions of the annotation.
+     * The options are:
+     * * Chart - Renders the annotation based on chart coordinates.
+     * * Series - Renders the annotation based on series coordinates.
      * @default 'Chart'
      */
     region: any;
     /**
-     * Specifies the position of the annotation. They are
-     * * Top - Align the annotation element as top side.
-     * * Bottom - Align the annotation element as bottom side.
-     * * Middle - Align the annotation element as mid point.
+     * Specifies the position of the annotation.
+     * The options are
+     * * Top - Aligns the annotation element to the top side.
+     * * Bottom - Aligns the annotation element to the bottom side.
+     * * Middle - Aligns the annotation element to the midpoint.
      * @default 'Middle'
      * @deprecated
      */
     verticalAlignment: any;
     /**
-     * if set coordinateUnit as `Pixel` X specifies the axis value
-     * else is specifies pixel or percentage of coordinate
+     * If `coordinateUnit` is set to `Pixel`, x specifies the pixel value.
+     * If `coordinateUnit` is set to `Point`, x specifies the axis value.
      * @default '0'
      * @asptype object
      */
     x: any;
     /**
-     * The name of horizontal axis associated with the annotation.
-     * It requires `axes` of chart.
+     * The name of the horizontal axis associated with the annotation.
+     * Requires the `axes` of the chart.
      * @default null
      */
     xAxisName: any;
     /**
-     * if set coordinateUnit as `Pixel` Y specifies the axis value
-     * else is specifies pixel or percentage of coordinate
+     * If `coordinateUnit` is set to `Pixel`, y specifies the pixel value.
+     * If `coordinateUnit` is set to `Point`, y specifies the axis value.
      * @default '0'
      */
     y: any;
     /**
-     * The name of vertical axis associated with the annotation.
-     * It requires `axes` of chart.
+     * The name of the vertical axis associated with the annotation.
+     * Requires the `axes` of the chart.
      * @default null
      */
     yAxisName: any;
     /**
-     * Content of the annotation, which accepts the id of the custom element.
+     * The content of the annotation, which also accepts the ID of the custom element.
      * @default null
      */
     content: any;