@syncfusion/ej2-angular-charts 26.2.14 → 27.1.48

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

@@ -15,28 +15,30 @@ export declare class StripLineDirective extends ComplexBase<StripLineDirective>
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Border of the strip line.
+     * The `border` property allows customization of the border for the strip line.
+     * It includes options to set the color and width of the border.
      */
     border: any;
     /**
-     * Specifies the color of the strip line.
+     * The `color` property specifies the color of the strip line.
      * @default '#808080'
      */
     color: any;
     /**
-     * Dash array of the strip line.
+     * Specifies the pattern of dashes and gaps used to render the strip line.
      * @default null
      * @aspdefaultvalueignore
      */
     dashArray: any;
     /**
-     * End value of the strip line.
+     * Specifies the ending value of the strip line.
      * @default null
      * @aspdefaultvalueignore
      */
     end: any;
     /**
-     * Defines the position of the strip line text horizontally. They are,
+     * Defines the position of the strip line text horizontally.
+     * Available options are:
      * * Start: Places the strip line text at the start.
      * * Middle: Places the strip line text in the middle.
      * * End: Places the strip line text at the end.
@@ -44,12 +46,12 @@ export declare class StripLineDirective extends ComplexBase<StripLineDirective>
      */
     horizontalAlignment: any;
     /**
-     * The URL of the background image for the strip line.
+     * Specifies the URL of the background image for the strip line. The image will be displayed as the background.
      * @default ''
      */
     imageUrl: any;
     /**
-     * Specifies whether the strip line is repeated.
+     * Specifies whether the strip line is repeated at regular intervals along the axis.
      * @default false
      * @aspdefaultvalueignore
      */
@@ -61,79 +63,80 @@ export declare class StripLineDirective extends ComplexBase<StripLineDirective>
      */
     isSegmented: any;
     /**
-     * Strip line Opacity.
+     * Specifies the opacity for the strip line.
      * @default 1
      */
     opacity: any;
     /**
-     * repeatEvery value of the strip line.
+     * Specifies the interval at which the strip line is repeated.
      * @default null
      * @aspdefaultvalueignore
      */
     repeatEvery: any;
     /**
-     * repeatUntil value of the strip line.
+     * Specifies the maximum value of the interval at which the strip line is repeated.
      * @default null
      * @aspdefaultvalueignore
      */
     repeatUntil: any;
     /**
-     * The angle to which the strip line text gets rotated.
+     * Defines the degree of rotation applied to the text on the strip line.
      * @default null
      * @aspdefaultvalueignore
      */
     rotation: any;
     /**
-     * segmentAxisName of the strip line.
+     * The name of the axis where the strip line segment is applied.
      * @default null
      * @aspdefaultvalueignore
      */
     segmentAxisName: any;
     /**
-     * segmentEnd value of the strip line.
+     * Specifies where a new segment of the strip line on the axis ends.
      * @default null
      * @aspdefaultvalueignore
      */
     segmentEnd: any;
     /**
-     * segmentStart value of the strip line.
+     * Specifies where a new segment of the strip line on the axis begins.
      * @default null
      * @aspdefaultvalueignore
      */
     segmentStart: any;
     /**
-     * Size of the strip line, when it starts from the origin.
+     * Specifies the size of the strip line when starting from the origin.
      * @default null
      * @aspdefaultvalueignore
      */
     size: any;
     /**
-     * Size type of the strip line.
+     * The `sizeType` property specifies how the size of the strip line is determined.
      * @default Auto
      */
     sizeType: any;
     /**
-     * Start value of the strip line.
+     * Specifies the starting value of the strip line.
      * @default null
      * @aspdefaultvalueignore
      */
     start: any;
     /**
-     *  If set true, strip line get render from axis origin.
+     * If set to true, the strip line is rendered from the axis origin.
      * @default false
      */
     startFromAxis: any;
     /**
-     * Strip line text.
+     * Defines the text to be displayed on the strip line.
      * @default ''
      */
     text: any;
     /**
-     * Options to customize the strip line text.
+     * The `textStyle` property enables customization of the text appearance on the strip line.
      */
     textStyle: any;
     /**
-     * Defines the position of the strip line text vertically. They are,
+     * Defines the position of the strip line text vertically.
+     * Available options are:
      * * Start: Places the strip line text at the start.
      * * Middle: Places the strip line text in the middle.
      * * End: Places the strip line text at the end.
@@ -141,12 +144,13 @@ export declare class StripLineDirective extends ComplexBase<StripLineDirective>
      */
     verticalAlignment: any;
     /**
-     * If set true, strip line for axis renders.
+     * If set to true, the strip line on the axis will render.
      * @default true
      */
     visible: any;
     /**
-     * Specifies the order of the strip line. They are,
+     * Specifies the order of the strip line.
+     * The options are:
      * * Behind: Places the strip line behind the series elements.
      * * Over: Places the strip line over the series elements.
      * @default 'Behind'

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

@@ -17,7 +17,14 @@ export declare class TrendlineDirective extends ComplexBase<TrendlineDirective>
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Defines the type of the trendline.
+     * Defines the type of trendline used in the series.
+     * Available types are:
+     * * Linear - A straight line that shows the general direction of data.
+     * * Exponential - A curve that fits data with exponential growth or decay.
+     * * Polynomial - A curve that fits data with a polynomial function.
+     * * Power - A curve that represents data with a power function.
+     * * Logarithmic - A curve that fits data with a logarithmic scale.
+     * * MovingAverage - A trendline that smoothens data using a moving average calculation.
      * @default 'Linear'
      */
     type: any;
@@ -26,53 +33,53 @@ export declare class TrendlineDirective extends ComplexBase<TrendlineDirective>
      */
     animation: any;
     /**
-     * Defines the period, by which the trend has to backward forecast.
+     * Defines the period by which the trend is to be backward forecasted.
      * @default 0
      */
     backwardForecast: any;
     /**
-     * Defines the pattern of dashes and gaps to stroke.
+     * Configures the pattern of dashes and gaps in the trendline stroke using the `dashArray` property.
      * @default ''
      */
     dashArray: any;
     /**
-     * Enables/disables tooltip for trendlines.
+     * Enables or disables the tooltip for the trendline using the `enableTooltip` property. By default, it is set to true.
      * @default true
      */
     enableTooltip: any;
     /**
-     * Defines the fill color of trendline.
+     * The fill color for the trendline, which accepts values in hex or rgba as valid CSS color strings.
      * @default ''
      */
     fill: any;
     /**
-     * Defines the period, by which the trend has to forward forecast.
+     * Defines the period by which the trend must be forward forecasted.
      * @default 0
      */
     forwardForecast: any;
     /**
-     * Defines the intercept of the trendline.
+     * Specifies the intercept value of the trendline.
      * @default null
      * @aspdefaultvalueignore
      */
     intercept: any;
     /**
-     * Sets the legend shape of the trendline.
+     * The `legendShape` property defines the shape used to represent the trendline in the chart legend.
      * @default 'SeriesType'
      */
     legendShape: any;
     /**
-     * Options to customize the marker for trendlines.
+     * Options for customizing the markers for trendlines, including shape, size, color, and other visual aspects.
      * @deprecated
      */
     marker: any;
     /**
-     * Defines the name of trendline.
+     * The `name` property is used to assign a descriptive name to the trendline, which will be displayed in the chart as a legend.
      * @default ''
      */
     name: any;
     /**
-     * Defines the period, the price changes over which will be considered to predict moving average trend line.
+     * Defines the period, the price changes over which will be considered to predict the moving average trendline.
      * @default 2
      */
     period: any;
@@ -82,7 +89,7 @@ export declare class TrendlineDirective extends ComplexBase<TrendlineDirective>
      */
     polynomialOrder: any;
     /**
-     * Specifies the visibility of trendline.
+     * The `visible` property controls the display of the trendline. If set to true, the trendline will be rendered on the chart. If set to false, the trendline will be hidden.
      * @default true
      */
     visible: any;

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

@@ -11,13 +11,13 @@ export declare class Chart3DSelectedDataIndexDirective extends ComplexBase<Chart
     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
      */

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

@@ -11,13 +11,13 @@ export declare class CircularChart3DSelectedDataIndexDirective extends ComplexBa
     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
      */

package/src/stock-chart/trendlines.directive.d.ts

@@ -18,7 +18,14 @@ export declare class StockChartTrendlineDirective extends ComplexBase<StockChart
     private viewContainerRef;
     directivePropList: any;
     /**
-     * Defines the type of the trendline.
+     * Defines the type of trendline used in the series.
+     * Available types are:
+     * * Linear - A straight line that shows the general direction of data.
+     * * Exponential - A curve that fits data with exponential growth or decay.
+     * * Polynomial - A curve that fits data with a polynomial function.
+     * * Power - A curve that represents data with a power function.
+     * * Logarithmic - A curve that fits data with a logarithmic scale.
+     * * MovingAverage - A trendline that smoothens data using a moving average calculation.
      * @default 'Linear'
      */
     type: any;
@@ -27,53 +34,53 @@ export declare class StockChartTrendlineDirective extends ComplexBase<StockChart
      */
     animation: any;
     /**
-     * Defines the period, by which the trend has to backward forecast.
+     * Defines the period by which the trend is to be backward forecasted.
      * @default 0
      */
     backwardForecast: any;
     /**
-     * Defines the pattern of dashes and gaps to stroke.
+     * Configures the pattern of dashes and gaps in the trendline stroke using the `dashArray` property.
      * @default ''
      */
     dashArray: any;
     /**
-     * Enables/disables tooltip for trendlines.
+     * Enables or disables the tooltip for the trendline using the `enableTooltip` property. By default, it is set to true.
      * @default true
      */
     enableTooltip: any;
     /**
-     * Defines the fill color of trendline.
+     * The fill color for the trendline, which accepts values in hex or rgba as valid CSS color strings.
      * @default ''
      */
     fill: any;
     /**
-     * Defines the period, by which the trend has to forward forecast.
+     * Defines the period by which the trend must be forward forecasted.
      * @default 0
      */
     forwardForecast: any;
     /**
-     * Defines the intercept of the trendline.
+     * Specifies the intercept value of the trendline.
      * @default null
      * @aspdefaultvalueignore
      */
     intercept: any;
     /**
-     * Sets the legend shape of the trendline.
+     * The `legendShape` property defines the shape used to represent the trendline in the chart legend.
      * @default 'SeriesType'
      */
     legendShape: any;
     /**
-     * Options to customize the marker for trendlines.
+     * Options for customizing the markers for trendlines, including shape, size, color, and other visual aspects.
      * @deprecated
      */
     marker: any;
     /**
-     * Defines the name of trendline.
+     * The `name` property is used to assign a descriptive name to the trendline, which will be displayed in the chart as a legend.
      * @default ''
      */
     name: any;
     /**
-     * Defines the period, the price changes over which will be considered to predict moving average trend line.
+     * Defines the period, the price changes over which will be considered to predict the moving average trendline.
      * @default 2
      */
     period: any;
@@ -83,7 +90,7 @@ export declare class StockChartTrendlineDirective extends ComplexBase<StockChart
      */
     polynomialOrder: any;
     /**
-     * Specifies the visibility of trendline.
+     * The `visible` property controls the display of the trendline. If set to true, the trendline will be rendered on the chart. If set to false, the trendline will be hidden.
      * @default true
      */
     visible: any;