LineFormat
LineFormat class
Represents all setting of the line.
class LineFormat extends FillFormat;
Constructors
| Name | Description |
|---|---|
| constructor(FillFormat) | Constructs from a parent object convertible to this. |
Properties
| Property | Type | Description |
|---|---|---|
| compoundType | MsoLineStyle | Specifies the line compound type. |
| dashStyle | MsoLineDashStyle | Specifies the line dash type. |
| capType | LineCapType | Specifies the ending caps. |
| joinType | LineJoinType | Specifies the line join type. |
| beginArrowheadStyle | MsoArrowheadStyle | Gets and sets the begin arrow type of the line. |
| beginArrowheadWidth | MsoArrowheadWidth | Gets and sets the begin arrow width type of the line. |
| beginArrowheadLength | MsoArrowheadLength | Gets and sets the begin arrow length type of the line. |
| endArrowheadStyle | MsoArrowheadStyle | Gets and sets the end arrow type of the line. |
| endArrowheadWidth | MsoArrowheadWidth | Gets and sets the end arrow width type of the line. |
| endArrowheadLength | MsoArrowheadLength | Gets and sets the end arrow length type of the line. |
| weight | number | Gets or sets the weight of the line in unit of points. |
| fillType | FillType | Gets and sets fill type |
| transparency | number | Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
| gradientFill | GradientFill | Readonly. Gets GradientFill object. |
| textureFill | TextureFill | Readonly. Gets TextureFill object. |
| solidFill | SolidFill | Readonly. Gets SolidFill object. |
| patternFill | PatternFill | Readonly. Gets PatternFill object. |
| gradientColorType | GradientColorType | Readonly. Returns the gradient color type for the specified fill. |
| gradientStyle | GradientStyleType | Readonly. Returns the gradient style for the specified fill. |
| gradientColor1 | Color | Readonly. Returns the gradient color 1 for the specified fill. |
| gradientColor2 | Color | Readonly. Returns the gradient color 2 for the specified fill. |
| gradientDegree | number | Readonly. Returns the gradient degree for the specified fill. Only applies for Excel 2007. |
| gradientVariant | number | Readonly. Returns the gradient variant for the specified fill. Only applies for Excel 2007. |
| presetColor | GradientPresetType | Readonly. Returns the gradient preset color for the specified fill. |
| texture | TextureType | Represents the texture type for the specified fill. |
| pattern | FillPattern | Represents an area’s display pattern. |
| pictureFormatType | FillPictureType | Gets and sets the picture format type. |
| scale | number | Gets and sets the picture format scale. |
| imageData | Uint8Array | Gets and sets the picture image data. |
Methods
| Method | Description |
|---|---|
| setOneColorGradient(Color, number, GradientStyleType, number) | Sets the specified fill to a one-color gradient. Only applies for Excel 2007. |
| setTwoColorGradient(Color, Color, GradientStyleType, number) | Sets the specified fill to a two-color gradient. Only applies for Excel 2007. |
| setTwoColorGradient(Color, number, Color, number, GradientStyleType, number) | Sets the specified fill to a two-color gradient. Only applies for Excel 2007. |
| setPresetColorGradient(GradientPresetType, GradientStyleType, number) | Sets the specified fill to a preset-color gradient. Only applies for Excel 2007. |
| getHashCode() | Gets the hash code. |
| equals(VObject) | Determines whether this instance has the same value as another specified LineFormat object. |
constructor(FillFormat)
Constructs from a parent object convertible to this.
constructor(obj: FillFormat);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | FillFormat | The parent object. |
compoundType
Specifies the line compound type.
compoundType : MsoLineStyle;
dashStyle
Specifies the line dash type.
dashStyle : MsoLineDashStyle;
capType
Specifies the ending caps.
capType : LineCapType;
joinType
Specifies the line join type.
joinType : LineJoinType;
beginArrowheadStyle
Gets and sets the begin arrow type of the line.
beginArrowheadStyle : MsoArrowheadStyle;
beginArrowheadWidth
Gets and sets the begin arrow width type of the line.
beginArrowheadWidth : MsoArrowheadWidth;
beginArrowheadLength
Gets and sets the begin arrow length type of the line.
beginArrowheadLength : MsoArrowheadLength;
endArrowheadStyle
Gets and sets the end arrow type of the line.
endArrowheadStyle : MsoArrowheadStyle;
endArrowheadWidth
Gets and sets the end arrow width type of the line.
endArrowheadWidth : MsoArrowheadWidth;
endArrowheadLength
Gets and sets the end arrow length type of the line.
endArrowheadLength : MsoArrowheadLength;
weight
Gets or sets the weight of the line in unit of points.
weight : number;
fillType
Gets and sets fill type
fillType : FillType;
transparency
Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
transparency : number;
gradientFill
Readonly. Gets GradientFill object.
gradientFill : GradientFill;
textureFill
Readonly. Gets TextureFill object.
textureFill : TextureFill;
solidFill
Readonly. Gets SolidFill object.
solidFill : SolidFill;
patternFill
Readonly. Gets PatternFill object.
patternFill : PatternFill;
gradientColorType
Readonly. Returns the gradient color type for the specified fill.
gradientColorType : GradientColorType;
gradientStyle
Readonly. Returns the gradient style for the specified fill.
gradientStyle : GradientStyleType;
gradientColor1
Readonly. Returns the gradient color 1 for the specified fill.
gradientColor1 : Color;
gradientColor2
Readonly. Returns the gradient color 2 for the specified fill.
gradientColor2 : Color;
Remarks
Only when the gradient color type is GradientColorType.TwoColors, this property is meaningful.
gradientDegree
Readonly. Returns the gradient degree for the specified fill. Only applies for Excel 2007.
gradientDegree : number;
Remarks
Can only be a value from 0.0 (dark) through 1.0 (light).
gradientVariant
Readonly. Returns the gradient variant for the specified fill. Only applies for Excel 2007.
gradientVariant : number;
Remarks
Can only be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.
presetColor
Readonly. Returns the gradient preset color for the specified fill.
presetColor : GradientPresetType;
texture
Represents the texture type for the specified fill.
texture : TextureType;
pattern
Represents an area’s display pattern.
pattern : FillPattern;
pictureFormatType
Gets and sets the picture format type.
pictureFormatType : FillPictureType;
scale
Gets and sets the picture format scale.
scale : number;
imageData
Gets and sets the picture image data.
imageData : Uint8Array;
Remarks
If the fill format is not custom texture format, returns null.
setOneColorGradient(Color, number, GradientStyleType, number)
Sets the specified fill to a one-color gradient. Only applies for Excel 2007.
setOneColorGradient(color: Color, degree: number, style: GradientStyleType, variant: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| color | Color | One gradient color. |
| degree | number | The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light). |
| style | GradientStyleType | Gradient shading style. |
| variant | number | The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
setTwoColorGradient(Color, Color, GradientStyleType, number)
Sets the specified fill to a two-color gradient. Only applies for Excel 2007.
setTwoColorGradient(color1: Color, color2: Color, style: GradientStyleType, variant: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| color1 | Color | One gradient color. |
| color2 | Color | Two gradient color. |
| style | GradientStyleType | Gradient shading style. |
| variant | number | The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
setTwoColorGradient(Color, number, Color, number, GradientStyleType, number)
Sets the specified fill to a two-color gradient. Only applies for Excel 2007.
setTwoColorGradient(color1: Color, transparency1: number, color2: Color, transparency2: number, style: GradientStyleType, variant: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| color1 | Color | One gradient color. |
| transparency1 | number | The degree of transparency of the color1 as a value from 0.0 (opaque) through 1.0 (clear). |
| color2 | Color | Two gradient color. |
| transparency2 | number | The degree of transparency of the color2 as a value from 0.0 (opaque) through 1.0 (clear). |
| style | GradientStyleType | Gradient shading style. |
| variant | number | The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
setPresetColorGradient(GradientPresetType, GradientStyleType, number)
Sets the specified fill to a preset-color gradient. Only applies for Excel 2007.
setPresetColorGradient(presetColor: GradientPresetType, style: GradientStyleType, variant: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| presetColor | GradientPresetType | Preset color type |
| style | GradientStyleType | Gradient shading style. |
| variant | number | The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
getHashCode()
Gets the hash code.
getHashCode() : number;
equals(VObject)
Determines whether this instance has the same value as another specified LineFormat object.
equals(obj: VObject) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | VObject | The LineFormat object to compare with this instance. |
Returns
true if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false.