[ { "objectName": "Task", "filter": "{}", "titleFieldName": "Subject", "dateFieldName": "ActivityDate", "popoverFields": "CreatedDate,LastModifiedDate", "popoverColums": 2, "coloring": "[{\"color\":\"#8cedbb\",\"exp\":true}]", "actions": "[]", "defaultValues": "{\"StartDateTime\":\"$fromTime\"}", "icon": "standard:task", "label": "Tasks" } ]

Property	Description
name	Internal unique identifier for the section (used in logic). `{ "name": "accountInformation" }`
label	The display title of the section, shown to users. `{ "label": "Account Information" }`
active	A flag (true/false or special value like "always") that controls if the section is enabled. If set to "always" it means the section is always active. `{ "name": "contactInformation", "label": "Contact Information", "active": "always", "cols": 2, "rows": [ [ { "apiName": "Email" }, { "apiName": "Phone" } ] ] }`
cols	Number of columns to display in that section. This controls layout/grid: how many fields (or blocks) appear per row. `{ "name": "accountInformation", "label": "Account Information", "cols": 3, "rows": [ [ { "apiName": "Name" }, { "apiName": "Phone" }, { "apiName": "Website" } ] ] }`
visibility	A visibility condition (JSON object) that determines whether the entire section is visible or hidden based on field values of the record. This follows the same rule‐structure as the “readOnly” conditions (operator, value). `{ "name": "addressInformation", "label": "Address Information", "active": true, "visibility": { "BillingCountry": { "operator": "=", "value": "USA" } }, "cols": 2, "rows": [ [ { "apiName": "BillingStreet" }, { "apiName": "ShippingStreet" } ] ] }`
readOnly	A read‐only condition for the whole section. If this evaluates true, all fields in the section become non‐editable. `{ "name": "accountInformation", "label": "Account Information", "active": true, "readOnly": { "Industry": { "operator": "=", "value": "Banking" } }, "cols": 3, "rows": [ [ { "apiName": "Name" }, { "apiName": "Industry" }, { "apiName": "Phone" } ] ] }`
rows	An array of rows. Each row is itself an array of “cells” (either field definitions or emptyBlock definitions) that fill up to cols columns. Fields can span columns using colSize. `{ "name": "accountInformation", "label": "Account Information", "cols": 3, "rows": [ [ { "apiName": "Name" }, { "apiName": "Phone" }, { "apiName": "Website" } ], [ { "apiName": "Description", "colSize": 2 }, { "emptyBlock": true } ] ] }`

Property

Description

name

Internal unique identifier for the section (used in logic).

{
  "name": "accountInformation"
}

label

The display title of the section, shown to users.

{
  "label": "Account Information"
}

active

A flag (true/false or special value like "always") that controls if the section is enabled. If set to "always" it means the section is always active.

{
  "name": "contactInformation",
  "label": "Contact Information",
  "active": "always",
  "cols": 2,
  "rows": [
    [
      { "apiName": "Email" },
      { "apiName": "Phone" }
    ]
  ]
}

cols

Number of columns to display in that section. This controls layout/grid: how many fields (or blocks) appear per row.

{
  "name": "accountInformation",
  "label": "Account Information",
  "cols": 3,
  "rows": [
    [
      { "apiName": "Name" },
      { "apiName": "Phone" },
      { "apiName": "Website" }
    ]
  ]
}

visibility

A visibility condition (JSON object) that determines whether the entire section is visible or hidden based on field values of the record. This follows the same rule‐structure as the “readOnly” conditions (operator, value).

{
  "name": "addressInformation",
  "label": "Address Information",
  "active": true,
  "visibility": {
    "BillingCountry": { "operator": "=", "value": "USA" }
  },
  "cols": 2,
  "rows": [
    [
      { "apiName": "BillingStreet" },
      { "apiName": "ShippingStreet" }
    ]
  ]
}

readOnly

A read‐only condition for the whole section. If this evaluates true, all fields in the section become non‐editable.

{
  "name": "accountInformation",
  "label": "Account Information",
  "active": true,
  "readOnly": {
    "Industry": { "operator": "=", "value": "Banking" }
  },
  "cols": 3,
  "rows": [
    [
      { "apiName": "Name" },
      { "apiName": "Industry" },
      { "apiName": "Phone" }
    ]
  ]
}

rows

An array of rows. Each row is itself an array of “cells” (either field definitions or emptyBlock definitions) that fill up to cols columns. Fields can span columns using colSize.

{
  "name": "accountInformation",
  "label": "Account Information",
  "cols": 3,
  "rows": [
    [
      { "apiName": "Name" },
      { "apiName": "Phone" },
      { "apiName": "Website" }
    ],
    [
      { "apiName": "Description", "colSize": 2 },
      { "emptyBlock": true }
    ]
  ]
}

Property	Description
apiName	The API name of the field in the data model that will be displayed. `{ "apiName": "Name" }`
colSize	Optional. Defines how many columns wide the field spans (useful when a field should cover more than a single column). `{ "apiName": "Description", "colSize": 2 }`
noWhitespace	Optional boolean. If true, removes extra whitespace/margins around the field component. `{ "apiName": "Industry", "noWhitespace": true }`
readOnly	A JSON condition (like visibility) that determines if the field is editable or not. Even if the section is editable, this field can individually be read‐only. `{ "apiName": "AccountSource", "readOnly": { "AccountSource": { "operator": "in", "value": ["Web", "Other"] } } }`
visibility	A JSON condition that determines whether the field is shown at all. `{ "apiName": "Industry", "visibility": { "BillingCountry": { "operator": "!=", "value": "USA" } } }`
coloring	An array of coloring rules: each rule has a color value and an exp object that defines a condition under which that color is applied to the field. This allows conditional highlighting. `{ "apiName": "Status", "coloring": [ { "color": "#a6f79e", "exp": { "Status": { "operator": "=", "value": "Active" } } } ] }`
emptyBlock	If the object is { "emptyBlock": true }, it means “insert an empty slot here” for layout purposes (no field displayed). `[ { "apiName": "Description", "colSize": 2 }, { "emptyBlock": true } ]`
autocomplete	Provides a City field with an autocomplete dropdown, suggesting values like Paris, London, New York, and Rome as the user types. `{ "apiName": "City", "autocomplete": ["Paris", "London", "New York", "Rome"] }`

Property

Description

apiName

The API name of the field in the data model that will be displayed.

{
  "apiName": "Name"
}

colSize

Optional. Defines how many columns wide the field spans (useful when a field should cover more than a single column).

{
  "apiName": "Description",
  "colSize": 2
}

noWhitespace

Optional boolean. If true, removes extra whitespace/margins around the field component.

{
  "apiName": "Industry",
  "noWhitespace": true
}

readOnly

A JSON condition (like visibility) that determines if the field is editable or not. Even if the section is editable, this field can individually be read‐only.

{
  "apiName": "AccountSource",
  "readOnly": {
    "AccountSource": { "operator": "in", "value": ["Web", "Other"] }
  }
}

visibility

A JSON condition that determines whether the field is shown at all.

{
  "apiName": "Industry",
  "visibility": {
    "BillingCountry": { "operator": "!=", "value": "USA" }
  }
}

coloring

An array of coloring rules: each rule has a color value and an exp object that defines a condition under which that color is applied to the field. This allows conditional highlighting.

{
  "apiName": "Status",
  "coloring": [
    {
      "color": "#a6f79e",
      "exp": { "Status": { "operator": "=", "value": "Active" } }
    }
  ]
}

emptyBlock

If the object is { "emptyBlock": true }, it means “insert an empty slot here” for layout purposes (no field displayed).

[
  { "apiName": "Description", "colSize": 2 },
  { "emptyBlock": true }
]

autocomplete

Provides a City field with an autocomplete dropdown, suggesting values like Paris, London, New York, and Rome as the user types.

{
  "apiName": "City",
  "autocomplete": ["Paris", "London", "New York", "Rome"]
}

Mode	Moving a task	What drives the schedule
MS Project	Sets a date constraint on the task	Constraints take priority over dependencies
Auto	Adjusts the lag or lead on the task's dependency	Dependencies remain in control
Manual	Applies your dates as entered	You do the chart does not reschedule on your behalf

Mode

Moving a task

What drives the schedule

MS Project

Sets a date constraint on the task

Constraints take priority over dependencies

Auto

Adjusts the lag or lead on the task's dependency

Dependencies remain in control

Manual

Applies your dates as entered

You do the chart does not reschedule on your behalf

What you change	Constraint applied
Start date	SNET — Start No Earlier Than
Finish date	FNET — Finish No Earlier Than
Task bar position	SNET — Start No Earlier Than

What you change

Constraint applied

Start date

SNET — Start No Earlier Than

Finish date

FNET — Finish No Earlier Than

Task bar position

SNET — Start No Earlier Than

Label	Description	Type
Select Filter	Enables the user to create a new filter or apply an existing filter to the data displayed.	Global
Quick Link Filter	Enables the user to create a Quick Link Filter for the selected filter.	Global
Pin/Unpin Filter	Enables the user to pin or unpin the selected filter.	Global
Edit Filter	Enables the user to edit the selected filter.	Global
Clone Filter	Enables the user to clone the selected filter.	Global
Search Input	Enable the user to search for a specific word in the grid.	Global
Reload Items	Reload the entire grid	Global
Load more Items	Loads more items based on page size defined on the grid.	Global
Freeze Columns	Enables the user to define a set number of columns to freeze.	Global
Export Items	Enables the data displayed in the grid to be exported to an Excel or CSV file.	Global
Edit items	Enables inline editing of the data displayed.	Global
Create Record	Enables the user to add a new record.	Global
Clone Items	Clones selected records.	Record
Delete Items	Enables a record to be deleted.	Record
Actions	Dropdown list enabling access to the GridMate provided and also user-created custom actions.	Record

Label

Description

Type

Select Filter

Enables the user to create a new filter or apply an existing filter to the data displayed.

Global

Quick Link Filter

Enables the user to create a Quick Link Filter for the selected filter.

Global

Pin/Unpin Filter

Enables the user to pin or unpin the selected filter.

Global

Edit Filter

Enables the user to edit the selected filter.

Global

Clone Filter

Enables the user to clone the selected filter.

Global

Search Input

Enable the user to search for a specific word in the grid.

Global

Reload Items

Reload the entire grid

Global

Load more Items

Loads more items based on page size defined on the grid.

Global

Freeze Columns

Enables the user to define a set number of columns to freeze.

Global

Export Items

Enables the data displayed in the grid to be exported to an Excel or CSV file.

Global

Edit items

Enables inline editing of the data displayed.

Global

Create Record

Enables the user to add a new record.

Global

Clone Items

Clones selected records.

Record

Delete Items

Enables a record to be deleted.

Record

Actions

Dropdown list enabling access to the GridMate provided and also user-created custom actions.

Record

Key	Default	Description
`distance`	—	Maximum distance (slider end)
`minDistance`	`10`	Minimum distance (slider start)
`stepDistance`	`5`	Slider increment

Key

Default

Description

distance

—

Maximum distance (slider end)

minDistance

10

Minimum distance (slider start)

stepDistance

5

Slider increment

Key	Description
`objectName`	Object API name
`objectLabel`	Label shown in the picker
`titleField`	Field used as the marker title
`subTitleField`	Field used as the marker subtitle
`iconName`	SLDS icon, e.g. `standard:account`
`latitudeField`	Geolocation latitude field
`longitudeField`	Geolocation longitude field
`defaultValue`	Record Id to centre on — accepts the placeholders below
`defaultDistance`	Initial radius when `defaultValue` is set
`keyPrefix`	Object key prefix of `defaultValue` (optional — derived from the Id when omitted)

Key

Description

objectName

Object API name

objectLabel

Label shown in the picker

titleField

Field used as the marker title

subTitleField

Field used as the marker subtitle

iconName

SLDS icon, e.g. standard:account

latitudeField

Geolocation latitude field

longitudeField

Geolocation longitude field

defaultValue

Record Id to centre on — accepts the placeholders below

defaultDistance

Initial radius when defaultValue is set

keyPrefix

Object key prefix of defaultValue (optional — derived from the Id when omitted)

Placeholder	Resolves to
`$recordId`	Id of the host record
`$record.FieldApiName`	Value of that field on the host record (direct fields only)

Placeholder

Resolves to

$recordId

Id of the host record

$record.FieldApiName

Value of that field on the host record (direct fields only)

Field	Description
Label	A user-friendly name for the data source displayed in the Salesforce user interface.
Name	A unique identifier used to refer to this external data source definition through the API. The Name field can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
Type	Choose Files Connect: Google Drive
Identity Type	The identity type used to authenticate to the external data source. Select Per User to require separate credentials for each user who accesses the data source. (Administrators must enable the data source for specific permission sets and profiles. Users then enter their credentials when first accessing the data source..) Select Named Principal to use the same set of credentials for every user who accesses the data source from Salesforce.
Authentication Protocol	The protocol used to access Google Drive. Select OAuth 2.0.
Authentication Provider	Enter the Google Drive authentication provider.
Scope	Leave blank.
Start Authentication Flow on Save	Select to immediately test the settings above.

Field

Description

Label

A user-friendly name for the data source displayed in the Salesforce user interface.

Name

A unique identifier used to refer to this external data source definition through the API. The Name field can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Type

Choose Files Connect: Google Drive

Identity Type

The identity type used to authenticate to the external data source.

Select Per User to require separate credentials for each user who accesses the data source. (Administrators must enable the data source for specific permission sets and profiles. Users then enter their credentials when first accessing the data source..)

Select Named Principal to use the same set of credentials for every user who accesses the data source from Salesforce.

Authentication Protocol

The protocol used to access Google Drive.

Select OAuth 2.0.

Authentication Provider

Enter the Google Drive authentication provider.

Scope

Leave blank.

Start Authentication Flow on Save

Select to immediately test the settings above.

Field	Description
Sobject	The object of the record to display.
Record Id Field	The field of the page record holding the Id of the record to display. `Id` when the component is placed on the record itself.
Record Layout	The Record Layout JSON.
Layout Actions	The Layout Actions JSON.
Record Actions	The Record Actions JSON.
Button Actions	Display the record actions as buttons instead of icons.
Visible Actions	Number of record actions displayed before the overflow menu.
Show Border	Display the card border.

Field

Description

Sobject

The object of the record to display.

Record Id Field

The field of the page record holding the Id of the record to display. Id when the component is placed on the record itself.

Record Layout

The Record Layout JSON.

Layout Actions

The Layout Actions JSON.

Record Actions

The Record Actions JSON.

Button Actions

Display the record actions as buttons instead of icons.

Visible Actions

Number of record actions displayed before the overflow menu.

Show Border

Display the card border.

global class QuoteSaveHook implements gmpkg.SaveHookManager.ISaveHook { global static List<gmpkg.SaveHookManager.SaveHookResult> call(String action, List<Quote> quotes) { List<gmpkg.SaveHookManager.SaveHookResult> res = new List<gmpkg.SaveHookManager.SaveHookResult>(); switch on action { when 'beforeUpdate' { // Synchronous call ... create HTTP request ... HttpResponse response = new Http().send(req); List<Object> apiResults = (List<Object>) JSON.deserializeUntyped(response.getBody()); for (Integer i = 0; i < quotes.size(); i++) { Quote newQuote = quotes[i]; /* this is the API result for example if I receive : { "statusCode" : "400", "messageAPI" : "error", "success" : false, "relatedFields" : ["Test__c"] } i will map this fields with the SaveHookResult */ Map<String, Object> apiResult = (Map<String, Object>) apiResults[i]; Booloean success = (Boolean) apiResult.get('success'); String statusCode = (String) apiResult.get('statusCode'); String message = (String) apiResult.get('messageAPI'); List<String> fields = (List<String>) apiResult.get('relatedFields'); if (success == false) { gmpkg.SaveHookManager.SaveHookResult errorResult = new gmpkg.SaveHookManager.SaveHookResult(success, statusCode, message, fields); res.add(errorResult); } else { gmpkg.SaveHookManager.SaveHookResult successResult = new gmpkg.SaveHookManager.SaveHookResult(); res.add(successResult); } } } } return res; } }

``` We have also to implement the Visualforce controller with its unit test class ```java /*** * @author Hicham El Mansouri@GridMate * @date 12/2019 * @description DataGrid controller class for VFListViewDataGrid. */ public with sharing class VFListViewDataGridController { private final String lightningApp; private final String relatedObjectName; private final String listViewName; private final String attributes; public VFListViewDataGridController() { lightningApp = ApexPages.currentPage().getParameters().get('c__lightningApp'); relatedObjectName = ApexPages.currentPage().getParameters().get('c__object'); attributes = ApexPages.currentPage().getParameters().get('c__attributes'); listViewName = getLastUsedListView(relatedObjectName); } private static String getLastUsedListView(String objName) { try{ RecentlyViewed recentItem = [Select Id, Name From RecentlyViewed Where Type='ListView' Order by LastViewedDate Desc Limit 1]; ListView listView = [Select Id, Name, DeveloperName From ListView Where SobjectType=:objName And Name=:recentItem.Name Limit 1]; return listView.DeveloperName; } catch(Exception ex){ System.debug(ex.getStackTraceString()); return null; } } public String getRelatedObjectName() { return relatedObjectName; } public String getAttributes() { return attributes; } public String getListViewName() { return listViewName; } public String getLightningApp() { return lightningApp; } } ``` ```java /*** * @author Hicham El Mansouri@GridMate * @date 12/2019 * @description DataGrid controller class for VFListViewDataGrid. */ @isTest public class VFListViewDataGridControllerTest { static testMethod void testGetLastUsedListView(){ ApexPages.currentPage().getParameters().put('c__lightningApp', 'c:VFListViewDataGridApp'); ApexPages.currentPage().getParameters().put('c__object', 'Account'); ApexPages.currentPage().getParameters().put('c__attributes', '%7B"canCreate"%3A+true%2C"canClone"%3A+true%7D'); VFListViewDataGridController c = new VFListViewDataGridController(); String lastUsed = c.getListViewName(); if(lastUsed == null){System.assert(lastUsed == null);} else{ System.assert(lastUsed != null);} String relatedObjectName = c.getRelatedObjectName(); System.assert(relatedObjectName != null); String attributes = c.getAttributes(); System.assert(attributes != null); String lightningApp = c.getLightningApp(); System.assert(lightningApp != null); } } ``` ## Mass Edit button setup To trigger the mass edit Visualforce page, we have to configure a link on the targeted object. ![](https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MEsSbGy_U_OhthKUpxu%2F-MFFC0b29nEm7BzPxo6U%2F-MFFI7PaKOEbmyK7lCLv%2FScreenshot%202020-08-21%20at%2011.14.08.png?alt=media\&token=5bc11831-0237-4a9c-9401-d8431f629155) ```javascript {! URLFOR( "/apex/VFListViewDataGridPage?", null, [ c__lightningApp='c:VFListViewDataGridApp', c__object='Account', c__attributes='{"canCreate":true,"canClone":true,"canFilter":true}' ] )} ``` {% hint style="info" %} Mass Edit can be enabled on any object by duplicating the link below and changing the **c\_\_object** parameter only. {% endhint %} The link should be added to the list of actions on a ListView. ![](https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MEsSbGy_U_OhthKUpxu%2F-MFFC0b29nEm7BzPxo6U%2F-MFFJ9zFHT7IbVRhwcg4%2FScreenshot%202020-08-21%20at%2011.18.56.png?alt=media\&token=a515047f-5b8c-44d9-ac37-52cae105031d) ## Remote Site setup GridMate uses API to fetch the ListView's metadata. Visualforce URL should be added to Remote Site Settings. See below :point\_down: ![Remote Site settings](https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MEsSbGy_U_OhthKUpxu%2F-MFFC0b29nEm7BzPxo6U%2F-MFFKD-72KGmmCcqqHJW%2FScreenshot%202020-08-21%20at%2011.23.37.png?alt=media\&token=e44af774-7315-4ae5-9939-0253c7e86a0f) # Components Library # GM - RelatedList Grid (gmpkg:RelatedListDataGridComponent) ## **Documentation** **GM - RelatedList Grid** component is used to display a specified related list based on the assigned layout to the current user. This component requires the permission **API Enabled**. **Use case:** Display a grid of opportunities on the account page. {% hint style="info" %} The GM - RelatedList Grid is driven by the Salesforce Related List established on the Page Layout. Users can add or remove fields on the Salesforce Related List for the changes to be reflected on the GM - RelatedList Grid. {% endhint %} {% hint style="info" %} ### GM - Related List Grid may not function on Gov Cloud due to restrictions from Salesforce. You are recommended to use a FieldSet Grid or a UserGrid to replicate the Related List {% endhint %} ## **Specification** The following properties use JSON syntax as part of their configuration: **Filter, Aggregate, Default Values, Actions, Related Record Grids, Custom Field Labels, Cell Coloring.** The configuration wizard can be run to generate the required JSON strings for each of these properties. More details on the JSON syntax is available at the following location: [w3schools.com - JSON syntax.](https://www.w3schools.com/js/js_json_syntax.asp)

Property	Type	Description
recordId	String	recordId to use. Keep this empty if you want to use the current record.
Related List Label *	String	The label defined on the layout page. Set it to Contacts to display the list of contacts on the Account page.
DataGrid Code	String	The code to identify the DataGrid
Row Limit *	Integer	The maximum number of rows to fetch. The grid will never go beyond this number of records. The default value is 100.
Page Size *	Integer	The number of rows to fetch per step. If you have a contact related list of 50. If you set the Row Limit to 20 and the Page Size to 10. The first load of the grid will show 10 records and the grid title will be ‘Contacts (10+)’. The ‘+’ sign indicates that there are more records to load. You can fetch more rows using the ‘Load More’ button. The default value is 10.
Enable Pagination	Boolean	Check this option to enable pagination instead of scrolling. Can be combined with Enable Interactive Filters — see Interactive Filters.
Custom Label	String	Override the title of the data grid. This is relevant when the related list is filtered. We can combine the filtering and the custom title to display different grids. You can filter only closed opportunities and set the title to Closed Opportunities.
Custom Icon	String	Customize the data grid icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/
Grid Height	Integer	Set the grid height. Set this property if you want to control the height and show up components after the grid. The user has to scroll vertically to see more records. If the value is set 9999, The grid will use the remaining space on the page even if the user resizes the window. This behavior is relevant to build a responsive app page.
Formula Columns	String	JSON string to define formula columns. A formula column is not saved in the database. it's calculated on the fly when the grid is rendered or when the record is edited by the user. The configuration wizard can be used to set this property (See Dynamic Formula guide). The produced configuration can be be adjusted to set the column index of each formula. See the example below: `{ "name": "ARR9qfzn__f", "fieldApiName": "ARR9qfzn__f", "label": "ARR", "type": "Currency", "JSFormula": "Amount*12", "isClientSide": true, "isJSFormula": true, "digits": "0", "precision": "18", "scale": "2", "index": 2 }`
Column Style	String	JSON string to override the column's style. Don’t forget __c for custom fields. This property can be used to default the width, the text alignment or wrapping for a specific column: To set the card header background: `{ "gm__card_header": "background:lightblue" }` To set the height of the header: `{ "gm__header": "height:4rem;whiteSpace:normal" }` To set the width of the any column: `{ "gm__header": "width:120px;" }` To style the grouping row: `{ "gm__group": "background: #6BBD6E;color: #FFFFFF" }` Only the color and the background are supported. To style the total row: `{ "gm__total": "background: #6BBD6E;color: #FFFFFF" }` Only the color and the background are supported. To set the width: `{ "StageName": "width:200px" }` To set the alignment: `{ "Amount": "text-align:left" }` To set the text wrapping: `{ "Name": "cellcontent:wrap" }` To set the text wrapping during edit mode: `{ "Name": "celleditcontent:wrap" }` This styling is available for String only. The field is edited through a textarea input. To set the number of visible lines for Long Text Area/Rich Text: `{ "Notes": "line-clamp:3" }`
Hidden Columns	String	',' separated list of hidden columns. Don’t forget __c for custom fields. Hidden columns are useful for coloring, read only conditions....They are not visibles to the end user. If the explorer is enabled, the hidden columns are not visibles as well.
Filter	String	JSON string to define filter criteria. Don’t forget __c for custom fields. To see only Opportunities which are more than $1000 enter the following: `{ "Amount": { "operator": ">", "value": "1000" } }` We support operators below: (‘=’,‘!=’,‘>’,‘>=’,‘<=’,‘in’, ‘not in’, ‘includes’, 'excludes', ‘like’, ‘notLike’). The configuration wizard can be used to build the filter query. For advanced configuration, see Grid - Advanced Filtering
Sort	String	The field list to sort the data grid. This field is used only for the initial load. Don’t forget __c for custom fields. To sort on multiple fields add a comma between field names. `Amount,StageName` We can define the order by field. If you define the order on the Sort, you don’t have to set if on the order. `Amount desc,StageName asc` The configuration wizard can be used to set this property.
Order	String	Ascending or descending order for sorting. For ascending enter the value asc. For descending enter the value desc
Group By	String	',' separated list of fields to group by. Don’t forget __c for custom fields. When an aggregation is defined, the Grid will display the intermediate aggregations at the group level. The configuration wizard can be used to set this property.
Collapse Groups	Boolean	Check this options to collapse groups by default. This option is relevant only it the records are grouped. The user can still expand a group. When a group is expanded, the user can select/unselect the whole group records using the checkbox at the group level.
Multi Level Grouping	Boolean	Multi Level Grouping
Aggregate	String	JSON string to define the aggregate field. Use __c for custom fields. The supported functions are "sum", "min", "max", "avg" and "avgnotnull", "sumstr". To aggregate and sum the ‘amount’ fieldset this property to be: `{ "Amount": "sum" }` The configuration wizard can be used to set this property. By default aggregated values are displayed on the header and on the bottom total row. The display can be controlled with advanced configuration using a JSON object per property: `{ "Amount": { "op": "sum", "label": "Total Amount", "nobottom": true, "notop": true } }` Within this type of configuration, we can override the label and also define the calculated aggregated values: `{ "allocated__c": { "op": "max", "label": "Total Allocated", "nobottom": true }, "invoiced__c": "sum", "Remaining": { "op": "formula", "label": "Remaining", "formula": "$allocated__c - $invoiced__c", "type": "Currency" } }`
Show Aggregate Header	Boolean	Show the aggregate header as a card on the top of the grid. The aggregate header will display the aggregate fields with their values on the grid header.
Enable Update Object	Boolean	Check this option if you wish to allow the end-user to perform inline editing of the record displayed. This option will show or hide the 'Edit Records' and 'Mass Update' icons from the list of quick actions.
Enable Mass Update	Boolean	Check this option if you wish to allow the end-user to perform mass updated on the displayed records. This option will show or hide the 'Mass Update' icons from the list of quick actions.
Enable Delete Object	Boolean	Check this option if you wish to allow the end-user to delete records. This option will show or hide the 'Delete Records' icon from the list of quick actions.
Enable Create Object	Boolean	Check this option if you wish to allow the end-user to create new records. This option will show or hide the 'Create New Record' icon from the list of quick actions. ⚠️When this option is checked, you may need to define the property Default Values to set the required fields for the object.
Enable Filter Object	Boolean	Check this option if you wish to allow the end-user to use filters. This option will show or hide the filter combobox.
Enable Clone Object	Boolean	Check this option if you wish to allow the end-user to clone records. This option will show or hide the 'Clone Records' icon from the list of quick actions.
Enable Export Object	Boolean	Check this option if you wish to allow the end-user to export records. This option will show or hide the 'Export' icon from the list of quick actions.
Enable Import Object	Boolean	Check this option if you wish to allow the end-user to import CSV files. This option will show or hide the 'Import' icon from the list of quick actions.
Enable Freeze Columns	Boolean	Check this option if you wish to allow the end-user to freeze columns. This option will show or hide the 'Freeze Columns' icon from the list of quick actions.
Enable View All	Boolean	Check this option if you want to use View All link.
Full Record Creation	Boolean	Check this option if you wish to create a full record instead of using a quick action. If this option is activated, the user will be able to create a record using the assigned layout when he clicks on the ‘Create New Record’ button. ‘Default Values’ property is used to initialize the new record.
Disable Modal Creation	Boolean	Check this option if you wish to disable record creation when the grid is displayed in view mode. If this option is activated, the user will not be able to create a record in view mode.
Disable Inline Creation	Boolean	Check this option if you wish to disable record creation when the grid is displayed in edit mode. If this option is activated, the user will not be able to create a record in edit mode.
Disable Modal Modification	Boolean	Check this option if you wish to disable record edition when the grid is displayed in view mode. If this option is activated, the user will not be able to edit a record in the view mode.
Disable Inline Modification	Boolean	Check this option if you wish to disable inline edition.
Default Values	String	JSON string to initialize a new object created from the data grid. Use __c for custom fields. If you want to create a new opportunity record then set this field to: `{ "accountid": "$recordId", "name": "Opp 1", "closedate": "2019-10-01", "stagename": "Needs Analysis" }` The JSON string should contain at least all the required fields of the object in lower case. $recordId can be used to implicitly use the current recordId. The configuration wizard can be used to set this property. Any field from the current object can be used. Parent fields can be referenced as a merge field $record.fieldApiName: `{ "Country__c": "$record.BillingCountry" }` An apex class can be used to set the default value for a specific field: `$APEX.CloseDateValueProvider({"Id":"$recordId"})`
Hidden Fields	String	',' separated list of hidden fields for modal creation. When a user creates a new record, hidden fields will be defaulted but not displayed to the end-user (RecordTypeId for instance). The configuration wizard can be used to set this property.
Actions	String	JSON string to initialize the list of available actions from the data grid. Custom actions are available from the dropdown menu. You can leverage your existing quick actions. The configuration wizard can be used to build the list of actions The visibility can be defined for each action based on the displayed master record.
Show Actions as Buttons	Boolean	Check this option if you wish to display actions as buttons instead of icons. When the actions are displayed as icons, we can define the icon on JSON actions configuration using the icon attribute.
Custom Visible Actions	Integer	Set the number of visible custom actions. All the core actions will always be displayed depending on the configuration of course. The remaining custom actions will be added as an option on the button menu.
Record Actions	String	JSON string to initialize the list of available record actions. Row actions are available on each row in view mode only. The configuration wizard can be used to build the list of actions.
Frozen Columns	Integer	# of columns to freeze at startup.
Total Color	String	Total row text color
Total Background	String	Total row background color
Show Record Details	Boolean	Check this option to allow the end-user to view the record details in the grid
Record Related Components	String	A JSON string to add a list of inline component (Grids and Record Layouts) to display per record. Each inline grid should have: component: the name of GridMate component. attributes: the list of attributes to configure, same as on the lightning app builder. All the component names and their attributes are available here. If you want to see the cases under a contacts grid then set this field to `[ { "component": "gmpkg:RelatedListDataGridComponent", "attributes": { "relatedListLabel": "Cases", "canCreate": false, "canUpdate": true, "canDelete": true, "recordDetail": true } } ]` The configuration wizard can be used to set this property. Configuration samples are available here 👉 Config Snippets
Extra Record Related Components	String	A JSON string to add extra record related components. Use this option for a large related components configuration.
Edit Record Layout	String	A JSON string to customize the edit layout when editing a single record. The JSON should a valid record layout configuration 👉 GM - Record Layout
Search Fields	String	',' separated list of fields to search in. If the list is empty, the search input is hidden in action. Only text fields (Text, PickList, Phone, Email, URL) are supported. The configuration wizard can be used to set this property.
Wildcard Search	Boolean	Check this option if you wish to use a wildcard search. If this option is activated, the end user doesn’t have to add ‘*’ to the search query.
Show Border	Boolean	Check this option if you wish to add a border to the grid.
Show Column Border	Boolean	Check this option if you wish to add a border to the grid columns.
Custom Field Labels	String	A JSON string to override column label: {"AccountId":"Organization","StageName":"Step"} The configuration wizard can be used to set this property.
ReadOnly Fields	String	',' separated list of read-only fields. The user will not be able to edit these fields the same as read-only fields on the page layout. In a complex use case, a JSON string can be used instead to set the read-only condition for each field: `{ "fieldApiName": { "operator": "$operator", "value": "$value" } }` In the example below Subject and Priority are locked when the case is closed: `{ "Subject": { "Status": { "operator": "=", "value": "Closed" } }, "Priority": { "Status": { "operator": "=", "value": "Closed" } } }` All the displayed fields can be used to handle complex logic and different operators are supported: (‘=’,‘!=’,‘>’,‘>=’,‘<=’, ‘in’, ‘includes’, 'excludes', 'like') Conditions can be combined with conjunctions like ‘or’, ‘and’. Below is a complex condition: `{ "or": [ { "Status": { "operator": "=", "value": "Closed" } }, { "Priority": { "operator": "=", "value": "high" } } ] }` Relative dates are supported: `YESTERDAY() TODAY() TOMORROW() LAST_N_DAYS NEXT_N_DAYS LAST_WEEK() THIS_WEEK() NEXT_WEEK() LAST_MONTH() THIS_MONTH() NEXT_MONTH() LAST_YEAR() THIS_YEAR() NEXT_YEAR()` The configuration wizard can be used to set this property.
Cell Coloring	String	JSON conditions for cells coloring. You can define for each field displayed in the grid the coloring and the corresponding condition. `{ "CloseDate": [ { "color": "#fac8d4", "exp": { "Late__c": { "operator": "=", "value": true } }, "label": "Late Opp." } ], "Amount": [ { "color": "#d1fac8", "exp": { "Amount": { "operator": ">", "value": 50000 } }, "label": "Big Deal" } ] }` Coloring condition should be built it the same way as Read Only Fields. To set the define a coloring at the row level, set the colored field to *''.** See the example below: `{ "": [ { "color": "#fac8d4", "exp": { "Late__c": { "operator": "=", "value": true } }, "label": "Late Opp." } ] }` Note that $recordId* can be used to implicitly use the current recordId. The configuration wizard can be used to set this property. The label property is used to build a legend to the end user to give insights on the applied coloring.
Extra Cell Coloring	String	Extra JSON conditions for cells coloring. This property is useful for complex coloring that go beyond 2000 characters.
Lookup Fields Options	String	JSON string to customize lookup fields. You can define different aspects for each lookup field. Title field : Field ApiName for the title Subtitle field : Field ApiName for subtitle Candidates provider : In some situations, the search is very complex especially for lookup filters. In this case, you can bring your own Apex Class. Pasted value provide: If lookup filters are enabled, you can bring your own Apex Class to filter the records based on the pasted values and the current record Id. Create related record: Boolean to enable/disable record creation. Default values : JSON string to set values for new record. This option is used only if the user is authorized to create a new record. `{ "AccountId": { "titleField": "Name", "subTitleField": "Website", "candidatesProvider": "CaseAccountCandidatesProvider", "pastedValueProvider": "CaseAccountCandidatesProvider", "refObjCreateable": true, "defaultValues": { "RecordTypeId": "0123i000000d27DAAQ", "Type": "Prospect" } } }`
Disable Refresh View	Boolean	Check this option if you wish to avoid the page load when the grid is saved. This option is automatically set to true for inline grids.
Enable Dynamic Interactions	Boolean	Check this option if you want to enable dynamic interactions. When this option is enabled, the grid publish a Row Clicked event when a row is selected. This option is required a Dynamic Interaction experience.
Enable Split View	Boolean	Check this option if you want to enable split view. When this option is enabled, the inline components are displayed on the right side. See Split View example.
Enable Interactive Filters	Boolean	Check this option if you want to enable interactive filters. With this option enabled, the user can easily filter the records at the column level either by selecting the values or defining conditions. See Interactive Filters.
Enable Auto Fill	Boolean	Check this option if you want to enable auto fill. With this option enabled, the user can drag to fill values like Excel.
Enable Cell Editing	Boolean	Check this option if you want to enable cell editing
Enable Parent Field Editing	Boolean	Check this option if you want to enable parent field editing
Enable Config Checker	Boolean	Check this option if you want to enable the Config. Checker. With this option enabled, the user will be able to validate the component configuration. See Grid - Config Checker.
Auto Select 1st Row	Boolean	Check this option if you want to select the first row automatically. Applicable only if dynamic interaction or split view is enabled
Default Mode	String	String to define the initial display mode of the grid (edit \| read \| editOnly). If this property is set to edit, the grid is displayed in edit in the first load of the page. If this property is set to editOnly, the grid is displayed in edit all the time.
Enable Grid Collapse	Boolean	Check this option if you want to enable Grid collapse. When this option is activate, the end user can minimize the Grid.
Enable Toggle Fullscreen	Boolean	Check this option if you want to enable toggle fullscreen for the Grid. When this option is active, the end user can open the Grid in fullscreen dialog.
Enable Explorer	Boolean	Check this option if you want to use the Grid Explorer. When this option is active, the end user will be able to explore the grid through the Explorer by filtering the records, hiding or reordering the columns and also by setting the grouping.
Split Width	Integer	Set the split view width. Applicable only the split view is enabled
Density	String	Grid density: comfy \| compact. Currently the density is applied only to the toolbar. The compact layout is more for inline Grids.
Object Name	String	SObject to use. Useful only for dynamic interaction.

{% hint style="info" %} Lightning App Builder support custom labels to dynamically configure any component property. This feature is useful when dealing record types or any property depending on the environment. Below is an example of default values using custom labels: ```json { "RecordTypeId": "{!$Label.Outbound_Contact}" } ``` {% endhint %} ## **API Reference** {% tabs fullWidth="true" %} {% tab title="RelatedListDataGridComponent.design" %} {% code fullWidth="true" %} ```xml ``` {% endcode %} {% endtab %} {% tab title="Public Event Handlers" %} **Event Handler registration** ```xml ``` **DataGridCellChangeEvent** properties: ```xml ``` {% endtab %} {% tab title="Public Methods" %} ```xml ``` {% endtab %} {% endtabs %} ## Lookup Providers The candidates provider class should implement a Callable interface. GridMate delegates the candidates search to the given provider: ```java Callable handler = (Callable) Type.forName(candidatesProvider).newInstance(); return (Object[]) handler.call('getLookupCandidates', new Map{ 'objectId' => objectId, 'refObjName' => refObjName, 'refFieldName'=> refFieldName, 'searchTerm'=> searchTerm, 'titleField'=> titleField, 'subTitleField'=> subTitleField}); ``` The example below showcase a specific provider for ‘**AccountId**’ on **Case** object: {% hint style="warning" %} The apex class should be declared as global. If not we will not be able to instantiate the class from the managed package. {% endhint %} ```java global class CaseAccountCandidatesProvider implements Callable { global Object call(String action, Map args) { if(action=='getLookupCandidates'){ String query = 'Select Id, Name From Account'; String searchTerm = (String)args.get('searchTerm'); if(searchTerm != null){query += ' Where Name like \'' + searchTerm + '%\'';} query += ' Limit 5'; List

Property	Type	Description
Custom Label	String	Set the label of the calendar.
Custom Icon	String	Customize the calendar icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/
Calendar Height	Integer	Set the grid height. Set this property if you want to control the height and show up components after the grid. The user has to scroll vertically to see more records. If the value is set 9999, The calendar will use the remaining space on the page even if the user resizes the window. This behavior is relevant to build a responsive app page.
Calendar Style	String	CSS hooks to override the style of the calendar. The properties are available: the minimum activity cell width and the assignee width. See example below: `cell-min-width:10rem;col-header-width:10rem;`
# Of Visible Activities	Integer	Set the number of visibles activities (3 by default). Extra activities will be displayed in the extra wrapper when the user click on link. By setting the number if visible activities, we can control the height of the rows.
Default View	String	Calendar default view : daily \| weekly \| biweekly \| monthly \| quarterly. The user can still change the view using the view switcher when the calendar is rendered.
Enable 2 Weeks View	Boolean	Check this option to add the 2 Weeks view to the view switcher (off by default). The view covers 14 days starting on the Week Start Day. Next/Previous move a full two-week period.
Week Start Day	Integer	Week start day from 0 to 6. 0 is Monday.
Day Start Hour	Integer	Day start hour from 0 to 11.
Skip Night Hours	Boolean	Check this options to skip the night hours (12 hours) when the user clicks Next/Prev.
Year Start	String	Set the start of the year (month). Used only for quarterly view
Show Actions as Buttons	Boolean	Check this option if you wish to display actions as buttons instead of icons.
Assignee
Assignee Object*	String	The name of the assignee object to display. Don’t forget __c for custom objects.
Assignee ListView*	String	The ListView API Name of the assignee object to display. The component will use the ListView filter to fetch the relevant records.
Available Assignee ListView(s)	String	',' Separated list of assignee ListView(s). The user will be able to switch between different ListView(s) to streamline the assignment process.
Assignee Filter*	String	JSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid filter property for more details.
Assignee Sort	String	The field list to sort assignee. This field is used only for the initial load. See GM - RelatedList Grid sort property for more details.
Assignee Order	String	Ascending or descending order for sorting. For ascending enter the value asc. For descending enter the value desc.
Assignee Row Limit	Integer	The maximum number of assignee to fetch. The component will never go beyond this number of records. The default value is 100.
Assignee Title Field*	String	Set the assignee title field to display on the row header. Use __c for custom fields.
Assignee SubTitle Field	String	Set the assignee sub title field to display on the row header. Use __c for custom fields.
Assignee Popover Fields	String	',' separated list of fields to display. These fields are used when the user hover on a specific assignee.
Assignee Popover Columns #	Number	The number of columns to display the assignee detail when the user hover on a specific assignee.
Assignee Icon	String	The icon to use for the assignee object.
Assignee Label	String	Override the assignee label instead of using the object label.
Activity
Activity Object*	String	The name of the activity object to display. Don’t forget __c for custom objects.
Activity ListView*	String	The ListView API Name of the activity object to display. The component will use the ListView filter to fetch the relevant records.
Activity Title Field*	String	Set the title field to display for an activity. Use __c for custom fields.
Activity SubTitle Field	String	Set the sub title field to display for an activity. Use __c for custom fields.
Activity Date Field Name	String	Set the activity date field for an activity. Use __c for custom fields.
Activity From Date Field Name	String	Set the activity from date field for an activity. This field is required when dealing with datetimes. Use __c for custom fields.
Activity End Date Field Name	String	Set the activity end date field for an activity. This field is required when dealing with datetimes. Use __c for custom fields.
Activity User Id Field Name	String	Set the used Id field for an activity. Use __c for custom fields.
Activity Aggregations	String	Json string to define the aggregated activity fields
Activity Default Values	String	JSON string to initialize a new record created from the calendar. Use __c for custom fields. See GM - RelatedList Grid default values property for more details.
Hidden Fields	String	',' separated list of hidden fields for modal creation. When a user creates a new record, hidden fields will be defaulted but not displayed to the end-user (RecordTypeId for instance). See GM - RelatedList Grid hidden fields property for more details.
Activity Popover Fields	String	',' separated list fields to display. These fields are used when the user hover on a specific activity.
Activity Popover Columns #	Number	The number of columns to display the activity detail when the user hover on a specific record.
Activity Coloring	String	JSON conditions for cells coloring. You can define a list of colorings and the corresponding conditions. `[ { "color": "#60ace6", "exp": { "Subject": { "operator": "=", "value": "Email" } } }, { "color": "#8cedbb", "exp": { "Subject": { "operator": "=", "value": "Meeting" } } } ]` See GM - RelatedList Grid cell coloring fields property for more details.
Activity Actions	String	Json string to initialize the list of available actions for an activity . See the actions configuration example
Activity Icon	String	The icon to use for the activity object.
Activity Label	String	Override the activity label instead of using the object label.
Extra Activities	String	JSON string to add extra activities. The component is able to display multiple activity types on the same calendar as long as they belong to the same object. As an example we can build a calendar to display Events and Tasks assigned to a list of contacts. See configuration example.
Permissions
Enable Update Activity	Boolean	Check this option to allow the end-user to edit activities.
Enable Delete Activity	Boolean	Check this option to allow the end-user to delete activities.
Enable Create Activity	Boolean	Check this option to allow the end-user to create activities.
Enable Export Activity	Boolean	Check this option to allow the end-user to export activities.
Enable Toggle Fullscreen	Boolean	Check this option if you want to enable toggle fullscreen

Property	Type	Description
Custom Label	String	Set the label of the calendar.
Custom Icon	String	Customize the calendar icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/
Calendar Height	Integer	Set the grid height. Set this property if you want to control the height and show up components after the grid. The user has to scroll vertically to see more records. If the value is set 9999, The calendar will use the remaining space on the page even if the user resizes the window. This behavior is relevant to build a responsive app page.
Calendar Style	String	CSS hooks to override the style of the calendar. The properties are available: the minimum activity cell width and the assignee width. See example below: `cell-min-width:10rem;col-header-width:10rem;`
# Of Visible Activities	Integer	Set the number of visibles activities (3 by default). Extra activities will be displayed in the extra wrapper when the user click on link. By setting the number if visible activities, we can control the height of the rows.
Default View	String	Calendar default view : daily \| weekly \| biweekly \| monthly \| quarterly. The user can still change the view using the view switcher when the calendar is rendered.
Enable 2 Weeks View	Boolean	Check this option to add the 2 Weeks view to the view switcher (off by default). The view covers 14 days starting on the Week Start Day. Next/Previous move a full two-week period.
Week Start Day	Integer	Week start day from 0 to 6. 0 is Monday.
Day Start Hour	Integer	Day start hour from 0 to 11.
Skip Night Hours	Boolean	Check this options to skip the night hours (12 hours) when the user clicks Next/Prev.
Year Start	String	Set the start of the year (month). Used only for quarterly view
Show Actions as Buttons	Boolean	Check this option if you wish to display actions as buttons instead of icons.
Assignee
Assignee Object*	String	The name of the assignee object to display. Don’t forget __c for custom objects.
Assignee ListView*	String	The ListView API Name of the assignee object to display. The component will use the ListView filter to fetch the relevant records.
Available Assignee ListView(s)	String	',' Separated list of assignee ListView(s). The user will be able to switch between different ListView(s) to streamline the assignment process.
Assignee Filter*	String	JSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid filter property for more details.
Assignee Sort	String	The field list to sort assignee. This field is used only for the initial load. See GM - RelatedList Grid sort property for more details.
Assignee Order	String	Ascending or descending order for sorting. For ascending enter the value asc. For descending enter the value desc.
Assignee Row Limit	Integer	The maximum number of assignee to fetch. The component will never go beyond this number of records. The default value is 100.
Assignee Title Field*	String	Set the assignee title field to display on the row header. Use __c for custom fields.
Assignee SubTitle Field	String	Set the assignee sub title field to display on the row header. Use __c for custom fields.
Assignee Popover Fields	String	',' separated list of fields to display. These fields are used when the user hover on a specific assignee.
Assignee Popover Columns #	Number	The number of columns to display the assignee detail when the user hover on a specific assignee.
Assignee Icon	String	The icon to use for the assignee object.
Assignee Label	String	Override the assignee label instead of using the object label.
Activity
Activity Object*	String	The name of the activity object to display. Don’t forget __c for custom objects.
Activity ListView*	String	The ListView API Name of the activity object to display. The component will use the ListView filter to fetch the relevant records.
Activity Title Field*	String	Set the title field to display for an activity. Use __c for custom fields.
Activity SubTitle Field	String	Set the sub title field to display for an activity. Use __c for custom fields.
Activity Date Field Name	String	Set the activity date field for an activity. Use __c for custom fields.
Activity From Date Field Name	String	Set the activity from date field for an activity. This field is required when dealing with datetimes. Use __c for custom fields.
Activity End Date Field Name	String	Set the activity end date field for an activity. This field is required when dealing with datetimes. Use __c for custom fields.
Activity User Id Field Name	String	Set the used Id field for an activity. Use __c for custom fields.
Activity Aggregations	String	Json string to define the aggregated activity fields
Activity Default Values	String	JSON string to initialize a new record created from the calendar. Use __c for custom fields. See GM - RelatedList Grid default values property for more details.
Hidden Fields	String	',' separated list of hidden fields for modal creation. When a user creates a new record, hidden fields will be defaulted but not displayed to the end-user (RecordTypeId for instance). See GM - RelatedList Grid hidden fields property for more details.
Activity Popover Fields	String	',' separated list fields to display. These fields are used when the user hover on a specific activity.
Activity Popover Columns #	Number	The number of columns to display the activity detail when the user hover on a specific record.
Activity Coloring	String	JSON conditions for cells coloring. You can define a list of colorings and the corresponding conditions. `[ { "color": "#60ace6", "exp": { "Subject": { "operator": "=", "value": "Email" } } }, { "color": "#8cedbb", "exp": { "Subject": { "operator": "=", "value": "Meeting" } } } ]` A rule's `color` can also be `$record.FieldApiName` to use the colour stored on the record. See GM - RelatedList Grid cell coloring fields property for more details.
Activity Actions	String	Json string to initialize the list of available actions for an activity . See the actions configuration example
Activity Icon	String	The icon to use for the activity object.
Activity Label	String	Override the activity label instead of using the object label.
Extra Activities	String	JSON string to add extra activities. The component is able to display multiple activity types on the same calendar as long as they belong to the same object. As an example we can build a calendar to display Events and Tasks assigned to a list of contacts. See configuration example.
Permissions
Enable Update Activity	Boolean	Check this option to allow the end-user to edit activities.
Enable Delete Activity	Boolean	Check this option to allow the end-user to delete activities.
Enable Create Activity	Boolean	Check this option to allow the end-user to create activities.
Enable Export Activity	Boolean	Check this option to allow the end-user to export activities.
Enable Toggle Fullscreen	Boolean	Check this option if you want to enable toggle fullscreen

Property	Type	Description
recordId	String	recordId to use. Keep this empty if you want to use the current record.
Calendar Label	String	Set the label of the calendar.
Custom Icon	String	Customize the calendar icon. All lightning icons are supported.
Default Calendar View	String	Set the default view (daily\|weekly\|monthly\|schedule)
Calendar Height	Integer	Set the calendar height. Use 9999 for dynamic height.
Activity Object	String	Activity Object API Name. Don’t forget __c for custom objects.
Activity Title Field	String	Activity Title Field API Name. Don’t forget __c for custom fields.
Activity Sub Title Field	String	Activity Sub Title Field API Name. Don’t forget __c for custom fields.
Activity Date Field	String	Activity Date Field API Name. Don’t forget __c for custom fields.
Activity From Date Field	String	Activity From Date Field API Name. Don’t forget __c for custom fields.
Activity To Date Field	String	Activity To Date Field API Name. Don’t forget __c for custom fields.
Activity Popover Fields	String	Activity Popover Fields to display. Keep it empty to use the compact layout.
Activity Popover Columns #	Integer	Activity Popover Columns #
Activity Filter	String	Activity Filter. The filter should be a JSON string.
Activity Default Values	String	JSON string to initialize a new activity created from the calendar. Don’t forget __c for custom fields.
Activity Coloring	String	Activity Coloring. The coloring should be a JSON string. A rule's `color` accepts `$record.FieldApiName` to use the colour stored on the record.
Activity Actions	String	JSON string to initialize the list of available actions for an activity.
Activity Icon	String	Activity Icon.
Activity Label	String	Activity Label.
Enable Create Activity	Boolean	Check this option if you want to create activities.
Enable Update Activity	Boolean	Check this option if you want to update activities.
Enable Delete Activity	Boolean	Check this option if you want to delete activities.
Enable Toggle Fullscreen	Boolean	Check this option if you want to enable toggle fullscreen.
Extra Activities	String	Extra Activities Config.

Property	Type	Description
Gantt Id	String	Identifier for the Gantt chart parent record.
Icon name	String	Icon displayed for the Gantt chart, You can get the icon name from https://lightningdesignsystem.com/icons/
Title	String	Title displayed at the top of the Gantt chart.
Can select	Boolean	Determines if tasks can be selected in the chart.
Can reorder	Boolean	Indicates if tasks can be reordered by user interaction.
Can edit	Boolean	Indicates if tasks can be edited directly in the chart.
Columns	String	Configuration for the columns displayed in the chart.
Relation config	String	JSON configuration that defines the data modal for the Gantt Chart. JSON string configuration
Show only work hours	Boolean	Option to show only defined work hours in the chart.
Work day start	Integer	Hour at which the workday starts (1-24).
Work day end	Integer	Hour at which the workday ends (1-24).
Hour span	Integer	The time interval that defines a task slot’s length and the step size for moving tasks on the timeline (max 12h).
Work week start	Integer	The day the workweek starts, default is 1 (Monday).
Work week end	Integer	The day the workweek ends, default is 5 (Friday).
First day of week	Integer	Representation of the first day of the week (1-7).
Default displayed tasks	Integer	The number of tasks displayed by default.
Slot size	Integer	Width of each task slot in pixels.
Row height	Integer	Height of each row in pixels.
Left panel width (%)	Integer	Width of the left panel as a percentage of total width, up to 100%.
Right panel width (%)	Integer	Width of the right panel as a percentage of total width, up to 100%.
Default view	String	Initial view setting, e.g., “month” for monthly view.

Property	Type	Description
Record Id	String	recordId to use. Keep this empty if you want to use the current record.
Custom Label	String	Set the custom label. Keep it empty to use the default value.
Default View	String	Set the default view (table\|tree\|gallery\|carousel).
Enable Delete	Boolean	Check this option if you wish to allow the end-user to delete files.
Enable Hard Delete	Boolean	Check this option if you want to hard delete files
Enable Copy/Paste	Boolean	Check this option if you wish to allow the end-user to copy/paste files from a record to another one.
Hide Topics	Boolean	Check this option if you want to hide topics.
Enable Search By Topics	Boolean	Check this option if you wish to enable the search by Topic.
Enable Update Topics	Boolean	Check this option if you wish to enable Topics update. This option is available only in the carousel view.
Collapse Carousel Split View	Boolean	Check this option if you want to collapse the carousel split view.
Disable Salesforce Upload	Boolean	Check this option to disable the file upload functionality to Salesforce.
Disable Download	Boolean	Check this option to prevent users from downloading files in the explorer.
Show Border	Boolean	Check this option if you want to show border.
Filter	String	JSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid
Accepted Formats	String	Comma-separated list of file extensions that can be uploaded in the format .ext, such as .pdf,.jpg,.png.
Content Library	String	Content Library Name. The library is optional. When enabled, this option filters files to display only those within a specified library. Uploaded files will also be moved to that library. This feature is useful for organizing files by business unit, for example contracting, finance, hr...
Folder Name	String	Upload Folder Name. If a folder name is specified, uploaded files will be moved to that folder. Otherwise, this step is optional.
Actions	String	JSON string to initialize the list of available mass actions.
Height	Integer	Sets the height of the file explorer container.
Inline Preview	Boolean	Check this option to enable an inline preview of selected files.
Preview Position	String	Position of the inline preview (top\|bottom\|right\|left).
Preview Height	Integer	Sets the height for the inline preview section.
Preview Width	Integer	Sets the width for the inline preview section.

Property	Type	Description
Related Object Name*	String	The name of the related object to display.
FieldSet Name*	String	The Field Set name of the related object to display.
Community Visibility Condition	String	JSON visibility condition. To use for Community only. The condition should be built it the same way as Read-Only Fields

Property	Type	Description
Related Object Name *	String	The name of the related object to display.
ListView Name *	String	The ListView API Name of the related object to display.

Property	Type	Description
Object Name *	String	The name of the related object to display.
Record Id Field *	String	The name of the lookup field to fetch. If you want to display the list of contacts of the opportunity account, set this property to AccountId.

Property	Type	Description
Custom Label	String	Set the label of the kanban.
Custom Icon	String	Customize the kanban icon. All lightning icons are supported.
Object Name	String	The name of the object to display (e.g., Opportunity).
Target Object Name	String	The name of the object to display if the kanban is shown on a record page.
Stage Field	String	The stage field to use for the kanban.
Stage Values	String	JSON string defining the subset of stage values to use within the kanban.
Title Field	String	The title field to use for each kanban card's title.
Object Fields	String	A comma-separated list of detail fields for the cards.
Row Limit	Integer	The maximum number of rows to fetch from the specified object.
Filter	String	JSON string defining filter criteria. Ex. `{'StageName':'Needs Analysis'}.`
Sort	String	The field list to sort the data.
Order	String	Ascending or descending order for sorting.
Enable Create Object	Boolean	Check to enable the creation of new objects from the kanban.
Enable Update Object	Boolean	Check to enable updates to existing objects.
Enable Mass Update	Boolean	Check to allow bulk updates to existing objects.
Enable Delete Object	Boolean	Check to allow deletion of objects from the kanban.
Enable Mass Delete	Boolean	Check to allow bulk deletion of objects.
Aggregate	String	JSON string to define aggregate fields. Ex. `{'Amount':'sum'}` to sum amounts of opportunities.
Actions	String	JSON string to initialize the list of available actions, The Kanban Board supports Quick Actions, Global Actions, and calling Flows.
Show Actions as Buttons	Boolean	Use buttons for actions instead of icons.
Custom Visible Actions	Integer	Number of visible custom actions.
Record Actions	String	JSON string to initialize the list of available record actions.
Stage States	String	JSON Stage States configuration to control the behavior when the user move a card.
Popover Fields	String	Popover Fields to display
Popover Columns #	String	# Of Popover Columns
Card Coloring	String	JSON conditions for card coloring based on defined metrics.
Show Border	Boolean	Check this option to add a border to the kanban.
Density	String	Component density: comfy or compact.
Board Height	Integer	Set the board height in pixels.

Property	Type	Description
Title	String	The title of the Compact Calendar.
Custom Icon	String	Customize the data grid icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/
Json Config	Json	The JSON configuration describes the calendar setup, including the object API name, date fields, and popover fields. `backgroundColor` accepts a fixed colour or a JSON string of coloring rules; a rule's `color` may be `$record.FieldApiName`.

Property	Type	Description
UserCalendar Id or Developer Name	String	GM - UserCalendar Id or Developer Name to use
Calendar Height	Integer	Set the calendar height. Use 9999 for dynamic height

Property	Type	Description
Record Id Field *	String	The name of the lookup field to maps. Set this property to recordId to use the current recordId.
Place Fields *	String	',' Separated list of fields to build the address. Ex BillingStreet,BillingCity,BillingState. This property is useful for place view only.
Latitude Field *	String	Latitude Field. Ex BillingLatitude. This property is useful for street view only.
Longitude Field *	String	Longitude Field. Ex BillingLongitude. This property is useful for street view only.
Maps View	String	Maps default view place \| streetview. The user can still switch to a different view if Enable Switch View is checked.
Enable Switch View	Boolean	Check this option to allow the user to switch between place and street view.
Maps Height	Integer	The height of the map.
Custom Label	String	The title of the map.
Custom Icon	String	The card icon. All lightning icons are supported. The list of icons is available under https://lightningdesignsystem.com/icons/.
Show Border	Boolean	Check this option to add a border to the card.

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.

Property	Type	Description
Show Header	Boolean	Check this option if you wish to display the header.
Title	String	Title of the card.
Icon	String	Icon name from the Salesforce Lightning Design System to display in the header. Ex: standard:account
Timeline Configuration	String	JSON configuration describing the timeline content.
Card Variant	String	Path variant to use; linear or non-linear.

Property	Type	Description
Card Title *	String	The card title to display
Card Icon	String	The card icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/
Object Name *	String	The name of the related object to display.
Record Id Field *	String	The name of the lookup field to display. If you want to display an account card, set this property to AccountId.
Record Fields	String	Record Fields to display in a JSON format. For instance, for an account card, we can set it to: `["Name", "Website","BillingCity"]` This property is ignored if Record Layout property is defined.
Record Actions	String	Record actions to apply. You can leverage your existing quick actions. The configuration wizard can be used to build the list of actions. See Actions Configuration
# of columns	Integer	# of columns for the layout. This property is ignored if Record Layout property is defined.
Display Mode	String	Display mode (edit, view, readonly).
Show Border	Boolean	Check this option if you wish to add a border to the card.
Record Layout	String	Record Layout to display. See GM - Record Layout
Show Actions as Buttons	Boolean	Check this option if you wish to display actions as buttons instead of icons. When the actions are displayed as icons, we can define the icon on JSON actions configuration using the icon attribute.
Visible Actions	Integer	Set the number of visible custom actions. All the core actions will always be displayed depending on the configuration of course. The remaining custom actions will be added as an option on the button menu.

Key	Description
`name`	Unique name of the action.
`label`	Button label.
`icon`	Button icon, e.g. `utility:check`.
`mode`	`view` or `edit`. Omit to display the action in both modes.
`type`	`layout` (default) applies the `command` to the layout. `apex` runs the Apex validator.
`stateful`	`layout` actions are toggles by default. Set to `false` for a one-shot action.
`command`	`layout` actions only. `{ "id", "target": { "fields" \| "sections" \| "formula" }, "changes": { "hidden", "readOnly", "highlighted", "backgroundColor", "style" } }`
`apexClass`	`apex` actions only. Name of the `Callable` class.
`params`	`apex` actions only. JSON object passed to the class.
`successMessage`	`apex` actions only. Toast displayed when the class returns no error.

Property	Description
Record Id	Id of the record to display. Leave empty on a record page.
Layout Config	Developer Name of a Record Layout custom metadata record. When set, the values of the record replace the properties below, including the empty ones.
Object Name	API name of the object to display.
Record Id Field	Field of the page record holding the Id of the record to display. `Id` when the component is placed on the record itself.
Record Layout	JSON layout: sections, rows, visibility, read-only and coloring rules, `validate` rules and `rulesMode`.
Layout Actions	JSON array of layout actions displayed in the header.
Record Actions	JSON array of record actions displayed in the record toolbar.
Show Actions as Buttons	Display the record actions as buttons instead of icons.
Custom Visible Actions	Number of record actions displayed before the overflow menu.
Show Border	Display the card border.

Property	Type	Description
recordId	String	Record Id to use. Keep this empty if you want to use the current record.
PickList Field Name	String	PickList field API name to use for stages.
Path Variant	String	Path variant to use; linear or non-linear.

Property	Type	Description
Tabs Config *	String	Tabs JSON configuration describing the tabs and the content for each tab.
Extra Tabs Config	String	Extra Tabs JSON configuration describing the tabs and the content for each tab.
Variant	String	The The appearance of the Tabs : default, scoped or vertical
Show Border	Boolean	Check this option if you wish to add a border.

Property	Type	Description
Accordion Config *	String	Tabs JSON configuration describing the accordion and the content for each section.
Show Border	Boolean	Check this option if you wish to add a border.