Line
Line class
Encapsulates the object that represents the line format.
class Line;
Example
const { Workbook, ChartType, LineType, ChartMarkerType, WeightType } = require("aspose.cells.node");
var workbook = new Workbook();
var cells = workbook.worksheets.get(0).cells;
cells.get("a1").putValue(2);
cells.get("a2").putValue(5);
cells.get("a3").putValue(3);
cells.get("a4").putValue(6);
cells.get("b1").putValue(4);
cells.get("b2").putValue(3);
cells.get("b3").putValue(6);
cells.get("b4").putValue(7);
var chartIndex = workbook.worksheets.get(0).charts.add(ChartType.Column, 11, 0, 27, 10);
var chart = workbook.worksheets.get(0).charts.get(chartIndex);
chart.nSeries.add("A1:B4", true);
//Applying a dotted line style on the lines of an NSeries
chart.nSeries.get(0).border.style = LineType.Dot;
//Applying a triangular marker style on the data markers of an NSeries
chart.nSeries.get(0).marker.markerStyle = ChartMarkerType.Triangle;
//Setting the weight of all lines in an NSeries to medium
chart.nSeries.get(0).border.weight = WeightType.MediumLine;
Properties
| Property | Type | Description |
|---|---|---|
| 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 |
|---|---|
| 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. |
| isNull() | Checks whether the implementation object is null. |
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;
getCompoundType()
@deprecated. Please use the ‘compoundType’ property instead. Specifies the compound line type
getCompoundType() : MsoLineStyle;
Returns
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
isNull()
Checks whether the implementation object is null.
isNull() : boolean;