Page interface

Properties

contribution

Contribution for the page.

id

The id for the layout node.

inherited

A value indicating whether this layout node has been inherited from a parent layout. This is expected to only be only set by the combiner.

isContribution

A value indicating if the layout node is contribution are not.

label

The label for the page.

locked

A value indicating whether any user operations are permitted on this page and the contents of this page

order

Order in which the page should appear in the layout.

overridden

A value indicating whether this layout node has been overridden by a child layout.

pageType

The icon for the page.

sections

The sections of the page.

visible

A value indicating if the page should be hidden or not.

Property Details

contribution

Contribution for the page.

contribution: WitContribution

Property Value

id

The id for the layout node.

id: string

Property Value

string

inherited

A value indicating whether this layout node has been inherited from a parent layout. This is expected to only be only set by the combiner.

inherited: boolean

Property Value

boolean

isContribution

A value indicating if the layout node is contribution are not.

isContribution: boolean

Property Value

boolean

label

The label for the page.

label: string

Property Value

string

locked

A value indicating whether any user operations are permitted on this page and the contents of this page

locked: boolean

Property Value

boolean

order

Order in which the page should appear in the layout.

order: number

Property Value

number

overridden

A value indicating whether this layout node has been overridden by a child layout.

overridden: boolean

Property Value

boolean

pageType

The icon for the page.

pageType: PageType

Property Value

sections

The sections of the page.

sections: Section[]

Property Value

visible

A value indicating if the page should be hidden or not.

visible: boolean

Property Value

boolean