Skip to main content

Interface: ILayout

Represents a layout contained within a specific user created design.

Properties​

createdAt​

createdAt: Date

The date this layout was created.


editableArea?​

optional editableArea?: object

height​

height: number

width​

width: number

x​

x: number

y​

y: number


height​

height: number

The height of the layout. This matches the background element on the canvas as a convenience.


id​

id: string

The internal identifier for this layout.


index​

index: number

The index this layout appears at in its design


layoutPath?​

optional layoutPath?: string

A link to the json resource describing this layout


name​

name: string


panelId​

panelId: string

An id for the panel associated to this layout.


previewRegion?​

optional previewRegion?: object

height​

height: number

left​

left: number

top​

top: number

width​

width: number


title?​

optional title?: string


transparentBackground?​

optional transparentBackground?: boolean

When true this layout should contain no background fill.


updatedAt​

updatedAt: Date

The date this layout was last updated.


useEditableArea?​

optional useEditableArea?: boolean


width​

width: number

The width of the layout. This matches the background element on the canvas as a convenience.