Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
AnalyticsCloudComponentLayoutItem Class
ConsoleComponent Class
Container Class
CustomConsoleComponents Class
CustomMetadata Class
CustomMetadataValue Class
DeployCallback Interface
DeployCallbackContext Class
DeployContainer Class
DeployDetails Class
DeployMessage Class
DeployProblemType Enum
DeployResult Class
DeployStatus Enum
FeedItemTypeEnum Enum
FeedLayout Class
FeedLayoutComponent Class
FeedLayoutComponentType Enum
FeedLayoutFilter Class
FeedLayoutFilterPosition Enum
FeedLayoutFilterType Enum
Layout Class
LayoutColumn Class
LayoutHeader Enum
LayoutItem Class
LayoutSection Class
LayoutSectionStyle Enum
Metadata Class
MetadataType Enum
MetadataValue Class
MiniLayout Class
Operations Class
PlatformActionList Class
PlatformActionListContextEnum Enum
PlatformActionListItem Class
PlatformActionTypeEnum Enum
PrimaryTabComponents Class
QuickActionList Class
QuickActionListItem Class
RelatedContent Class
RelatedContentItem Class
RelatedList Class
RelatedListItem Class
ReportChartComponentLayoutItem Class
ReportChartComponentLayoutItem Properties
ReportChartComponentLayoutItem Methods
ReportChartComponentSize Enum
SidebarComponent Class
SortOrder Enum
StatusCode Enum
SubtabComponents Class
SummaryLayoutStyleEnum Enum
SummaryLayout Class
SummaryLayoutItem Class
UiBehavior Enum
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

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.

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.

Signature

public Object clone()

Return Value

Type: Object