Interface: IBaseSurfaceDefinition

A structure representing basic surface features.

Extends

• IModelComponent

Extended by

• ISurfaceDefinition
• ISurfaceTemplate
• IBaseSurfacesDefinition

Properties

name?

optional name?: string

A name of a surface (a page) in the product.

Remarks

In multipage products, it allows you to use a name mask for product surfaces. If this string contains the {0} placeholder, it will be replaced with a page number, starting from 1. For example, name: "Page {0}" specifies the following page captions in the Bottom toolbar: Page 1, Page 2, and so on.

Inherited from

IModelComponent.name

---

foldingLines?

optional foldingLines?: IFoldingLine[]

A collection of folding lines defined in the surface (page).

---

spines?

optional spines?: ISpine[]

A collection of spines defined in the surface (page).

---

bgFoldingMode?

optional bgFoldingMode?: IBgFoldingModeParams

Parameters of the background folding mode.

---

proofImage?

optional proofImage?: IProofImage

Settings of proof images.