@syncfusion/ej2-angular-charts 26.2.14 → 27.1.48

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

@@ -13,170 +13,185 @@ export declare class IndicatorDirective extends ComplexBase<IndicatorDirective>
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Defines the type of the technical indicator.
+     * Defines the types of technical indicators. They are:
+     * * 'Sma' - Predicts the trend using the Simple Moving Average approach.
+     * * 'Ema' - Predicts the trend using the Exponential Moving Average approach.
+     * * 'Tma' - Predicts the trend using the Triangular Moving Average approach.
+     * * 'Atr' - Predicts the trend using the Average True Range approach.
+     * * 'AccumulationDistribution' - Predicts the trend using the Accumulation Distribution approach.
+     * * 'Momentum' - Predicts the trend using the Momentum approach.
+     * * 'Rsi' - Predicts the trend using the Relative Strength Index (RSI) approach.
+     * * 'Macd' - Predicts the trend using the Moving Average Convergence Divergence (MACD) approach.
+     * * 'Stochastic' - Predicts the trend using the Stochastic Oscillator approach.
+     * * 'BollingerBands' - Predicts the trend using the Bollinger Bands approach.
      * @default 'Sma'
      */
     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;
     /**
-     * Options for customizing the BollingerBand in the indicator.
+     * Configures the settings for customizing the Bollinger Bands in the indicator.
      * @default 'rgba(211,211,211,0.25)'
      */
     bandColor: 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 period, the price changes over which will define the %D value in stochastic indicators.
+     * Defines the period over which price changes determine the %D value in stochastic indicators.
      * @default 3
      */
     dPeriod: 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;
     /**
-     * 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;
     /**
-     * Sets the fast period to define the Macd line.
+     * Sets the fast period to define the MACD line.
      * @default 26
      */
     fastPeriod: any;
     /**
-     * Defines the field to compare the current value with previous values.
+     * Defines the field used to compare the current value with previous values.
      * @default 'Close'
      */
     field: 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;
     /**
-     * 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 look back period, the price changes over which will define the %K value in stochastic indicators.
+     * Defines the look-back period for price changes used to calculate the %K value in stochastic indicators.
      * @default 14
      */
     kPeriod: 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;
     /**
-     * Defines the appearance of lower line in technical indicators.
+     * Defines the appearance of the lower line in technical indicators.
      */
     lowerLine: any;
     /**
-     * Defines the appearance of the the MacdLine of Macd indicator.
+     * Defines the appearance of the MACD line in the MACD indicator.
      * @default { color: '#ff9933', width: 2 }
      */
     macdLine: any;
     /**
-     * Defines the color of the negative bars in Macd indicators.
+     * Specifies the color for negative bars in the MACD indicator.
      * @default '#e74c3d'
      */
     macdNegativeColor: any;
     /**
-     * Defines the color of the positive bars in Macd indicators.
+     * Specifies the color for positive bars in the MACD indicator.
      * @default '#2ecd71'
      */
     macdPositiveColor: any;
     /**
-     * Defines the type of the Macd indicator.
+     * Defines the type of the MACD (Moving Average Convergence Divergence) indicator.
      * @default 'Both'
      */
     macdType: 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;
     /**
-     * Defines the over-bought(threshold) values. It is applicable for RSI and stochastic indicators.
+     * Specifies the over-bought (threshold) values applicable for RSI and stochastic indicators.
      * @default 80
      */
     overBought: any;
     /**
-     * Defines the over-sold(threshold) values. It is applicable for RSI and stochastic indicators.
+     * Defines the over-sold (threshold) values for RSI and stochastic indicators.
      * @default 20
      */
     overSold: any;
     /**
-     * Defines the period, the price changes over which will be considered to predict the trend.
+     * Defines the period over which price changes are considered for trend prediction.
      * @default 14
      */
     period: any;
     /**
-     * Defines the appearance of period line in technical indicators.
+     * Defines the appearance of the period line in technical indicators.
      */
     periodLine: 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;
     /**
-     * Defines the name of the series, the data of which has to be depicted as indicator.
+     * Specifies the name of the series to be used for displaying the indicator data.
      * @default ''
      */
     seriesName: any;
     /**
-     * Enables/Disables the over-bought and over-sold regions.
+     * Specifies whether to enable or disable the over-bought and over-sold regions.
      * @default true
      */
     showZones: any;
     /**
-     * Sets the slow period to define the Macd line.
+     * Sets the slow period for defining the MACD line.
      * @default 12
      */
     slowPeriod: any;
     /**
-     * Sets the standard deviation values that helps to define the upper and lower bollinger bands.
+     * Sets the standard deviation values used to define the upper and lower Bollinger Bands.
      * @default 2
      */
     standardDeviation: any;
@@ -185,38 +200,38 @@ export declare class IndicatorDirective extends ComplexBase<IndicatorDirective>
      */
     upperLine: 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
      */

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

@@ -17,26 +17,29 @@ export declare class MultiLevelLabelDirective extends ComplexBase<MultiLevelLabe
     childCategories: any;
     tags: string[];
     /**
-     * Defines the position of the multi level labels. The available options are,
-     * * Near: Places the multi-level labels near.
-     * * Center: Places the multi-level label in the center.
-     * * Far: Places the multi-level labels far.
+     * Defines the position of the multi-level labels.
+     * The available options are:
+     * * Near: Places the multi-level labels close to the chart elements.
+     * * Center: Positions the multi-level labels in the center of the chart elements.
+     * * Far: Places the multi-level labels further from the chart elements.
      * @default 'Center'
      */
     alignment: any;
     /**
-     * Border of the multi-level labels.
+     * The `border` property allows customization of the border for multi-level labels.
+     * It includes options to set the color, width, and type of the border.
      */
     border: any;
     /**
-     * Multi level categories for multi-level labels.
+     * Configures multi-level categories for multi-level labels.
      */
     categories: any;
     /**
-     * Defines the textOverFlow for multi level labels. They are,
-     * * Trim: Trim textOverflow for multi level labels.
-     * * Wrap: Wrap textOverflow for multi level labels.
-     * * none: None textOverflow for multi level labels.
+     * Defines the text overflow behavior for multi-level labels.
+     * The available options are:
+     * * Trim: Trims the text that overflows for multi-level labels.
+     * * Wrap: Wraps the text that overflows for multi-level labels.
+     * * None: No text overflow handling for multi-level labels.
      * @default 'Wrap'
      */
     overflow: any;

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

@@ -11,19 +11,19 @@ export declare class RangeColorSettingDirective extends ComplexBase<RangeColorSe
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Specify the fill colors of point those lies on the given range, if multiple colors mentioned, then we need to fill gradient.
+     * Specifies the fill colors for points that lie within the given range. If multiple colors are specified, a gradient will be applied.
      */
     colors: any;
     /**
-     * Specify the end value of color mapping range.
+     * Specifies the end value of the color mapping range.
      */
     end: any;
     /**
-     * Specify name for the range mapping item.
+     * Specifies the name or label for the range mapping item.
      */
     label: any;
     /**
-     * Specify the start value of color mapping range.
+     * Specifies the start value of the color mapping range.
      */
     start: any;
     constructor(viewContainerRef: ViewContainerRef);

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

@@ -16,7 +16,7 @@ export declare class RowDirective extends ComplexBase<RowDirective> {
     border: any;
     /**
      * The height of the row as a string accepts input both as '100px' and '100%'.
-     * If specified as '100%, row renders to the full height of its chart.
+     * If specified as '100%', the row renders to the full height of its chart.
      * @default '100%'
      */
     height: any;

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

@@ -17,12 +17,12 @@ export declare class SegmentDirective extends ComplexBase<SegmentDirective> {
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Defines the color of a region.
+     * Defines the fill color for the region using a color name, hex code, or rgba value.
      * @default null
      */
     color: any;
     /**
-     * Defines the pattern of dashes and gaps to stroke.
+     * Specifies the dash pattern for the stroke of the series. The string format allows defining various dash and gap lengths.
      * @default '0'
      */
     dashArray: any;

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

@@ -11,13 +11,13 @@ export declare class SelectedDataIndexDirective extends ComplexBase<SelectedData
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Specifies the point index.
+     * Specifies the index of the data point within the series.
      * @default 0
      * @asptype int
      */
     point: any;
     /**
-     * Specifies the series index.
+     * Specifies the index of the series.
      * @default 0
      * @asptype int
      */