TablePanel¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A visualization Panel of type Table (static or realtime)
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| TablePanel | addColumn(column id, column type) | Boolean | Creates a transient column with the given column id. Acceptable types are text, numeric, progress, time, date, price, percent, html, json, image, checkbox, Masked, spark, time_sec,time_millis, time_micros, time_nanos, datetime, datetime_sec, datetime_millis, datetime_micros, datetime_nanos |
| Panel | addPanelNextToMe(position, configuration) | DividerPanel | Adds a new panel adjacent to this panel by creating a divider portlet. The divider portlet is returned. This Panel's Parent must be transient. |
| TablePanel | asFormattedTable() | Table | Copies and returns the values of this panel as a table. |
| TablePanel | asFormattedTable(selectedRows, unselectedRows, filteredRows, visibleColumns, hiddenColumns) | Table | Copies and returns the values of this panel as a table, with cells formatted. |
| TablePanel | asFormattedTable(selectedRows, unselectedRows, filteredRows, visibleColumns, hiddenColumns, columns) | Table | Copies and returns the values of this panel as a table, with cells formatted. |
| TablePanel | asTable() | Table | Copies and returns the values of this panel as a table. |
| TablePanel | asTable(options, columns) | Table | Copies and returns the values of this panel as a table given the options and a list of columns to include. |
| TablePanel | asTable(selectedRows, unselectedRows, filteredRows, visibleColumns, hiddenColumns) | Table | Copies and returns the values of this panel as a table, with the options to predefine which rows to be selected/unselected/visible/hidden. |
| TablePanel | asTable(selectedRows, unselectedRows, filteredRows, visibleColumns, hiddenColumns, columns) | Table | Copies and returns the values of this panel as a table, with the options to predefine which rows to be selected/unselected/visible/hidden and define columns to include. |
| TablePanel | autosizeAllColumns() | Boolean | Autosizes all visible columns. Returns true if operation is successful, false otherwise. |
| Panel | bringToFront() | Object | Makes this panel visible and bring its containing window to the front. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns commandUid (String) on success, otherwise null. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns the commandUid (String) for this command call or null on failure. |
| TablePanel | callCommandOnSelected(applicationId, cmdId) | Boolean | Calls the given command on the currently user-selected rows. |
| Panel | callRelationship(relationshipName) | Boolean | Reruns the relationship targeting this panel based on name. Returns true on success. |
| Panel | callRelationshipId(relationshipId) | Boolean | Reruns the relationship targeting this panel based on id. Returns true on success. |
| TablePanel | cancelEdit() | Boolean | Cancels table edit. |
| TablePanel | clearFilters() | Boolean | Clears all filters in this table. Returns true on success, false otherwise. |
| TablePanel | clearRows() | Boolean | Clears all rows in this table. Returns true on success, false otherwise. |
| Panel | clearUserSelection() | Object | Clears the user's selection. |
| Panel | close() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient. |
| Panel | deletePanel() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient |
| TablePanel | ensureRowVisible(rowNumber, alignment) | Boolean | Snaps the table panel to the row number in the indicated snap alignment. |
| Panel | exportConfig() | Map | Exports this panel's configuration to a map. |
| Panel | exportConfig(includeRelationships, includeDatamodels) | Map | Exports this panel's configuration to a map, with the options to include external relationships and external datamodels. |
| Panel | exportConfigIncludeExternalRelationships() | Map | Exports this panels configuration with external relationships |
| Panel | exportUserPreferences() | Map | Exports this panel's user preferences to a map. |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| TablePanel | getColumn(columnName) | TablePanelColumn | Returns the column with the given column name. |
| TablePanel | getColumnById(Id) | TablePanelColumn | Returns the column given its column id. |
| TablePanel | getColumnFilter(columnName) | TablePanelColumnFilter | Returns the filter for a given column, or null if the column is not filtered or missing. |
| TablePanel | getColumnLocation(columnName) | Integer | Returns the zero-indexed left based position of the column, -1 if hidden, -2 if it doesn't exist. |
| TablePanel | getColumnSorting(columnName) | String | Returns the sort, returns true=ascending, false=descending, null=no sort or column not found. |
| TablePanel | getColumnsFilter() | List | Return a list of the names of the columns that have filters. |
| TablePanel | getColumnsWithSort() | List | Return a list of the names of the columns that have sorts. |
| Panel | getCurrentRelationship() | Relationship | Returns the Relationship object currently applied to this panel. |
| TablePanel | getCurrentWhere() | String | Returns the currently applied filter. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| Panel | getDatamodels() | Object | Returns a set of datamodels that were used in this panel. |
| TablePanel | getDefaultWhere() | String | Returns the currently applied filter. |
| TablePanel | getDownloadName() | String | Returns the name of files for download (null indicates title will be used instead). |
| Panel | getDownstreamMode() | String | Returns status of send data downstream to realtime panels. The statuses are OFF or SELECTED_OR_ALL. |
| TablePanel | getFilter(columnName) | List | Returns a list of the string values that are in a filter for a given column, or null if the column is not filtered or missing. |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| TablePanel | getHiddenColumns() | List | Return a list of the names of the columns that are hidden. |
| Panel | getId() | String | Returns this panel's ID (as defined in settings). |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| Panel | getLayout() | Layout | Returns layout that owns this panel. |
| Panel | getLocation() | Rectangle | Returns a Rectangle object that stores the location of this panel relative to the upper left corner of the browser, not including the 3Forge header. |
| Panel | getMenu() | MenuItem | Returns this panel's root custom context menu. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| Panel | getParent() | Panel | Returns the parent panel of this panel. |
| TablePanel | getSearch() | String | Returns the value inside the search box of the table (null if empty). |
| TablePanel | getSelectedRows() | List | Deprecated, use asTable("SELECTED",....) instead. Returns a list of the rows of this panel selected by the user. |
| TablePanel | getSelectedValues(columnNames) | Table | Deprecated, use asTable("SELECTED",....) instead. Returns a table whose rows are those that are selected, columns are those that are specified in the argument. |
| Panel | getStyle(styleKey) | String | Returns the value for a particular style given the style code, which can be obtained by clicking on the style name. Returns Null if key not found. |
| Panel | getStyle(styleKey, index) | String | Returns the value for a particular style given the style code at the specified position. The style code can be obtained by clicking on the style name. Returns Null if key not found, returns the first value in the list if position is out of bound. |
| Panel | getStyleNumber(styleKey) | Number | Returns the numeric value associated with the supplied style key in this portlets style. Null if key not found, or value is not a number. Ex: using this method for text align will return null as its values are not numeric. |
| Panel | getStyleSet() | StyleSet | Returns the StyleSet for this panel. |
| TablePanel | getTitle() | String | Returns the name of the table panel. |
| Panel | getType() | String | Returns the type of this panel, either: html, div_v, div_h, tabs, or one of the AMI visualization types. |
| Panel | getUid() | String | Returns this panel's ami-generated ID. |
| Panel | getValue(key) | Object | Returns the value associated with key from this portlet's attributes. Returns null if key does not exist. |
| TablePanel | getVisibleColumns() | List | Return a list of the names of the columns that are visible, from left to right. |
| TablePanel | getVisibleRowsCount() | Integer | Returns the number of visible rows. |
| Panel | getWindow() | Window | Returns the window that owns this panel. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| TablePanel | isEditing() | Boolean | Returns if table is in edit mode. |
| Panel | isPoppedOut() | Boolean | Returns true if this panel is popped out. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| Panel | isUndocked() | Boolean | Returns true if this panel is undocked. |
| TablePanel | isValidWhereClause(whereClause) | Boolean | Checks if the WHERE clause will successfully apply on this panel. Returns true if successful, false otherwise. |
| Panel | isVisible() | Boolean | Returns true if this panel is visible. |
| TablePanel | meetsWhereClause(row) | Boolean | Returns true if the row satisfies the WHERE clause defined by this panel, false otherwise. |
| Panel | minimize() | Object | Minimizes the window, same as calling getWindow().minimize(). |
| TablePanel | moveColumnsTo(pos, columnNames) | Object | Moves a list of columns to a particular position in the table, or hide them. |
| TablePanel | removeColumn(column id) | Boolean | Removes a transient column with the given column id |
| TablePanel | resetColumns() | Boolean | Resets all columns to their default locations. |
| TablePanel | resetWhere() | Boolean | Resets the current WHERE filter to the default. |
| TablePanel | selectRows(shouldSelect) | Boolean | Selects or deselects all rows. Returns true on success, false otherwise. |
| TablePanel | selectRowsRange(selection) | Boolean | Overrides the currently selected rows with the supplied range of rows. If there is no currently selected rows, this method simply sets selected rows. Otherwise this will de-selected any previously selected rows then sets selected rows. |
| TablePanel | setCurrentWhere(booleanExpression) | Boolean | Applies a filter on the underlying data for this table panel. If the filter is null or an empty string then no filter is applied and all data is shown. Returns true on success, false otherwise. |
| TablePanel | setDefaultWhere(booleanExpression) | Boolean | Sets the default WHERE filter that will be applied on login. Returns true on success, false otherwise. |
| TablePanel | setDownloadName(name) | Boolean | Sets the file name of downloaded files (do not include extension) to the given string. If null, then the return value from getTitle() is used (see getTitle) |
| Panel | setDownstreamMode(mode) | String | Sets and returns the mode for sending data downstream to realtime panels. The modes are OFF or SELECTED_OR_ALL. |
| TablePanel | setFilter(columnName, values) | Boolean | DEPRECATED... use the setFilter() under TablePanelColumn. Sets or clears the filter. Clears the filter if you only pass in the column name. Sets the filter if you also pass in values. Returns true on success, false if the column not found. |
| TablePanel | setFilter(columnName, isKeep, isPattern, values) | Boolean | DEPRECATED... use the setFilter() under TablePanelColumn. Sets or clears a filter using the supplied column name and filter values. If value is empty the filter is cleared. Returns true on success, false if the column not found. |
| TablePanel | setHiddenColumns(columnName) | Object | Specifies a particular list of columns to be hidden. |
| TablePanel | setSearch(searchValue) | Boolean | Sets the value of the search box of the table. Empty or null value clears out the search. |
| TablePanel | setTitle(title) | Boolean | Sets the title of the table with the given string. |
| Panel | setValue(key, value) | Boolean | Adds the key value pair to this portlet's attributes and return true if successful. |
| TablePanel | setVisibleColumns(columnName) | Object | Specifies a particular list of columns to be visible. |
| TablePanel | sort(keepSorting, AorD, ColumnNames) | Boolean | Sets the sort. |
| TablePanel | startEdit(rows) | Boolean | Starts the editing of the table panel if not in edit mode already. Aborts editing if onBeforeEdit callback returns false. |
| TablePanel | swapVisibleColumn(visible, hidden) | Object | Replaces a visible column with a currently hidden one, effectively hiding the currently visible one. Returns true if the column arrangement changed as a result, false otherwise. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
addColumn(column id,column type)¶
Boolean TablePanel::addColumn(String column id, String column type)
Description¶
Creates a transient column with the given column id. Acceptable types are text, numeric, progress, time, date, price, percent, html, json, image, checkbox, Masked, spark, time_sec,time_millis, time_micros, time_nanos, datetime, datetime_sec, datetime_millis, datetime_micros, datetime_nanos
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| column id | String | Column ID |
| column type | String | type of column |
asFormattedTable()¶
Table TablePanel::asFormattedTable()
Description¶
Copies and returns the values of this panel as a table.
asFormattedTable(selectedRows,unselectedRows,filteredRows,visibleColumns,hiddenColumns)¶
Table TablePanel::asFormattedTable(Boolean selectedRows, Boolean unselectedRows, Boolean filteredRows, Boolean visibleColumns, Boolean hiddenColumns)
Description¶
Copies and returns the values of this panel as a table, with cells formatted.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| selectedRows | Boolean | Include selected Rows |
| unselectedRows | Boolean | include unselected Rows |
| filteredRows | Boolean | include filtered Rows |
| visibleColumns | Boolean | include Visible Columns |
| hiddenColumns | Boolean | Include Hidden Columns |
asFormattedTable(selectedRows,unselectedRows,filteredRows,visibleColumns,hiddenColumns,columns)¶
Table TablePanel::asFormattedTable(Boolean selectedRows, Boolean unselectedRows, Boolean filteredRows, Boolean visibleColumns, Boolean hiddenColumns, Set columns)
Description¶
Copies and returns the values of this panel as a table, with cells formatted.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| selectedRows | Boolean | Include selected Rows |
| unselectedRows | Boolean | include unselected Rows |
| filteredRows | Boolean | include filtered Rows |
| visibleColumns | Boolean | include Visible Columns |
| hiddenColumns | Boolean | Include Hidden Columns |
| columns | Set | Set of column names to include |
asTable()¶
Table TablePanel::asTable()
Description¶
Copies and returns the values of this panel as a table.
asTable(options,columns)¶
Table TablePanel::asTable(String options, Set columns)
Description¶
Copies and returns the values of this panel as a table given the options and a list of columns to include.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| options | String | A comma delimited combination of: SELECTED,UNSELECTED,FILTERED,VISIBLE,HIDDEN,FORMAT |
| columns | Set | Set of column names to include, if null all columns are included |
asTable(selectedRows,unselectedRows,filteredRows,visibleColumns,hiddenColumns)¶
Table TablePanel::asTable(Boolean selectedRows, Boolean unselectedRows, Boolean filteredRows, Boolean visibleColumns, Boolean hiddenColumns)
Description¶
Copies and returns the values of this panel as a table, with the options to predefine which rows to be selected/unselected/visible/hidden.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| selectedRows | Boolean | include selected Rows |
| unselectedRows | Boolean | include unselected Rows |
| filteredRows | Boolean | include filtered Rows |
| visibleColumns | Boolean | include Visible Columns |
| hiddenColumns | Boolean | include Hidden Columns |
asTable(selectedRows,unselectedRows,filteredRows,visibleColumns,hiddenColumns,columns)¶
Table TablePanel::asTable(Boolean selectedRows, Boolean unselectedRows, Boolean filteredRows, Boolean visibleColumns, Boolean hiddenColumns, Set columns)
Description¶
Copies and returns the values of this panel as a table, with the options to predefine which rows to be selected/unselected/visible/hidden and define columns to include.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| selectedRows | Boolean | Include selected Rows |
| unselectedRows | Boolean | include unselected Rows |
| filteredRows | Boolean | include filtered Rows |
| visibleColumns | Boolean | include Visible Columns |
| hiddenColumns | Boolean | Include Hidden Columns |
| columns | Set | Set of column names to include |
autosizeAllColumns()¶
Boolean TablePanel::autosizeAllColumns()
Description¶
Autosizes all visible columns. Returns true if operation is successful, false otherwise.
callCommandOnSelected(applicationId,cmdId)¶
Boolean TablePanel::callCommandOnSelected(String applicationId, String cmdId)
Description¶
Calls the given command on the currently user-selected rows.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| applicationId | String | |
| cmdId | String |
cancelEdit()¶
Boolean TablePanel::cancelEdit()
Description¶
Cancels table edit.
clearFilters()¶
Boolean TablePanel::clearFilters()
Description¶
Clears all filters in this table. Returns true on success, false otherwise.
clearRows()¶
Boolean TablePanel::clearRows()
Description¶
Clears all rows in this table. Returns true on success, false otherwise.
ensureRowVisible(rowNumber,alignment)¶
Boolean TablePanel::ensureRowVisible(Integer rowNumber, String alignment)
Description¶
Snaps the table panel to the row number in the indicated snap alignment.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| rowNumber | Integer | Row number to snap to |
| alignment | String | Alignment of snap = "TOP" OR "BOTTOM" |
getColumn(columnName)¶
TablePanelColumn TablePanel::getColumn(String columnName)
Description¶
Returns the column with the given column name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | String | Name of the column. |
getColumnById(Id)¶
TablePanelColumn TablePanel::getColumnById(String Id)
Description¶
Returns the column given its column id.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| Id | String | The column id |
getColumnFilter(columnName)¶
TablePanelColumnFilter TablePanel::getColumnFilter(String columnName)
Description¶
Returns the filter for a given column, or null if the column is not filtered or missing.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | String |
getColumnLocation(columnName)¶
Integer TablePanel::getColumnLocation(String columnName)
Description¶
Returns the zero-indexed left based position of the column, -1 if hidden, -2 if it doesn't exist.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | String |
getColumnSorting(columnName)¶
String TablePanel::getColumnSorting(String ... columnName)
Description¶
Returns the sort, returns true=ascending, false=descending, null=no sort or column not found.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | String ... |
getColumnsFilter()¶
List TablePanel::getColumnsFilter()
Description¶
Return a list of the names of the columns that have filters.
getColumnsWithSort()¶
List TablePanel::getColumnsWithSort()
Description¶
Return a list of the names of the columns that have sorts.
getCurrentWhere()¶
String TablePanel::getCurrentWhere()
Description¶
Returns the currently applied filter.
getDefaultWhere()¶
String TablePanel::getDefaultWhere()
Description¶
Returns the currently applied filter.
getDownloadName()¶
String TablePanel::getDownloadName()
Description¶
Returns the name of files for download (null indicates title will be used instead).
getFilter(columnName)¶
List TablePanel::getFilter(String columnName)
Description¶
Returns a list of the string values that are in a filter for a given column, or null if the column is not filtered or missing.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | String |
getHiddenColumns()¶
List TablePanel::getHiddenColumns()
Description¶
Return a list of the names of the columns that are hidden.
getSearch()¶
String TablePanel::getSearch()
Description¶
Returns the value inside the search box of the table (null if empty).
getSelectedRows()¶
List TablePanel::getSelectedRows()
Description¶
Deprecated, use asTable("SELECTED",....) instead. Returns a list of the rows of this panel selected by the user.
getSelectedValues(columnNames)¶
Table TablePanel::getSelectedValues(String ... columnNames)
Description¶
Deprecated, use asTable("SELECTED",....) instead. Returns a table whose rows are those that are selected, columns are those that are specified in the argument.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnNames | String ... | names of the columns to include values for |
getTitle()¶
String TablePanel::getTitle()
Description¶
Returns the name of the table panel.
getVisibleColumns()¶
List TablePanel::getVisibleColumns()
Description¶
Return a list of the names of the columns that are visible, from left to right.
getVisibleRowsCount()¶
Integer TablePanel::getVisibleRowsCount()
Description¶
Returns the number of visible rows.
isEditing()¶
Boolean TablePanel::isEditing()
Description¶
Returns if table is in edit mode.
isValidWhereClause(whereClause)¶
Boolean TablePanel::isValidWhereClause(String whereClause)
Description¶
Checks if the WHERE clause will successfully apply on this panel. Returns true if successful, false otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| whereClause | String | WHERE clause to be compiled agains this panel. |
meetsWhereClause(row)¶
Boolean TablePanel::meetsWhereClause(Map row)
Description¶
Returns true if the row satisfies the WHERE clause defined by this panel, false otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| row | Map | An object of type Map. |
moveColumnsTo(pos,columnNames)¶
Object TablePanel::moveColumnsTo(Integer pos, String ... columnNames)
Description¶
Moves a list of columns to a particular position in the table, or hide them.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| pos | Integer | zero-indexed left offset Position of the first column, or -1 to hide all columns |
| columnNames | String ... | name of the columns to move, from left to right |
removeColumn(column id)¶
Boolean TablePanel::removeColumn(String column id)
Description¶
Removes a transient column with the given column id
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| column id | String |
resetColumns()¶
Boolean TablePanel::resetColumns()
Description¶
Resets all columns to their default locations.
resetWhere()¶
Boolean TablePanel::resetWhere()
Description¶
Resets the current WHERE filter to the default.
selectRows(shouldSelect)¶
Boolean TablePanel::selectRows(Boolean shouldSelect)
Description¶
Selects or deselects all rows. Returns true on success, false otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| shouldSelect | Boolean | If true selects all otherwise deselects all |
selectRowsRange(selection)¶
Boolean TablePanel::selectRowsRange(String selection)
Description¶
Overrides the currently selected rows with the supplied range of rows. If there is no currently selected rows, this method simply sets selected rows. Otherwise this will de-selected any previously selected rows then sets selected rows.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| selection | String | Comma delimited row indeces OR a range (selectRows(\"0,1,3,5\") OR selectRows(\"5-10\")). |
setCurrentWhere(booleanExpression)¶
Boolean TablePanel::setCurrentWhere(String booleanExpression)
Description¶
Applies a filter on the underlying data for this table panel. If the filter is null or an empty string then no filter is applied and all data is shown. Returns true on success, false otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| booleanExpression | String | An expression to filter incoming data on, evaluating to true indicates the data is displayed, false means filtered out |
setDefaultWhere(booleanExpression)¶
Boolean TablePanel::setDefaultWhere(String booleanExpression)
Description¶
Sets the default WHERE filter that will be applied on login. Returns true on success, false otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| booleanExpression | String | An expression to filter incoming data on, evaluating to true indicates the data is displayed, false means filtered out |
setDownloadName(name)¶
Boolean TablePanel::setDownloadName(String name)
Description¶
Sets the file name of downloaded files (do not include extension) to the given string. If null, then the return value from getTitle() is used (see getTitle)
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| name | String |
setFilter(columnName,values)¶
Boolean TablePanel::setFilter(String columnName, String ... values)
Description¶
DEPRECATED... use the setFilter() under TablePanelColumn. Sets or clears the filter. Clears the filter if you only pass in the column name. Sets the filter if you also pass in values. Returns true on success, false if the column not found.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | String | name of the column to set a filter for |
| values | String ... | values to filter in |
setFilter(columnName,isKeep,isPattern,values)¶
Boolean TablePanel::setFilter(String columnName, Boolean isKeep, Boolean isPattern, List values)
Description¶
DEPRECATED... use the setFilter() under TablePanelColumn. Sets or clears a filter using the supplied column name and filter values. If value is empty the filter is cleared. Returns true on success, false if the column not found.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | String | name of the column to set a filter for |
| isKeep | Boolean | true=keep those that match,false=hide those that match |
| isPattern | Boolean | values are patterns |
| values | List | values to filter in |
setHiddenColumns(columnName)¶
Object TablePanel::setHiddenColumns(List columnName)
Description¶
Specifies a particular list of columns to be hidden.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | List | A list containing the name of the columns. |
setSearch(searchValue)¶
Boolean TablePanel::setSearch(String searchValue)
Description¶
Sets the value of the search box of the table. Empty or null value clears out the search.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| searchValue | String | The value to set in the search box of the table. |
setTitle(title)¶
Boolean TablePanel::setTitle(String title)
Description¶
Sets the title of the table with the given string.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| title | String |
setVisibleColumns(columnName)¶
Object TablePanel::setVisibleColumns(List columnName)
Description¶
Specifies a particular list of columns to be visible.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnName | List | A list containing the name of the columns. |
sort(keepSorting,AorD,ColumnNames)¶
Boolean TablePanel::sort(Boolean keepSorting, String AorD, String ... ColumnNames)
Description¶
Sets the sort.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| keepSorting | Boolean | |
| AorD | String | |
| ColumnNames | String ... |
startEdit(rows)¶
Boolean TablePanel::startEdit(Collection rows)
Description¶
Starts the editing of the table panel if not in edit mode already. Aborts editing if onBeforeEdit callback returns false.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| rows | Collection | List of row numbers, 0 indexed |
swapVisibleColumn(visible,hidden)¶
Object TablePanel::swapVisibleColumn(String visible, String hidden)
Description¶
Replaces a visible column with a currently hidden one, effectively hiding the currently visible one. Returns true if the column arrangement changed as a result, false otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| visible | String | visible column to hide |
| hidden | String | hidden column to show |