ReportChartComponentLayoutItem Class

Represents the settings for a report chart on a standard or custom page.

Namespace

Metadata

Usage

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

ReportChartComponentLayoutItem Properties

The following are properties for ReportChartComponentLayoutItem.

  • cacheData
    Indicates whether to use cached data when displaying the chart. When the attribute is set to true, data is cached for 24 hours. When the attribute is set to false, the report is run every time the page is refreshed.
  • contextFilterableField
    Unique development name of the field by which a report chart is filtered to return data relevant to the page. If set, the ID field for the parent object of the page or report type is the chart data filter. The parent object for the report type and the page must match for a chart to return relevant data.
  • error
    Error string that is populated only when an error occurs in the underlying report.
  • hideOnError
    Controls whether users see a chart that has an error. When an error occurs and this attribute is not set, the chart doesn’t show any data except the error. Set the attribute to true to hide the chart from a page on error.
  • includeContext
    If true, filters the report chart to return data that’s relevant to the page.
  • reportName
    Unique development name of a report that includes a chart.
  • showTitle
    If true, applies the title from the report to the chart.
  • size
    Size of the displayed chart. The default is medium.

cacheData

Indicates whether to use cached data when displaying the chart. When the attribute is set to true, data is cached for 24 hours. When the attribute is set to false, the report is run every time the page is refreshed.

Signature

public Boolean cacheData {get; set;}

Property Value

Type: Boolean

contextFilterableField

Unique development name of the field by which a report chart is filtered to return data relevant to the page. If set, the ID field for the parent object of the page or report type is the chart data filter. The parent object for the report type and the page must match for a chart to return relevant data.

Signature

public String contextFilterableField {get; set;}

Property Value

Type: String

error

Error string that is populated only when an error occurs in the underlying report.

Signature

public String error {get; set;}

Property Value

Type: String

hideOnError

Controls whether users see a chart that has an error. When an error occurs and this attribute is not set, the chart doesn’t show any data except the error. Set the attribute to true to hide the chart from a page on error.

Signature

public Boolean hideOnError {get; set;}

Property Value

Type: Boolean

includeContext

If true, filters the report chart to return data that’s relevant to the page.

Signature

public Boolean includeContext {get; set;}

Property Value

Type: Boolean

reportName

Unique development name of a report that includes a chart.

Signature

public String reportName {get; set;}

Property Value

Type: String

showTitle

If true, applies the title from the report to the chart.

Signature

public Boolean showTitle {get; set;}

Property Value

Type: Boolean

size

Size of the displayed chart. The default is medium.

Signature

public Metadata.ReportChartComponentSize size {get; set;}

Property Value

Type: Metadata.ReportChartComponentSize

ReportChartComponentLayoutItem Methods

The following are methods for ReportChartComponentLayoutItem.

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

clone()

Makes a duplicate copy of the Metadata.ReportChartComponentLayoutItem.

Signature

public Object clone()

Return Value

Type: Object