LayoutItem Class

Represents the valid values that define a layout item.

Metadata

Use this class when accessing Metadata.Layout metadata components. For more information, see “LayoutItem” in the Metadata API Developer Guide.

The following are properties for LayoutItem.

  • analyticsCloudComponent

    A Wave Analytics dashboard component on a page.

  • behavior

    Determines the field behavior.

  • canvas

    References a canvas app.

  • component

    References a component.

  • customLink

    The custom link reference.

  • emptySpace

    Controls if this layout item is a blank space.

  • field

    The field name reference, relative to the layout, for example “Description” or “MyField__c”.

  • height

    For s-controls and pages only, the height in pixels.

  • page_x

    Reference to a Visualforce page.

  • reportChartComponent

    Refers to a report chart that you can add to a standard or custom object page.

  • scontrol

    Reference to an s-control.

  • showLabel

    For s-control and pages only, whether to show the label.

  • showScrollbars

    For s-control and pages only, whether to show scrollbars.

  • width

    For s-control and pages only, the width in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values must include the percent sign, for example, 20%.

A Wave Analytics dashboard component on a page.

public Metadata.AnalyticsCloudComponentLayoutItem analyticsCloudComponent {get; set;}

Type: Metadata.AnalyticsCloudComponentLayoutItem

Determines the field behavior.

public Metadata.UiBehavior behavior {get; set;}

Type: Metadata.UiBehavior

References a canvas app.

public String canvas {get; set;}

Type: String

References a component.

public String component {get; set;}

Type: String

The custom link reference.

public String customLink {get; set;}

Type: String

Controls if this layout item is a blank space.

public Boolean emptySpace {get; set;}

Type: Boolean

The field name reference, relative to the layout, for example “Description” or “MyField__c”.

public String field {get; set;}

Type: String

For s-controls and pages only, the height in pixels.

public Integer height {get; set;}

Type: Integer

Reference to a Visualforce page.

public String page_x {get; set;}

Type: String

Refers to a report chart that you can add to a standard or custom object page.

public Metadata.ReportChartComponentLayoutItem reportChartComponent {get; set;}

Type: Metadata.ReportChartComponentLayoutItem

Reference to an s-control.

public String scontrol {get; set;}

Type: String

For s-control and pages only, whether to show the label.

public Boolean showLabel {get; set;}

Type: Boolean

For s-control and pages only, whether to show scrollbars.

public Boolean showScrollbars {get; set;}

Type: Boolean

For s-control and pages only, the width in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values must include the percent sign, for example, 20%.

public String width {get; set;}

Type: String

The following are methods for LayoutItem.

  • clone()

    Makes a duplicate copy of the Metadata.LayoutItem.

Makes a duplicate copy of the Metadata.LayoutItem.

public Object clone()

Type: Object