Excel.Interfaces.ShapeLineFormatData interface

Package:

excel

An interface describing the data returned by calling shapeLineFormat.toJSON().

Properties

color	Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
dashStyle	Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent dash styles. See Excel.ShapeLineDashStyle for details.
style	Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See Excel.ShapeLineStyle for details.
transparency	Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
visible	Specifies if the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.
weight	Represents the weight of the line, in points. Returns null when the line is not visible or there are inconsistent line weights.

Property Details

color

Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").

color?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

dashStyle

Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent dash styles. See Excel.ShapeLineDashStyle for details.

dashStyle?: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

Property Value

Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"

Remarks

[ API set: ExcelApi 1.9 ]

style

Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See Excel.ShapeLineStyle for details.

style?: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

Property Value

Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"

Remarks

[ API set: ExcelApi 1.9 ]

transparency

Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.

transparency?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

visible

Specifies if the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

weight

Represents the weight of the line, in points. Returns null when the line is not visible or there are inconsistent line weights.

weight?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]