Skip to main content

 

 

 

 
 
Applies only to Reactive Web Apps
Service Studio version:
 
 
OutSystems

Data Grid Reactive APIs

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Data Grid for Reactive Web Applications is built on top of Grape City Data Grid, an Enterprise Grade Javascript Data Grid, that can be used for building applications, such as reporting, data analytics, and business workflow.

    Summary

    Widget Description
    ActionColumn Column for your GridContainer Block to render number fields. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    CheckboxColumn Column for your GridContainer Block to render boolean fields. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    ContextMenu Add a context menu to the grid. Default options: Copy, Copy with headers, Export to CSV to Excel Freeze column(s), Unfreeze column(s).
    CurrencyColumn Column for your GridContainer Block to render number fields. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    DateColumn Column for your GridContainer Block to render text fields. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    DateTimeColumn Column for your GridContainer Block to render text fields. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    DropdownColumn Column for your GridContainer Block to render fields with dropdown options. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    Grid Container that displays the grid. Add the Grid Block to your Screen and associate your data to it.
    MenuItem_Column_Freeze Allows the user to freeze columns on the grid.
    MenuItem_Column_FreezeUnfreeze Allows the user to freeze or unfreeze columns on the grid.
    MenuItem_Column_Unfreeze Allows the user to unfreeze columns on the grid.
    MenuItem_Copy Allows the user to copy data from the grid.
    MenuItem_Copy_WithHeaders Allows the user to copy data from the grid, including its headers.
    MenuItem_CustomOption Allows the user to set customized actions on the ContextMenu.
    MenuItem_Export Aggregates all the available export functions.
    MenuItem_Export_ToCSV Allows the user to export data to a .CSV file
    MenuItem_Export_ToExcel Allow the user to export data to an .XLS file
    MenuItem_Export_ToExcelWithoutStyles Allows the user to export data to an .XLS file, ignoring CSS styles.
    MenuItem_Rows_Add Allows the user to insert as many rows as the selected.
    MenuItem_Rows_Delete Allows the user to delete the selected rows.
    MenuItem_Separator Insert a line separator. Used to distinguish areas in a context menu.
    NumberColumn Column for your GridContainer Block to render number fields. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    OnFiltersChange This block enables you to handle the OnFiltersChange event of a given grid. When the user changes a filter, the event is fired with all of the currently active filters.
    SearchData Allows the user to search for data on an already loaded grid
    TextColumn Column for your GridContainer Block to render text fields. Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.
    Action Description
    ArrangeData Prepares your data to be used by the Data Grid. Use this action in the Data Action after you have fetched the data from the database.
    Client Action Description
    ActivateFilter Activates a filter on a given column.
    AddClass Adds a CSS class to a specific row on the grid.
    AddNewRows Adds new lines to the grid (depending on the number of lines that are selected).
    ClearFilter Clears the filter on a given column.
    ClearSort Clears all sorting on the grid
    DeactivateFilter Deactivates the filter on a given column.
    FreezeColumns Freezes the left-most columns on the grid.
    FreezeColumnsByActiveCell Freezes the left-most columns on the grid, considering the active cell.
    GetAllSelections Returns the ranges for all selections on the grid.
    GetAllSelectionsData Returns the DataSource for all the ranges and rows selected on the grid.
    GetChangedLines Gets the lines that were added/changed/removed by the user.
    GetSelectedRowsCount Returns the amount of rows selected on the grid.
    GetSelectedRowsData Returns the DataSource for all the rows selected on the grid
    GetViewLayout Returns the current layout of the grid.
    HasFrozenColumns Checks if the grid has frozen columns.
    HasSelectedRows Checks if the grid has selected rows.
    MarkChangesAsSaved Marks the lines that were changed, as saved in the database.
    RemoveAllClasses Removes all CSS classes from a specific row on the grid.
    RemoveClass Removes a CSS class from a specific row on the grid.
    RemoveSelectedRows Deletes the lines that are selected on the grid.
    SearchData_deprecated Searches for data on an already loaded grid.
    SetValidationStatus Defines a specific cell as valid/invalid and displays an error message to the user when the content of that same cell is invalid.
    SetViewLayout Adds new lines to the grid depending on the number of lines that are selected.
    UnfreezeColumns Unfreezes all columns on the grid.
    Structure Description
    ActionOptionalConfigs Additional configurations that can be set in the Action column.
    ActiveFilters Contains the information of a given filter of a column.
    BindingValue Represents the content of a cell.
    CellRange Represents a range of cells.
    ChangedLines Information about the lines that were added/changed/removed by the user.
    ColumnOptionalConfigs Additional configurations that can be set in the Column.
    CurrencyOptionalConfigs Additional configurations that can be set in the Currency columns.
    DateConditionalFormatRule Conditional format rule definition for the Date column.
    DateFormatCondition Condition to be validated.
    DateOptionalConfigs Additional configurations that can be set in the Date columns.
    DateTimeConditionalFormatRule Conditional format rule definition for DateTime column.
    DateTimeFormatCondition Condition to be validated.
    DateTimeOptionalConfigs Additional configurations that can be set in the DateTime columns.
    DropdownOption Option displayed in the Dropdown column.
    ErrorMessage Error message from actions, such as adding or removing rows from the grid.
    Filter_Condition Represents a filter condition.
    Mandatory Sets column fields as mandatory and sets an error message.
    MenuItemOptionalConfigs Additional configurations that can be set in the Context Menu items.
    NumberConditionalFormatRule Conditional format rule definition for the Number column.
    NumberFormatCondition Condition to be validated.
    NumberOptionalConfigs Additional configurations that can be set in the Number columns.
    OptionalConfigs Additional configurations that can be set in the grid.
    RangeData Represents a range of selected cells in a row.
    RowData Represent the data source of a row.
    Static Entity Description
    AlignMode Alignment modes for the column Align parameter. Has the values Center, Left and Right.
    DateOperator Operators used by the Date and DateTime conditional format.
    Filter_OperatorType Operators supported by the filter.
    Filter_Type Type of filter supported by the grid - condition and value.
    NumberOperator Operators used by the Number and Currency conditional format.

    Widgets

    ActionColumn

    Column for your GridContainer block to render number fields.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    TextFixed
    Type: optional, Text.
    Text to be displayed in the column links.
    If used, the TextFromBinding field is ignored.
    TextFromBinding
    Type: optional, Text.
    Field to be displayed as text of the link from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.Name"
    Note: Field "TextFixed" is dominant.
    ActionOptionalConfigs
    Type: optional, ActionOptionalConfigs.
    Sets additional parameters to customize the column's behavior and functionality.

    CheckboxColumn

    Column for your GridContainer Block to render boolean fields.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    Binding
    Type: mandatory, Text.
    Field to be displayed from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.IsFavourite"
    ColumnOptionalConfigs
    Type: optional, ColumnOptionalConfigs.
    Sets additional parameters to customize the column's behavior and functionality.

    ContextMenu

    Adds a context menu to the grid. (Default options: Copy, Copy with headers, Export to CSV to Excel, Freeze column(s), Unfreeze columns)

    CurrencyColumn

    Column for your GridContainer Block to render number fields.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    Binding
    Type: mandatory, Text.
    Field to be displayed from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.Price"
    Mandatory
    Type: optional, Mandatory.
    Sets column fields as mandatory and sets an error message
    ColumnOptionalConfigs
    Type: optional, ColumnOptionalConfigs.
    Sets additional parameters to customize the column's behavior and functionality.
    CurrencyOptionalConfigs
    Type: optional, CurrencyOptionalConfigs.
    Sets additional configurations that can be set in the Currency columns.

    DateColumn

    Column for your GridContainer Block to render text fields.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    Binding
    Type: mandatory, Text.
    Field to be displayed from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.CreatedOn"
    Mandatory
    Type: optional, Mandatory.
    Set column fields as mandatory and set an error message
    ColumnOptionalConfigs
    Type: optional, ColumnOptionalConfigs.
    Sets additional parameters to customize the column's behavior and functionality.
    DateOptionalConfigs
    Type: optional, DateOptionalConfigs.
    Sets additional configurations that can be set in the Date columns.

    DateTimeColumn

    Column for your GridContainer Block to render text fields.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    Binding
    Type: mandatory, Text.
    Field to be displayed from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.CreatedOn"
    Mandatory
    Type: optional, Mandatory.
    Sets column fields as mandatory and sets an error message
    ColumnOptionalConfigs
    Type: optional, ColumnOptionalConfigs.
    Sets additional parameters to customize the column's behavior and functionality.
    DateTimeOptionalConfigs
    Type: optional, DateTimeOptionalConfigs.
    Sets additional configurations that can be set in the DateTime columns.

    Column for your GridContainer Block to render fields with dropdown options.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    Binding
    Type: mandatory, Text.
    Field to be displayed from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.Category"
    Mandatory
    Type: optional, Mandatory.
    Sets column fields as mandatory and sets an error message
    DropdownOptionList
    Type: mandatory, DropdownOption List.
    List of options to appear in the dropdown.
    ColumnOptionalConfigs
    Type: optional, ColumnOptionalConfigs.
    Set additional parameters to customize the column's behavior and functionality.

    Grid

    Container that displays the grid.

    Add the Grid Block on your Screen and associate your data to it.

    Inputs

    Data
    Type: mandatory, Text.
    The content that is displayed in the grid. To best set data in this parameter, fetch data from your database and convert it to JSON with either the ArrangeData action or the JSON Serialize node.
    IsDataFetched
    Type: mandatory, Boolean.
    Defines if an empty state should be displayed while data is loading.
    For example: DataAction.IsDataFetched
    GridHeight
    Type: optional, Integer.
    Set the container's height in pixels (Default: 400px).
    HasGroupPanel
    Type: optional, Boolean.
    Enables the group panel to allow dragging columns and apply the grouping by the fields corresponding to the dragged columns (Default: True).
    OptionalConfigs
    Type: optional, OptionalConfigs.
    Set additional parameters to customize the grid's behavior and functionality.

    Allows the user to freeze columns on the grid.

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allows the user to freeze or unfreeze columns on the grid.

    Inputs

    FreezeColumnsLabel
    Type: optional, Text.
    Menu item's label
    UnfreezeColumnsLabel
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allows the user to unfreeze columns on the grid.

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allows the user to copy data from the grid.

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allow the user to copy data from grid, including its headers.

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allows the user to set customized actions on the ContextMenu.

    Inputs

    Label
    Type: optional, Text.
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Aggregates all the available export functions.

    Inputs

    Label
    Type: optional, Text.
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allows the user to export data to a .CSV file

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allows the user to export data to a .XLS file

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allow the user to export data to a .XLS file, ignoring CSS styles.

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allows the user to insert as many rows as the selected.

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Allow the user to delete the selected rows.

    Inputs

    Label
    Type: optional, Text.
    Menu item's label
    MenuItemOptionalConfigs
    Type: optional, MenuItemOptionalConfigs.
    Additional configurations that can be set in the context menu items.

    Inserts a line separator. Used to distinguish areas in a context menu.

    NumberColumn

    Column for your GridContainer Block to render number fields.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    Binding
    Type: mandatory, Text.
    Field to be displayed from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.Stock"
    Mandatory
    Type: optional, Mandatory.
    Sets column fields as mandatory and sets an error message
    ColumnOptionalConfigs
    Type: optional, ColumnOptionalConfigs.
    Sets additional parameters to customize the column's behavior and functionality.
    NumberOptionalConfigs
    Type: optional, NumberOptionalConfigs.
    Sets additional configurations that can be set in the Number columns.

    OnFiltersChange

    This block enables you to handle theOnFiltersChange event of a given grid.
    When the user changes a filter, the event is fired with all of the currently active filters.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block, that the block will handle the events.

    SearchData

    Searches for data on an already loaded grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.
    PromptMessage
    Type: optional, Text.
    Message that appears in the search input (Default: "Search for data in the Grid").

    TextColumn

    Column for your GridContainer Block to render text fields.

    Drag as many columns as you need into the GridColumnsPlaceholder in the GridContainer Block.

    Inputs

    Header
    Type: mandatory, Text.
    Title of the column.
    Binding
    Type: mandatory, Text.
    Field to be displayed from your data.
    Expected format: "{EntityName}.[FieldName]"
    For example: "Product_Sample.Name"
    Mandatory
    Type: optional, Mandatory.
    Sest column fields as mandatory and sets an error message
    ColumnOptionalConfigs
    Type: optional, ColumnOptionalConfigs.
    Sets additional parameters to customize the column's behavior and functionality.

    Actions

    ArrangeData

    Prepares your data to be used by the Data Grid.
    You should use this action in the Data Action after you fetch the data from the database.

    Inputs

    Data
    Type: mandatory, Object.
    Data to be displayed in the datagrid. Use the method ToObject() to pass your data.
    For example: ToObject(GetProducts.List)

    Outputs

    Success
    Type: Boolean.
    Result of the operation. If the result is false, the ErrorMessage output is displayed.
    DataJSON
    Type: Text.
    Data in JSON format to be provided to the Data Grid.
    ErrorMessage
    Type: Text.
    Problem that has occurred.

    Client Actions

    ActivateFilter

    Activate filter on a given column

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    ColumnWidgetId
    Type: mandatory, Text.
    ID of the Column block in which the filter will be activated.

    AddClass

    Add a CSS class to a specific row from the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.
    RowNumber
    Type: mandatory, Integer.
    Number of the row in which the class is going to be added.
    Class
    Type: mandatory, Text.
    CSS class to add to the row.

    AddNewRows

    Add new lines to the grid depending on the number of lines that are selected.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.

    Outputs

    Success
    Type: Boolean.
    Boolean that indicates if the action was successfully performed.
    ErrorMessage
    Type: ErrorMessage.
    Error message from actions, such as adding or removing rows from the grid. Contains a code and a message explaining the error.

    ClearFilter

    Clear filter on a given column.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    ColumnWidgetId
    Type: mandatory, Text.
    ID of the Column block in which the filter will be cleared.

    ClearSort

    Clear all sorting on the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    DeactivateFilter

    Deactivate filter on a given column.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    ColumnWidgetId
    Type: mandatory, Text.
    ID of the Column block in which the filter will be deactivated.

    FreezeColumns

    Freezes the leftmost columns in the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    ColumnsCount
    Type: mandatory, Integer.
    Number of leftmost columns to freeze

    FreezeColumnsByActiveCell

    Freezes the leftmost columns from the grid, considering the active cell.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    GetAllSelections

    Returns the Ranges for all selections on Grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    Outputs

    SelectedRanges
    Type: CellRange List.
    Returns all selections made in grid.

    GetAllSelectionsData

    Returns the DataSource for all the ranges and rows selected on the Grid

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    Outputs

    SelectionData
    Type: RangeData List.
    Returns the values selected in each row.

    GetChangedLines

    Gets the lines that were added/changed/removed by the user.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.

    Outputs

    ChangedLines
    Type: ChangedLines.
    Lines that were added/changed/removed by the user.

    GetSelectedRowsCount

    Returns the number of rows selected on the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    Outputs

    RowsCount
    Type: Integer.
    Returns the number of selected rows.

    GetSelectedRowsData

    Returns the DataSource for all the rows selected on the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    Outputs

    RowsData
    Type: RowData List.
    Returns the selected rows data.

    GetViewLayout

    Returns the current layout of the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.

    Outputs

    Config
    Type: Text.

    HasFrozenColumns

    Checks if the grid has frozen columns.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    Outputs

    IsFrozen
    Type: Boolean.
    Returns a boolean indicating if the grid has frozen columns.

    HasSelectedRows

    Checks if the grid has selected rows.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    Outputs

    HasSelectedRows
    Type: Boolean.
    Returns a boolean indicating if the grid has selected rows.

    MarkChangesAsSaved

    Marks the lines that were changed as saved in the database.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.

    RemoveAllClasses

    Remove all CSS classes from a specific row on the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.
    RowNumber
    Type: mandatory, Integer.
    Number of the rows from which all classes will be removed.

    RemoveClass

    Remove a CSS class from a specific row on the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.
    RowNumber
    Type: mandatory, Integer.
    Number of the rows from which all CSS classes will be removed.
    Class
    Type: mandatory, Text.
    CSS class to remove from the row.

    RemoveSelectedRows

    Delete the lines that are selected on the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.

    Outputs

    Success
    Type: Boolean.
    Boolean that indicates if the action was successfully performed.
    ErrorMessage
    Type: ErrorMessage.
    Error message from actions, such as adding or removing rows from the grid. Contains a code and a message explaining the error.

    SearchData_deprecated

    Search for data on an already loaded grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.
    SearchValue
    Type: mandatory, Text.
    Value to be searched in the Grid.

    SetValidationStatus

    Defines a specific cell as valid/invalid and displays an error message to the user when the content of that same cell is invalid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    RowNumber
    Type: mandatory, Integer.
    Number of the row in which the action of validation should be triggered.
    ColumnWidgetId
    Type: mandatory, Text.
    ID of the Column block in which the action of validation should be triggered.
    IsValid
    Type: mandatory, Boolean.
    Boolean that indicates whether the cell value meets a validation or data type rule. True, if the value conforms to the rule. Otherwise, False.
    ErrorMessage
    Type: optional, Text.
    Message shown to the user when the value introduced is not valid. By default: "Invalid [ColumnName]"

    SetViewLayout

    Adds new lines to the grid depending on the number of lines that are selected.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.
    By default: first grid on the screen.
    Config
    Type: optional, Text.

    UnfreezeColumns

    Unfreezes all columns in the grid.

    Inputs

    GridWidgetId
    Type: mandatory, Text.
    ID of Grid block.

    Structures

    ActionOptionalConfigs

    Additional configurations that can be set in the Action Column.

    Attributes

    Align
    Type: AlignMode Identifier.
    Set the horizontal alignment of cells in the column
    Default:
    Text Columns - Left
    Currency Columns - Right
    Numeric Columns - Right
    Dropdown Columns - Left
    Date/DateTime Columns - Right
    Checkbox Columns - Center
    AllowReorder
    Type: Boolean.
    Allows changing the column order (Default: True).
    AllowResize
    Type: Boolean.
    Allows resizing the column width (Default: True).
    Visible
    Type: Boolean.
    Allows to hide/display the column in the data grid (Default: True).
    Width
    Type: Integer.
    Set the column's default width in pixels (default: 0 -> set automatically by the grid).

    ActiveFilters

    Contains the information of a column's filter.

    Attributes

    ColumnWidgetId
    Type: Text.
    Column Id where the filter was applied. If not using columns, and relying on the auto-generate of columns, then this value will be empty.
    Binding
    Type: Text.
    Binding where the filter was applied to.
    FilterTypeId
    Type: Filter_Type Identifier.
    Type of filter applied can be either "condition" or "value".
    FilterConditions
    Type: Filter_Condition List.
    List of conditions defined in the filter.
    FilterShowValues
    Type: Text List.
    List of values (in string format) of selected values for the filter.

    BindingValue

    Represents the content of a Cell

    Attributes

    Binding
    Type: Text.
    Cell binding property.
    Value
    Type: Text.
    Cell's value.

    CellRange

    Represents a range of cells.

    Attributes

    TopRowIndex
    Type: Integer.
    Topmost row index
    Top row index.
    LeftColumnIndex
    Type: Integer.
    Leftmost column index.
    BottomRowIndex

    Type: Integer.

    Bottom row index.

    RightColumnIndex
    Type: Integer.
    Rightmost column index.

    ChangedLines

    Information about the lines that were added/changed/removed by the user.

    Attributes

    HasChanges
    Type: Boolean.
    Checks if there was any change made to the data grid by the user.
    If "false", then no change was made to the data.
    AddedLines
    Type: Text.
    JSON Serialization of the lines that were added by the user.
    EditedLines
    Type: Text.
    JSON Serialization of the lines that were edited by the user.
    RemovedLines
    Type: Text.
    JSON Serialization of the lines that were removed by the user.
    HasInvalidLines
    Type: Boolean.
    Checks if there are any invalid lines in the data grid.
    InvalidLines
    Type: Text.
    JSON Serialization of the lines that are invalid in the data grid.

    ColumnOptionalConfigs

    Additional configurations that can be set in the Column.

    Attributes

    Align
    Type: AlignMode Identifier.
    Set the horizontal alignment of cells in the column.
    Default per column type:
    Text Columns - Left
    Currency Columns - Right
    Numeric Columns - Right
    Dropdown Columns - Left
    Date/DateTime Columns - Right
    Checkbox Columns - Center
    AllowEdit
    Type: Boolean.
    Allows editing the column (Default: True).
    AllowReorder
    Type: Boolean.
    Allows changing the column order (Default: True).
    AllowResize
    Type: Boolean.
    Allows resizing the column width (Default: True).
    AllowSort
    Type: Boolean.
    Allows sorting data by column (Default: True).
    Visible
    Type: Boolean.
    Allows to hide/display the column in the data grid (Default: True).
    Width
    Type: Integer.
    Set the column's default width in pixels (Default: 0 -> set automatically by the grid).

    CurrencyOptionalConfigs

    Additional configurations that can be set in the Currency columns.

    Attributes

    NumberConditionalFormatRules
    Type: NumberConditionalFormatRule List.
    List of conditional format rules to be applied to the Currency column.
    DecimalPlaces
    Type: Integer.
    Set the column's default decimal places (Default: 2).
    Decimal places should be defined between 0 and 11.
    Symbol
    Type: Text.
    Set the column's default currency symbol (Default: $).

    DateConditionalFormatRule

    Conditional format rule definition for Date column.

    Attributes

    DateFormatConditions
    Type: DateFormatCondition List.
    List of Conditions to be validated in order to apply the CSS class in the cell and/or row.
    CellClass
    Type: Text.
    CSS class to be applied in the cell.
    RowClass
    Type: Text.
    CSS class to be applied in the row.

    DateFormatCondition

    Condition to be validated.

    Attributes

    DateOperatorId
    Type: DateOperator Identifier.
    Operator used to compare the value field with the cell value.
    Value
    Type: Date.
    Value to be compared to.

    DateOptionalConfigs

    Additional configurations that can be set in the Date columns.

    Attributes

    DateConditionalFormatRules
    Type: DateConditionalFormatRule List.
    List of conditional format rules to be applied to the Date column.

    DateTimeConditionalFormatRule

    Conditional format rule definition for DateTime column.

    Attributes

    DateTimeFormatConditions
    Type: DateTimeFormatCondition List.
    List of Conditions to be validated in order to apply the css class in the cell and/or row.
    CellClass
    Type: Text.
    CSS class to be applied in the cell.
    RowClass
    Type: Text.
    CSS class to be applied in the row.

    DateTimeFormatCondition

    Condition to be validated.

    Attributes

    DateOperatorId
    Type: DateOperator Identifier.
    Operator used to compare the value field with the cell value.
    Value
    Type: Date Time.
    Value to be compared to.

    DateTimeOptionalConfigs

    Additional configurations that can be set in the DateTime columns.

    Attributes

    DateTimeConditionalFormatRules
    Type: DateTimeConditionalFormatRule List.
    List of conditional format rules to be applied to the DateTime column.

    DropdownOption

    Option to be displayed in the Dropdown column.

    Attributes

    Text
    Type: Text.
    Text to be displayed.
    For example: Sample_ProductCategory.Label
    Value
    Type: Text.
    ID of this option.
    For example: Sample_ProductCategory.Id

    ErrorMessage

    Error message from actions such as adding or removing rows from the grid.

    Attributes

    Code
    Type: Long Integer.
    Code that tells if there was any success or error resulting from the actions such as adding or removing lines from the grid.
    Message
    Type: Text.
    Message that explains the resulting code from the actions, such as adding or removing lines from the grid.

    Filter_Condition

    Represents a filter condition

    Attributes

    And
    Type: Boolean.
    Operator to be used between conditions. If true "and", else "or".
    OperatorTypeId
    Type: Filter_OperatorType Identifier.
    Filter operator to be used in the condition (e.g. "Is Greater than", ...)
    Value
    Type: Text.
    Condition value against which the cell value will be matched against - string format.

    Mandatory

    Set column fields as mandatory and set an error message

    Attributes

    IsMandatory
    Type: Boolean.
    Boolean that tells if this column will be mandatory or not.
    If you wish to have another type of validation, you can use the SetValidationStatus client action.
    ErrorMessage
    Type: Text.
    Message that will be displayed if the cell is not filled with any value

    MenuItemOptionalConfigs

    Additional configurations that can be set in the Context Menu items.

    Attributes

    Enabled
    Type: Boolean.
    Boolean literal or expression that defines if the Context Menu item is enabled. The menu item will not be clickable if this configuration is set to False.

    NumberConditionalFormatRule

    Conditional format rule definition for Number column.

    Attributes

    NumberFormatConditions
    Type: NumberFormatCondition List.
    List of Conditions to be validated in order to apply the css class in the cell and/or row.
    CellClass
    Type: Text.
    CSS class to be applied in the cell.
    RowClass
    Type: Text.
    CSS class to be applied in the row.

    NumberFormatCondition

    Condition to be validated.

    Attributes

    NumberOperatorId
    Type: NumberOperator Identifier.
    Operator used to compare the value field with the cell value.
    Value
    Type: Decimal (0, 0).
    Value to be compared to.

    NumberOptionalConfigs

    Additional configurations that can be set in the Number columns.

    Attributes

    NumberConditionalFormatRules
    Type: NumberConditionalFormatRule List.
    List of conditional format rules to be applied to the Number column.
    DecimalPlaces
    Type: Integer.
    Set the column's default decimal places (Default: 0).
    Decimal places should be defined between 0 and 11.
    MaxValue
    Type: Decimal (0, 0).
    Set the maximum value accepted by the column.
    When the cell is in edit mode and it is changed to a value higher than Max Value, the cell value will become Max Value.
    If Max Value is 0, then no maximum value will be defined.
    MinValue
    Type: Decimal (0, 0).
    Set the minimum value accepted by the column.
    When the cell is in edit mode and it is changed to a value lower than Min Value, the cell value will become Min Value.
    If Min Value is 0, then no minimum value will be defined.
    Step
    Type: Decimal (0, 0).
    Set the step value in the increments in the column.
    When step value is defined and the cell is in edit mode, the input will show two buttons, a plus (+) that will increase the cell value with the step value and a minus (-) that will decrease the cell value.
    If step value is 0, then no buttons will be displayed.

    OptionalConfigs

    Additional configurations that can be set in the grid.

    Attributes

    AllowColumnEdit
    Type: Boolean.
    Allows to make the columns editable (Default: True).
    AllowColumnReorder
    Type: Boolean.
    Allows changing the column order (Default: True).
    AllowColumnResize
    Type: Boolean.
    Allows resizing the column width (Default: True).
    AllowColumnSort
    Type: Boolean.
    Allows sorting data by column (Default: True).
    RowHeight
    Type: Integer.
    Set the row height in pixels (Default: 48px).
    RowsPerPage
    Type: Integer.
    Set the number of rows per page (Default: 50).

    RangeData

    Represents a range of selected cells in a row.

    Attributes

    RowIndex
    Type: Integer.
    Row Index
    Selected
    Type: BindingValue List.
    List of selected cells

    RowData

    Represents the data source of a Row.

    Attributes

    DataItem
    Type: Text.
    Data source serialized to string
    RowIndex
    Type: Integer.
    Row Index.

    Static Entities

    AlignMode

    Alignment modes for the column Align parameter. Has the values Center, Left and Right.

    Attributes

    Id
    Type: Text (50).

    Records

    • Center
    • Left
    • Right

    DateOperator

    Operators to be used in Date and DateTime conditional format.

    Attributes

    Label
    Type: Text (50).

    Records

    • LessOrEqualsTo
    • GreaterThan
    • LessThan
    • Equals
    • GreaterOrEqualsTo

    Filter_OperatorType

    Operators supported by the filter.

    Attributes

    Id
    Type: Text (50).
    Label
    Type: Text (50).
    Order
    Type: Integer.

    Records

    • Contains
    • EndsWith
    • BeginsWith
    • IsGreaterThanOrEqualTo
    • DoesNotContain
    • DoesNotEquals
    • IsLessThanOrEqualTo
    • Equals
    • IsGreaterThan
    • IsLessThan

    Filter_Type

    Type of filter supported by the grid - condition and value.

    Attributes

    Id
    Type: Text (50).

    Records

    • Condition
    • Value

    NumberOperator

    Operators to be used in Number and Currency conditional format.

    Attributes

    Label
    Type: Text (50).

    Records

    • GreaterOrEqualsTo
    • GreaterThan
    • NotEquals
    • Equals
    • LessThan
    • LessOrEqualsTo
    • Was this article helpful?