Edit

Share via

Word.Interfaces.ColorFormatData interface

Package:
word

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

Properties

brightness

Specifies the brightness of a specified shape color. Valid values are from -1 (darkest) to 1 (lightest), 0 represents neutral.
objectThemeColor

Specifies the theme color for a color format.
rgb

Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format.
tintAndShade

Specifies the lightening or darkening of a specified shape's color. Valid values are from -1 (darkest) to 1 (lightest), 0 represents neutral.
type

Returns the shape color type.

Property Details

brightness

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 brightness of a specified shape color. Valid values are from -1 (darkest) to 1 (lightest), 0 represents neutral.

brightness?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

objectThemeColor

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 theme color for a color format.

objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2";

Property Value

Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

rgb

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 red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format.

rgb?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

tintAndShade

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 lightening or darkening of a specified shape's color. Valid values are from -1 (darkest) to 1 (lightest), 0 represents neutral.

tintAndShade?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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.

Returns the shape color type.

type?: Word.ColorType | "rgb" | "scheme";

Property Value

Word.ColorType | "rgb" | "scheme"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]