@syncfusion/ej2-angular-charts 26.2.14 → 27.1.48

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

@@ -16,229 +16,243 @@ export declare class SeriesDirective extends ComplexBase<SeriesDirective> {
     childSegments: any;
     tags: string[];
     /**
-     * The type of the series are:
-     * * Line
-     * * Column
-     * * Area
-     * * Bar
-     * * Histogram
-     * * StackingColumn
-     * * StackingArea
-     * * StackingBar
-     * * StepLine
-     * * StepArea
-     * * Scatter
-     * * Spline
-     * * StackingColumn100
-     * * StackingBar100
-     * * StackingArea100
-     * * RangeColumn
-     * * Hilo
-     * * HiloOpenClose
-     * * Waterfall
-     * * RangeArea
-     * * SplineRangeArea
-     * * Bubble
-     * * Candle
-     * * Polar
-     * * Radar
-     * * BoxAndWhisker
-     * * Pareto
+     * The type of the series determines the visual representation of the data.
+     * Available series types include:
+     * * Line - Draws a line series.
+     * * Column - Draws a column series.
+     * * Area - Draws an area series.
+     * * Bar - Draws a bar series.
+     * * Histogram - Draws a histogram series.
+     * * StackingColumn - Draws a stacking column series.
+     * * StackingArea - Draws a stacking area series.
+     * * StackingBar - Draws a stacking bar series.
+     * * StepLine - Draws a step line series.
+     * * StepArea - Draws a step area series.
+     * * Scatter - Draws a scatter series.
+     * * Spline - Draws a spline series.
+     * * StackingColumn100 - Draws a 100% stacked column series.
+     * * StackingBar100 - Draws a 100% stacked bar series.
+     * * StackingArea100 - Draws a 100% stacked area series.
+     * * RangeColumn - Draws a range column series.
+     * * Hilo - Draws a Hilo series.
+     * * HiloOpenClose - Draws a Hilo Open Close series.
+     * * Waterfall - Draws a waterfall series.
+     * * RangeArea - Draws a range area series.
+     * * SplineRangeArea - Draws a spline range area series.
+     * * Bubble - Draws a bubble series.
+     * * Candle - Draws a candle series.
+     * * Polar - Draws a polar series.
+     * * Radar - Draws a radar series.
+     * * BoxAndWhisker - Draws a box and whisker series.
+     * * Pareto - Draws a Pareto series.
      * @default 'Line'
      */
     type: any;
     /**
-     * Options for customizing animation for the 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;
     /**
-     * This property is used in financial charts to visualize the price movements in stock.
-     * It defines the color of the candle/point, when the opening price is less than the closing price.
+     * This property is used in financial charts to visualize price movements in stocks.
+     * It defines the color of the candle/point when the opening price is less than the closing price.
      * @default null
      */
     bearFillColor: any;
     /**
-     * The bin interval of each histogram point.
+     * The `binInterval` property controls the width of each bin and the interval between bins for histogram points.
      * @default null
      * @aspdefaultvalueignore
      */
     binInterval: any;
     /**
-     * Options for customizing the border of the series. This is applicable only for `Column` and `Bar` type series.
+     * Options for customizing the border of the series.
+     * > Note that this property is applicable only for `Column` and `Bar` type series.
      */
     border: any;
     /**
-     * The mode of the box and whisker char series. They are,
-     * Exclusive
-     * Inclusive
-     * Normal
+     * Specifies the box plot mode for the box and whisker chart series.
+     * The available modes are:
+     * Exclusive - Renders the series based on the exclusive mode.
+     * Inclusive - Renders the series based on the inclusive mode.
+     * Normal - Renders the series based on the normal mode.
      * @default 'Normal'
      */
     boxPlotMode: any;
     /**
-     * This property is used in financial charts to visualize the price movements in stock.
-     * It defines the color of the candle/point, when the opening price is higher than the closing price.
+     * This property is used in financial charts to visualize price movements in stocks.
+     * It defines the color of the candle/point when the opening price is higher than the closing price.
      * @default null
      */
     bullFillColor: any;
     /**
-     * It defines tension of cardinal spline types.
+     * Specifies the tension parameter for cardinal splines. This affects the curvature of the spline.
      * @default 0.5
      */
     cardinalSplineTension: any;
     /**
-     * The DataSource field that contains the close value of y.
-     * It is applicable for both series and technical indicators
+     * The data source field that contains the close value.
+     * It is applicable for both financial series and technical indicators.
      * @default ''
      */
     close: any;
     /**
-     * The DataSource field that contains the color mapping value.
-     * It is applicable for range color mapping properly.
+     * The data source field that contains the color mapping value.
+     * It is applicable for range color mapping.
      */
     colorName: any;
     /**
      * Defines the shape of the data in a column and bar chart.
-     * * Rectangle: Displays the data in a column and bar chart in a rectangle shape.
-     * * Cylinder: Displays the data in a column and bar chart in a cylinder shape.
+     * Available shapes are:
+     * * Rectangle: Displays the data in a column and bar chart with a rectangular shape.
+     * * Cylinder: Displays the data in a column and bar chart with a cylindrical shape.
      * @default 'Rectangle'
      */
     columnFacet: any;
     /**
-     * To render the column series points with particular column spacing. It takes value from 0 - 1.
+     * This property determines the space between columns in a column or bar chart.
+     * > Note that it takes a value from 0 to 1.
      * @default 0
      */
     columnSpacing: any;
     /**
-     * Render the column series points with a particular column width. If the series type is histogram the
-     * default value is 1 otherwise 0.7.
+     * The `columnWidth` property can be used to customize the width of the columns in a column series.
+     * > Note that if the series type is histogram, the default value is 1; otherwise, it is 0.7.
      * @default null
      * @aspdefaultvalueignore
      * @blazordefaultvalue Double.NaN
      */
     columnWidth: any;
     /**
-     * To render the column series points with particular column width as pixel.
+     * To render the column series points with a specific column width in pixels.
      * @default null
      * @aspdefaultvalueignore
      * @blazordefaultvalue Double.NaN
      */
     columnWidthInPixel: any;
     /**
-     * Defines the appearance of line connecting adjacent points in waterfall charts.
+     * Specifies the appearance of the line connecting adjacent points in waterfall charts.
      */
     connector: any;
     /**
-     * To render the column series points with particular rounded corner.
+     * The `cornerRadius` property specifies the radius for the corners of the column series points to create a rounded appearance in the chart.
      */
     cornerRadius: any;
     /**
-     * Defines the pattern of dashes and gaps to stroke the lines in `Line` type series.
+     * Defines the pattern of dashes and gaps used to stroke the lines in `Line` type series.
      * @default ''
      */
     dashArray: any;
     /**
-     * Specifies the data source 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 drag settings for series
+     * Customize the drag settings for the series with this property to configure drag behavior in the chart.
      */
     dragSettings: any;
     /**
-     * Type of series to be drawn in radar or polar series. They are:
-     * * 'Line'
-     * * 'Column'
-     * * 'Area'
-     * * 'Scatter'
-     * * 'Spline'
-     * * 'StackingColumn'
-     * * 'StackingArea'
-     * * 'RangeColumn'
-     * * 'SplineArea'
+     * Specifies the type of series to be drawn in radar or polar charts.
+     * The available options are:
+     * * 'Line' - Renders a line series.
+     * * 'Column' - Renders a column series.
+     * * 'Area' - Renders an area series.
+     * * 'Scatter' - Renders a scatter series.
+     * * 'Spline' - Renders a spline series.
+     * * 'StackingColumn' - Renders a stacking column series.
+     * * 'StackingArea' - Renders a stacking area series.
+     * * 'RangeColumn' - Renders a range column series.
+     * * 'SplineArea' - Renders a spline area series.
      * @default 'Line'
      */
     drawType: any;
     /**
-     * Options to customize the empty points in series.
+     * Customization options for the appearance of empty points in the series.
+     * `null` or `undefined` values are considered empty points.
      */
     emptyPointSettings: any;
     /**
-     * This property is used to improve chart performance via data mapping for series dataSource.
+     * This property is used to improve chart performance through data mapping for the series data source.
      * @default false
      */
     enableComplexProperty: any;
     /**
-     * This property is applicable for candle series.
-     * It enables/disables to visually compare the current values with the previous values in stock.
+     * This property is applicable for the candle series.
+     * It enables or disables the visual comparison of the current values with previous values in stock charts.
      * @default false
      */
     enableSolidCandles: any;
     /**
-     * Enable tooltip for the chart series.
+     * Controls whether the tooltip for the chart series is enabled or disabled. Set to true to display tooltips on hover, or false to hide them.
      * @default true
      */
     enableTooltip: any;
     /**
-     * Options for displaying and customizing error bar for individual points in a series.
+     * Options for displaying and customizing error bars for individual points in a series.
      */
     errorBar: any;
     /**
-     * The fill color for the series, which can accept values in hex or rgba as a valid CSS color string.
+     * The fill color for the series, which accepts values in hex or rgba as a valid CSS color string.
      * It also represents the color of the signal lines in technical indicators.
-     * For technical indicators, the default value is 'blue' and for series, it is null.
+     * For technical indicators, the default value is 'blue', and for series, it is null.
      * @default null
      */
     fill: any;
     /**
      * Defines the name that specifies the chart series are mutually exclusive and can be overlaid.
-     * The axis in the same group shares the same baseline and location on the corresponding axis.
+     * Series in the same group share the same baseline and location on the corresponding axis.
      * @default ''
      */
     groupName: any;
     /**
-     * The DataSource field that contains the high value of y.
-     * It is applicable for both series and technical indicators.
+     * The data source field that contains the high value.
+     * It is applicable for both financial series and technical indicators.
      * @default ''
      */
     high: any;
     /**
-     * Defines the collection of indexes of the intermediate summary columns in waterfall charts.
+     * Defines the collection of indexes for the intermediate summary columns in waterfall charts.
      * @default []
      * @asptype int[]
      */
     intermediateSumIndexes: any;
     /**
-     * Specifies whether to join the start and end point of a line/area series used in polar/radar chart to form a closed path.
+     * Specifies whether to join the start and end points of a line/area series used in a polar/radar chart to form a closed path.
      * @default true
      */
     isClosed: 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, which can be one of the following:
-     * * Circle
-     * * Rectangle
-     * * Triangle
-     * * Diamond
-     * * Cross
-     * * HorizontalLine
-     * * VerticalLine
-     * * Pentagon
-     * * InvertedTriangle
-     * * SeriesType
-     * * Image
+     * Specifies the shape of the legend icon for each series.
+     * 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;
     /**
-     * The DataSource field that contains the low value of y
-     * It is applicable for series and technical indicators
+     * The data source field that contains the low value.
+     * It is applicable for both financial series and technical indicators.
      * @default ''
      */
     low: any;
@@ -247,98 +261,109 @@ export declare class SeriesDirective extends ComplexBase<SeriesDirective> {
      */
     marker: any;
     /**
-     * Specifies the maximum radius.
+     * Specifies the maximum radius for the data points in the series.
      * @default 3
      */
     maxRadius: any;
     /**
-     * Specifies the minimum radius.
+     * Specifies the minimum radius for the data points in the series.
      * @default 1
      */
     minRadius: any;
     /**
-     * The name of the series as displayed in the legend.
+     * The `name` property allows setting a name for the series, which will be displayed in the legend, identifying different series in the chart, especially when multiple series are present.
      * @default ''
      */
     name: any;
     /**
-     * Defines the visual representation of the negative changes in waterfall charts.
+     * Defines the visual representation of negative changes in waterfall charts.
      * @default '#C64E4A'
      */
     negativeFillColor: any;
     /**
-     * Custom style for the non-highlighted series or points.
+     * When set to true, the step series will be rendered without the vertical lines (risers) connecting the horizontal steps.
+     * > Note this property is only applicable to step series.
+     * @default false
+     */
+    noRisers: any;
+    /**
+     * The `nonHighlightStyle` property is used to specify custom CSS styles for the non-highlighted series or points.
      * @default null
      */
     nonHighlightStyle: 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;
     /**
-     * The DataSource field that contains the open value of y
-     * It is applicable for series and technical indicators
+     * The data source field that contains the open value.
+     * It is applicable for both financial series and technical indicators.
      * @default ''
      */
     open: any;
     /**
-     * Options for customizing the pareto line series.
+     * Options for customizing the Pareto line series, including its appearance and behavior in the chart.
      */
     paretoOptions: any;
     /**
-     * The DataSource field that contains the color value of a point.
+     * The data source field that contains the color value of a point.
      * It is applicable for series.
      * @default ''
      */
     pointColorMapping: any;
     /**
-     * Specifies a query to select data from the DataSource. This property is applicable only when the DataSource is an `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 ''
      */
     query: any;
     /**
-     * Defines the axis, based on which the line series will be split.
+     * Defines the axis along which the line series will be split.
      */
     segmentAxis: any;
     /**
-     * Defines the collection of regions that helps to differentiate a line series.
+     * Specifies a collection of regions used to differentiate a line series.
      */
     segments: 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;
     /**
-     * If set to true, the mean value for box and whisker will be visible.
+     * If set to true, the mean value for the box and whisker plot will be visible.
      * @default true
      */
     showMean: any;
     /**
-     * The normal distribution of histogram series.
+     * Specifies whether to display the normal distribution curve for the histogram series.
      * @default false
      */
     showNormalDistribution: any;
     /**
-     * The DataSource field that contains the size value of y.
+     * The data source field that contains the size value for the y-axis.
      * @default ''
      */
     size: any;
     /**
-     * Defines the type of spline to be rendered.
+     * Specifies the type of spline used for rendering.
+     * Available options include:
+     * * Natural - Renders a natural spline.
+     * * Cardinal - Renders a cardinal spline.
+     * * Clamped - Renders a clamped spline.
+     * * Monotonic - Renders a monotonic spline.
      * @default 'Natural'
      */
     splineType: any;
     /**
-     * This property allows grouping of series in `stacked column / bar` charts.
-     * Any string value can be provided to the stackingGroup property.
-     * If any two or more series have the same value, those series will be grouped together.
+     * This property allows the grouping of series in stacked column and stacked bar charts.
+     * Any string value can be assigned to the `stackingGroup` property.
+     * Series with the same `stackingGroup` value will be grouped together in the chart.
      * @default ''
      */
     stackingGroup: any;
     /**
-     * Defines the position for the steps in the step line, step area, and step range area chart types.
+     * The `step` property can be used to change the position of the steps in step line, step area, and step range area chart types.
      * * Left: Steps start from the left side of the 2nd point.
      * * Center: Steps start between the data points.
      * * Right: Steps start from the right side of the 1st point.
@@ -346,86 +371,87 @@ export declare class SeriesDirective extends ComplexBase<SeriesDirective> {
      */
     step: any;
     /**
-     * Defines the collection of indexes of the overall summary columns in waterfall charts.
+     * Defines the collection of indexes for the overall summary columns in waterfall charts.
      * @default []
      * @asptype int[]
      */
     sumIndexes: any;
     /**
-     * Defines the visual representation of the summaries in waterfall charts.
+     * Defines the visual representation of summaries in waterfall charts.
      * @default '#4E81BC'
      */
     summaryFillColor: any;
     /**
-     * Format of the tooltip content.
+     * Use this property to define a custom format for how tooltips are displayed.
+     *
      * @default ''
      */
     tooltipFormat: any;
     /**
-     * The data source field that contains the tooltip value.
+     * The data source field that contains the value to be displayed in the tooltip.
      * @default ''
      */
     tooltipMappingName: any;
     /**
-     * Defines the collection of trendlines that are used to predict the trend.
+     * Defines the collection of trendlines used to predict the trend.
      */
     trendlines: any;
     /**
-     * Custom style for the deselected series or points.
+     * The `unSelectedStyle` property is used to specify custom CSS styles for the deselected series or points.
      * @default null
      */
     unSelectedStyle: any;
     /**
-     * Specifies the visibility of the series.
+     * If set to `true`, the series will be visible. If set to `false`, the series will be hidden.
      * @default true
      */
     visible: any;
     /**
      * Defines the data source field that contains the volume value in candle charts.
-     * It is applicable for both financial series and technical indicators
+     * It is applicable for both financial series and technical indicators.
      * @default ''
      */
     volume: any;
     /**
-     * The stroke width for the series that is applicable only for `Line` type series.
+     * The stroke width for the series, applicable only for `Line` type series.
      * It also represents the stroke width of the signal lines in technical indicators.
      * @default 1
      */
     width: any;
     /**
      * The name of the horizontal axis associated with the series. It requires `axes` of the chart.
-     * It is applicable for series and technical indicators
+     * It is applicable for series and technical indicators.
      *
      * @default null
      */
     xAxisName: any;
     /**
-     * The DataSource field that contains the x value.
-     * It is applicable for both series and technical indicators.
+     * The data source field that contains the x value.
+     * It is applicable to both series and technical indicators.
      * @default ''
      */
     xName: any;
     /**
      * The name of the vertical axis associated with the series. It requires `axes` of the chart.
-     * It is applicable for series and technical indicators
+     * It is applicable for series and technical indicators.
      *
      * @default null
      */
     yAxisName: any;
     /**
-     * The DataSource field that contains the y value.
+     * The data source field that contains the y value.
      * @default ''
      */
     yName: any;
     /**
-     * The z order of the series.
+     * The z-order of the series, which controls the stack order of the series. Higher values are drawn on top of lower values.
      * @default 0
      */
     zOrder: any;
     dataLabel_template: any;
     constructor(viewContainerRef: ViewContainerRef);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<SeriesDirective, "e-series-collection>e-series", never, { "animation": "animation"; "bearFillColor": "bearFillColor"; "binInterval": "binInterval"; "border": "border"; "boxPlotMode": "boxPlotMode"; "bullFillColor": "bullFillColor"; "cardinalSplineTension": "cardinalSplineTension"; "close": "close"; "colorName": "colorName"; "columnFacet": "columnFacet"; "columnSpacing": "columnSpacing"; "columnWidth": "columnWidth"; "columnWidthInPixel": "columnWidthInPixel"; "connector": "connector"; "cornerRadius": "cornerRadius"; "dashArray": "dashArray"; "dataSource": "dataSource"; "dragSettings": "dragSettings"; "drawType": "drawType"; "emptyPointSettings": "emptyPointSettings"; "enableComplexProperty": "enableComplexProperty"; "enableSolidCandles": "enableSolidCandles"; "enableTooltip": "enableTooltip"; "errorBar": "errorBar"; "fill": "fill"; "groupName": "groupName"; "high": "high"; "intermediateSumIndexes": "intermediateSumIndexes"; "isClosed": "isClosed"; "legendImageUrl": "legendImageUrl"; "legendShape": "legendShape"; "low": "low"; "marker": "marker"; "maxRadius": "maxRadius"; "minRadius": "minRadius"; "name": "name"; "negativeFillColor": "negativeFillColor"; "nonHighlightStyle": "nonHighlightStyle"; "opacity": "opacity"; "open": "open"; "paretoOptions": "paretoOptions"; "pointColorMapping": "pointColorMapping"; "query": "query"; "segmentAxis": "segmentAxis"; "segments": "segments"; "selectionStyle": "selectionStyle"; "showMean": "showMean"; "showNormalDistribution": "showNormalDistribution"; "size": "size"; "splineType": "splineType"; "stackingGroup": "stackingGroup"; "step": "step"; "sumIndexes": "sumIndexes"; "summaryFillColor": "summaryFillColor"; "tooltipFormat": "tooltipFormat"; "tooltipMappingName": "tooltipMappingName"; "trendlines": "trendlines"; "type": "type"; "unSelectedStyle": "unSelectedStyle"; "visible": "visible"; "volume": "volume"; "width": "width"; "xAxisName": "xAxisName"; "xName": "xName"; "yAxisName": "yAxisName"; "yName": "yName"; "zOrder": "zOrder"; }, {}, ["dataLabel_template", "childTrendlines", "childSegments"]>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<SeriesDirective, "e-series-collection>e-series", never, { "animation": "animation"; "bearFillColor": "bearFillColor"; "binInterval": "binInterval"; "border": "border"; "boxPlotMode": "boxPlotMode"; "bullFillColor": "bullFillColor"; "cardinalSplineTension": "cardinalSplineTension"; "close": "close"; "colorName": "colorName"; "columnFacet": "columnFacet"; "columnSpacing": "columnSpacing"; "columnWidth": "columnWidth"; "columnWidthInPixel": "columnWidthInPixel"; "connector": "connector"; "cornerRadius": "cornerRadius"; "dashArray": "dashArray"; "dataSource": "dataSource"; "dragSettings": "dragSettings"; "drawType": "drawType"; "emptyPointSettings": "emptyPointSettings"; "enableComplexProperty": "enableComplexProperty"; "enableSolidCandles": "enableSolidCandles"; "enableTooltip": "enableTooltip"; "errorBar": "errorBar"; "fill": "fill"; "groupName": "groupName"; "high": "high"; "intermediateSumIndexes": "intermediateSumIndexes"; "isClosed": "isClosed"; "legendImageUrl": "legendImageUrl"; "legendShape": "legendShape"; "low": "low"; "marker": "marker"; "maxRadius": "maxRadius"; "minRadius": "minRadius"; "name": "name"; "negativeFillColor": "negativeFillColor"; "noRisers": "noRisers"; "nonHighlightStyle": "nonHighlightStyle"; "opacity": "opacity"; "open": "open"; "paretoOptions": "paretoOptions"; "pointColorMapping": "pointColorMapping"; "query": "query"; "segmentAxis": "segmentAxis"; "segments": "segments"; "selectionStyle": "selectionStyle"; "showMean": "showMean"; "showNormalDistribution": "showNormalDistribution"; "size": "size"; "splineType": "splineType"; "stackingGroup": "stackingGroup"; "step": "step"; "sumIndexes": "sumIndexes"; "summaryFillColor": "summaryFillColor"; "tooltipFormat": "tooltipFormat"; "tooltipMappingName": "tooltipMappingName"; "trendlines": "trendlines"; "type": "type"; "unSelectedStyle": "unSelectedStyle"; "visible": "visible"; "volume": "volume"; "width": "width"; "xAxisName": "xAxisName"; "xName": "xName"; "yAxisName": "yAxisName"; "yName": "yName"; "zOrder": "zOrder"; }, {}, ["dataLabel_template", "childTrendlines", "childSegments"]>;
 }
 /**
  * Series Array Directive