Type alias LayoutItem

LayoutItem: {
    fieldSummary: LayoutFieldInfo[];
    id: string;
    mode: LayoutModeType;
    name: string;
    numFields: number;
    parentCategory: string;
    restrictions: LayoutRestrictions | null;
    src: string;
}

The layout item holds the information about a specific layout. A layout holds a field configuration similar to a page. The fields are arranged in a defined position and order. The fields within a layout are usually empty, but for some, default data can be configured.

Type declaration

  • Readonly fieldSummary: LayoutFieldInfo[]

    A field summary. The order of the field info items are based on the z-index on the page.

  • Readonly id: string

    The id of the layout

  • Readonly mode: LayoutModeType

    The layout mode determines for which pages the layout can be used and how it is applied.

  • Readonly name: string

    The name of the layout

  • Readonly numFields: number

    The number of fields within the layout

  • Readonly parentCategory: string

    The id of the parent company

  • Readonly restrictions: LayoutRestrictions | null

    The restrictions (if any) for the layout. If restrictions are enabled, the layout set against the page controls the available background and clipart categories. Note that the MegaEdit product setting enableLayoutRestrictions must be set to true for this to work.

  • Readonly src: string

    This is the base 64 encoded thumbnail of the layout. The thumbnail is a low resolution version of the layout.

Settings

Member Visibility

Theme

Generated using TypeDoc