GridPage class

Level: advanced

Class uses to configure list layout, sorting, search logic, etc.

Methods

setPrimaryColumn(modelName, column)

Sets the primary display column. Configures the displaying of a title of the list record.

Parameters

modelName	model name
column	column name

Example of call

Terrasoft.sdk.GridPage.setPrimaryColumn("Case", "Subject");

setSubtitleColumns(modelName, columns)

Sets the columns displayed under the title. Sets the subtitle display as a list of columns with a separator.

Parameters

modelName	model name
columns	an array of columns or column configuration objects

Example of call (option 1)

Terrasoft.sdk.GridPage.setSubtitleColumns("Case", ["RegisteredOn","Number"]);

Example of call (option 2)

Terrasoft.sdk.GridPage.setSubtitleColumns("Case", ["RegisteredOn", {
    name: "Number",
    convertFunction: function(values){
        return values.Number;
    
}]);

setGroupColumns(modelName, columns)

Sets a group with columns that are displayed vertically. Configures displaying the group of columns.

Parameters

modelName	model name
columns	can array of columns or column configuration objects

Example of call (option 1)

Terrasoft.sdk.GridPage.setGroupColumns("Case", ["Symptoms"]);

Example of call (option 2)

Terrasoft.sdk.GridPage.setGroupColumns("Case", [{
    name: "Symptoms",
    isMultiline: true,
    label: "CaseGridSymptomsColumnLabel",
    convertFunction: function(values) {
        return values.Symptoms;
    }
}]);

setImageColumn()

Sets the image column.

setOrderByColumns()

Sets the list sorting.

setSearchColumn()

Sets the search column.

setSearchColumns()

Sets the search columns.

setSearchPlaceholder()

Sets the hint text in the search field.

setTitle()

Sets the title of the list page.