Excel.Interfaces.ShapeLineFormatUpdateData interface

An interface for updating data on the ShapeLineFormat object, for use in "shapeLineFormat.set({ ... })".

Properties

color

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

[ 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.ShapeLineStyle for details.

[ 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.

[ 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.

[ API set: ExcelApi 1.9 ]

visible

Represents whether or not the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.

[ 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.

[ API set: ExcelApi 1.9 ]

Property Details

color

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

[ API set: ExcelApi 1.9 ]

color?: string;

Property Value

string

dashStyle

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

[ API set: ExcelApi 1.9 ]

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"

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.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

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.

[ API set: ExcelApi 1.9 ]

transparency?: number;

Property Value

number

visible

Represents whether or not the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.

[ API set: ExcelApi 1.9 ]

visible?: boolean;

Property Value

boolean

weight

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

[ API set: ExcelApi 1.9 ]

weight?: number;

Property Value

number