ExcelScript.ShapeLineFormat interface
Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
get |
Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). |
get |
Represents the line style of the shape. Returns |
get |
Represents the line style of the shape. Returns |
get |
Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns |
get |
Specifies if the line formatting of a shape element is visible. Returns |
get |
Represents the weight of the line, in points. Returns |
set |
Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). |
set |
Represents the line style of the shape. Returns |
set |
Represents the line style of the shape. Returns |
set |
Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns |
set |
Specifies if the line formatting of a shape element is visible. Returns |
set |
Represents the weight of the line, in points. Returns |
Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
getColor(): string;
Returns
string
Represents the line style of the shape. Returns null
when the line is not visible or there are inconsistent dash styles. See ExcelScript.ShapeLineDashStyle
for details.
getDashStyle(): ShapeLineDashStyle;
Returns
Represents the line style of the shape. Returns null
when the line is not visible or there are inconsistent styles. See ExcelScript.ShapeLineStyle
for details.
getStyle(): ShapeLineStyle;
Returns
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.
getTransparency(): number;
Returns
number
Specifies if the line formatting of a shape element is visible. Returns null
when the shape has inconsistent visibilities.
getVisible(): boolean;
Returns
boolean
Represents the weight of the line, in points. Returns null
when the line is not visible or there are inconsistent line weights.
getWeight(): number;
Returns
number
Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
setColor(color: string): void;
Parameters
- color
-
string
Returns
void
Represents the line style of the shape. Returns null
when the line is not visible or there are inconsistent dash styles. See ExcelScript.ShapeLineDashStyle
for details.
setDashStyle(dashStyle: ShapeLineDashStyle): void;
Parameters
- dashStyle
- ExcelScript.ShapeLineDashStyle
Returns
void
Represents the line style of the shape. Returns null
when the line is not visible or there are inconsistent styles. See ExcelScript.ShapeLineStyle
for details.
setStyle(style: ShapeLineStyle): void;
Parameters
Returns
void
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.
setTransparency(transparency: number): void;
Parameters
- transparency
-
number
Returns
void
Specifies if the line formatting of a shape element is visible. Returns null
when the shape has inconsistent visibilities.
setVisible(visible: boolean): void;
Parameters
- visible
-
boolean
Returns
void
Represents the weight of the line, in points. Returns null
when the line is not visible or there are inconsistent line weights.
setWeight(weight: number): void;
Parameters
- weight
-
number
Returns
void
Office Scripts feedback
Office Scripts is an open source project. Select a link to provide feedback: