Interface BackgroundItem

A background item to be used for page as background. Double pages can have two backgrounds, one for each page.

Hierarchy

  • BackgroundItem

Properties

color name parent preview thumbnail

Properties

Readonly color

color: string

The color of the background item when a color background is used. For image backgrounds, this is null. Otherwise this is the CMYK or RGB color value.

Readonly name

name: string

The name of the background. This is the file name of the background item for image backgrounds and the name of the color for color backgrounds.

Readonly parent

parent: string

The parent is the id of the background category the background item belongs to.

Readonly preview

preview: string

The relative link to the preview of the background item when an image background is used. For color backgrounds, this is null. The preview is a medium resolution version of the background item.

Readonly thumbnail

thumbnail: string

The relative link to the thumbnail of the background item when an image background is used. For color backgrounds, this is null. The thumbnail is a low resolution version of the background item.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc