LayoutFieldInfo: {
    height: number;
    isClipArt: boolean;
    name: string;
    sequence: number;
    tags: string[];
    type: string;
    width: number;
}

The layout field info is part of the response about a layout item and can be used by the script to identify what is within the layout.

Type declaration

  • height: number

    The relative height of the field (0-1)

  • isClipArt: boolean

    Boolean flag to control if the field is a clipart field. For non image fields, this is always false. If an image field is a clipart, it will keep the reference to the image used when the layout is applied, otherwise the field will be always empty.

  • name: string

    The name of the field. Most fields may not have a name set.

  • sequence: number

    The sequence number is used to control a logical order of the fields within a layout. The sequence is used when transfering data from on layout to another.

  • tags: string[]

    The tags of the field.

  • type: string

    The type of the field.

  • width: number

    The relative width of the field (0-1)

Generated using TypeDoc