Trendline

Trendline class

Represents a trendline in a chart.

class Trendline extends Line;

Example

const { Workbook, ChartType, TrendlineType } = require("aspose.cells.node");

//Instantiating a Workbook object
var workbook = new Workbook();
//Adding a new worksheet to the Excel object
var sheetIndex = workbook.worksheets.add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
var worksheet = workbook.worksheets.get(sheetIndex);
//Adding a sample value to "A1" cell
worksheet.cells.get("A1").putValue(50);
//Adding a sample value to "A2" cell
worksheet.cells.get("A2").putValue(100);
//Adding a sample value to "A3" cell
worksheet.cells.get("A3").putValue(150);
//Adding a sample value to "A4" cell
worksheet.cells.get("A4").putValue(200);
//Adding a sample value to "B1" cell
worksheet.cells.get("B1").putValue(60);
//Adding a sample value to "B2" cell
worksheet.cells.get("B2").putValue(32);
//Adding a sample value to "B3" cell
worksheet.cells.get("B3").putValue(50);
//Adding a sample value to "B4" cell
worksheet.cells.get("B4").putValue(40);
//Adding a sample value to "C1" cell as category data
worksheet.cells.get("C1").putValue("Q1");
//Adding a sample value to "C2" cell as category data
worksheet.cells.get("C2").putValue("Q2");
//Adding a sample value to "C3" cell as category data
worksheet.cells.get("C3").putValue("Y1");
//Adding a sample value to "C4" cell as category data
worksheet.cells.get("C4").putValue("Y2");
//Adding a chart to the worksheet
var chartIndex = worksheet.charts.add(ChartType.Column, 5, 0, 15, 5);
//Accessing the instance of the newly added chart
var chart = worksheet.charts.get(chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
chart.nSeries.add("A1:B4", true);
//Setting the data source for the category data of NSeries
chart.nSeries.categoryData = "C1:C4";
//adding a linear trendline
var index = chart.nSeries.get(0).trendLines.add(TrendlineType.Linear);
var trendline = chart.nSeries.get(0).trendLines.get(index);
//Setting the custom name of the trendline.
trendline.name = "Linear";
//Displaying the equation on chart
trendline.displayEquation = true;
//Displaying the R-Squared value on chart
trendline.displayRSquared = true;
//Saving the Excel file
workbook.save("output/ChartsTrendline.xls");

Constructors

Constructor	Description
constructor(Line)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
isNameAuto	boolean	Returns if Microsoft Excel automatically determines the name of the trendline.
type	TrendlineType	Readonly. Returns the trendline type.
name	string	Returns the name of the trendline.
order	number	Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.
period	number	Returns or sets the period for the moving-average trendline.
forward	number	Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than or equal to zero.
backward	number	Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than or equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5
displayEquation	boolean	Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.
displayRSquared	boolean	Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.
intercept	number	Returns or sets the point where the trendline crosses the value axis.
dataLabels	DataLabels	Readonly. Represents the DataLabels object for the specified series.
legendEntry	LegendEntry	Readonly. Gets the legend entry according to this trendline
compoundType	MsoLineStyle	Specifies the compound line type
dashType	MsoLineDashStyle	Specifies the dash line type
capType	LineCapType	Specifies the ending caps.
joinType	LineJoinType	Specifies the joining caps.
beginType	MsoArrowheadStyle	Specifies an arrowhead for the begin of a line.
endType	MsoArrowheadStyle	Specifies an arrowhead for the end of a line.
beginArrowLength	MsoArrowheadLength	Specifies the length of the arrowhead for the begin of a line.
endArrowLength	MsoArrowheadLength	Specifies the length of the arrowhead for the end of a line.
beginArrowWidth	MsoArrowheadWidth	Specifies the width of the arrowhead for the begin of a line.
endArrowWidth	MsoArrowheadWidth	Specifies the width of the arrowhead for the end of a line.
themeColor	ThemeColor	Gets and sets the theme color.
color	Color	Represents the Color of the line.
transparency	number	Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
style	LineType	Represents the style of the line.
weight	WeightType	Gets or sets the WeightType of the line.
weightPt	number	Gets or sets the weight of the line in unit of points.
weightPx	number	Gets or sets the weight of the line in unit of pixels.
formattingType	ChartLineFormattingType	Gets or sets format type.
isAutomaticColor	boolean	Readonly. Indicates whether the color of line is automatic assigned.
isVisible	boolean	Represents whether the line is visible.
isAuto	boolean	Indicates whether this line style is auto assigned.
gradientFill	GradientFill	Readonly. Represents gradient fill.

Methods

Method	Description
isNameAuto()	@deprecated. Please use the ‘isNameAuto’ property instead. Returns if Microsoft Excel automatically determines the name of the trendline.
setIsNameAuto(boolean)	@deprecated. Please use the ‘isNameAuto’ property instead. Returns if Microsoft Excel automatically determines the name of the trendline.
getType()	@deprecated. Please use the ’type’ property instead. Returns the trendline type.
getName()	@deprecated. Please use the ’name’ property instead. Returns the name of the trendline.
setName(string)	@deprecated. Please use the ’name’ property instead. Returns the name of the trendline.
getOrder()	@deprecated. Please use the ‘order’ property instead. Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.
setOrder(number)	@deprecated. Please use the ‘order’ property instead. Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.
getPeriod()	@deprecated. Please use the ‘period’ property instead. Returns or sets the period for the moving-average trendline.
setPeriod(number)	@deprecated. Please use the ‘period’ property instead. Returns or sets the period for the moving-average trendline.
getForward()	@deprecated. Please use the ‘forward’ property instead. Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than or equal to zero.
setForward(number)	@deprecated. Please use the ‘forward’ property instead. Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than or equal to zero.
getBackward()	@deprecated. Please use the ‘backward’ property instead. Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than or equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5
setBackward(number)	@deprecated. Please use the ‘backward’ property instead. Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than or equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5
getDisplayEquation()	@deprecated. Please use the ‘displayEquation’ property instead. Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.
setDisplayEquation(boolean)	@deprecated. Please use the ‘displayEquation’ property instead. Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.
getDisplayRSquared()	@deprecated. Please use the ‘displayRSquared’ property instead. Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.
setDisplayRSquared(boolean)	@deprecated. Please use the ‘displayRSquared’ property instead. Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.
getIntercept()	@deprecated. Please use the ‘intercept’ property instead. Returns or sets the point where the trendline crosses the value axis.
setIntercept(number)	@deprecated. Please use the ‘intercept’ property instead. Returns or sets the point where the trendline crosses the value axis.
getDataLabels()	@deprecated. Please use the ‘dataLabels’ property instead. Represents the DataLabels object for the specified series.
getLegendEntry()	@deprecated. Please use the ’legendEntry’ property instead. Gets the legend entry according to this trendline
isNull()	Checks whether the implementation object is null.
getCompoundType()	@deprecated. Please use the ‘compoundType’ property instead. Specifies the compound line type
setCompoundType(MsoLineStyle)	@deprecated. Please use the ‘compoundType’ property instead. Specifies the compound line type
getDashType()	@deprecated. Please use the ‘dashType’ property instead. Specifies the dash line type
setDashType(MsoLineDashStyle)	@deprecated. Please use the ‘dashType’ property instead. Specifies the dash line type
getCapType()	@deprecated. Please use the ‘capType’ property instead. Specifies the ending caps.
setCapType(LineCapType)	@deprecated. Please use the ‘capType’ property instead. Specifies the ending caps.
getJoinType()	@deprecated. Please use the ‘joinType’ property instead. Specifies the joining caps.
setJoinType(LineJoinType)	@deprecated. Please use the ‘joinType’ property instead. Specifies the joining caps.
getBeginType()	@deprecated. Please use the ‘beginType’ property instead. Specifies an arrowhead for the begin of a line.
setBeginType(MsoArrowheadStyle)	@deprecated. Please use the ‘beginType’ property instead. Specifies an arrowhead for the begin of a line.
getEndType()	@deprecated. Please use the ’endType’ property instead. Specifies an arrowhead for the end of a line.
setEndType(MsoArrowheadStyle)	@deprecated. Please use the ’endType’ property instead. Specifies an arrowhead for the end of a line.
getBeginArrowLength()	@deprecated. Please use the ‘beginArrowLength’ property instead. Specifies the length of the arrowhead for the begin of a line.
setBeginArrowLength(MsoArrowheadLength)	@deprecated. Please use the ‘beginArrowLength’ property instead. Specifies the length of the arrowhead for the begin of a line.
getEndArrowLength()	@deprecated. Please use the ’endArrowLength’ property instead. Specifies the length of the arrowhead for the end of a line.
setEndArrowLength(MsoArrowheadLength)	@deprecated. Please use the ’endArrowLength’ property instead. Specifies the length of the arrowhead for the end of a line.
getBeginArrowWidth()	@deprecated. Please use the ‘beginArrowWidth’ property instead. Specifies the width of the arrowhead for the begin of a line.
setBeginArrowWidth(MsoArrowheadWidth)	@deprecated. Please use the ‘beginArrowWidth’ property instead. Specifies the width of the arrowhead for the begin of a line.
getEndArrowWidth()	@deprecated. Please use the ’endArrowWidth’ property instead. Specifies the width of the arrowhead for the end of a line.
setEndArrowWidth(MsoArrowheadWidth)	@deprecated. Please use the ’endArrowWidth’ property instead. Specifies the width of the arrowhead for the end of a line.
getThemeColor()	@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.
setThemeColor(ThemeColor)	@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.
getColor()	@deprecated. Please use the ‘color’ property instead. Represents the Color of the line.
setColor(Color)	@deprecated. Please use the ‘color’ property instead. Represents the Color of the line.
getTransparency()	@deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(number)	@deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).
getStyle()	@deprecated. Please use the ‘style’ property instead. Represents the style of the line.
setStyle(LineType)	@deprecated. Please use the ‘style’ property instead. Represents the style of the line.
getWeight()	@deprecated. Please use the ‘weight’ property instead. Gets or sets the WeightType of the line.
setWeight(WeightType)	@deprecated. Please use the ‘weight’ property instead. Gets or sets the WeightType of the line.
getWeightPt()	@deprecated. Please use the ‘weightPt’ property instead. Gets or sets the weight of the line in unit of points.
setWeightPt(number)	@deprecated. Please use the ‘weightPt’ property instead. Gets or sets the weight of the line in unit of points.
getWeightPx()	@deprecated. Please use the ‘weightPx’ property instead. Gets or sets the weight of the line in unit of pixels.
setWeightPx(number)	@deprecated. Please use the ‘weightPx’ property instead. Gets or sets the weight of the line in unit of pixels.
getFormattingType()	@deprecated. Please use the ‘formattingType’ property instead. Gets or sets format type.
setFormattingType(ChartLineFormattingType)	@deprecated. Please use the ‘formattingType’ property instead. Gets or sets format type.
isAutomaticColor()	@deprecated. Please use the ‘isAutomaticColor’ property instead. Indicates whether the color of line is automatic assigned.
isVisible()	@deprecated. Please use the ‘isVisible’ property instead. Represents whether the line is visible.
setIsVisible(boolean)	@deprecated. Please use the ‘isVisible’ property instead. Represents whether the line is visible.
isAuto()	@deprecated. Please use the ‘isAuto’ property instead. Indicates whether this line style is auto assigned.
setIsAuto(boolean)	@deprecated. Please use the ‘isAuto’ property instead. Indicates whether this line style is auto assigned.
getGradientFill()	@deprecated. Please use the ‘gradientFill’ property instead. Represents gradient fill.

constructor(Line)

Constructs from a parent object convertible to this.

constructor(obj: Line);

Parameters:

Parameter	Type	Description
obj	Line	The parent object.

isNameAuto

Returns if Microsoft Excel automatically determines the name of the trendline.

isNameAuto : boolean;

type

Readonly. Returns the trendline type.

type : TrendlineType;

name

Returns the name of the trendline.

name : string;

order

Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.

order : number;

period

Returns or sets the period for the moving-average trendline.

period : number;

Remarks

This value should be between 2 and 255. And it must be less than the number of the chart points in the series

forward

Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than or equal to zero.

forward : number;

backward

Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than or equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5

backward : number;

displayEquation

Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.

displayEquation : boolean;

displayRSquared

Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.

displayRSquared : boolean;

intercept

Returns or sets the point where the trendline crosses the value axis.

intercept : number;

dataLabels

Readonly. Represents the DataLabels object for the specified series.

dataLabels : DataLabels;

legendEntry

Readonly. Gets the legend entry according to this trendline

legendEntry : LegendEntry;

compoundType

Specifies the compound line type

compoundType : MsoLineStyle;

dashType

Specifies the dash line type

dashType : MsoLineDashStyle;

capType

Specifies the ending caps.

capType : LineCapType;

joinType

Specifies the joining caps.

joinType : LineJoinType;

beginType

Specifies an arrowhead for the begin of a line.

beginType : MsoArrowheadStyle;

endType

Specifies an arrowhead for the end of a line.

endType : MsoArrowheadStyle;

beginArrowLength

Specifies the length of the arrowhead for the begin of a line.

beginArrowLength : MsoArrowheadLength;

endArrowLength

Specifies the length of the arrowhead for the end of a line.

endArrowLength : MsoArrowheadLength;

beginArrowWidth

Specifies the width of the arrowhead for the begin of a line.

beginArrowWidth : MsoArrowheadWidth;

endArrowWidth

Specifies the width of the arrowhead for the end of a line.

endArrowWidth : MsoArrowheadWidth;

themeColor

Gets and sets the theme color.

themeColor : ThemeColor;

Remarks

If the foreground color is not a theme color, NULL will be returned.

color

Represents the Color of the line.

color : Color;

transparency

Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).

transparency : number;

style

Represents the style of the line.

style : LineType;

weight

Gets or sets the WeightType of the line.

weight : WeightType;

weightPt

Gets or sets the weight of the line in unit of points.

weightPt : number;

weightPx

Gets or sets the weight of the line in unit of pixels.

weightPx : number;

formattingType

Gets or sets format type.

formattingType : ChartLineFormattingType;

isAutomaticColor

Readonly. Indicates whether the color of line is automatic assigned.

isAutomaticColor : boolean;

isVisible

Represents whether the line is visible.

isVisible : boolean;

isAuto

Indicates whether this line style is auto assigned.

isAuto : boolean;

gradientFill

Readonly. Represents gradient fill.

gradientFill : GradientFill;

isNameAuto()

@deprecated. Please use the ‘isNameAuto’ property instead. Returns if Microsoft Excel automatically determines the name of the trendline.

isNameAuto() : boolean;

setIsNameAuto(boolean)

@deprecated. Please use the ‘isNameAuto’ property instead. Returns if Microsoft Excel automatically determines the name of the trendline.

setIsNameAuto(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getType()

@deprecated. Please use the ’type’ property instead. Returns the trendline type.

getType() : TrendlineType;

Returns

TrendlineType

getName()

@deprecated. Please use the ’name’ property instead. Returns the name of the trendline.

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Returns the name of the trendline.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getOrder()

@deprecated. Please use the ‘order’ property instead. Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.

getOrder() : number;

setOrder(number)

@deprecated. Please use the ‘order’ property instead. Returns or sets the trendline order (an integer greater than 1) when the trendline type is Polynomial. The order must be between 2 and 6.

setOrder(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getPeriod()

@deprecated. Please use the ‘period’ property instead. Returns or sets the period for the moving-average trendline.

getPeriod() : number;

Remarks

This value should be between 2 and 255. And it must be less than the number of the chart points in the series

setPeriod(number)

@deprecated. Please use the ‘period’ property instead. Returns or sets the period for the moving-average trendline.

setPeriod(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

This value should be between 2 and 255. And it must be less than the number of the chart points in the series

getForward()

@deprecated. Please use the ‘forward’ property instead. Returns or sets the number of periods (or units on a scatter chart) that the trendline extends forward. The number of periods must be greater than or equal to zero.

getForward() : number;

setForward(number)

setForward(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBackward()

@deprecated. Please use the ‘backward’ property instead. Returns or sets the number of periods (or units on a scatter chart) that the trendline extends backward. The number of periods must be greater than or equal to zero. If the chart type is column ,the number of periods must be between 0 and 0.5

getBackward() : number;

setBackward(number)

setBackward(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getDisplayEquation()

@deprecated. Please use the ‘displayEquation’ property instead. Represents if the equation for the trendline is displayed on the chart (in the same data label as the R-squared value). Setting this property to True automatically turns on data labels.

getDisplayEquation() : boolean;

setDisplayEquation(boolean)

setDisplayEquation(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getDisplayRSquared()

@deprecated. Please use the ‘displayRSquared’ property instead. Represents if the R-squared value of the trendline is displayed on the chart (in the same data label as the equation). Setting this property to True automatically turns on data labels.

getDisplayRSquared() : boolean;

setDisplayRSquared(boolean)

setDisplayRSquared(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getIntercept()

@deprecated. Please use the ‘intercept’ property instead. Returns or sets the point where the trendline crosses the value axis.

getIntercept() : number;

setIntercept(number)

@deprecated. Please use the ‘intercept’ property instead. Returns or sets the point where the trendline crosses the value axis.

setIntercept(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getDataLabels()

@deprecated. Please use the ‘dataLabels’ property instead. Represents the DataLabels object for the specified series.

getDataLabels() : DataLabels;

Returns

DataLabels

getLegendEntry()

@deprecated. Please use the ’legendEntry’ property instead. Gets the legend entry according to this trendline

getLegendEntry() : LegendEntry;

Returns

LegendEntry

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getCompoundType()

@deprecated. Please use the ‘compoundType’ property instead. Specifies the compound line type

getCompoundType() : MsoLineStyle;

Returns

MsoLineStyle

setCompoundType(MsoLineStyle)

@deprecated. Please use the ‘compoundType’ property instead. Specifies the compound line type

setCompoundType(value: MsoLineStyle) : void;

Parameters:

Parameter	Type	Description
value	MsoLineStyle	The value to set.

getDashType()

@deprecated. Please use the ‘dashType’ property instead. Specifies the dash line type

getDashType() : MsoLineDashStyle;

Returns

MsoLineDashStyle

setDashType(MsoLineDashStyle)

@deprecated. Please use the ‘dashType’ property instead. Specifies the dash line type

setDashType(value: MsoLineDashStyle) : void;

Parameters:

Parameter	Type	Description
value	MsoLineDashStyle	The value to set.

getCapType()

@deprecated. Please use the ‘capType’ property instead. Specifies the ending caps.

getCapType() : LineCapType;

Returns

LineCapType

setCapType(LineCapType)

@deprecated. Please use the ‘capType’ property instead. Specifies the ending caps.

setCapType(value: LineCapType) : void;

Parameters:

Parameter	Type	Description
value	LineCapType	The value to set.

getJoinType()

@deprecated. Please use the ‘joinType’ property instead. Specifies the joining caps.

getJoinType() : LineJoinType;

Returns

LineJoinType

setJoinType(LineJoinType)

@deprecated. Please use the ‘joinType’ property instead. Specifies the joining caps.

setJoinType(value: LineJoinType) : void;

Parameters:

Parameter	Type	Description
value	LineJoinType	The value to set.

getBeginType()

@deprecated. Please use the ‘beginType’ property instead. Specifies an arrowhead for the begin of a line.

getBeginType() : MsoArrowheadStyle;

Returns

MsoArrowheadStyle

setBeginType(MsoArrowheadStyle)

@deprecated. Please use the ‘beginType’ property instead. Specifies an arrowhead for the begin of a line.

setBeginType(value: MsoArrowheadStyle) : void;

Parameters:

Parameter	Type	Description
value	MsoArrowheadStyle	The value to set.

getEndType()

@deprecated. Please use the ’endType’ property instead. Specifies an arrowhead for the end of a line.

getEndType() : MsoArrowheadStyle;

Returns

MsoArrowheadStyle

setEndType(MsoArrowheadStyle)

@deprecated. Please use the ’endType’ property instead. Specifies an arrowhead for the end of a line.

setEndType(value: MsoArrowheadStyle) : void;

Parameters:

Parameter	Type	Description
value	MsoArrowheadStyle	The value to set.

getBeginArrowLength()

@deprecated. Please use the ‘beginArrowLength’ property instead. Specifies the length of the arrowhead for the begin of a line.

getBeginArrowLength() : MsoArrowheadLength;

Returns

MsoArrowheadLength

setBeginArrowLength(MsoArrowheadLength)

@deprecated. Please use the ‘beginArrowLength’ property instead. Specifies the length of the arrowhead for the begin of a line.

setBeginArrowLength(value: MsoArrowheadLength) : void;

Parameters:

Parameter	Type	Description
value	MsoArrowheadLength	The value to set.

getEndArrowLength()

@deprecated. Please use the ’endArrowLength’ property instead. Specifies the length of the arrowhead for the end of a line.

getEndArrowLength() : MsoArrowheadLength;

Returns

MsoArrowheadLength

setEndArrowLength(MsoArrowheadLength)

@deprecated. Please use the ’endArrowLength’ property instead. Specifies the length of the arrowhead for the end of a line.

setEndArrowLength(value: MsoArrowheadLength) : void;

Parameters:

Parameter	Type	Description
value	MsoArrowheadLength	The value to set.

getBeginArrowWidth()

@deprecated. Please use the ‘beginArrowWidth’ property instead. Specifies the width of the arrowhead for the begin of a line.

getBeginArrowWidth() : MsoArrowheadWidth;

Returns

MsoArrowheadWidth

setBeginArrowWidth(MsoArrowheadWidth)

@deprecated. Please use the ‘beginArrowWidth’ property instead. Specifies the width of the arrowhead for the begin of a line.

setBeginArrowWidth(value: MsoArrowheadWidth) : void;

Parameters:

Parameter	Type	Description
value	MsoArrowheadWidth	The value to set.

getEndArrowWidth()

@deprecated. Please use the ’endArrowWidth’ property instead. Specifies the width of the arrowhead for the end of a line.

getEndArrowWidth() : MsoArrowheadWidth;

Returns

MsoArrowheadWidth

setEndArrowWidth(MsoArrowheadWidth)

@deprecated. Please use the ’endArrowWidth’ property instead. Specifies the width of the arrowhead for the end of a line.

setEndArrowWidth(value: MsoArrowheadWidth) : void;

Parameters:

Parameter	Type	Description
value	MsoArrowheadWidth	The value to set.

getThemeColor()

@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.

getThemeColor() : ThemeColor;

Returns

ThemeColor

Remarks

If the foreground color is not a theme color, NULL will be returned.

setThemeColor(ThemeColor)

@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.

setThemeColor(value: ThemeColor) : void;

Parameters:

Parameter	Type	Description
value	ThemeColor	The value to set.

Remarks

If the foreground color is not a theme color, NULL will be returned.

getColor()

@deprecated. Please use the ‘color’ property instead. Represents the Color of the line.

getColor() : Color;

Returns

Color

setColor(Color)

@deprecated. Please use the ‘color’ property instead. Represents the Color of the line.

setColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getTransparency()

@deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).

getTransparency() : number;

setTransparency(number)

@deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the line as a value from 0.0 (opaque) through 1.0 (clear).

setTransparency(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getStyle()

@deprecated. Please use the ‘style’ property instead. Represents the style of the line.

getStyle() : LineType;

Returns

LineType

setStyle(LineType)

@deprecated. Please use the ‘style’ property instead. Represents the style of the line.

setStyle(value: LineType) : void;

Parameters:

Parameter	Type	Description
value	LineType	The value to set.

getWeight()

@deprecated. Please use the ‘weight’ property instead. Gets or sets the WeightType of the line.

getWeight() : WeightType;

Returns

WeightType

setWeight(WeightType)

@deprecated. Please use the ‘weight’ property instead. Gets or sets the WeightType of the line.

setWeight(value: WeightType) : void;

Parameters:

Parameter	Type	Description
value	WeightType	The value to set.

getWeightPt()

@deprecated. Please use the ‘weightPt’ property instead. Gets or sets the weight of the line in unit of points.

getWeightPt() : number;

setWeightPt(number)

@deprecated. Please use the ‘weightPt’ property instead. Gets or sets the weight of the line in unit of points.

setWeightPt(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getWeightPx()

@deprecated. Please use the ‘weightPx’ property instead. Gets or sets the weight of the line in unit of pixels.

getWeightPx() : number;

setWeightPx(number)

@deprecated. Please use the ‘weightPx’ property instead. Gets or sets the weight of the line in unit of pixels.

setWeightPx(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getFormattingType()

@deprecated. Please use the ‘formattingType’ property instead. Gets or sets format type.

getFormattingType() : ChartLineFormattingType;

Returns

ChartLineFormattingType

setFormattingType(ChartLineFormattingType)

@deprecated. Please use the ‘formattingType’ property instead. Gets or sets format type.

setFormattingType(value: ChartLineFormattingType) : void;

Parameters:

Parameter	Type	Description
value	ChartLineFormattingType	The value to set.

isAutomaticColor()

@deprecated. Please use the ‘isAutomaticColor’ property instead. Indicates whether the color of line is automatic assigned.

isAutomaticColor() : boolean;

isVisible()

@deprecated. Please use the ‘isVisible’ property instead. Represents whether the line is visible.

isVisible() : boolean;

setIsVisible(boolean)

@deprecated. Please use the ‘isVisible’ property instead. Represents whether the line is visible.

setIsVisible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isAuto()

@deprecated. Please use the ‘isAuto’ property instead. Indicates whether this line style is auto assigned.

isAuto() : boolean;

setIsAuto(boolean)

@deprecated. Please use the ‘isAuto’ property instead. Indicates whether this line style is auto assigned.

setIsAuto(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getGradientFill()

@deprecated. Please use the ‘gradientFill’ property instead. Represents gradient fill.

getGradientFill() : GradientFill;

Returns

GradientFill