GM - FieldSet Pivot
(gmpkg:FieldSetPivotGridComponent)
Documentation
GM - FieldSet Pivot component is used to display a collection of records as a Pivot Table. With this component, we can display time series records with the ability to summarize and edit the data.
Use case: Display a Forecast Grid where the forecast can be set by Opportunity and by Month. See Pivot Grid Tutorial
Specification
Property | Type | Description |
---|---|---|
recordId | String | recordId to use. Keep this empty if you want to use the current record. |
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 |
X Columns * | String | JSON Array of field API Names to build X columns of the Pivot Grid. Don’t forget __c for custom fields. |
X Column Sort | String | The field to sort with to create the pivot header. If this field is empty, X Column field will be used. |
X Column Order | String | The order for X Column Sort (asc|desc). Keep it empty for ascending or if X Column Sort is empty |
Y Columns * | String | JSON Array of field API Names to build Y columns of the Pivot Grid. Don’t forget __c for custom fields |
Y Hidden Columns | String | Y Hidden Columns API Name. The records will be grouped by Y Columns, however the hidden columns will not be displayed to the end user. Don’t forget __c for custom fields |
Value Columns * | String | The list of columns to display/edit on the grid as cells. Don’t forget __c for custom fields |
Row Limit * | Integer | The maximum number of rows to fetch. |
Page Size * | Integer | The number of rows to fetch per step. |
Custom Label | String | Override the title of the data grid. |
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. |
Filter | String | JSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid |
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. See GM - RelatedList Grid |
Order | String | Ascending or descending order for sorting. For ascending enter the value asc. For descending enter the value desc |
Aggregate | String | JSON string to define the aggregate field. Use __c for custom fields. See GM - RelatedList Grid |
Enable Update Object | Boolean | Check this option if you wish to allow the end-user to perform inline editing of the grid. |
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 items' 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 records' 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 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 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 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 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 records' icon from the list of quick actions. |
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. |
Hide Field Column | Boolean | The Pivot Grid is able to display multiple fields. To distinguish the fields we have an extra column containing the field name. Check this field to hide the field name. |
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 Record’ button. |
Default Values | String | JSON string to initialize a new object created from the pivot grid. See GM - RelatedList Grid |
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. |
Grid 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 style of the header: To set X Column style: To set Field Column style: To set Total Column style : To set any Y Column style: To set the alignment for any V Column: |
Frozen Columns | Integer | # of columns to freeze at startup. Note that the Y Columns and Field Column will be always frozen. |
Total Color | String | Total row text color |
Total Background | String | Total row background color |
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. |
Cell Coloring | String | JSON conditions for cells coloring. You can define for each field displayed in the grid the coloring and the corresponding condition. See GM - RelatedList Grid |
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. See GM - RelatedList Grid. |
Default Mode | String | String to define the initial display mode of the grid (edit | read). If this property is set to edit, the grid is displayed in edit in the first load of the page. |
API Reference
Last updated