grid.xtable
Hierarchy
coregrid.xtableRequires
Files
Config options
Sets the buffer type of a table.
Defaults to: 'scroll'/'page'/'s-page'/'vscroll'
Sets the number of rows per page.
Defaults to: 100
Sets a column index shown when the Show/Hide Column menu is enabled.
Defaults to: false
Sets the column key shown when converted to a CSV string.
Defaults to: null
Sets the maximum number of rows when creating a CSV string.
Defaults to: 10000
Sets the name of a column shown when converting to a CSV string, which must be defined in the same order as the CSV option.
Defaults to: null
Sets the column key to be changed to a number form when converted to a CSV string.
Defaults to: null
Sets the initial row list of a table.
Defaults to: []
Defines a DOM event to be used in a UI
Defaults to: {}
Determines whether to use an extended row area.
Defaults to: false
Shows the extended area automatically when clicking on a row.
Defaults to: true
Sets the name of columns in the order of being displayed on the table screen.
Defaults to: null
Determines whether to use the table sort function.
Defaults to: false
Determines whether to use the column resizing function.
Defaults to: false
Sets the reference height of a body area when using a table scroll.
Defaults to: 26
Sets the initial row list of a table (@Deprecated).
Sets the initial row list of a table (@Deprecated).
Sets the reference height of a body area when using a table scroll.
Defaults to: 200
Sets the reference width of a body area when using a table scroll.
Defaults to: 0
Determines whether to use the table sort function.
Defaults to: false
Configures settings to ensure that the sort state can be maintained even when the table is updated.
Defaults to: false
Determines whether to use the sort function when you click on a column.
Defaults to: true
Determines whether to use the table sort function.
Defaults to: null
Determines whether to show the loading screen when sorting a table.
Defaults to: false
Determines whether to use the table sort function.
Defaults to: "asc"
Defines a template markup to be used in a UI
Defaults to: {}
Activate the xss filter to set the column value.
Defaults to: false
Methods
Gets the index of a row that is activated in an extended/modified/selected state.
Returns
- Integer
index
Check the parameter type of a UI method and generates an alarm when a wrong value is entered
Parameters
- name : String
Method name
- params : Array
Parameters
Add a row or a child row to at a specified index.
Parameters
- row : RowObject
- row : RowObject
Sets a callback function that is called after a UI method is run
Parameters
- name : String
Method name
- callback : Function
Returns
- Mixed
Sets a callback function that is called before a UI method is run
Parameters
- name : String
Method name
- callback : Function
Returns
- Mixed
Sets a callback function and the delay time before/after a UI method is run
Parameters
- name : String
Method name
- callback : Function
Gets the number of trows of a table.
Returns
- Integer
count
Removes all events set in a UI obejct and the DOM element
Downloads the data of a table as a CSV file.
Parameters
- name : String
- isTree : Boolean
Generates a custom event. The first parameter is the type of a custom event. A function defined as an option or on method is called
Parameters
- type : String
Event type
- args : Function
Event Arguments
Returns
- Mixed
Filters columns at a specified to locate rows that contain keywords in the cell value.
Parameters
- callback : Function
Hides a child row of a specified index.
Parameters
- index : Integer
Gets the row at the specified index.
Parameters
- index : Integer|String
Returns
- RowObject
row
Gets all rows of at the specified index including child rows.
Parameters
- index : Integer
Returns
- Array
rows
Gets the column at the specified index.
Parameters
- key : "Integer"/"String"
index or column key
Returns
- ColumnObject
column
Gets the data of a table as a CSV string.
Parameters
- isTree : Boolean
Returns
- String
csv
Gets the data of a table as a CSV string encoded as base64.
Parameters
- isTree : Boolean
Returns
- String
base64
Gets the data at the specified index.
Parameters
- key : "Integer"/"String"
index
Returns
- ColumnObject
data
Get a row in which the extended area is currently activated.
Returns
- RowObject
row
Gets the current page of a table.
Returns
- Integer
page
This method has been deprecated
Sets the scroll based on the height of a table.
Parameters
- height : Integer
Hides the column index (or column name).
Parameters
- key : "Integer"/"String"
index or column name
Hides the extended row area of a specified index.
It is possible to determine the index or name of the column to be shown in an array.
Parameters
- key : "Integer"/"String"
index or column name
Gets the data of all the rows of a table.
Returns
- Array
datas
Moves a row iat a specified index to the target index.
Parameters
- index : Array
- order : Array
"asc" or "desc"
Removes a custom event of an applicable type or callback handler
Parameters
- type : String
Event type
A callback function defined as an on method is run when an emit method is called
Parameters
- type : String
Event type
- callback : Function
Shows a child row of a specified index.
Parameters
- index : Integer
Changes to the page of at a specified index.
Parameters
- index : Integer
Resets the inner scroll and columns of a table.
Returns filtered rows to the original state.
Ir is possible to use a function for all row data applicable to the column (or column name) of a specified column (or column name). Currently only SUM and AVG are supported.
Parameters
- funcType : "sum"/"svg"
- columnIndex : Integer
- callback : Function
Sets the scroll based on the height of a table.
Parameters
- height : Integer
Sets the scroll based on the height of a table.
Parameters
- index : Integer|String
- dist : Integer
Sets the scroll based on the width of a table.
Parameters
- width : Integer
Adds a selected class to a row at a specified index and gets an instance of the applicable row.
Parameters
- index : Integer
Returns
- RowObject
row
Dynamically defines the options of a UI
Parameters
- key : String
- value : Mixed
Dynamically defines the template method of a UI
Parameters
- name : String
Template name
- html : String
Template markup
Shows the column index (or column name).
Parameters
- key : "Integer"/"String"
index or column name
Shows the Show/Hide Column menu at specified coordinates.
Parameters
- x : Integer
- y : Integer
Shows the extended row area of a specified index.
Parameters
- index : Integer
Shows the loading screen for the specified delay time.
Parameters
- delay : Integer
Gets the size of all the rows of a table.
Returns
- Integer
size
Moves a row iat a specified index to the target index.
Parameters
- index : Integer
- order : String
"asc" or "desc"
Shows or hides the Show/Hide Column menu.
Parameters
- x : Integer
- y : Integer
Removes a selected class from a selected row and gets an instance of the row in question.
Returns
- RowObject
row
Updates the list of rows or modifies the row at a specified index.
Parameters
- rows : Array
It is possible to configure a tree table using an object array with the index and data properties.
Parameters
- rows : Array
Events
Event that occurs when a row is clicked
Parameters
- e : RowObject) row
@param {EventObject
The event object
Event that occurs when a column is clicked.
Parameters
- e : ColumnObject) column
@param {EventObject
The event object
Event that occurs when hidden column is selected.
Parameters
- e : ColumnObject) column
@param {EventObject
The event object
Event that occurs when the column resizing is activated.
Parameters
- e : ColumnObject) column
@param {EventObject
The event object
Event that occurs when shown column is selected.
Parameters
- e : ColumnObject) column
@param {EventObject
The event object
Event that occurs when a row is double clicked
Parameters
- e : RowObject) row
@param {EventObject
The event object
Event that occurs when the extended row area is enabled.
Parameters
- e : RowObject) row
@param {EventObject
The event object
Event that occurs when the extended row area is disabled.
Parameters
- e : RowObject) row
@param {EventObject
The event object
Event that occurs when the scroll of a table is located at the lowermost position.
Parameters
- e : EventObject
The event object
Event that occurs when a row is selected (@Deprecated)
Parameters
- e : RowObject) row
@param {EventObject
The event object
Event that occurs when the table is sorted.
Parameters
- e : ColumnObject) column
@param {EventObject
The event object