A keypress model which is received from the client.
Note The the key model is available for the following grid events only
ON_GRID_CELL_CLICK and ON_GRID_CELL_DOUBLE_CLICK. In all other cases , it will be null()
Set to true to specify that the sort should take into account accented characters, if this feature is turned on the sort will perform slower.
#Configuration
#GridRenderer
Add new column sorting to the model
Add new row
Add Language File This method can be used for new languages, or to overrule the default translation file that is shipped with the grid plugin
An array of rows to add
Align the current grid with the passed one
Aligning two or more grids means columns will be kept aligned in all grids. In other words, column changes to one grid (column width, column order, column visibility etc) are reflected in the other grid. This is useful if you have two grids, one above the other such that their columns are vertically aligned, and you want to keep the columns aligned.
Enable a chart toolbar item
#Enterprise
#Configuration
#API
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add new column definition
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Group Vector of Columns
#Configuration
#ColumnsRenderer
Group Vector of Columns
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add column group
#Configuration
#ColumnsRenderer
Add statusbar component
Index for rows to add
add a new suggestion item
Add a new suggestion item
Add a new suggestion item
Add new context menu item
Add a predefined context menu item
Enable pivot for columns
#Enterprise
#Configuration
#API
Clear already created charts. Note that this method does not clear user created charts
#API
Add new range selection
#API
Add new range selection
#API
Add new range selection
#API
Add new range selection
#API
Add new row
#API
Add new row at the beginning of the grid
#API
Enable row grouping for columns
#Enterprise
#Configuration
#API
Add Style block
#API
Add Style block
#API
Enable value for columns
#Enterprise
#Configuration
#API
Name of function to use for aggregation. One of [sum, min, max, first, last].
#Configuration
#ColumnsRenderer
agg functions to show on the panel. possible values are: 'count', 'sum', 'min', 'max', 'avg'
When set to true, series values will be summed for each category before charting.
The component alignment
When true , then input values which are not part of the suggestion list will be accepted , rejected otherwise
Aggregation functions allowed on this column eg ['sum', 'avg'].
#Configuration
#ColumnsRenderer
When true then accepts direct user's input from the input field.
Set to true to always show the vertical scrollbar.
#Configuration
#GridRenderer
Set to true to enable Row Animation.
#Configuration
#GridRenderer
Apply the filter
This method will only compose the model and send it to the client in case send! is true.
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Apply the filter
This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Apply the filter
This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Apply the filter
This method only compose the model and send it to the client
On the client the new model will be displayed on the filter panel but it will not be applied on the data.
To execute the model on the client you need to call execute(1)
Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button.
Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button.
Set to true to have the filter use an Apply button. If the Apply button is present, then the filter is only applied after the user hits the Apply button.
Set to true to apply the Set Filter immediately when the user is typing in the Mini Filter. Default: false
Convert the client row to a DataRow
Executes the specified JavaScript in this BBjHtmlView control and returns immediately
Allows specifying the group 'auto column' if you are not happy with the default.
If grouping, this column def is included as the first column definition in the grid.
If not grouping, this column is not included.
#Configuration
#GridRenderer
Set to true to have the grid calculate height of row based on contents of this column.
#Configuration
#ColumnsRenderer
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
looks at the rendered cells on the screen, and works out the width based on what it sees. It cannot see the columns that are not rendered due to column virtualisation. Thus it is not possible to autosize a column that is not visible on the screen.
Column Virtualisation is the technique the grid uses to render large amounts of columns with degrading performance by only rendering columns that are visible due to the horizontal scroll positions. Eg the grid can have 1000 columns with only 10 rendered if the horizontal scroll is only showing 10 columns. To get around this, you can turn off column virtualisation by setting grid options SuppressColumnVirtualisation=true.
#API
How many pixels to add to a column width after the auto-sizing calculation. The default is 4 pixels. Set this if you want to add extra room to accommodate (for example) sort icons, or some other dynamic nature of the header.
#Configuration
#GridRenderer
The Grid Core Class.This class works as a columns manager and api provider. It contains a big number of methods and properties to configure the column from A..Z. Every property and method has one or more tag attached.
The following is the meaning for each tag :
| Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
| Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
| API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
| ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
| GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
disabled default constructor
The constructor that creates the widget in the ChildWindow
The constructor that creates the widget in the ChildWindow
The constructor that creates the widget on wnd!
The constructor that creates the widget on wnd!
Build the column definitions from the passed ResultSet
Set to true to make text filtering case sensitive, otherwise the filtering will be case insensitive
The current cell where the context menu is triggered
CSS class(es) to use for the cell.
#Configuration
#ColumnsRenderer
Rules which can be applied to include certain CSS classes. These rules are provided as a map where the keys are the class names and the values are expressions that if evaluated to true, the class gets used. An expression is evaluated by the grid by executing the string as if it were a Javascript expression.
#Configuration
#ColumnsRenderer.
The expression has the following attributes available to it.
| x | Mapped from cell value |
| rowIndex | Maps the current row index |
| data | Mapped from the DataRow |
| ctx | The grid client context |
CellEditor to use for this column
#Configuration
#ColumnsRenderer
Provide a cell renderer for each value
A cellRenderer to use for this column
#Configuration
#ColumnsRenderer
Provide a cell renderer for each value
A map of css values.
#Configuration
#ColumnsRenderer
Constant value which defines that chart toolbar data item
Constant value which defines that chart toolbar download item
Constant value which defines that chart toolbar format item
Constant value which defines that chart toolbar settings item
A constant which defines column chart category
A constant which defines column chart excluded, columns which set chart type to excluded will be excluded from charts
A constant which defines column chart series
Defines the chart data type that should be used for a column. There are two types of charting ranges; a category range that is highlighted in green and a series range that is highlighted in blue. A category range can only contain cells from a single column, whereas a series range can contain values from many columns. Columns can be explicitly configured or left for the grid to infer the type based on the data contained in the cells where columns containing string values will map to 'categories' and columns containing number values will map to 'series' charting columns.
#Configuration
#ColumnsRenderer.
When true enable checkbox selection, disable otherwise
Set to true to render a selection checkbox in the column.
#Configuration
#ColumnsRenderer
The row child index.
if the childIndex is -1 then the row is pinned to top or bottom
Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.
Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.
Set to true to have the filter use a Clear button. The Clear button will clear the details of the filter thus resetting it.
Remove callback
Clear already created chart by its id
#API
Note that this method does not clear user created charts
Clear already created charts. Note that this method does not clear user created charts
#API
Alias for resetAllColumns()
#Configuration
#ColumnsRenderer
Clear row data (Empty the grid )
#API
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear the filter
Clear all active filters on columns
#API
Clears the selected range.
#API
Clear row data (Empty the grid )
#API
A json object which is used as context to configure the grid and it various components on the client
The client row data as JsonObject.
Close toolpanel
Close the given toolpanel
A DOMString with the code value of the physical key represented by the event.
collapse all groups
#API
Number of character columns to display. Default is 60.
The column model
The cell's column
The working column
A constant which defines the group state as opened
A constant which defines the group state as opened
A constant which defines the group state as opened
A constant which defines the group state as opened
Whether to show the column when the group is open / closed.
#Configuration
#ColumnsRenderer
Set to true to highlight columns by adding the ag-column-hover CSS class.
#Configuration
#GridRenderer
An array of column objects where every object is instance of GxClientColumnModel
A list of column ids to use. Note that none existing columns will be ignored silently
Column & column groups definitions map
The column definitions map
The column groups definitions map
Columns Manager instance
A grid expression which can be executed to perform column spanning.
The expression must return the number of columns to span , if no spanning should be applied , then
return 1 instead (ex: "data.Section === 'quarters'")
By default, each cell will take up the width of one column. You can change this behaviour to allow cells to span multiple columns. This feature is similar to 'cell merging' in Excel or 'column spanning' in HTML tables.
Constraints with Column Spanning :
Column Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Column Spanning, be aware of the following:
#Configuration
#ColumnsRenderer.
Compare two cell editors
Compare two filters
Compare two cell renderers
The grid context menu
#Configuration
#GridRenderer
By default, column groups start expanded. Pass true to default to contracted groups
Create a new suggestion item
Create a new suggestion item
Create a new suggestion item
Additional CSS classes to be applied to the menu item
A string template which will be compiled on the client to return an array for the tree hierarchy.
#Enterprise
#Configuration
#GridRenderer
The number of milliseconds to debounce by before applying the filter
When true the grid will use the unmingled version of the Javascript code then open the debugger in a new window.
Number of decimal to use when parsing the size. default is 2
The number's decimal separator to use. by default the bbj decimal separator will be used
The number's decimal separator to use. by default the bbj decimal separator will be used
Contains column properties all columns will inherit.
#Configuration
#GridRenderer
Contains column group properties all column groups will inherit.
#Configuration
#GridRenderer
The default dates mask to use. by default %Dz.%Mz.%Yd
Initial value of the hour element.
Initial value of the minute element.
The default numbers mask to use. by default null()
The default Filter Options to be selected. By default it is Equals
The default Filter Options to be selected. By default it is Equals
The default strings mask to use. by default null()
The default dates mask to use. by default %Dz.%Hz:%mz:%sz
The default timestamps mask to use. by default %Dz.%Mz.%Yl %Hz:%mz:%sz
Set this to true to instead show all values as de-selected by default. Default: false
The id of the default panel
By default when new columns are loaded into the grid, the following properties (Order, Aggregation Function, Width, Pivot, Row Group, Pinned ) are not used
To change this behaviour and have column attributes above take effect each time the grid updates the columns, then set this option to true
#Configuration
#GridRenderer
deselect all rows
#API
deselect all rows
#API
Destroy the grid
Set disableMobile to true to always use the non-native picker.
Set to true if the column is editable, otherwise false.
#Configuration
#ColumnsRenderer
An expression which determines whether the column is editable
or not. when this config is different than null , then the column
configuration Editable will be ignored
Set to 'fullRow' to enable Full Row Editing. Otherwise leave blank to edit one cell at a time.
#Configuration
#GridRenderer
The message that will be showed when there are no suggestions that match the entered value.
Enable / disable time 24 format.
Set to true to use the browser's default tooltip instead of using Ag-Grid's Tooltip Component.
#Configuration
#GridRenderer
Enable / disable Calendar input.
Set to true to enable charting
#Enterprise
#Configuration
When true the filter is enabled, disabled otherwise
#Configuration
#ColumnsRenderer
When true enables the floating filters, disable otherwise
#Configuration
#GridRenderer
Set to true if you want to be able to pivot by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
Set to true to enable Range Selection
#Enterprise
#Configuration
Set to true if you want to be able to row group by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
Set to true to operate grid in RTL (Right to Left) mode.
#Configuration
#GridRenderer
Enable / disable seconds selection
Enable / disable time selection
Set to true if you want to be able to aggregate by this column via the UI.
#Enterprise
#Configuration
#ColumnsRenderer
Enables display of week numbers in calendar.
End row id or index
Ensures the column is visible, scrolling the table if needed.
#API
Ensures the row key is visible by vertically scrolling the grid
Ensures the row index is visible by vertically scrolling the grid. The valid values for positions are {'top', 'middle', 'bottom'}. If top, middle or bottom, the grid will scroll the row to place the row at top, middle or bottom
#API
Ensures the row index is visible by vertically scrolling the grid
Ensures the row index is visible by vertically scrolling the grid. The valid values for positions are {'top', 'middle', 'bottom'}. If top, middle or bottom, the grid will scroll the row to place the row at top, middle or bottom
#API
Set to true to have Enter key move focus to the cell below if not editing. The default is Enter key starts editing the currently focused cell.
#Configuration
#GridRenderer
Set to true to have Enter key move focus to the cell below after Enter is pressed while editing. The default is editing will stop and focus will remain on the editing cell.
#Configuration
#GridRenderer
Compare two filters
Compare two filters
Compare two filters
Compare two filters
Compare two expressions
Compare two expressions
Compare two filters
Compare two filters
Compare two filters
Compare two filters
Compare two cell renderers
Compare two cell renderers
Compare two cell renderers
Execute the transaction on the widget model (ResultSet)
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
Execute a Javascript code on the client
Execute a Javascript code on the client and use the script itself as a key
Execute a Javascript code on the client with an auto calculated priority
Execute a Javascript code on the client , use the script itself as a key and auto calculate priority
Execute and debounce a Javascript code on the client and auto calculate priority
Execute and debounce a Javascript code on the client , use the script itself as a key and auto calculate priority
Set and apply a filter transaction
The transaction is a LinkedHashMap of columns and their models.
This the fastest way to apply several filters on several columns.
When using this method The grid will delay executing the filters on the data
until all models are set and ready.
#API
#Configuration
Execute a javascript code on the client.
Note that if the grid is not ready yet , then script will queued until the grid is ready then send to the client. If some reason you do not want this behavior , then use the executeScript method from the created internal HTML View
Execute a bulk update on the grid
The transaction method is to pass a transaction object to the grid containing rows to add, remove and update.
The grid keeps all active sorting, grouping and filtering, including updating to reflect the changes in the data should the sorting, grouping or filtering be impacted.
Updating using transactions is the best way to do large updates to the grid, as the grid treats them as delta changes, so the grid only refreshes what is needed giving a performance boost.
All row and range selection will be kept.
Note that all update done on the grid will reflected also on the ResultSet instance which is the grid is using.
#API
Execute a bulk update on the grid
The transaction method is to pass a transaction object to the grid containing rows to add, remove and update.
The grid keeps all active sorting, grouping and filtering, including updating to reflect the changes in the data should the sorting, grouping or filtering be impacted.
Updating using transactions is the best way to do large updates to the grid, as the grid treats them as delta changes, so the grid only refreshes what is needed giving a performance boost.
All row and range selection will be kept.
Note that all update done on the grid will reflected also on the ResultSet instance which is the grid is using.
#API
Instance of he scripts executor
Expand all groups
#API
Expression string
False value translation
The value to use when when the component needs to render false values. in case it is null() then we use the first item in PossibleFalseValues!
The field of the row to get the cells data from
Note: Once the field name is set, it becomes immutable
The value associated with the filter.
The value associated with the filter.
The value associated with the filter.
The value associated with the filter.
The filter component to use for this column
#Configuration
#ColumnsRenderer
What Filter Options to present to the user. By default all supported options are presented
What Filter Options to present to the user. By default all supported options are presented
In case you are using range filter , then this is the second input value
In case you are using range filter , then this is the second input value
An Ag Grid expression which can be executed to get the value for filtering purposes.
#Configuration
#ColumnsRenderer.
The first filter condition
The row pin position (top , bottom , null)
When true enable the floating filter on this column , false otherwise
#Configuration
#ColumnsRenderer
The height for the row containing the floating filters. If not specified the default is 20px.
#Configuration
#GridRenderer
Iterate over the enqueued scripts and execute them on the HTML View.
The gird should call this method once when it is ready to kick in the execution process.
Normally this done after the ON_PAGE_LOADED event is fired.
The executor then will keep flushing itself whenever it is needed.
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the first column
#API
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the given column
#API
Set the focus on the given row id and the first column
#API
Will set the focus on the first cell of the first row. In case the grid has already a different selected cell , the the method will retain this information.
#API
Provide a footer value getter expression
When true, the grid will force using the community version of the grid whether there is a license key or not.
Affects the output by switching the way a mask with "#" characters in the trailing positions is filled. for example, the function NumberMask.mask(.10:"#.##") returns .10 instead of .1 . The options is used only when numberMask is defined
A valid expression which validates the datetime
If true, then row group, pivot and value aggregation will be read only from the UI.
The grid will display what values are used for each, but will not allow the use to change the selection
#Configuration
#API
Get sorting for the given column
Get the component alignment
Convert the model to JSON array
Build the grid json configuration object
Convert the filter definition to Json Object
@override
{@inheritDoc}
@override
{@inheritDoc}
Convert the filter definition to Json Object
@override
{@inheritDoc}
@override
{@inheritDoc}
@override
{@inheritDoc}
Get the row data as JsonObject
Convert the model to JSON object
Convert the model to JSON object
Convert the model to JSON object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
Convert the filter definition to Json Object
@override
Convert the filter definition to Json Object
Transform the options object to json
Transform the options object to json
Build the grid json configuration object
Convert the renderer definition to Json Object
Convert the renderer definition to Json Object
Get a json representation for the toolpanel
Get a json representation for the toolpanel
Get a json representation for the toolpanel
Get a json representation for the toolpanel
Convert the sidebar into json object
Get the component's JSON representation
Get the component's JSON representation
Get the component's JSON representation
Map a JSON object to GxClientCellModel
Map a JSON string to GxClientCellModel
A constant which holds the client cell editor real name
@override
{@inheritDoc}
@override
{@inheritDoc}
@override
{@inheritDoc}
A constant which holds the client cell editor real name
@override
{@inheritDoc}
@override
{@inheritDoc}
A constant which holds the client cell editor real name
@override
{@inheritDoc}
A constant which holds the client renderer real name
A constant which holds the client renderer real name
Get the grid's client context
Get instance of GxClientJsonFactory
Get the column definition instance
#Configuration
#ColumnsRenderer
Get the cell's column
Map column name to GxClientColumnModel
Get the working column
Get the column definition instance
#Configuration
#ColumnsRenderer
Get the column definition instance
#Configuration
#ColumnsRenderer
Get the column definition instance
#Configuration
#ColumnsRenderer
Get the column group definition instance
#Configuration
#ColumnsRenderer
Get the column group definition instance
#Configuration
#ColumnsRenderer
Get the column group definition instance
#Configuration
#ColumnsRenderer
Get the column group definition instance
#Configuration
#ColumnsRenderer
Get the grid's columns , sorting and filtering state
#API
Get statusbar component
Get the grid default context menu
Get the unique control type
Alias for getAsJsonObject()
Get DeltaColumn Mode value
Get DeltaColumn Mode value
Parse a filter conditions (single or combined) and return a filter model
Parse a filter conditions (single or combined) and return a filter model
Get The combined filter model for the given column
This method will return a GxClientFilterCombinedModel for the given column
If the column has already some filter values set through the UI , then the model will contain
these changes too.
In case the grid is not ready (not renderer yet) then the method will just return any empty combined filter model for the column.
#API
#Configuration
Parse a filter condition and return a filter model
Get The filter model for the given column
This method will return a GxClientFilterModel for the given column
If column has already some filter values set through the UI , then the model will contain
these changes too.
In case the grid is not ready (not renderer yet) then the method will just return any empty filter model for the column.
#API
#Configuration
A constant which holds the client filter real name
@override
A constant which holds the client filter real name
Get the tooltip for the column group header
Get the editor unique id
Get the menu item ID
Get the menu item ID
Get the toolbar unique name
Get the component id
Alias for imageToBase64()
Get the column index
Returns the index of the column with the specified name.
Return the number of initiated instances of the grid
Map a JSON object to GxClientKeypressModel
Get the selected language
Get the language keys
Get the translation keys as JSON string
Get the language keys
Get the translation keys as JSON string
Get the language manager instance
Get the column mask
Get the column type
Returns the metadata of the column.
Get the mini filter value.
Note that if the grid is not ready , then this method will always return an empty string
even if you have called setMiniFilter before.
#API
Get the column name
Get the pinned bottom rows as defined in the grid options
Get the bottom pinned rows as json String
Get the bottom pinned rows as Json Array
Get the count of pinned rows on bottom
Get the pinned top rows as defined in the grid options
Get the top pinned rows as json String
Get the top pinned rows as Json Array
Get the count of pinned rows on top
Check if pivot mode is enabled or disabled
#Configuration
#API
Map a JSON object to GxClientRangeSelectionModel
The method will return a vector of the selected ranges including columns and rows
#API
Get the editor resolver instance
Get the root id of the grid
The root id is a unique & auto-generated id for the grid instance. This id is used in the client to distinguish the grid instances
Returns the row with the given key from the grid.
Note : if you only need to get the row and you don't care about other meta data like parent(when grouping) , isSelected, ... then use the ResultSet API (ex ResultSet.getItem(BBjString key!) )
Get the cell's row
Map a JSON object to GxClientRowModel
Map a JSON string to GxClientRowModel
Get the rows from grid in the given phase after applying the given filter expression.
Note: if you only need to get the whole rows from the grid and you don't care about filtering and sorting Then retrieve them from ResultSet as this will be faster especially in BUI
Get the rows from grid in the given phase after applying the given filter expression.
Note: if you only need to get the whole rows from the grid and you don't care about filtering and sorting Then retrieve them from ResultSet as this will be faster especially in BUI
Get the rows from grid in the given phase after applying the given filter expression.
Note: if you only need to get the whole rows from the grid and you don't care about filtering and sorting Then retrieve them from ResultSet as this will be faster especially in BUI
Get the rows from grid after sorting and filtering
Get the current selected row
#API
Get the number of affected rows by the last event
Get Array of selected rows
#API
Get the grid sidebar instance
Get the grid's columns , sorting and filtering state
#API
Get the grid statusbar instance
Get the grid supported themes
#API
Get the column type
Returns the value of the ColumnType property from the ResultSet's metadata.
Get the cell value
Get the widget instance
Get the widget instance
Get the widget instance
Get the widget instance
Constant value to define centered column
Constant value to define left aligned column
Constant value to define right aligned column
Constant value to define editing mode "cell"
Constant value to define editing mode "row"
Constant value to define enter key behavior (Move to next cell)
Constant value to define enter key behavior (Stop editing)
Constant value which defines the rows floating on bottom
Constant value which defines the rows with no floating
Constant value which defines the rows floating on top
Constant value which defines that group panel must always be hidden
Constant value which defines that group panel must be shown only when grouping
Constant value which defines that group panel must always be shown
Constant value to define navigation behavior (Move to next cell)
Constant value to define navigation behavior (Move to next row)
Constant value to define row position
Constant value to define row position
Constant value to define row position
Constant value which describes the rows in after filtering phase.
Constant value which describes the rows in after filtering and sorting phase.
Constant value which describes the rows in before sorting and filtering phase.
Constant value which defines the alpine theme
Constant value which defines the alpine dark theme
Constant value which defines that balham theme
Constant value which defines that balham dark theme
Constant value which defines the material theme
Specifies the results of row grouping should be displayed as custom: informs the grid that group columns will be provided.
Specifies the results of row grouping should be displayed as group rows: group rows are automatically added instead of group columns.
Specifies the results of row grouping should be displayed as multiple columns: a group column per row group is added automatically.
Specifies the results of row grouping should be displayed as single column: single group column automatically added by the grid.
If grouping, set to the number of levels to expand by default. Eg 0 for none, 1 first level only, etc. Default is 0 (expand none). Set to -1 for expand everything
#Configuration
#GridRenderer
Specifies how the results of row grouping should be displayed.
The options are:
#Configuration
#GridRenderer
The height for the rows containing header column groups. If not specified, it uses headerHeight
#Configuration
#GridRenderer
Set to true to hide parents that are open. When used with multiple columns for showing groups, it can give more pleasing user experience
#Configuration
#GridRenderer
The unique ID to give the column.
If grouping, whether to show a group footer when the group is expanded.
If true, then by default, the footer will contain aggregate data (if any)
when shown and the header will be blank.
When closed, the header will contain the aggregate data regardless
of this setting (as footer is hidden anyway).
This is handy for 'total' rows, that are displayed below the data when
the group is open, and alongside the group when it is closed
#Configuration
#GridRenderer
Set to true to show a 'grand' total group footer across all groups.
#Configuration
#GridRenderer
If using auto column, set to true to have each group in its own column separate column, eg if group by Country then Year, two auto columns will be created, one for country and one for year
#Configuration
#GridRenderer
Set to true to collapse lowest level groups that only have one child.
#Configuration
#GridRenderer
Set to true to collapse groups that only have one child.
#Configuration
#GridRenderer
When true, selecting a group will have the impact of selecting all its children
When false, then the group is selectable independently of the child nodes.
#Configuration
#GridRenderer
NoteThat this settings has no effect if MultipleSelection is disabled
If using groupSelectsChildren, then only the children that pass the current filter will get selected
#Configuration
#GridRenderer
The number's group separator to use. by default the bbj group separator will be used
The number's group separator to use. by default the bbj group separator will be used
If true, the grid will not swap in the grouping column when grouping is enabled.
Use this if you want complete control on the column displayed and don't want the grids help.
In other words, you already have a column in your column definitions that is responsible for displaying the groups
#Configuration
#GridRenderer
If true, and showing footer, aggregate data will be displayed at both the header and footer levels always.
This stops the possibly undesirable behaviour of the header details 'jumping' to the footer on expand.
#Configuration
#GridRenderer
If true, the group row won't be displayed and the groups will be expanded by default with no ability to expand / contract the groups. Useful when you want to just 'group' the rows, but not add parent group row to each group
#Configuration
#GridRenderer
If grouping, set to true or false (default is false).
If true, a group row will span all columns across the entire width of the table.
If false, the cells will be rendered as normal and you will have the opportunity to include
a grouping column (normally the first on the left) to show the group
#Configuration
#GridRenderer
Allows specifying the group 'auto column' if you are not happy with the default. If grouping, this column def is included as the first column definition in the grid. If not grouping, this column is not included.
Construct new instance
Abstract implementation for GxCellEditorInterface
Simple switch button to switch boolean values
A simple boolean editor based on the GxCellEditorRichSelect.
The editor provides a select box where the user can selected one of the three values (true , false , none)
#OnlyGUI
#Enterprise
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
A simple boolean editor based on the GxCellEditorSelect.
The editor provides a select box where the user can selected one of the three values (true , false , none)
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
Construct new GxCellEditorBasicBooleanSelect
A date cell editor
Construct a new GxCellEditorBasicDate
Construct new GxCellEditorBasicDate
A cell editor for timestamps
Construct new GxFilterBasicDateTime
Simple number input
Simple text input
Construct new GxCellEditorBasicText
A date cell editor
Construct a new GxCellEditorBasicTime
Construct new GxCellEditorBasicTime
Alias for GxCellEditorBasicDateTime
Construct new GxFilterBasicDateTime
Compare two cell editor components
Column Filter Public Interface
Simple editor that uses the standard HTML 'textarea' tag.
Simple editors that use the standard HTML select tag.
It is same as GxCellEditorSelect but as popup.
The standard HTML select to behave oddly in the grid. This is because the browser doesn't have a great API for opening and closing the selected popup.
We advise that you don't use it unless you have to - that is we advise against GxCellEditorPopupSelect as they give poor user experience, especially if using keyboard navigation.
If using Enhanced grid, you should use the provided GxCellEditorRichSelect.
#Enterprise
Same as GxCellEditorText but as popup.
Available in Enhanced Grid only. An alternative to using the browser's select popup for dropdown inside the grid.
#Enterprise
Simple editors that use the standard HTML select tag.
The standard HTML select to behave oddly in the grid. This is because the browser doesn't have a great API for opening and closing the selected popup.
We advise that you don't use it unless you have to - that is we advise against GxCellEditorSelect as they give poor user experience, especially if using keyboard navigation.
If using Enhanced grid , you should use the provided GxCellEditorRichSelect.
A Suggestion/autocomplete cell editor.
The suggestion cell editor is an input which gives the user a list of values (suggestions) to choose from while it types.
The suggestion list can be resolved using a custom object which implements
GxCellEditorSuggestionResolverInterface or extends GxCellEditorSuggestionResolver
ex:
use ::BBjGridExWidget/GxCellEditors.bbj::GxCellEditorSuggestion
editor! = new GxCellEditorSuggestion("ANY_UNIQUE_ID", new CustomResolver())
editor!.setEmptyMessage("No data to display")
column! = grid!.getColumn("COLUMN_ID")
column!.setCellEditor(editor2!)
Construct new GxCellEditorSuggestion
An generic implementation of GxCellEditorSuggestionResolverInterface
The class implements the resolve method defined in GxCellEditorSuggestionResolverInterface
and exposes some helpers methods like addItem , createItem to help building
the suggestion list.
Any Custom object which extends this class must implement the doResolve method
which accepts the search term.
ex:
use ::BBjGridExWidget/GxCellEditors.bbj::GxCellEditorSuggestionResolver
class public CustomResolver extends GxCellEditorSuggestionResolver
method public void doResolve(BBjString term!)
sbc! = new SqlQueryBC(BBjAPI().getJDBCConnection("CDStore"))
rs! = sbc!.retrieve(String.format("SELECT TITLE , MUSICTYPE, CDNUMBER FROM CDINVENTORY WHERE TITLE LIKE '%%%s%%' ORDER BY MUSICTYPE", term!))
it! = rs!.iterator()
while it!.hasNext()
next! = it!.next()
label! = String.format("[%s] %s", #getColumn().getName(), next!.getFieldAsString("TITLE"))
value! = next!.getFieldAsString("CDNUMBER")
group! = next!.getFieldAsString("MUSICTYPE")
#addItem(label!, value!, group!)
wend
methodend
classend
A interface which defines how a suggestion's resolver/builder should build the suggesting lst
Simple text editors that use the standard HTML 'input' tag
Compare two cell renderers components
The model is used to compose a range chart model in order to be applied on the client.
The model is used to compose a range selection model in order to be applied on the client.
Ranges are normally bounded by a start and end row. However it is also possible to define a range unbounded by rows (ie to contain all rows). For an unbounded range, do not provided start or end row positions.
A model for the client cell
A model for the client column
Construct new GxClientColumnModel
Cell Editing / Clicking Event
Context Menu Event
Keypress event
Cells range selection event
Cell Editing / Clicking Event
Row Selection Event (single & double)
A generic abstract implementation for the GxClientFilterModel interface
The filter model represents the state of the boolean filter
Construct new GxClientFilterBooleanModel
A filter a which wraps two filter models and combine them with an OR or AND operator
Construct new GxClientFilterCombinedModel
Construct new GxClientFilterCombinedModel
Construct new GxClientFilterCombinedModel
The filter model represents the state of the datetime filter. Please not this model will work for date , times and timestamps
Construct new GxClientFilterDateTimeModel
Construct new GxClientFilterDateTimeModel
Construct new GxClientFilterDateTimeModel
Construct new GxClientFilterDateTimeModel
When saving or restoring state on a filter the filter model is used. The filter model represents the state of the filter
The filter model represents the state of the number filter
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
Construct new GxClientFilterNumberModel
The filter model represents the enhanced filter type "setFilter"
Construct new GxClientFilterSetFilterModel
An abstract filter model which defined the common properties of the provided simple filters
The filter model represents the state of the text filter
Construct new GxClientFilterTextModel
Construct new GxClientFilterTextModel
Construct new GxClientFilterTextModel
The class will create client models from JSON
Construct new GxClientJsonFactory
The model is used to represent a keypress on the client
This model is used when range selections are read from the client
A client model for rows
Construct new client row
The sorting model describes how the columns will be sorted on the client
The model describes an transaction operation that can be passed to the grid to add / remove & update that data at once.
Construct new transaction model
The class holds the grid column props, it also introduces several helper methods to update the styles like, fore/back colors.
Create a new column definition
Create a new column definition
Create a new column definition
Create a new column definition
The class holds the common props between column and column groups. Every property and method has one or more tag attached.
The following is the meaning for each tag :
| Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
| Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
| API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
| ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
| GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
The class holds the shared ag filter options between all filter types. This is the base class for all ag filter types
Filter options constants for date/time filter
Filter options constants for numbers filter
Filter options constants for texts filter
The class holds the grid column group. With this object you can group several columns and several column groups together to create deep nested structure.
Construct new GxColumnGroup
Construct new GxColumnGroup
The class is a direct implementation for GxColumnsManagerInterface and it defines the common logic for all methods
The interface defines the common methods for columns and column groups management
Columns Toolpanel
Construct new columns toolpanel
Construct new toolpanel
Construct new toolpanel
A class which represents grid context menu
A class which represents a grid context menu item
Construct new Menu item
Construct new Menu item
Construct new Menu item
An interface which defines a menu item
The class represents the default column definition which the grid will use.
The class holds the default grid column group.
A class which represents the default grid context menu
Construct the default grid context menu
A class to define the default implementation of the grid sidebar
Construct the default grid sidebar
The GxExecutor is responsible of Javascript code execution in the HTMLView. It will also tries to debounce the scripts which are enqueued for execution and send them in patches at specific rate.
Construct new GxExecutor object
Expressions are Javascript functions which are written as strings. When you provide an expression to the grid, the grid converts the expression into a function for you and then executes the function on the client.
Expressions can be used with the columns ValueGetterExpression, ValueFormatterExpression, ValueSetterExpression, ValueParserExpression.
For example you can add a virtual column to the grid and define a value getter expression to get the value of this column based on other two columns.
Expression can be as simple as "data.CDNumber" or more complex as the GxExpressionNumbersFormatter which can accepts parameters.
When working with expression key the following points in mind:
Expression can access several predefined variables :
| x | Mapped from cell value |
| value | Same as x |
| oldValue | Mapped from the cell's old value, this is mapped in editing |
| newValue | Mapped from the cell's new value, this is mapped in editing |
| data | Mapped from the DataRow |
| column | Current column |
| columnGroup | Current column group |
| getValue | The value after it is processed by the ValueGetterExpression |
| ctx | The grid client context |
Abstract implementation for GxExpressionInterface
The class defines a grid expression to format bytes to one of the following measuring terms : ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
The class defines a grid expression to format date/timestamps according to BBj supported masks
Construct a new GxExpressionDatesFormatter
Construct a new GxExpressionDatesFormatter
Construct a new GxExpressionDatesFormatter
The class defines a grid expression to format date/timestamps according to BBj supported masks
Construct a new GxExpressionDateTimesFormatter
Construct a new GxExpressionDateTimesFormatter
Construct a new GxExpressionDateTimesFormatter
GxExpressionInterface
The class defines a grid expression to format numbers according to BBj supported masks
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
Construct a new GxExpressionNumbersFormatter
The class defines a grid expression to format strings according to BBj supported masks
Construct a new GxExpressionNumbersFormatter
Alias for GxExpressionDateTimesFormatter
Construct a new GxExpressionTimestampsFormatter
Construct a new GxExpressionTimestampsFormatter
Construct a new GxExpressionTimestampsFormatter
The class represents the boolean filter
The class represents the date filter
Construct a new GxFilterBasicDateTime
Construct new GxFilterBasicDate
The class represents the date time filter
Construct new GxFilterBasicDateTime
The class represents the time filter
Construct a new GxFilterBasicTime
Construct new GxFilterBasicTime
Alias for GxFilterBasicDateTime
Construct new GxFilterBasicTimestamp
Compare two filter components
The class represents the default ag-grid date filter
Column Filter Public Interface
The class represents the default ag-grid number filter
GxFilterSetFilter allow you to filter on set data, influenced by how filters work in Microsoft Excel
#Enterprise
A class which represents the filters toolpanel
Construct new filters toolpanel
Construct new filters toolpanel
Construct new filters toolpanel
The class represents the default ag-grid text filter
GxLanguageManager.bbj
The language manager will add, remove language files to the grid.
The grid will query the language manager in every render to get the translation keys.
Note Changing the language in the language manager will not automatically trigger a grid re-render.
GxLanguageManager
Construct a new GxLanguageManager instance
A logger class which is used internally to output log , warn , error messages to the console and to the debug.log file
The class holds the grid configuration properties
Every property and method has one or more tag attached.
The following is the meaning for each tag :
| Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
| Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
| API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
| ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
| GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
Construct new GxOptions instance
The class defines the common boolean options shared between components which manipulate booleans
Construct new GxOptionsBoolean
The class defines the common date time options shared between components which manipulate dates , times & timestamps
Abstract implementation for GxRendererInterface
The class represents a boolean cell renderer
The class can render a custom html using lodash string templates.
Inside the template you will have access to the params object which contains value, valueFormatted, ...
Use This render if you want to render the data with a custom html.
Construct new GxRendererCustomHTML
If you are grouping in the grid, then you will need to provide a group cell renderer as the group cell renderer is what provides the user with the expand and collapse functionality.
Construct new GxRendererGroupCellRenderer
Construct new GxRendererGroupCellRenderer
The renderer can be used to display a list of images based on the cells values using a json object
Construct new GxRendererImageRenderer
GxRendererInterface
The class manages the grid sidebar and its toolpanels
Construct new sidebar
The Grid state object
GxStatusBar
Gx status bar manager. The class can add, remove & hide status bar components
Construct new sidebar
A statusbar component which provides aggregations on the selected range.
Construct new Aggregation Component
Construct new Aggregation Component
An Abstract implementation for GxStatusBarComponentInterface
Constructor
An interface which defines a status bar component
A statusbar component which provides the filtered row count.
Constructor
A statusbar component which provides the selected row count
Constructor
A statusbar component which provides the total and filtered row count.
Constructor
A statusbar component which provides the total row count.
Constructor
An abstract class which represents a toolpanel which can be attached to a sidebar
Construct new toolpanel
Construct new toolpanel
A interface which defines a grid toolpanel
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Check if the column group definition exists
#Configuration
#ColumnsRenderer
Set to true to render a selection checkbox in the column's header.
#Configuration
#ColumnsRenderer
When true , The checkbox will select only filtered rows when checked and un-select only filtered rows when unchecked. The checkbox will update its state based only on filtered rows. When false The checkbox will select all rows when checked, and un-select all rows when unchecked. The checkbox will update its state based on all rows.
#Configuration
#ColumnsRenderer
CSS class(es) to use for the header cell.
#Configuration
#ColumnsRenderer
Tooltip for the column group header
The height for the row containing the column label header. If not specified the default is 25px.
#Configuration
#GridRenderer
Tooltip for the column header
#Configuration
#ColumnsRenderer
Setup the suggestion list height in pixels
The image's height
Set to true to make a column hidden by default.
#Configuration
#ColumnsRenderer
When true, the sidebar will be hidden on the first draw, visible otherwise. default is false
Clear all overlays
#API
Instance of the created HTMLView
The icon to display beside the icon, either a DOM element or HTML string
Icons to use inside the column instead of the grid's default icons.
The icons can either be set on the grid options (all icons) or on the column definition (all except group). If defined in both the grid options and column definitions, the column definition will get used. This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons and just the simple arrow for other columns.
#Configuration
#ColumnsRenderer.
The icons are set as follows:
// column header items
menu
filter
columns
sortAscending
sortDescending
sortUnSort
// row checkbox selection and tool panel column selection
checkboxChecked
checkboxUnchecked
checkboxIndeterminate
// tool panel column selection, when read only (ie disabled checkboxes)
checkboxCheckedReadOnly
checkboxUncheckedReadOnly
checkboxIndeterminateReadOnly
// when moving columns
columnMovePin // when column is to the left, before it gets pinned
columnMoveAdd // when adding a column
columnMoveHide // when removing a column
columnMoveMove // when moving a column
columnMoveLeft // when moving and scrolling left
columnMoveRight // when moving and scrolling right
columnMoveGroup // when about to drop into group panel
columnMoveValue // when about to drop into value panel
columnMovePivot // when about to drop into pivot panel
dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it
// menu
menuPin // beside the column pin menu item
menuValue // beside the column value menu item
menuAddRowGroup // beside the column row group menu item
menuRemoveRowGroup // beside the column row group menu item
clipboardCopy // beside the copy to clipboard menu item
clipboardPaste // beside the paste from clipboard menu item
// column drop panels
pivotPanel // beside where to drop columns for pivot
valuePanel // beside where to drop columns for value
Icons to use inside the grid instead of the grid's default icons.
The icons can either be set on the grid options (all icons) or on the column definition (all except group).
If defined in both the grid options and column definitions, the column definition will get used.
This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for
specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons
and just the simple arrow for other columns.
#Configuration
#GridRenderer.
The icons are set as follows:
// column header items
menu
filter
columns
sortAscending
sortDescending
sortUnSort
// expand / contract row group
groupExpanded
groupContracted
// expand / contract column group
columnGroupOpened
columnGroupClosed
// tool panel column group open / close
columnSelectOpen
columnSelectClosed
// row checkbox selection and tool panel column selection
checkboxChecked
checkboxUnchecked
checkboxIndeterminate
// tool panel column selection, when read only (ie disabled checkboxes)
checkboxCheckedReadOnly
checkboxUncheckedReadOnly
checkboxIndeterminateReadOnly
// when moving columns
columnMovePin // when column is to the left, before it gets pinned
columnMoveAdd // when adding a column
columnMoveHide // when removing a column
columnMoveMove // when moving a column
columnMoveLeft // when moving and scrolling left
columnMoveRight // when moving and scrolling right
columnMoveGroup // when about to drop into group panel
columnMoveValue // when about to drop into value panel
columnMovePivot // when about to drop into pivot panel
dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it
// menu
menuPin // beside the column pin menu item
menuValue // beside the column value menu item
menuAddRowGroup // beside the column row group menu item
menuRemoveRowGroup // beside the column row group menu item
clipboardCopy // beside the copy to clipboard menu item
clipboardPaste // beside the paste from clipboard menu item
// column drop panels
rowGroupPanel // beside where to drop columns for row group
pivotPanel // beside where to drop columns for pivot
valuePanel // beside where to drop columns for value
Get the toolbar unique name
The row id
Convert the image at the given path to base64 string
Puts the grid into Immutable Column mode, so that setting new columns keeps column state. Default: false
#Configuration
#GridRenderer
If true then blank (null or undefined) values will pass the 'equals' filter option.
If true then blank (null or undefined) values will pass the 'greaterThan' and 'greaterThanOrEqual' filter options.
If true then blank (null or undefined) values will pass the 'lessThan' and 'lessThanOrEqual' filter options.
Sync the client row data every time a new GxClientRowModel is composed by the grid.
Use this method if the row's data in the client is different that the row's data in the ResultSet
The row index
Constant value to define "info" log messages
Inject a js Script at the top window.
If for some reason you want to inject a script in the iframe , then use the injectScript method from the created internal HTML View.
Provide an inner renderer
If true then doing 'inRange' filter option will include values equal to the start and end of the range.
If true then doing 'inRange' filter option will include values equal to the start and end of the range.
A Boolean that is true if the Alt key was active when the key event was generated.
A Boolean that is true if the Ctrl key was active when the key event was generated.
Check if the filter is action or not
#API
Check if the filter is action or not
#API
The method will check whether the grid has license key or not.
A flag which defines when the grid is ready and the process events started
True when the row is selected, false otherwise
A Boolean that is true if the Shift key was active when the key event was generated.
A keypress model which is received from the client.
Note The the key model is available for the following grid events only
ON_GRID_ROW_CLICK and ON_GRID_DOUBLE_CLICK. In all other cases , it will be null()
A keypress model which is received from the client
A Number representing the Unicode reference number of the key. For keys whose char attribute contains multiple characters, this is the Unicode value of the first character in that attribute.
The name to render in the column header.
#Configuration
#ColumnsRenderer
The item's label
The default label of the toolpanel
The grid language manager
The Grid enterprise key
A json array which is used by the addItem methods and it
will be returned by the implemented resolve method
A json object
The date / timestamp locale to use.
The locale used to format and display dates and times. default to the System settings
Set to true block pinning column via the UI (API will still work).
#Configuration
#ColumnsRenderer
Set to true to always have column displayed first.
#Configuration
#ColumnsRenderer
Set to true block making column visible / hidden via the UI (API will still work).
#Configuration
#ColumnsRenderer
Output a log message on the console and Debug.log file
Output a log message on the console and Debug.log file
Output a log message on the console and Debug.log file
Make Hex Color
Convert the given BBjColor to a hex color string
Set to 'true' to keep columns in this group beside each other in the grid. Moving the columns outside of the group (and hence breaking the group) is not allowed.
A bbj string mask When set we use it to validate the value
The default column mask
The String mask to use.
The Number mask to use.
The date / timestamp mask to use.
The Date mask for calender input
The max allowed value
A valid iso 8601 datetime which defines the max allowed value in the calender
Max number of characters to allow. Default is 200.
Initial max width in pixels
#Configuration
#ColumnsRenderer
Set to an array containing zero, one or many of the pre built men tabs. This is used to figure out which menu tabs are present and in which order the tabs are shown.
The min allowed value
A valid iso 8601 datetime which defines the min allowed value in the calender
Specify the minimum length, when autocomplete should appear on the screen.
Initial min width in pixels
#Configuration
#ColumnsRenderer
Change column position
#API
Start Next Cell Editing
#API
Move to previous cell
#API
Allow selection of multiple cells or rows. When true enable multiselection, disable otherwise
#Configuration
#GridRenderer
Get the component name
Defines how users can move between rows using arrow keys.
#Configuration
#GridRenderer
A constant which describes the NewRowsAction behavior
A constant which describes the NewRowsAction behavior
If set to 'clear', then setting data into the grid will clear (reset) the filter If set to 'keep' then the grid will keep it's currently set filter. The default is 'clear'
None value Translation
The old value of the cell
Constant value to define cell click event
Constant value to define cell double-click event
Constant value to define cell editing start event
Constant value to define cell editing stop event
Constant value to define cell value changed event
Alias for ON_GRID_STATE_CHANGE()
Alias to ON_GRID_ROW_DOUBLE_CLICK()
Constant value to define A filter changed event.
Constant value to define keyboard keypress
Constant value to define range selection event
Constant value to define the grid ready event.
Constant value to define row click events
Constant value to define row double-click event
Constant value to define row editing start event
Constant value to define row editing stop event
Alias for ON_GRID_SELECT_ROW
Constant value to define A row has changed. This event corresponds to Full Row Editing only.
A Constant value to define row selection (selected/deselected) change events
Constant value to define grid state changes
A BBjTimerEvent listener which will be invoked when the executor count down reaches 0 to flush the enqueued scripts
Focus the grid by selecting the cell in the first cell and first column.
Note: If the grid has already a different selected cell , then the event handler will retain the selection
An Event listener executed after the initial load of the HTML View.
At this phase the grid will inject all required js files in the client to make the grid functional.
An Event listener executed after the second ON_PAGE_LOADED event
At this phase the grid flush all enqueued scripts
An Event listener for the fallback by timer
Sporadically the ON_PAGE_LOADED event did not fire
On NativeEvent
Event Handler for Native JavaScript Event coming from the client Determines and dispatches the actual event
Set to 'true' if this group should be opened by default.
Open toolpanel
Open the given toolpanel
The combine operator
Constant value which defines the AND operator
Constant value which defines the OR operator
Instance of the grid options class
Provide a template for 'loading' overlay if not happy with the default one.
#Configuration
#GridRenderer
Provide a template for 'no rows' overlay if not happy with the provided.
#Configuration
#GridRenderer
The row parent key, if any
A regular expression that the input's value must match in order for the value to pass constraint validation
A regular expression that the input's value must match In order for the value to pass constraint validation
Pin a column of the grid to the left or the right margin
#API
Set to 'left' or 'right' to pin.
#Configuration
#ColumnsRenderer
Get pinned left constant
Get pinned right constant
The ResultSet instance which contains the bottom pinned rows
A cellRenderer for pinned rows.
Use to give pinned row cell a different CellRenderer to the other cells. If both CellRenderer and PinnedRowCellRenderer are provided, pinned rows will use PinnedRowCellRenderer over CellRenderer.
#Configuration
#ColumnsRenderer
The ResultSet instance which contains the top pinned rows
The height for the row containing header column groups when in pivot mode. If not specified, it uses groupHeaderHeight
#Configuration
#GridRenderer
The height for the row containing the columns when in pivot mode. If not specified, it uses headerHeight.
#Configuration
#GridRenderer
Set this in columns you want to pivot by. If only pivoting by one column, set this to any number (eg 0). If pivoting by multiple columns, set this to where you want this column to be in the order of pivots (eg 0 for first, 1 for second, and so on).
#Configuration
#ColumnsRenderer
Set to true to enable pivot mode
#Configuration
#API
When to show the 'pivot panel' (where you drag rows to pivot) at the top.
Default is never. Set to either 'always' or 'onlyWhenPivoting'.
Note that the pivot panel will never show if pivotMode is off.
#Configuration
#GridRenderer
A hashset of what is considered false
A hashset of what is considered true
When true then the executor will try to executes the JavaScript in the BBjHtmlView and returns immediately without waiting for a return value from the client.
Enabling this option might boost the performance of the grid.
When true then the executor will try to executes the JavaScript in this BBjHtmlView and returns immediately without waiting for a return value from the client.
Enabling this option might boost the performance of the grid.
A prefix to append to the value after it is formatted
A prefix to append to the value after it is formatted
A map of scripts which must be executed
Defines the range of cells to be charted. A range is normally defined with start and end rows and a list of columns, If the start and end rows are omitted, the range covers all rows (ie entire columns are selected).
The number of milliseconds before the executor tries to flush the enqueued scripts on the client
@Override
This method is called whenever the widget needs to be rendered
Gets the grid to remove a row from the DOM and recreate it again from scratch.
When true, if you set new data into the grid and have groups open, the grid will keep groups open if they exist in the new dataset
#Configuration
#GridRenderer
Remove a column from the model
Add new row
Remove an added language
An array of row to remove
Disable the current grid alignment with the passed one
Disable a chart toolbar item
#Enterprise
#Configuration
#API
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Remove a column group definition
#Configuration
#ColumnsRenderer
Remove statusbar component
Remove statusbar component
Disable pivot for columns.
#Enterprise
#Configuration
#API
Remove a row from grid by the row reference
#API
Remove a row from grid by index
#API
Remove a row from grid by key
#API
Disable row grouping for columns.
#Enterprise
#Configuration
#API
Remove Style Block
#API
Disable value for columns.
#Enterprise
#Configuration
#API
Render the grid
The method will compose the grid config and send it to the client for a full re-render. You can use this method to force the client render after you update a setup configuration (ex: column definitions)
When true , then the input cannot be empty and a value is required to consider the input valid
When true , then the input cannot be empty and a value is required to consider the input valid
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Clear all columns and column groups
#Configuration
#ColumnsRenderer
Reset The row heights.
#API
The rows height is calculated once when the data is first given to the grid. If the data changes, or the width of a column changes, then you may require the grid to calculate the height again by calling this method
Set to true to allow column to be resized.
#Configuration
#ColumnsRenderer
Resolve/build the suggestion list
Resolve/build the suggestion list
Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column.
Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column.
Set to true to have the filter use a Reset button. The Reset button will clear the details of the filter and any active filters on that column.
The row model
The Row being edited
The cell's row.
Property to set CSS class for all rows
#Configuration
#GridRenderer
Rules which can be applied to include certain CSS classes for rows.
These rules are provided as a JavaScript map where the keys are class names and the values are expressions that
if evaluated to true, the class gets used. The expression is a string which is treated as a shorthand for a
function by the grid.
#Configuration
#GridRenderer.
The expression has the following attributes available:
| rowIndex | Maps the current row index |
| data | Mapped from the DataRow |
| ctx | The grid client context |
Set to true or false. If true, then rows will be deselected if you
hold down ctrl + click the row. Normal behaviour with the grid disallows
deselection of nodes (ie once a row is selected, it remains selected until
another row is selected in its place).
#Configuration
#GridRenderer
Set to true To group rows by this column
#Enterprise
#Configuration
#ColumnsRenderer
Set this in columns you want to group by. If only grouping by one column, set this to any number (eg 0). If grouping by multiple columns, set this to where you want this column to be in the group (eg 0 for first, 1 for second, and so on).
#Configuration
#ColumnsRenderer
When to show the 'row group panel' (where you drag rows to group) at the top. Default is never. Set to either 'always' or 'onlyWhenGrouping'
#Configuration
#GridRenderer
Default Row Height in pixels. Default is 25 pixels.
#Configuration
#API
Set to true to allow multiple rows to be selected with a single click.
E.g. if you click select one row, then click select another row, the first row will keep it's selection.
Clicking a selected row in this mode will deselect the row.
This is useful for touch devices where ctrl and shift clicking is
not an option.
#Configuration
#GridRenderer
Note that Despite the setting name, it works when MultipleSelection is enabled or disabled
The unique string to use as row index. default is __ROW_INDEX
Number of character rows to display. Default is 10.
An array of rows objects where every object is instance of GxClientRowModel
A grid expression which can be executed to perform row spanning.
The expression must return the number of rows to span , if no spanning should be applied , then
return 1 instead (ex: "data.SHOW ? 4 : 1")
By default, each cell will take up the height of one row. You can change this behaviour to allow cells to span multiple rows. This feature is similar to 'cell merging' in Excel or 'row spanning' in HTML tables.
To allow row spanning, the grid must have options SuppressRowTransform=true
To have a cell span more than one row, return how many rows to span in the RowSpanExpression.
The option SuppressRowTransform=true is used to stop the grid positioning rows using CSS transform
and instead the grid will use CSS top.
The reason row span will not work with CSS transform is that CSS transform creates a stacking context
which constrains CSS z-index from placing cells on top of other cells in another row.
Having cells extend into other rows is necessary for row span which means it will not
work when using CSS transform.
The downside to not using transform is performance; row animation (after sort or filter) will be slower.
Constraints with Row Spanning :
Row Spanning breaks out of the row / cell calculations that a lot of features in the grid are based on. If using Row Spanning, be aware of the following:
#Configuration
#ColumnsRenderer.
Property to set style for all rows. Set to an object of key (style names) and values (style values)
#Configuration
#GridRenderer
The ResultSet instance
The second filter condition
select all rows
#API
select all rows
#API
An array of selected rows
Select all values generated by the UI
#API
Clears the selection
#API
Selects a value
#API
Selects a value
#API
Sets the default alignment for a column
Sets the default alignment for a column
Set the component alignment
Set the allowed aggregation functions allowed on this column
Sets the background color of a column
Sets the background color of a column
Register an event handler
Register an event handler
Set the working column
Set an aggregation function for the passed column field
#Enterprise
#Configuration
#ColumnsRenderer
Sets the default alignment for a column
#Configuration
#ColumnsRenderer
Sets the background color of a column
#Configuration
#ColumnsRenderer
Sets the background color of a column
#Configuration
#ColumnsRenderer
Sets the foreground color for a column
#Configuration
#ColumnsRenderer
Sets the foreground color for a column
#Configuration
#ColumnsRenderer
Sets the default alignment for a column's header
#Configuration
#ColumnsRenderer
Set an image list for a given column using GxRendererImageRenderer.
#Configuration
#ColumnsRenderer
Note: This method will override the CellRenderer of the column. The column has to contain the values "1", "2", "3" to x to reference the slices in the BBjImage list
Set the mask of a column using value formatter expression.
#Configuration
#ColumnsRenderer
Note: This method will override the ValueFormatterExpression of the column.The method depends on the column type to determine the correct value formatter (number, date, ...)
Set the mask of a column in all supported components (filters , formatters , ...)
In case the column has no value formatter expression , then the method will create one
Add columns as comma separated string
Create a GxExpression from string and set it as column span expression
Apply the grid's columns , sorbing and filtering state
#API
Sets the visibility of column(s)
Sets the visibility of a column
Sets the width of a column
#Configuration
#API
Sets the default column width for all columns
#Configuration
#ColumnsRenderer
Hide/show statusbar component
Hide/show statusbar component
Feed the grid with data
Feed the grid with data
The method will sync the result set column definitions with the current column definitions , update the data and render the grid on the client
Feed the grid with data
The method will sync the result set column definitions with the current column definitions , update the data and render the grid on the client
Feed the grid with data
Feed the grid with data
The method will sync the result set column definitions with the current column definitions , update the data and render the grid on the client
Enable remote debugging on the given port
Enable remote debugging on the 9222 port
Set the initial value of the hour element.
Set the initial value of the minute element.
Enable/disable DeltaColumn Mode
Enable / disable column editing
#Configuration
#ColumnsRenderer
Create a GxExpression from string and set it as editable expression
Enable / disable time 24 format.
Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
#Configuration
#ColumnsRenderer
Enable / Disable column Filters.This method updates only the default column definition, columns can still override this setting individually.
#Configuration
#ColumnsRenderer
Throw an error when called because the field becomes immutable after the column's definition creation
Set and apply filter model for the given column
Change on the fly the available options
#API
Set the first condition
Make the currently visible columns fit the screen.
The columns will scale (growing or shrinking) to fit the available width. If you don't want a particular column to be included in the auto resize, then set the column setting SuppressSizeToFit=true. This is helpful if, for example, you want the first column to remain fixed with, but all other columns to fill the width of the table.
#API
Gets the grid to size the columns to the specified with
#API
Create a GxExpression from string and set it a footer value getter
Sets the foreground color for a column
Sets the foreground color for a column
Create a GxExpression from string and set it as FormatterExpression
If true, then row group, pivot and value aggregation will be read only from the Ui. The grid will display what values are used for each, but will not allow the use to change the selection
#Enterprise
#Configuration
#API
Set the default label used when a new group is created
#Configuration
#ColumnsRenderer
Throw an error when called because the group id becomes immutable after the column group's definition creation
Sets the default alignment for a column's header
Set the tooltip for the column group header
Construct an html image to use as an icon
Construct an html image to use as an icon
Set the grid icons
Set the grid icons
#Configuration
#GridRenderer
Enable/disable DeltaColumn Mode
Set the mask of a column in all supported components (filters , formatters , ...)
In case the column has no value formatter expression , then the method will create one
Sets the filter at the top of the filter (the 'quick search' in the popup)
#API
Sets the filter at the top of the filter (the 'quick search' in the popup)
#API
Set a result set of pinned rows on bottom
Set a result set of pinned rows on bottom
Set a result set of pinned rows on top
Set a result set of pinned rows on top
Disable pivot for all columns and enable it for the passed columns
#Enterprise
#Configuration
#API
Enable / disable pivot mode
#Configuration
#API
Perform throw columns search
#API
Perform throw columns search
#API
Update row data
#API
Update row data
#API
Disable row grouping for all columns and enable it for the passed columns
#Enterprise
#Configuration
#API
Set all rows height
#API
Set the given row height
#API
Set the given row height
#API
Feed the grid with a new ResultSet
Unlike the setData method, this one will update the grid with a new rows set(ResultSet) without doing a full re-render. The column definition will not be synced from the passed ResultSet in this case.
Use this method in case you want to replace the whole data in the grid at once. Please note that All row and range selection will be lost.
#API
Create a GxExpression from string and set it as row span expression
Set the first condition
Select a row by its index
#API
Select a row by its key
#API
Select a vector of rows. The vector can contain a mix of row indices and row keys
#API
Enable / disable showing row counts beside group labels
#Configuration
#ColumnsRenderer
Enable/ disable checkbox selection on groups
#Configuration
#ColumnsRenderer
setSize - set the size of the control
#API
Set a sorting for one or more columns
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Start Cell Editing at the given row and column
#API
Apply the grid's columns , sorbing and filtering state
#API
Set the grid theme
#Configuration
#API
Create a GxExpression from string and set it as tooltip value getter
Set the column type
Set the column type
Set The value to use when when the component needs to return a true value.
Set The value to use when when the component needs to return a true value.
Set The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
Set The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
Set The value to use when when the component needs to return a true value.
Set The value to use when when the component needs to return a true value.
Create a GxExpression from string and set it as value formatter
Create a GxExpression from string and set it as value getter
Create a GxExpression from string and set it as value parser
Create a GxExpression from string and set it as value setter
Set Visible
Enable / Disable the grid sidebar
Ensures the column is visible, scrolling the table if needed.
#API
Ensures the row index is visible by vertically scrolling the grid
Ensures the row index is visible by vertically scrolling the grid. The valid values for positions are {'top', 'middle', 'bottom'}. If top, middle or bottom, the grid will scroll the row to place the row at top, middle or bottom
#API
Set the widget instance
When true, selection box will be show on the first column's header
When false, no checkbox will be displayed.
#Configuration
#GridRenderer
Note The first column can override this settings when it sets the tHeaderCheckboxSelection to true
Note This option will ignore multi row selection option by default so it is always enabled
Show loading overlay
#API
Show 'no rows' overlay
#API
Displays suggestions on focus of the input element.
Note that if true, the MinLength option will be ignored and it will
always call the resolver.
When true, A selection box will be shown on the first column
When false, no checkbox will be displayed.
#Configuration
#GridRenderer
Note The first column can override this settings when it sets the CheckboxSelection to true
The grid sidebar
Set to true to enable Single Click Editing for cells, to start editing with a single click.
#Configuration
#GridRenderer
Set this to true to skip the headerName when autoSize is called by default
#Configuration
#GridRenderer
Set to 'asc' or 'desc' to sort by this column by default.
#Configuration
#ColumnsRenderer
Get sort direction constant
Get sort direction constant
Set to true to allow sorting on this column.
#Configuration
#ColumnsRenderer
Sort the given column with the given direction
#API
Start row id or index
Navigates the grid focus to the next cell, as if tabbing.
#API
Navigates the grid focus to the previous cell, as if shift-tabbing.
#API
The grid statusbar
The increment / decrement step
Stop editing and accepts changes
#API
Stop Editing
#API
Set this to true to stop cell editing when grid loses focus. The default is the grid stays editing until focus goes onto another cell. For inline (non-popup) editors only.
#Configuration
#GridRenderer
if this menu is a submenu, contains a list of submenu item definitions
A suffix to append to the value after it is formatted
A suffix to append to the value after it is formatted
An HTML template to be used for rendering the suggestion groups
ex:
template! = "<%= groupName %>" editor!.setSuggestionItemTemplate(template!)
An HTML template to be used for rendering the suggestion items
ex:
template! = "<%= item.label %> - <%= item.value %> - <%= item.group %>" editor!.setSuggestionItemTemplate(template!)
Check if the filter supported the combined model
When true, the aggregations won't be computed for root node of the grid
#Configuration
#GridRenderer
When true, column headers won't include the aggFunc, eg 'sum(Bank Balance)' will just be 'Bank Balance'.
#Configuration
#GridRenderer
If true, the filter will only offer Condition 1.
If true, the filter will only offer Condition 1.
When true, the grid will not use animation frames when drawing rows while scrolling.
Use this if the grid is working fast enough that you don't need animations frame and you don't want the grid to flicker.
#Configuration
#GridRenderer
Suppresses auto-sizing columns for columns. In other words, double-clicking a column header's edge will not auto-size.Default is false
#Configuration
#GridRenderer
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI context
By default this options is set to "0"
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI context
By default this options is set to "0"
If true, cells won't be selectable. This means cells will not get keyboard focus when you click on them. Default: false
Normally when a chart is displayed using the grid, the grid will highlight the range the chart is charting when the chart gets focus, to suppress this behaviour, set the field to false
Set to true so that neither single or double-click starts editing.
#Configuration
#GridRenderer
suppress Expand / Collapse all widget.
suppress Column Filter section.
Suppress Column Move section
If true, the ag-column-moving class is not added to the grid while columns are moving. In the default themes, this transpires to no animation for moving columns.
#Configuration
#GridRenderer
suppress Select / Un-select all widget.
Set to true so that the grid doesn't virtualize the columns. S o if you have 100 columns, but only 10 visible due to scrolling, all 100 will always be rendered.
#Configuration
#GridRenderer
When true , the logger will not output messages in the console
Set to true to not show context menu. Use if you don't want to use the default 'right click' context menu.
#Configuration
#GridRenderer
When true show row counts, hide otherwise
Suppress scripts debouncing for GUI and BUI
When true , the logger will not output messages in debug file
When true disable double-click for expand, enable otherwise
If true, when you drag a column out of the grid (eg to the group zone) the column is not hidden.
#Configuration
#GridRenderer
To suppress Expand / Collapse All
To suppress the Filter Search
Set to true if you do not want this column (filter) or group (filter group) to appear in the Filters Tool Panel.
#Configuration
#ColumnsRenderer
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in GUI context
By default this options is set to "1"
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in GUI context
By default this options is set to "1"
Set to true to never show the horizontal scroll.
#Configuration
#GridRenderer
Disables the 'loading' overlay.
#Configuration
#GridRenderer
Set to true to suppress sorting of un-sorted data to match original row data
#Configuration
#GridRenderer
By default when a column is un-grouped, it is made visible.
This property stops the column becoming visible again when un-grouping.
#Configuration
#GridRenderer
Set to true if no menu should be shown for this column header.
#Configuration
#ColumnsRenderer
Set to true to always show the column menu button, rather than only showing when the mouse is over the column header.
#Configuration
#GridRenderer
If true, then middle clicks will result in 'click' events for cell and row. Otherwise the browser will use middle click to scroll the grid.
#Configuration
#GridRenderer
Set to true to hide the mini filter.
Set to true if you do not want this column to be movable via dragging.
#Configuration
#ColumnsRenderer
Set to true to suppress column moving. In other words, set to true to make the columns fixed position.
#Configuration
#GridRenderer
Enable / disable one range selection even if ctrl key is held down
#Enterprise
#Configuration
Set to true to suppress multi-sort when the user shift-clicks a column header.
#Configuration
#GridRenderer
Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.
#Configuration
#ColumnsRenderer
Disables the 'no rows' overlay.
#Configuration
#GridRenderer
suppress Pivot Mode section.
suppress Column Labels (Pivot) section.
Set to true to stop the filter from removing values that are no longer available (like what Excel does).
since version 1.7.0. This option has been deprecated with no replacement.
If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer
If true, rows will not be deselected if you hold down Ctrl and click the row or press Space.
#Configuration
#GridRenderer
Suppress Row Groups section.
Set to true to not highlight rows by adding the ag-row-hover CSS class.
#Configuration
#GridRenderer
Uses CSS top instead of CSS transform for positioning rows.
Useful if the transform function is causing issues such as used in row spanning. Default: false
#Configuration
#GridRenderer
When true, the grid will not scroll to the top when new row data is provided.
Use this if you don't want the default behaviour of scrolling to the top every time you load new data.
#Configuration
#GridRenderer
Set to true to remove the "select all" checkbox.
Set to true to suppress column events being raised when state is changed throw the API methods
#Configuration
#GridRenderer
Set to true if you want this columns width to be fixed during 'size to fit' operation.
#Configuration
#ColumnsRenderer
If true, sorting will not be done on the set filter values. Use this if providing your own values and don't want them sorted as you are providing in the order you want.
When true , then the suggestion will not be triggered for invalid inputs
Suppress updating the layout of columns as they are rearranged in the grid
Suppress updating the layout of columns as they are rearranged in the grid
Set to true to have the values inside the set filter NOT refresh after values are changed inside the grid.
Set to true if you do not want this column or group to appear in the tool panel.
#Configuration
#ColumnsRenderer
Disables touch support (but does not remove the browsers efforts to simulate mouse events on touch).
#Configuration
#GridRenderer
suppress Values section
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI & DWC context
By default this options is set to "0"
When true then the executor will limit the rate at which executeScript gets invoked on the HTMLView.
Setting this to "0" will help to boost up the communication performance between BBj and the grid which lives inside the HTMLView in BUI & DWC context
By default this options is set to "0"
A special html string which uses the switch button to render true/false values
Navigates the grid focus to the next cell, as if tabbing.
#API
Navigates the grid focus to the previous cell, as if shift-tabbing.
#API
String template which will be compiled in the client.
<%= '' + (params.valueFormatted || params.value) + '' %>
The search term
Set the grid theme
#Configuration
#API
The date / timezone timezone to use.
The input title , when null and the textMask options is defined , then we use the mask as title , when set to default we the browser's default title , other wise the value defined in this option
The input title , when set to null() or "default" then we use the browser's default title , other wise the value defined in this option
CSS class(es) to use for the tool panel cell.
#Configuration
#ColumnsRenderer
A map for the registered toolpanels
Optional tooltip for the menu item
The field of the tooltip to apply to the cell.
#Configuration
#ColumnsRenderer
The delay in milliseconds that it takes for tooltips to show up once an element is hovered.
Note: This property does not work if enableBrowserTooltips is true.
#Configuration
#GridRenderer
A Grid expression which can be executed to return the tooltip value to display for each cell.
#Configuration
#ColumnsRenderer.
Convert row to string
Convert column to string
Convert the menu to a JSON string
Convert the item to String
Convert the item to String
Get the expression as string
Convert the statusbar into a parsable json string
Enable / Disable Tree Data mode
#Enterprise
#Configuration
#GridRenderer
True value translation
The value to use when when the component needs to render true values. in case it is null() then we use the first item in PossibleTrueValues!
The type of chart to create
One of the filter options
The Field Type.
#Configuration
#ColumnsRenderer
Note : Not all sql types are supported, for example it does not make sense to declare a colum type as STRUCT.
Constant value to define area chart
Constant value to define doughnut chart
Constant value to define groupedBar chart
Constant value to define groupedColumn chart
Constant value to define line chart
Constant value to define normalizedArea chart
Constant value to define normalizedBar chart
Constant value to define normalizedColumn chart
Constant value to define pie chart
Constant value to define stackedArea chart
Constant value to define stackedBar chart
Constant value to define stackedColumn chart
Unselects a value
#API
Unselects a value
#API
Set to true if you want the unsorted icon to be shown when no sort is applied to this column.
#Configuration
#ColumnsRenderer
Set to true to show the 'no sort' icon.
#Configuration
#GridRenderer
Update a row
Update the filter on the client and execute it.
Update the filter on the client and execute it.
Update the column definition from a meta map
An array of rows to update
Re-render the column definitions on the client.
#API
The method will collect the new changes in columns and column groups and force the client to reflect the change.
Force the context object update
Feed the grid with a new ResultSet
Unlike the setData method, this one will update the grid with a new rows set(ResultSet) without doing a full re-render. The column definition will not be synced from the passed ResultSet in this case.
Use this method in case you want to replace the whole data in the grid at once. Please note that All row and range selection will be lost.
#API
The method will merge the row data coming from the client with the current DataRow.
Update row data
#API
Update row data
#API
When true , then the user will be able to sort by multiple columns by holding down the ctrl
key (or Command key on Apple) while clicking the column header. By default this action is possible using the shift key.
The value to use when when the component needs to return a false value. in case it is null() then we use the first item in PossibleFalseValues!
The value to use when when the component needs to return a false value.
The value to use when when the component needs to return a false value.
The value to use when when the component needs to render false values. in case it is null() then we use the first item in PossibleFalseValues!
The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
The value to use when when the component needs to return a none/empty/null value. in case it is null() , then the none option will be hidden from the rendered list
The value to use when when the component needs to return a true value. in case it is null() then we use the first item in PossibleTrueValues!
The value to use when when the component needs to return a true value.
The value to use when when the component needs to return a true value.
The value to use when when the component needs to render true values. in case it is null() then we use the first item in PossibleTrueValues!
If set to true then the grid will use the provided cell formatter if one is provided.
The cell's value
An Ag Grid expression which can be executed to format the value for display.
#Configuration
#ColumnsRenderer.
An Ag Grid expression which can be executed before getting the value from your data for display
#Configuration
#ColumnsRenderer.
An Ag Grid expression which can be executed to parse the value for saving.
#Configuration
#ColumnsRenderer.
An array of values to allow the user to select from
The values to display in the filter. If this is not set, then the filter will takes its values from what is loaded in the table. Setting it allows you to set values where the value may not be present in the list for example, if you want to show all states in America so that the user is not confused by missing states, even though states are missing from the data set in the grid
The values to display in the filter. If this is not set, then the filter will takes its values from what is loaded in the table. Setting it allows you to set values where the value may not be present in the list (for example, if you want to show all states in America so that the user is not confused by missing states, even though states are missing from the data set in the grid)
An Ag Grid expression which can be executed before setting the value into your data for saving.
#Configuration
#ColumnsRenderer.
Output a warning message on the console and Debug.log file
Output a warning message on the console and Debug.log file
Constant value to define "warning" log messages
BBjGridExWidget instance
BBjGridExWidget instance
The widget instance
Setup the suggestion list width in pixels
Initial width in pixels
#Configuration
#ColumnsRenderer
Note: setting the width to zero will not hide the column, use setHidden() instead. And if the width is null()
this means the grid will auto set the width for this column
The image's width