Word.Interfaces.ShadowFormatData interface
An interface describing the data returned by calling shadowFormat.toJSON().
Properties
| blur | Specifies the blur level for a shadow format as a value between 0.0 and 100.0. |
| foreground |
Returns a |
| is |
Specifies whether the object or the formatting applied to it is visible. |
| obscured | Specifies |
| offsetX | Specifies the horizontal offset (in points) of the shadow from the shape. A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. |
| offsetY | Specifies the vertical offset (in points) of the shadow from the shape. A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. |
| rotate |
Specifies whether to rotate the shadow when rotating the shape. |
| size | Specifies the width of the shadow. |
| style | Specifies the type of shadow formatting to apply to a shape. |
| transparency | Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). |
| type | Specifies the shape shadow type. |
Property Details
blur
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the blur level for a shadow format as a value between 0.0 and 100.0.
blur?: number;Property Value
number
Remarks
foregroundColor
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Returns a ColorFormat object that represents the foreground color for the fill, line, or shadow.
foregroundColor?: Word.Interfaces.ColorFormatData;Property Value
Remarks
isVisible
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether the object or the formatting applied to it is visible.
isVisible?: boolean;Property Value
boolean
Remarks
obscured
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies true if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, false if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill.
obscured?: boolean;Property Value
boolean
Remarks
offsetX
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the horizontal offset (in points) of the shadow from the shape. A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left.
offsetX?: number;Property Value
number
Remarks
offsetY
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the vertical offset (in points) of the shadow from the shape. A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom.
offsetY?: number;Property Value
number
Remarks
rotateWithShape
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether to rotate the shadow when rotating the shape.
rotateWithShape?: boolean;Property Value
boolean
Remarks
size
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the width of the shadow.
size?: number;Property Value
number
Remarks
style
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the type of shadow formatting to apply to a shape.
style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";Property Value
Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"
Remarks
transparency
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).
transparency?: number;Property Value
number
Remarks
type
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the shape shadow type.
type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";Property Value
Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"