AnalyticsCloudComponentLayoutItem Class

Represents the settings for a Wave Analytics dashboard on a standard or custom page.

Namespace

Metadata

Usage

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

AnalyticsCloudComponentLayoutItem Properties

The following are properties for AnalyticsCloudComponentLayoutItem.

  • assetType
    Specifies the type of Wave Analytics asset.
  • devName
    Unique development name of the dashboard to add.
  • error
    An error string that is populated only when an error occurred in the underlying dashboard.
  • filter
    Dashboard filters for mapping data fields in the dashboard to the object’s fields.
  • height
    Specifies the height of the dashboard, in pixels.
  • hideOnError
    Controls whether users see a dashboard that has an error.
  • showHeader
    If true, includes the dashboard’s header bar. If false, the dashboard appears without a header bar.
  • showSharing
    If set to true, and the dashboard is shareable the dashboard shows the Share icon. If set to false, the dashboard doesn’t show the Share icon.
  • showTitle
    If true, includes the dashboard’s title above the dashboard. If false, the dashboard appears without a title.
  • width
    Specifies the width of the dashboard, in pixels or percentage.

assetType

Specifies the type of Wave Analytics asset.

Signature

public String assetType {get; set;}

Property Value

Type: String

devName

Unique development name of the dashboard to add.

Signature

public String devName {get; set;}

Property Value

Type: String

error

An error string that is populated only when an error occurred in the underlying dashboard.

Signature

public String error {get; set;}

Property Value

Type: String

filter

Dashboard filters for mapping data fields in the dashboard to the object’s fields.

Signature

public String filter {get; set;}

Property Value

Type: String

height

Specifies the height of the dashboard, in pixels.

Signature

public Integer height {get; set;}

Property Value

Type: Integer

hideOnError

Controls whether users see a dashboard that has an error.

Signature

public Boolean hideOnError {get; set;}

Property Value

Type: Boolean

showHeader

If true, includes the dashboard’s header bar. If false, the dashboard appears without a header bar.

Signature

public Boolean showHeader {get; set;}

Property Value

Type: Boolean

showSharing

If set to true, and the dashboard is shareable the dashboard shows the Share icon. If set to false, the dashboard doesn’t show the Share icon.

Signature

public Boolean showSharing {get; set;}

Property Value

Type: Boolean

showTitle

If true, includes the dashboard’s title above the dashboard. If false, the dashboard appears without a title.

Signature

public Boolean showTitle {get; set;}

Property Value

Type: Boolean

width

Specifies the width of the dashboard, in pixels or percentage.

Signature

public String width {get; set;}

Property Value

Type: String

AnalyticsCloudComponentLayoutItem Methods

The following are methods for AnalyticsCloudComponentLayoutItem.

  • clone()
    Makes a duplicate copy of the Metadata.AnalyticsCloudComponentLayoutItem.

clone()

Makes a duplicate copy of the Metadata.AnalyticsCloudComponentLayoutItem.

Signature

public Object clone()

Return Value

Type: Object