GM - Report Table

(gmpkg:reportTableLWC)

Documentation

GM - Report Table component is used to display a Report table on any Lightning page (Home, App, Record). It supports Tabular and Summarized Reports. The report filters can be configured through the App Builder and using the current object on a Record Page.

Use case: Display a summarized report of opportunities filtered by current account.

Specification

Property Type Description

Property	Type	Description
Report Developer Name *	String	The report developer name. This is a unique name across the org.
Details Row	Boolean	Check this option to show details row. This option is useful for Summarized report only.
Subtotals	Boolean	Check this option to show Subtotals row. This option is useful for Summarized report only.
Grand Total	Boolean	Check this option to show Grand Total header. This option is useful for Summarized report only.
Filter	String	JSON Report Filters. `{ "$report_field": { "value": "$field_value" } }` Where $report_field is the name of field to filter on an $field_value is the value of the filter. $recordId can be used to reference the current recordId. Below is an example to filter an opportunity report based on the current account. `{ "ACCOUNT_ID": { "value": "$recordId" } }` $record.fieldApiName can be used to filter by any record field when the component is configured on a Lightning Record Page.
Hide Refresh	Boolean	Check this checkbox to hide the refresh button
Hide Expand	Boolean	Check this checkbox to hide the Expand button.
Hide Footer	Boolean	Check this checkbox to hide the footer. The user will not be able to toggle Details Row, Sub Totals and Grand Total
Custom Label	Boolean	Set a specific label instead of the report label. When a custom label is defined, the user will no be able to navigate to the report.
Table Height	Integer	Set this property if you want to control the height. The user has to scroll vertically to see more records.

Report Developer Name *

String

The report developer name. This is a unique name across the org.

Details Row

Boolean

Check this option to show details row.

This option is useful for Summarized report only.

Subtotals

Boolean

Check this option to show Subtotals row.

This option is useful for Summarized report only.

Grand Total

Boolean

Check this option to show Grand Total header.

This option is useful for Summarized report only.

Filter

String

JSON Report Filters.

{
    "$report_field": {
        "value": "$field_value"
    }
}

Where $report_field is the name of field to filter on an $field_value is the value of the filter.

$recordId can be used to reference the current recordId.

Below is an example to filter an opportunity report based on the current account.

{
    "ACCOUNT_ID": {
        "value": "$recordId"
    }
}

$record.fieldApiName can be used to filter by any record field when the component is configured on a Lightning Record Page.

Hide Refresh

Boolean

Check this checkbox to hide the refresh button

Hide Expand

Boolean

Check this checkbox to hide the Expand button.

Hide Footer

Boolean

Check this checkbox to hide the footer. The user will not be able to toggle Details Row, Sub Totals and Grand Total

Custom Label

Boolean

Set a specific label instead of the report label. When a custom label is defined, the user will no be able to navigate to the report.

Table Height

Integer

Set this property if you want to control the height. The user has to scroll vertically to see more records.

API Reference

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata" fqn="reportTable">
    <apiVersion>55.0</apiVersion>
    <masterLabel>GM - Report Table</masterLabel>
    <isExposed>true</isExposed>
    <targets>
        <target>lightning__RecordPage</target>
        <target>lightning__AppPage</target>
        <target>lightning__HomePage</target>
    </targets>
    <targetConfigs>
        <targetConfig targets="lightning__RecordPage,lightning__AppPage,lightning__HomePage">
            <property
                name="developerName"
                type="String"
                label="Report Developer Name"
                description="Report Developer Name"
            />
            <property name="customLabel" type="String" label="Custom Label" description="Custom Report Label" />
            <property name="filter" type="String" label="Filter" description="JSON Report Filters" />
            <property name="detailsRow" type="Boolean" label="Details Row" description="Enable Details Row" />
            <property name="subtotals" type="Boolean" label="Subtotals" description="Enable Subtotals" />
            <property name="grandTotal" type="Boolean" label="Grand Total" description="Enable Grand Total" />
            <property name="showBorder" type="Boolean" label="Show Border" description="Show Border" />
            <property name="hideRefresh" type="Boolean" label="Hide Refresh" description="Hide the Refresh Button" />
            <property name="hideExpand" type="Boolean" label="Hide Expand" description="Hide the Expand Button" />
            <property name="hideFooter" type="Boolean" label="Hide Footer" description="Hide the Footer" />
            <property name="height" type="Integer" label="Table Height" description="Set the table height" />
        </targetConfig>
    </targetConfigs>
</LightningComponentBundle>

PreviousGM - Map List NextGM - Object Timeline

Last updated 3 months ago