cpr.controls.Grid

Grid A component that displays data in a table format.
Hierarchy

Index

Events
Event Description
animationend Event that occurs after the animation ends.
animationstart Event that occurs at the start of the animation.
before-cell-moved An event that occurs before moving a cell in the grid.
before-cell-resized Event raised before resizing the Grid Cell.
before-context-value-change Use a bind context in a control that has a bind context An event that occurs before the value changes.
before-delete An event that occurs before a row in the Grid is deleted.
before-draw This event is called just before group content is drawn.
before-editrow-change Event that occurs before the edit row of the Grid is changed.
before-insert An event that fires before a row in the Grid is added.
before-paste Event that fires before copying when copying with ctrl + p in the Grid.
before-selection-change Event that occurs before the unit corresponding to the set selectionunit is selected by clicking the detail cell.
before-update An event that fires before the grid's row data is modified.
blur An event that occurs after the control loses focus.
cell-click An event that occurs when a cell in the grid is clicked.
cell-mouseout Event that occurs when cell mouseout of Grid.
cell-mouseover An event that occurs when the Grid cell mouseover occurs.
cell-moved An event that occurs when a cell in the grid is moved.
cell-resized Event raised when the size of the Grid Cell is resized.
click An event that occurs when the user clicks the control.
collapse Event raised when the RowGroup of the Grid is collapsed.
context-value-change Use a bind context in a control that has a bind context An event that occurs after the value changes.
contextmenu When the right mouse button is clicked or the context menu key is pressed, Event called.
copy Event that occurs when the selected element of the Grid is copied with ctrl + c .
dblclick An event that occurs when the user double-clicks the control.
delete Event when a row in the Grid is deleted.
dispose The event that is called when the control is dispose.
dragenter When the mouse pointer enters the elements included in the control while dragging Events that occur.
dragleave During the drag, the mouse pointer may have exited the elements contained in the control.
dragover While dragging the source control with the mouse, the mouse pointer An event that occurs when moving within a region.
drop Drag the source control to the target control while dragging the source control with the mouse.
expand Event that occurs when the RowGroup of the Grid is expanded.
filterdialog-close Fired when closing the filter popup.
filterdialog-open Event that occurs when the filter popup is opened.
focus The event that occurs after the control gains focus.
focusin Just before the control and its sub-elements gain focus The event that occurs.
focusout Occurs just before the control's child elements below the control lose focus event.
header-check Event that occurs when Header Checkbox of Grid is checked.
header-uncheck Event raised when Header Checkbox of Grid is unchecked.
insert Event when a row in the Grid is added.
keydown Event raised when the user presses a key.
keyup Event that occurs when the user releases the key.
layout-change Event raised when the grid layout has changed.
measure-size Event raised when calculating control size
mousedown When the user presses the mouse button with the pointer over the control Occurs when an event occurs.
mouseenter An event that occurs when the mouse pointer enters the control.
mouseleave If the user moves the mouse pointer beyond the control and its children Events that occur when moving.
mousemove This event is raised when the user moves the pointer over the control.
mouseup The user releases the mouse button while over the control.
paste Event fired when copying with ctrl + p in the Grid.
row-check Event that occurs when the RowCheckbox of the Grid is checked.
row-dblclick Event that occurs when detail double-clicks a row.
row-radio-selected Event that occurs when the Grid row selection column (columnType=radio) is selected.
row-uncheck Event raised when RowCheckbox of Grid is unchecked.
rowgroup-click Event when the Grid's RowGroup is clicked.
rowgroup-dblclick Event when RowGroup of Grid is double-clicked.
scroll Event that fires when the grid detail content is scrolled.
selection-change Event that occurs when the unit corresponding to the set selectionunit is selected by clicking the detail cell.
selection-dispose Event that fires when the selection row disappears.
touchcancel What happens when one or more touch points are interrupted in a particular implementation event.
touchend What happens when one or more touch points are removed from the touch surface event.
touchmove What happens when one or more touch points move along the touch surface event.
touchstart What happens when one or more touch points are placed on a touch surface event.
transitionend Event that fires after CSS property transition ends.
transitionstart Event that fires when CSS property transition starts.
update Event when row data in the Grid has been modified.
Properties
Name Type Description
accessKey String Returns the keyboard shortcut.
accessbility Accessbility Gets the accessibility-related ARIA properties or gets the context in which they can be specified.
autoFit String Returns information about automatically resizing cells.
autoRowHeight String Automatically adjusts the row height to fit the cell data length.
bottomSplit Number Returns the fixed number of rows at the bottom of the detail area.
bottomSplitHeight Number Returns the default height of the area to be fixed at the bottom of the Detail area.
caption String Returns a description (caption) to the grid.
clickMode String Returns action via click
collapsible Boolean Returns whether to allow the group to be collapsed when using rowgroup.
columnCount Number Returns the number of grid columns.
columnMovable Boolean Returns whether the Header can be moved.
columnResizable Boolean Returns whether it is possible to adjust the size of the header.
dataSet DataCollection Returns the data control connected to the grid.
defaultSortMode SORTMODE Returns the default behavior when a header that supports multiple sorts is clicked.
detail GridDetailBand Returns grid detail area object
disposed Boolean Returns whether the control should be removed.
editable Boolean Returns whether the value can be changed by user action.
enabled Boolean Returns whether the control is enabled.
enabledCellAutoWidth Boolean It returns whether or not to automatically adjust the width of the cell to fit the width of the text shown when double-clicking the width adjustment area of ​​a cell for which resizable is true.
fieldLabel String Returns the logical field name of the control.
filterDialogButtons FilterDialogButton[] Returns an ordered list of buttons in the filter popup.
focusable Boolean Returns whether the control is focusable.
focused Boolean Returns whether the control has focus.
footer GridFooterBand Returns a grid footer area object
hScroll String Returns the horizontal scroll style.
header GridHeaderBand Returns a grid header area object
id String Returns the ID of the control.
leftSplit Number Returns the number of cells to be frozen (screen split) to the left of the grid.
leftSplitWidth Number Grid Returns the width (px) of the area to be frozen to the left (screen splitting).
name String Returns the name of the control.
noDataMessage String Returns a message to be shown when there is no data in the detail area.
overscrollBehavior OverscrollBehaviorType Returns a value that defines the parent's scrolling behavior when the end of the scrollable area is reached by the mouse wheel or touch event.
pasteMode String Returns the paste (ctrl + v) method.
pasteValidation Boolean Returns whether to validate when pasting (ctrl + v).
readOnly Boolean Returns whether a non-modifiable read-only mode is in effect.
resizableColumns String Returns whether it is possible to adjust the size of the header.
rightSplit Number Grid Returns the number of cells to be frozen to the right (split screen).
rightSplitWidth Number Grid Returns the width (px) of the area to be frozen to the right (screen splitting).
rowCount Number Returns the number of rows.
rowIndexerStartNum Number Returns the starting index of the row index shown in the grid.
selectionMulti String Returns whether multi-selected.
selectionUnit String Returns the units from which the grid can be selected.
showDeletedRow Boolean Returns whether to show deleted rows.
showExtraRow Boolean If the detail area is not full of data rows, Returns a setting whether to fill grid lines in the margins.
style Grid$Styler Returns the style settings of the control.
suppressedCellEditMode SuppressedCellEditMode When editing the suppressed detail cell, whether to modify only the value of the edit row, Returns whether or not to change the values ​​of all the suppressed and visible cells.
suppressedCellType String Returns whether the suppressed detail cell is expressed as split or merged.
tabIndex Number Returns the control focus sequence using the Tab Key.
tabMode TabMode Returns the tab movement method.
tooltip String Returns a description of the control
topSplit Number Returns the number of rows fixed at the top of the Detail area.
topSplitHeight Number Returns the default height of the area to be fixed at the top of the Detail area.
type ControlType Returns the signature string of the Control's unique Type that can distinguish the Control.
uuid String Returns the unique ID of the control.
vScroll String Returns the vertical scroll style.
viewingMode ViewingMode Returns the shape of the control placed in the detail area to be displayed in the viewing mode.
visible Boolean Returns the style property for controlling css visibility.
wheelRowCount Number Returns the number of rows to scroll at a time with the wheel.
Methods
Name Return Type Description
addColumn Add a grid column.
addEventListener Add listeners by EventType to the control.
addEventListenerOnce (e: cpr.events.CEvent)=>Void Add a listener to the control that will run only once per EventType.
bind IBindFactory Bind that property.
blur Removes focus from the control.
cancelSelection If the current row/column/cell is being selected, deselect it.
checkAllRow Set all checkboxes whose columntype is checkbox to check status.
checkAllTreeCheck Set all grid tree cell checkboxes to the checked state.
clearAllCheck Unchecks all checkboxes whose columntype is a checkbox.
clearAllRowHeight Removes any custom row height values ​​applied.
clearAllTreeCheck Set all grid tricell checkboxes to unchecked.
clearFilter Removes the filter applied to the currently connected data structure.
clearSelection Boolean Removes all current selections.
clearSort Removes sort applied to the currently connected data structure.
collapseAll Collapse the entire row group.
columnVisible Change the visible property of a specific cell(column).
commitData Makes all the changed data of the current grid as original data.
confirmEvent Boolean Determines whether to run the Control's Default Event Handler depending on the state of the Control.
deleteColumn Remove the grid column.
deleteRow Delete a specific row.
dispatchEvent Boolean Forwards specific events.
dispose Removes the objects contained in the control.
expandAll Expand the entire row group.
filter Change the filter condition on the currently connected data structure, and filter.
findAllRow GridRow[] Finds the Row that meets the condition and returns the corresponding GridRow array.
findFirstRow GridRow Finds the first Row that matches the condition and returns the corresponding GridRow.
findParent UIControl Find the parent control.
focus Assigns focus to the control.
focusCell Focuses the cell of the information that the user has delivered.
focusNext Moves focus to the next control.
focusPrevious Moves focus to the previous control.
forEachOfGridCells The Grid Data is passed to the function that receives the attribute array for each cell in the order shown on the screen in row units (including header, detail, footer, group header, and group footer).
getActivateRowGroup Boolean Returns whether a specific group is active.
getActualRect Rectangle Gets the bounds value of the control relative to the browser's view port.
getAppInstance AppInstance Returns the App to which the control belongs.
getBindContext BindContext Returns the bind context.
getBindInfo BindInfo Returns the bind property information for the control.
getCellBounds Rectangle Get the bounds of a specific cell being displayed on the browser viewport.
getCellIndex Number Returns the detail cell index through the column name mapped to the grid.
getCellIndicesByVisible Number[] Returns the header cell index array corresponding to visible information.
getCellInfo { columnType: String, columnName: String, mergeToIndexExpr: String, mergedColumnName: String, suppressible: Boolean, suppressRef: String, control: cpr.controls.UIControl }
getCellText String Returns the visible value of a specific cell.
getCellValue Object Returns the value of a specific cell (detail area).
getCheckRowIndices Number[] Returns the row index array currently checked.
getColIndicesByVisible Number[] Returns colIndex array corresponding to visible information.
getColumnLayout GridColumnLayout Returns grid layout information.
getColumnWidths String[] Returns the width array of columns.
getConstraint GridControlLayoutConstraint Returns the constraint for this control.
getContentRow Object Returns the GridRow object at the row index shown.
getContentRowCount Number Returns the total number of rows in the grid.
getDataRow GridRow Returns the GridRow object of the actual data row index.
getDataRowCount Number Returns the actual number of data rows.
getDetailCellIndices Number[] Returns the detail cell index in the column corresponding to the header cell index.
getDisplayItems { value: String, label: String }[] Deduplicates the value of a specific column in a specific data list and returns it as a json array in the form of label and value.
getEditRowIndex Number Returns the index of the row currently being edited in the grid.
getExportData ExportData Returns Grid data in JSON format.
getFilter #expression Returns the filter conditional expression set on the currently connected data structure.
getFooterCellValue Object Returns the value of a specific cell (footer area)
getFooterData String[] Returns all the data for the footer.
getGridRowGroup GridRowGroup Returns the GridRowGroup object that maps to a row when its rowIndex is a grouped row.
getHeaderCellIndices Number[] Returns the header cell index in the column corresponding to the detail cell index.
getHtmlAttrNames String[] Returns all custom DOM DATA attribute names.
getInitConfig GridConfig Returns the grid initial setting information.
getMaxRowHeight Number Returns the maximum row height set by the user when autoRowHeight is set.
getNextControl UIControl Returns the control to be moved by Tab Key or by the autoskip property.
getOffsetRect Rectangle The area being displayed is obtained based on the parent container to which it belongs.
getParent Container Gets the parent control.
getPrevControl UIControl Shift + Tab Returns the focus to be moved through the key.
getRadioSelection Number Returns the row index in which columnType=radio is currently selected.
getRow GridRow Returns the GridRow object for this row index.
getRowCount Number Returns the number of rows.
getRowGroup GridRowGroupBand Returns a RowGroup Band that meets the corresponding grouping criteria.
getRowHeight Number[] If a user-defined row height is applied, the height of the applied row is returned; otherwise, the row height defined at design time is returned.
getRowState RowState Returns the state of a specific row index.
getSelectedCellIndices CellPosition[] Returns the currently selected cell information as an array.
getSelectedColumnIndices Number[] Returns the currently selected column index array.
getSelectedIndices Number[] | cpr.controls.gridpart.selection.CellPosition[] Returns the currently selected information.
getSelectedRow GridRow Returns a GridRow object for the currently selected row.
getSelectedRowIndex Number Returns the index of the currently selected row.
getSelectedRowIndices Number[] Returns the currently selected row index array.
getSelectedRows GridRow[] Returns a GridRow object of the currently selected rows.
getSelectionData String Returns the currently selected data.
getSort #expression Returns the sort conditional expression set on the currently connected data structure.
getTreeCheckIndices Number[] Returns the row index that is checked in the checkbox of the current tree cell.
getUnfilteredRows DataRows Returns the data list excluding the filter applied to the column in a specific column.
getUserAttrNames String[] Returns all custom attribute names.
getViewingEndRowIndex Number Returns the index of the last row currently displayed.
getViewingStartRowIndex Number Returns the starting row index of the currently visible rows.
getVisualParentControl UIControl Gets the closest parent UI control.
getWholeRenderingMode String | false | true Returns whether or not to draw all areas that are not visible due to scrolling.
hasFooter Boolean Returns the presence or absence of the footer area.
hasHScroll Boolean Returns whether horizontal scrolling exists.
hasVScroll Boolean Returns whether vertical scrolling exists.
htmlAttr Specifies custom DOM properties.
init Set grid initial properties and design information.
insertColumn Add a column to a specific position on the grid.
insertRow GridRow Adds a new row to the grid.
insertRowData GridRow Adds a new row to the grid.
isAvailableBinding Boolean Returns whether the queried property is bindable and the binding has been configured to obtain a valid value.
isBindable Boolean Make sure it is a bindable property.
isCheckColumnEnabled Boolean Returns whether the checkbox column of a specific row is activated.
isCheckedRow Boolean Returns whether the checkbox cell of the row of the rowIndex entered is checked.
isEditing Boolean Returns whether the grid is currently being edited.
isEnabledTypedCell Boolean Returns whether a specific row of the column whose columnType is set is active.
isFloated Boolean Returns whether the control is floating through an app instance or a specific container.
isHeaderCheckColumnEnabled Boolean Returns whether the header checkbox column is enabled.
isRadioColumnEnabled Boolean Returns whether columnType=radio column of a specific row is enabled.
isRadioSelected Boolean Returns whether columnType=radio of a specific Row is selected.
isSelectionStarted Boolean Returns whether the current row/column/cell is being selected.
isShowing Boolean Returns the status that the screen is showing.
isTreeChecked Boolean Returns whether the tricell checkbox present in the row of the input rowIndex is checked.
isVisibleTypedCell Boolean Returns the visibility of a specific row of the column for which columnType is set.
isWholeRenderingMode Boolean Sets whether or not to draw all areas up to the invisible area due to scrolling.
makeRelativePoint Point Converts browser viewport base coordinates to relative coordinates for this container.
moveColumn Change the location of a specific cell.
moveToCell Scroll to the location of the input cell.
openFilterDialog Open the filter popup.
redraw Redraw the control.
removeAllEventListeners Removes all event listeners for the control.
removeAllHtmlAttr Delete all custom DOM DATA attributes.
removeAllUserAttr Delete all custom attributes.
removeEventListener Remove Listener for each EventType in the control.
removeEventListeners Remove all EventType listeners from the control.
removeHtmlAttr Removes the user-defined DOM DATA attribute for a specific attribute name.
removeRadioSelection Uncheck columnType=radio.
removeUserAttr Removes user-defined attributes for a specific attribute name.
replaceConstraint Boolean Replace the constraints of the control.
resetGrid Initialize the set Grid information.
resizeColumn Change the width of a specific cell.
revertData Recovers all changed data within the grid.
revertRowData Recovers data from specific rows that have changed within the grid.
scrollTo If the grid contains scrolling, it will scroll to that position.
select Boolean Select row, column, or cell for the current selectionUnit.
selectCells Boolean Select specific cells.
selectColumns Boolean Select specific columns.
selectRadio Select columnType=radio for a specific row.
selectRows Boolean Select specific rows.
setActivateRowGroup Activate or deactivate a specific group.
setBindContext Sets the bind context.
setCellValue Boolean Changes the value of a specific cell.
setCheckColumnEnabled Set whether to activate the checkbox column of a specific row.
setCheckColumnEnabledForAllRows Sets whether to enable all checkboxes whose columnType is checkbox.
setCheckRowIndex Sets the value of the checkbox column for a specific row.
setColumnLayout Set grid layout information.
setEditRowIndex Boolean Switches the passed line to edit mode.
setEnabledTypedCell Set whether to activate a specific row of the column whose columnType is set.
setEnabledTypedCellForAllRows Set whether to activate all rows of the column whose columnType is set.
setFilter Change the filter condition on the currently connected data structure, and filter.
setFilterDialogMatcher Set the matching method when searching within the grid filter popup.
setFooterData Change all data in the footer area.
setHeaderCheckColumnEnabled Set whether to enable header checkbox column.
setLeftSplitCellIndex Set leftSplit through header cellIndex.
setMaxRowHeight Set the maximum row height when setting autoRowHeight.
setNextControl Sets the control to be moved by Tab Key or by the autoskip property.
setPrevControl Shift + Tab Set the focus to be moved through the key.
setRadioColumnEnabled Set whether to enable columnType=radio for a specific row.
setRadioColumnEnabledForAllRows Set whether to activate all radios with columnType=radio.
setRightSplitCellIndex Set rightSplit through header cellIndex.
setRowHeight User-defined row height is supported only for grids without automatic row height.
setRowState Changes the state of a specific row index.
setTreeCheckIndex Check or uncheck the tricell checkbox of a specific row in the grid.
setVisibleTypedCell Sets the visibility of a specific row of the column for which columnType is set.
setVisibleTypedCellForAllRows Set whether all rows of the column whose columnType is set are visible.
setWholeRenderingMode Set whether to draw all invisible areas outside the scroll viewport.
sort Change the sort condition on the currently connected data structure and sort it.
unbind Unbind that property.
updateConstraint Boolean Change the Control's Constraints.
updateRow Boolean Changes the data for a specific row.
userAttr Specifies custom properties.
userData Specifies custom data.
userattr Object Returns a user-defined property.

Constructor

Grid(id)
Parameters
name type description
idoptional String Returns the ID of the control.

Events

animationend
CAnimationEvent Event that occurs after the animation ends.
animationstart
CAnimationEvent Event that occurs at the start of the animation.
before-cell-moved
CGridEvent An event that occurs before moving a cell in the grid. 
data: {sourceHeaderIndex : number, targetHeaderIndex: number, before: boolean}
Source and target information of the cell to be moved.
before-cell-resized
CGridEvent Event raised before resizing the Grid Cell. 
data: {oldHeaderCellWidth: string, newHeaderCellWidth: string, cellIndex: number}
Before and after size information of the cell whose size you want to change.
before-context-value-change
CValueChangeEvent Use a bind context in a control that has a bind context An event that occurs before the value changes.
before-delete
CGridEvent An event that occurs before a row in the Grid is deleted. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} The row object to be deleted.
rowIndex: {number} The row index to be deleted.
before-draw
CUIEvent This event is called just before group content is drawn. It is only used for dynamically constructing internal content.
before-editrow-change
CGridEvent Event that occurs before the edit row of the Grid is changed. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
oldSelection: {cpr.controls.provider.GridRow} Previously edited row object.
newSelection: {cpr.controls.provider.GridRow} The row object that will be the current edit state.
isCommit: {boolean} Whether to reflect the data being edited.
before-insert
CGridEvent An event that fires before a row in the Grid is added. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail)
before-paste
CGridEvent Event that fires before copying when copying with ctrl + p in the Grid. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} The row object on which the paste was executed.
rowIndex: {number} The row index at which the paste was executed.
cellIndex: {number} The cell index where the paste was executed.
columnName: {number} The columnName of the cell where the paste was executed.
data: {string} Data to paste.
before-selection-change
CSelectionEvent Event that occurs before the unit corresponding to the set selectionunit is selected by clicking the detail cell. 
oldSelection: {number[] | gridpart.selection.CellPosition[]} The previously selected index or array of cellPositions.
newSelection: {number[] | gridpart.selection.CellPosition[]} currently selected index or array of cellPosition
before-update
CGridEvent An event that fires before the grid's row data is modified. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} The row object to be modified.
rowIndex?: {number} The row index to be modified.
columnName?: {string} The column name to be modified.
oldValue?: {any} Value before modification.
newValue?: {any} The value to be modified.
blur
CFocusEvent An event that occurs after the control loses focus.
cell-click
CGridEvent An event that occurs when a cell in the grid is clicked. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} The row object of the clicked cell.
rowIndex: {number} The row index of the clicked cell.
cellIndex: {number} The cell index of the clicked cell.
columnName: {number} columnName of the clicked cell.
cellBoundingRect: {geometry.Rectangle} The actual size of the detail cell where the event occurred.
cell-mouseout
CGridEvent Event that occurs when cell mouseout of Grid. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} The row object of the cell where the event was triggered.
rowIndex: {number} The row index of the cell where the event was triggered.
cellIndex: {number} The cell index of the cell where the event was triggered.
columnName: {number} The columnName of the cell where the event was triggered.
cellBoundingRect: {geometry.Rectangle} The actual size of the detail cell where the event occurred.
cell-mouseover
CGridEvent An event that occurs when the Grid cell mouseover occurs. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} The row object of the cell where the event was triggered.
rowIndex: {number} The row index of the cell where the event was triggered.
cellIndex: {number} The cell index of the cell where the event was triggered.
columnName: {number} The columnName of the cell where the event was triggered.
cellBoundingRect: {geometry.Rectangle} The actual size of the detail cell where the event occurred.
cell-moved
CGridEvent An event that occurs when a cell in the grid is moved. 
data: {sourceHeaderIndex : number, targetHeaderIndex: number, before: boolean}
Source and target information of the moved cell.
cell-resized
CGridEvent Event raised when the size of the Grid Cell is resized. 
data: {oldHeaderCellWidth: string, newHeaderCellWidth: string, cellIndex: number}
Size information before and after the cell whose size has been changed.
click
CMouseEvent An event that occurs when the user clicks the control.
collapse
CGridEvent Event raised when the RowGroup of the Grid is collapsed. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail, rowgroup) 
rowgroup : {cpr.controls.provider.GridRowGroup} The rowgroup object where the event occurred (collapsed).
context-value-change
CValueChangeEvent Use a bind context in a control that has a bind context An event that occurs after the value changes.
contextmenu
CMouseEvent When the right mouse button is clicked or the context menu key is pressed, Event called.
copy
CGridEvent Event that occurs when the selected element of the Grid is copied with ctrl + c . 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
data: {string} The copied data. Currently selected data.
dblclick
CMouseEvent An event that occurs when the user double-clicks the control.
delete
CGridEvent Event when a row in the Grid is deleted. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail)
dispose
CEvent The event that is called when the control is dispose.
dragenter
CMouseEvent When the mouse pointer enters the elements included in the control while dragging Events that occur.
dragleave
CMouseEvent During the drag, the mouse pointer may have exited the elements contained in the control. The event that occurs when.
dragover
CMouseEvent While dragging the source control with the mouse, the mouse pointer An event that occurs when moving within a region.
drop
CMouseEvent Drag the source control to the target control while dragging the source control with the mouse. Event that fires when dropping.
expand
CGridEvent Event that occurs when the RowGroup of the Grid is expanded. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail, rowgroup) 
rowgroup : {cpr.controls.provider.GridRowGroup} The rowgroup object where the event occurred (expanded).
filterdialog-close
CGridEvent Fired when closing the filter popup.
filterdialog-open
CGridEvent Event that occurs when the filter popup is opened. 
data: {cpr.controls.gridpart.DataRows} List of data to be displayed in the filter dialog.
focus
CFocusEvent The event that occurs after the control gains focus.
focusin
CFocusEvent Just before the control and its sub-elements gain focus The event that occurs.
focusout
CFocusEvent Occurs just before the control's child elements below the control lose focus event.
header-check
CGridEvent Event that occurs when Header Checkbox of Grid is checked. (columnType=checkbox) 
relativeTargetName: {string} The target name in the grid where the event occurred. (header)
header-uncheck
CGridEvent Event raised when Header Checkbox of Grid is unchecked. (columnType=checkbox) 
relativeTargetName: {string} The target name in the grid where the event occurred. (header)
insert
CGridEvent Event when a row in the Grid is added. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} Added row object.
rowIndex: {number} Added row index.
keydown
CKeyboardEvent Event raised when the user presses a key. Keycode related constants can be referenced at KeyCode.
keyup
CKeyboardEvent Event that occurs when the user releases the key. Keycode related constants can be referenced at KeyCode.
layout-change
CGridEvent Event raised when the grid layout has changed. 
reason: {string} Information about what caused the layout change.
(column-added, column-deleted, cell-resized, cell-moved, column-visible)
measure-size
CMeasureSizeEvent Event raised when calculating control size
mousedown
CMouseEvent When the user presses the mouse button with the pointer over the control Occurs when an event occurs.
mouseenter
CMouseEvent An event that occurs when the mouse pointer enters the control.
mouseleave
CMouseEvent If the user moves the mouse pointer beyond the control and its children Events that occur when moving.
mousemove
CMouseEvent This event is raised when the user moves the pointer over the control.
mouseup
CMouseEvent The user releases the mouse button while over the control. When an event occurs.
paste
CGridEvent Event fired when copying with ctrl + p in the Grid. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} The row object on which the paste was executed.
rowIndex: {number} The row index at which the paste was executed.
cellIndex: {number} The cell index where the paste was executed.
columnName: {number} The columnName of the cell where the paste was executed.
data: {string} Data to paste.
row-check
CGridEvent Event that occurs when the RowCheckbox of the Grid is checked. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} checked row object.
rowIndex: {number} checked index.
row-dblclick
CGridEvent Event that occurs when detail double-clicks a row. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} Double-clicked row object.
rowIndex: {number} Double-clicked row index.
cellIndex: {number} Double-clicked cell index.
columnName: {number} The columnName of the double-clicked cell.
row-radio-selected
CGridEvent Event that occurs when the Grid row selection column (columnType=radio) is selected. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row:: {cpr.controls.provider.GridRow} Radio selected row object.
rowIndex: {number} Radio selected row index.
row-uncheck
CGridEvent Event raised when RowCheckbox of Grid is unchecked. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} unchecked row object.
rowIndex: {number} Checked row index.
rowgroup-click
CGridEvent Event when the Grid's RowGroup is clicked. 
relativeTargetName: {string} The target name in the grid where the event occurred. (rowgroup) 
rowgroup : {cpr.controls.provider.GridRowGroup} The clicked rowgroup object.
cellIndex: {number} The clicked cell index.
rowgroup-dblclick
CGridEvent Event when RowGroup of Grid is double-clicked. 
relativeTargetName: {string} The target name in the grid where the event occurred. (rowgroup) 
rowgroup : {cpr.controls.provider.GridRowGroup} The clicked rowgroup object.
cellIndex: {number} The clicked cell index.
scroll
CScrollEvent Event that fires when the grid detail content is scrolled.
selection-change
CSelectionEvent Event that occurs when the unit corresponding to the set selectionunit is selected by clicking the detail cell. 
oldSelection: {number[] | gridpart.selection.CellPosition[]} The previously selected index or array of cellPositions.
newSelection: {number[] | gridpart.selection.CellPosition[]} The currently selected index or array of cellPositions.
selection-dispose
CGridEvent Event that fires when the selection row disappears. 
Ex. deleteRow, filter, revertData, revertRowData, commitData, showDeletedRow=false
oldSelection: {number[] | gridpart.selection.CellPosition[]} An array of previously selected indices or cellPositions.
newSelection: {number[] | gridpart.selection.CellPosition[]} empty array.
touchcancel
CTouchEvent What happens when one or more touch points are interrupted in a particular implementation event.
touchend
CTouchEvent What happens when one or more touch points are removed from the touch surface event.
touchmove
CTouchEvent What happens when one or more touch points move along the touch surface event.
touchstart
CTouchEvent What happens when one or more touch points are placed on a touch surface event.
transitionend
CTransitionEvent Event that fires after CSS property transition ends.
transitionstart
CTransitionEvent Event that fires when CSS property transition starts.
update
CGridEvent Event when row data in the Grid has been modified. 
relativeTargetName: {string} The target name in the grid where the event occurred. (detail) 
row: {cpr.controls.provider.GridRow} modified row object
rowIndex?: {number} modified row index
columnName?: {string} Edited column name
oldValue?: {any} Value before modification.
newValue?: {any} modified value.

Properties

accessKey
type String
get
Returns the keyboard shortcut.
set
Keyboard shortcut Sets a single character (letter or number).
The shortcut key is [alt] + [shortcut key] for Windows or [option] + [shortcut key] for Mac.
accessbility
declaring type UIControl
type Accessbility
readonly
Gets the accessibility-related ARIA properties or gets the context in which they can be specified.
autoFit
type String
get
Returns information about automatically resizing cells.
set
Set whether to automatically resize cells to fit the width of the specified area.
[none]: It does not use the function and is set to the specified width.
[all]: All columns have the ratio of the corresponding size (100px, 200px, 400px-> 1: 2: 4) and are set to the width of the grid. It does not occur when the grid width is exceeded.
[columnindex]: When a specific column index is specified, only the column size is adjusted to fit the width of the designated area.
Multiple columns can be set through the comma (,) separator.
autoRowHeight
type String
get
Automatically adjusts the row height to fit the cell data length.
set
Set whether to automatically adjust the row height to fit the cell data length. The minimum value is the set row height.
(Basic cell, output, text area, HTML snippet, UDC.)
[none]: This function is not used and is set to a fixed height.
[all]: Automatically adjusts the row height according to the data length of all columns.
[cellindex]: When a specific cell index is specified, the row height is automatically adjusted according to the data length of the cell.
Multiple columns can be set through the comma (,) separator.
bottomSplit
type Number
get
Returns the fixed number of rows at the bottom of the detail area.
set
Set the number of ROW fixed at the bottom of the Detail area.
When using Grouping and Treecell, we do not support TOPSPLIT and BOTTOMSPLIT -related settings.
bottomSplitHeight
type Number
get
Returns the default height of the area to be fixed at the bottom of the Detail area.
set
Returns the default height of the area to be fixed at the bottom of the Detail area.
caption
deprecated2019.06.12 Deprecated property.
type String
get
Returns a description (caption) to the grid.
set
Sets the description (caption) on the grid.
clickMode
type String
get
Returns action via click
[select]: Click mode will be activated when clicked.
[edit]: Click to operate in edit mode.
set
Set action via click
[select]: Click mode will be activated when clicked.
[edit]: Click to operate in edit mode.
collapsible
type Boolean
get
Returns whether to allow the group to be collapsed when using rowgroup.
set
Sets whether or not to collapse the group when using rowgroup.
columnCount
type Number
readonly
Returns the number of grid columns.
columnMovable
type Boolean
get
Returns whether the Header can be moved.
set
Set whether the header can be moved.
If a control that provides a separate function through drag is placed in the header cell, column movement is not possible.
(Target controls: input box, date input, number editor, mask editor, search input, combo box, file input, text area)
columnResizable
deprecatedPlease use resizableColumns.
type Boolean
get
Returns whether it is possible to adjust the size of the header.
set
It sets whether to adjust the size of the header.
dataSet
type DataCollection
readonly
Returns the data control connected to the grid.
defaultSortMode
type SORTMODE
get
Returns the default behavior when a header that supports multiple sorts is clicked.
set
Set the default behavior when clicking on a header that supports multiple sorting. Applied when the value of the header column property [sortable] is true.
[multi]: Set multi-sort as the default operation. Single sort when (alt+click header).
[single]: Set single sorting as the default action. Multiple sorting when (ctrl+click header).
detail
type GridDetailBand
readonly
Returns grid detail area object
You can access the API related to the detail area.
disposed
declaring type Control
type Boolean
readonly
Returns whether the control should be removed.
editable
declaring type UIControl
type Boolean
readonly
Returns whether the value can be changed by user action.
UIControl (Output, etc.) that does not allow input returns false.
In the case of an inputtable UIControl, returns true if the binding context in which the value is bound is valid.
Otherwise, it returns false even if it is an inputtable UIControl.

Accordion/Button/Group/Dialog/EmbeddedApp/EmbeddedPage/Grid/HTMLObject/Image/MDIFolder/Menu/
NavigationBar/Notifier/Output/Progress/TabFolder/Shell/FileUpload
In the case of the above control, editable is always false.
enabled
declaring type EnableUIControl
type Boolean
get
Returns whether the control is enabled.
set
Sets whether to activate the control.
enabledCellAutoWidth
type Boolean
get
It returns whether or not to automatically adjust the width of the cell to fit the width of the text shown when double-clicking the width adjustment area of ​​a cell for which resizable is true. [false] : Double-click does not work. [true] : When double-clicked, the cell width is automatically adjusted to fit the text width.
set
Set whether to automatically adjust the width of the cell to fit the width of the text shown when double-clicking the width adjustment area of ​​a cell for which resizable is true. [false] : Double-click does not work. [true] : When double-clicked, the cell width is automatically adjusted to fit the text width.
fieldLabel
declaring type UIControl
type String
get
Returns the logical field name of the control.
set
Sets the logical field name of the control.
filterDialogButtons
type FilterDialogButton[]
get
Returns an ordered list of buttons in the filter popup.
set
Set the button order list of the filter popup.
focusable
declaring type UIControl
type Boolean
readonly
Returns whether the control is focusable.
focused
declaring type UIControl
type Boolean
readonly
Returns whether the control has focus.
footer
type GridFooterBand
readonly
Returns a grid footer area object
You can access the API related to the footer area.
hScroll
type String
get
Returns the horizontal scroll style.
set
Set the horizontal scroll style.
[auto]: Scrolling is automatically set according to the size of the inner area.
[scroll]: Scroll is set regardless of the size of the inner area.
[hidden]: Scroll is set to be invisible regardless of the size of the inner area.
header
type GridHeaderBand
readonly
Returns a grid header area object
You can access the API related to the header area.
id
declaring type Control
type String
readonly
Returns the ID of the control.
leftSplit
type Number
get
Returns the number of cells to be frozen (screen split) to the left of the grid.
set
Set the number of cells to be fixed (split screen) to the left of the grid.
If you set all cells in grid to leftSplit or rightSplit, vertical scroll is not visible, It is recommended not to set all cells to leftSplit or rightSplit as movement and scrolling using the arrow keys in the grid do not work.
Related properties: [leftSplitWidth] If leftSplitWidth is 0, the left segment is not shown even if leftSplit is set.
leftSplitWidth
type Number
get
Grid Returns the width (px) of the area to be frozen to the left (screen splitting).
set
Sets the width (px) of the area to be fixed to the left of the grid (screen splitting).
Related property: [leftSplit] If leftSplit is not specified, the left partition is not split.
name
declaring type UIControl
type String
get
Returns the name of the control.
set
Sets the name of the control.
noDataMessage
type String
get
Returns a message to be shown when there is no data in the detail area.
set
Sets the message to be shown when there is no data in the detail area.
(If there is an up / down / left / right fixed area, the corresponding text is placed in the center area of ​​the detail area.)
overscrollBehavior
declaring type Container
type OverscrollBehaviorType
get
Returns a value that defines the parent's scrolling behavior when the end of the scrollable area is reached by the mouse wheel or touch event. The default value is AUTO, which delegates scrolling behavior to the parent.
set
Sets a value that defines the parent's scrolling behavior when the end of the scrollable area is reached by the mouse wheel or touch event. OverscrollBehaviorType.AUTO: Delegates scrolling behavior to parent. OverscrollBehaviorType.NONE: Blocks propagation to the parent.
pasteMode
type String
get
Returns the paste (ctrl + v) method.
[all]: Pasted to all controls except those with enabled = false and readOnly = true. (default)
[editable]: Pasted only to editable controls. (Example of excluded control: Output, Input (disabled))
[none]: Paste is not supported.
set
Set the paste (ctrl + v) method.
[all]: Pasted to all controls except those with enabled = false and readOnly = true. (default)
[editable]: Pasted only to editable controls. (Example of excluded control: Output, Input (disabled))
[none]: Paste is not supported.
pasteValidation
type Boolean
get
Returns whether to validate when pasting (ctrl + v).
When validating, invalid values ​​are not pasted.
Cells that do not require additional validation, such as basic cells and outputs, are pasted as they are.
set
Sets whether to check validation when pasting (ctrl + v).
When validating, invalid values ​​are not pasted.
Cells that do not require additional validation, such as basic cells and outputs, are pasted as they are.
readOnly
declaring type EnableUIControl
type Boolean
get
Returns whether a non-modifiable read-only mode is in effect.
set
Sets whether to enable read-only mode, which can not be modified.
resizableColumns
type String
get
Returns whether it is possible to adjust the size of the header.
set
Set whether header size can be adjusted.
[none]: All columns do not change size.
[all]: All columns can be resized.
[columnindex]: When specifying a specific column index, only that column can be resized.
You can set multiple columns using the comma (,) separator.
rightSplit
type Number
get
Grid Returns the number of cells to be frozen to the right (split screen).
set
Set the number of cells to be fixed (split screen) to the right of the grid.
If you set all cells in grid to leftSplit or rightSplit, vertical scroll is not visible, It is recommended not to set all cells to leftSplit or rightSplit as movement and scrolling using the arrow keys in the grid do not work.
rightSplitWidth
type Number
get
Grid Returns the width (px) of the area to be frozen to the right (screen splitting).
set
Grid Sets the width (px) of the area to be fixed to the right (screen splitting).
rowCount
type Number
readonly
Returns the number of rows.
rowIndexerStartNum
type Number
get
Returns the starting index of the row index shown in the grid.
set
Sets the starting index of the row index shown in the grid.
selectionMulti
type String
get
Returns whether multi-selected.
set
Set whether to select multiple.
[none]: Prevent selection.
[single]: Supports single selection
[multi]: Supports multiple selection.
selectionUnit
type String
get
Returns the units from which the grid can be selected.
set
Set the units from which you can select a grid.
[cell]: Support cell selection.
[row]: supports row selection.
[column]: Supports column-by-column selection.
showDeletedRow
type Boolean
get
Returns whether to show deleted rows.
set
Sets whether to show deleted rows.
showExtraRow
type Boolean
get
If the detail area is not full of data rows, Returns a setting whether to fill grid lines in the margins.
set
If the detail area is not full of data rows, Sets whether to fill grid lines in the margins.
style
type Grid$Styler
readonly
Returns the style settings of the control.
In case of style changes, only the corresponding control is updated.
Propagation from style changes does not occur.
suppressedCellEditMode
type SuppressedCellEditMode
get
When editing the suppressed detail cell, whether to modify only the value of the edit row, Returns whether or not to change the values ​​of all the suppressed and visible cells.
set
When editing the suppressed detail cell, whether to modify only the value of the edit row, Set whether to change the values ​​of all the cells that are suppressed.
suppressedCellType
type String
get
Returns whether the suppressed detail cell is expressed as split or merged. [split]: When the same value is repeated, the first value is output and the remaining values ​​are omitted. (default) [merged]: Provides the effect of merging cells of repeated values ​​when the same value is repeated.
set
Set whether to display Suppressed detail cells in split or merged format. [split]: When the same value is repeated, the first value is output and the remaining values ​​are omitted. (default) [merged]: Provides the effect of merging cells of repeated values ​​when the same value is repeated.
tabIndex
type Number
get
Returns the control focus sequence using the Tab Key.
This property controls the tabindex in HTML.
set
Set the control focus order using Tab Key.
This property controls the tabindex in HTML.
tabMode
type TabMode
get
Returns the tab movement method.
[all] : You can move the entire cell by tab. (Including both default cell and Output) (default)
[editable] : Only editable controls are tabbed. (Example of control that cannot move tab: Output, Input(disabled))
[focusable] : Only focusable controls are tabbed. (Affected by tabIndex.)
[none] : Tab movement is not supported.
set
Set the tab movement method.
[all] : You can move the entire cell by tab. (Including both default cell and Output) (default)
[editable] : Only editable controls are tabbed. (Example of control that cannot move tab: Output, Input(disabled))
[focusable] : Only focusable controls are tabbed. (Affected by tabIndex.)
[none] : Tab movement is not supported.
tooltip
declaring type VisibleUIControl
type String
get
Returns a description of the control
It works when mouse over.
set
Set a description for the control.
It works when mouse over.
topSplit
type Number
get
Returns the number of rows fixed at the top of the Detail area.
set
Set the number of ROW fixed at the top of the Detail area.
When using Grouping and Treecell, we do not support TOPSPLIT and BOTTOMSPLIT -related settings.
topSplitHeight
type Number
get
Returns the default height of the area to be fixed at the top of the Detail area.
set
Sets the default height of the area to be fixed at the top of the Detail area.
type
declaring type Control
type ControlType
readonly
Returns the signature string of the Control's unique Type that can distinguish the Control. Please refer to ControlType for available constant values. For UDC controls, each unique type name is returned. Example: udc.MyUDC
uuid
declaring type Control
type String
readonly
Returns the unique ID of the control.
vScroll
type String
get
Returns the vertical scroll style.
set
Set the vertical scroll style.
[auto]: Scrolling is automatically set according to the amount of data in the detail area.
[scroll]: Scrolling is set regardless of the amount of data in the detail area.
[hidden]: Scroll is set to be invisible regardless of the amount of data in the detail area.
viewingMode
type ViewingMode
get
Returns the shape of the control placed in the detail area to be displayed in the viewing mode.
set
Sets the shape of the control placed in the detail area to be expressed in the viewing mode.
visible
declaring type VisibleUIControl
type Boolean
get
Returns the style property for controlling css visibility.
set
Sets the style property to control css visibility.
wheelRowCount
type Number
get
Returns the number of rows to scroll at a time with the wheel.
set
Sets the number of rows to scroll at a time with the wheel.

Methods

addColumn(column)
Add a grid column.
The added column is placed at the end.
The colIndex of the column to be added is written based on 0 base, or
It must be written with the colIndex corresponding to the position to be added.
Parameters
name type description
column IGridColumnLayoutConfig The column information you want to add.
addEventListener(type, listener)
declaring typeUIControl
Add listeners by EventType to the control.
Add a listener to the control to handle when a specific event occurs. 
var button = new cpr.controls.Button("btn01");
button.addEventListener("click", function(e) {
// event code...
});
Parameters
name type description
type String
listener (e: cpr.events.CEvent)=>Void
addEventListenerOnce(type, listener)
declaring typeUIControl
Add a listener to the control that will run only once per EventType.
Add a listener to the control to handle when a specific event occurs. The added listener is automatically deleted after running once. Since the object of the added listener is changed, when the listener is deleted It is an object returned after calling addEventListenerOnce and can be deleted. 
var button = new cpr.controls.Button("btn01");
button.addEventListenerOnce("click", function(e) {
// event code...
});
Parameters
name type description
type String
listener (e: cpr.events.CEvent)=>Void
return (e: cpr.events.CEvent)=>Void The modified Listener object.
bind(name)
declaring typeUIControl
Bind that property.
Parameters
name type description
name String
return IBindFactory Factory showing bind type.
blur()
declaring typeUIControl
Removes focus from the control.
cancelSelection()
If the current row/column/cell is being selected, deselect it.
If you cancel a selection, it reverts to the previous selection.
checkAllRow()
Set all checkboxes whose columntype is checkbox to check status.
checkAllTreeCheck()
Set all grid tree cell checkboxes to the checked state.
clearAllCheck()
Unchecks all checkboxes whose columntype is a checkbox.
clearAllRowHeight()
Removes any custom row height values ​​applied.
clearAllTreeCheck()
Set all grid tricell checkboxes to unchecked.
clearFilter()
Removes the filter applied to the currently connected data structure.
clearSelection(emitEvent)
Removes all current selections.
Parameters
name type description
emitEventoptional Boolean defaulttrue Whether to fire an event (before-selection-change, selection-change).
return Boolean
clearSort()
Removes sort applied to the currently connected data structure.
collapseAll(deep)
Collapse the entire row group.
If deep is set to false, only row groups of the first depth are collapsed,
Collapses the entire rowgroup if deep is set to true.
Parameters
name type description
deepoptional Boolean defaulttrue Whether to fold down to sub-depth rowgroups.
columnVisible(cellIndex, visible, unit)
Change the visible property of a specific cell(column).
All other connected cells or detail and footer on the same column line are also visible.
When moving a column, if there is a hidden column in the area to be moved, it is moved before the column located to the right of the displayed column.
(ex. [0(true), 1(false), 2(true), 3(true)]
If you move column 3 between 0 and 2, move to the front of column 2)
Parameters
name type description
cellIndex Number Header cell index to change visible property.(or column index)
visible Boolean The visible value to change.
unitoptional IndexUnit default"cell-index" Unit to apply (cell or column). [cell-index]: per cell, [column-index]: per column
commitData()
Makes all the changed data of the current grid as original data.
confirmEvent(e)
declaring typeUIControl
Determines whether to run the Control's Default Event Handler depending on the state of the Control.
Parameters
name type description
e CEvent event
return Boolean Whether the control's event handler is running.
deleteColumn(cellIndex)
Remove the grid column.
Parameters
name type description
cellIndex Number The header cell index to be removed.
deleteRow(rowIndex, emitEvent)
Delete a specific row.
Parameters
name type description
rowIndex Number | Number[] An array of row indexes or indexes to be deleted.
emitEventoptional Boolean defaulttrue Whether to fire an event (before-delete, delete).
dispatchEvent(e)
declaring typeUIControl
Forwards specific events.
Parameters
name type description
e CEvent
return Boolean Whether to continue processing the default action after propagating the event.
dispose()
Removes the objects contained in the control.
expandAll(deep)
Expand the entire row group.
If deep is set to false, only row groups of the first depth are expanded,
Expands the entire rowgroup if deep is set to true.
Parameters
name type description
deepoptional Boolean defaulttrue Whether to expand to sub-depth rowgroups.
filter(condition)
Change the filter condition on the currently connected data structure, and filter. It works the same as the setFilter method.
Parameters
name type description
condition #expression filter conditional expression.
findAllRow(condition)
Finds the Row that meets the condition and returns the corresponding GridRow array.
Parameters
name type description
condition #expression Conditional expression to search.
return GridRow[] A GridRow array that meets the conditions.
findFirstRow(condition)
Finds the first Row that matches the condition and returns the corresponding GridRow.
Parameters
name type description
condition #expression Conditional expression to search.
return GridRow A GridRow array that meets the conditions.
findParent(predicate, includeSelf)
declaring typeUIControl
Find the parent control.
If includeSelf is true, the parent including the self is found.
Parameters
name type description
predicate (c: cpr.controls.UIControl)=>Boolean
includeSelfoptional Boolean defaultfalse Whether you include yourself.
return UIControl Parental control.
focus(forward)
Assigns focus to the control.
Parameters
name type description
forwardoptional Boolean defaulttrue
focusCell(rowIndex, cellIndex)
Focuses the cell of the information that the user has delivered.
Parameters
name type description
rowIndex Number Row index.
cellIndex any cell index or column name.
focusNext()
declaring typeUIControl
Moves focus to the next control. If there are multiple structural elements that have focus inside a control, focus may transition to the next element.
focusPrevious()
declaring typeUIControl
Moves focus to the previous control. If there are multiple structural elements that have focus inside a control, focus may transfer to the previous element.
forEachOfGridCells(func)
The Grid Data is passed to the function that receives the attribute array for each cell in the order shown on the screen in row units (including header, detail, footer, group header, and group footer).
Attribute parameter information for each cell GridCellInfo[] : {
region: GRIDREGION, // Grid region information: header, middle(top ∪ middle ∪ bottom), footer, gheader, gfooter
dsRowIndex: number, // Row index in DataSet
cellIndex: number, // grid design cell index
rowIndex: number, // grid design row index
colIndex: number, // grid design column index
rowSpan: number, // grid design rowSpan
colSpan: number, // grid design colSpan
columnType: string, // normal, rowindex, checkbox
columnName: string, // dataset column name
value: string | number, // dataset value
text: string, // the text displayed on the screen
ctrl: UIControl // UIControl to which data is bound
}
Parameters
name type description
func (cellInfos: cpr.controls.GridCellInfo[])=>Void (cellInfos: GridCellInfo[]) => void
getActivateRowGroup(groupCondition)
Returns whether a specific group is active.
Parameters
name type description
groupCondition #column The grouping condition to check.
return Boolean Whether to activate.
getActualRect()
declaring typeUIControl
Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values ​​of 0 is returned.
return Rectangle About the position and size of controls in the HTML DOM
getActualRect(includeWrap)
declaring typeUIControl
Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values ​​of 0 is returned.
Parameters
name type description
includeWrap Boolean If this value is true, the layout of the parent group gets the area of ​​the node surrounding this control. If false, only get the area of ​​the control node.
return Rectangle About the position and size of controls in the HTML DOM
getActualRect(options)
declaring typeUIControl
Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values ​​0 is returned.
Parameters
name type description
options { includeWrap?: Boolean, scaled?: Boolean }
return Rectangle
getAppInstance()
declaring typeUIControl
Returns the App to which the control belongs.
return AppInstance App that belongs
getBindContext()
declaring typeUIControl
Returns the bind context.
return BindContext bind context
getBindInfo(name)
declaring typeUIControl
Returns the bind property information for the control.
Parameters
name type description
name String
return BindInfo BindInfo Properties
getCellBounds(region, rowIndex, cellIndex)
Get the bounds of a specific cell being displayed on the browser viewport.
Parameters
name type description
region String The region in which the cell to get the bounds is located. (ex. header, detail, footer, rowgroup)
rowIndex Number The row index where the cell to get bounds is located. Please enter null for header and footer.
cellIndex Number The cellIndex of the cell to get the bounds for.
return Rectangle
getCellIndex(columnName)
Returns the detail cell index through the column name mapped to the grid.
Parameters
name type description
columnName String Name of the mapped column.
return Number Detail cell index.
getCellIndicesByVisible(visible)
Returns the header cell index array corresponding to visible information.
Parameters
name type description
visible Boolean The visible value of the cell to be returned.
return Number[] Header cell index array corresponding to visible information.
getCellInfo(cellInfo)
deprecated2018.09.05 Returns information on a specific cell. Please use GridDetailBand#getColumn.
Parameters
name type description
cellInfo any The cell index or column name of the cell for which you want to retrieve information.
return { columnType: String, columnName: String, mergeToIndexExpr: String, mergedColumnName: String, suppressible: Boolean, suppressRef: String, control: cpr.controls.UIControl } \ {columnType: string, columnName: string, suppressible: boolean, suppressRef: string, control: UIControl} Returns null if no cell is found.
getCellText(rowIndex, cellIndex)
Returns the visible value of a specific cell.
Controls that support the "text" property return a text value, and other controls return a value.
If the columnType of a cell is a checkbox, Y or N is returned depending on whether or not it is checked.
Parameters
name type description
rowIndex Number The row index of the cell whose value you want to retrieve.
cellIndex Number Cell index of the cell to get the value.
return String Visible value of the cell.
getCellValue(rowIndex, cellIndex)
Returns the value of a specific cell (detail area).
Parameters
name type description
rowIndex Number The row index of the cell whose value you want to retrieve.
cellIndex any The cell index of the cell for which you want to retrieve the value. (Or bound data column name)
return Object The value of the corresponding cell.
getCheckRowIndices()
Returns the row index array currently checked.
return Number[] The row index array that is currently checked.
getColIndicesByVisible(visible)
Returns colIndex array corresponding to visible information.
Parameters
name type description
visible Boolean The visible value of the column to be returned.
return Number[] colIndex array corresponding to visible information.
getColumnLayout(includeColumnVisible)
Returns grid layout information.
You can set that information through setColumnLayout.
The information fetched is the cell order by cellIndex, the cell size, and the visible information of the cell.
Parameters
name type description
includeColumnVisibleoptional Boolean defaultfalse Whether to include visible information of column area in grid layout information.
return GridColumnLayout Grid layout information.
getColumnWidths()
Returns the width array of columns.
return String[] Column width array.
getConstraint(child)
Returns the constraint for this control.
Parameters
name type description
child UIControl The control you want to return.
return GridControlLayoutConstraint The corresponding constraint.
getContentRow(ctntRowIdx)
Returns the GridRow object at the row index shown.
Parameters
name type description
ctntRowIdx Number
return Object The GridRow object at the index.
getContentRowCount()
Returns the total number of rows in the grid.
This is the number of rows including gheader and gfooter added when using a row group.
return Number Number of rows.
getDataRow(dataRowIdx)
Returns the GridRow object of the actual data row index.
Parameters
name type description
dataRowIdx Number
return GridRow The GridRow object at the index.
getDataRowCount()
Returns the actual number of data rows.
Number of rows excluding header and footer added when using a row group.
return Number Number of rows.
getDetailCellIndices(headerCellIndex)
Returns the detail cell index in the column corresponding to the header cell index.
Parameters
name type description
headerCellIndex Number CellIndex of the header area cell.
return Number[] CellIndex array of detail area cells.
getDisplayItems(dataRows, detailCellIndex, filterText)
Deduplicates the value of a specific column in a specific data list and returns it as a json array in the form of label and value.
If there is a control, the displayText of the control will be the label and the actual value will be the value.
You can also return only result values ​​that contain specific text.
Parameters
name type description
dataRows DataRows A list of data to get values ​​from.
detailCellIndex Number The detail cell index from which to get the value.
filterText String Text to filter.
return { value: String, label: String }[] json array with displayText as label and actual value as value.
getEditRowIndex()
Returns the index of the row currently being edited in the grid.
return Number Rows in edit mode Index.
getExportData(option)
Returns Grid data in JSON format.
Parameters
name type description
optionoptional ExportOption Whether to exclude the style set in Grid when exporting. default true.
or export option.
exceptStyle: Whether or not to exclude styles when exporting. default true.
applyFormat : Whether to return the text with Format applied. default true. To export the number data type, the corresponding option must be given as false.
useFormat: Whether to use the format property of the file when exporting to an Excel file (xlsx, xls, etc.). default true.
applySuppress: Whether to reflect cell merging by suppress or mergedToIndexExpr when exporting to Excel. default false.
The rows option is not supported when setting applySuppress.
freezeHeader: Whether to freeze the header area of ​​the grid when exporting to Excel. default false.
reduce: Whether to remove unnecessary data. (ex. {}(empty json object)) default false.
excludeCellIndex : Header cellIndex array to be excluded when exporting. When setting excludeCols, include all cells that are set to visible=false.
excludeColIndex : Array of colIndex to be excluded when exporting. When setting excludeCols, include all cells that are set to visible=false.
rows : A specific row index array to be exported.
rowDataHandler(datas: CellData[], rowIndex: number) : A handler that can change the style or data of each row when exporting to Excel.
rowgroupStyleHandler(cellStyle: utils.CellStyle, region: gridpart.VLOC_REGION, cellIndex: number, columnName: string) : A handler that can change the style or format of each cell when exporting to Excel.
return ExportData Grid Data.
{ metadata: {password: string, printPageOrientation: "PORTRAIT" | "LANDSCAPE", wrapLineBreak: true | false},
name? : string,
freezepane? : {colsplit: number, rowsplit: number},
cols: {width: string} [],
rowgroups: {
region: string, // header, detail, footer, gheader, gfooter
style ?: {
type: string, // string | number
rowindex: number,
colIndex: number,
rowSpan: number,
colSpan: number,
style ?: {
[styleName: string]: (string | number)
}} [],
data: (string | number) [] []
} [] }
getFilter()
Returns the filter conditional expression set on the currently connected data structure.
return #expression filter conditional expression.
getFooterCellValue(cellIndex)
Returns the value of a specific cell (footer area)
Parameters
name type description
cellIndex Number Cell index of the cell to get the value.
return Object The value of the corresponding cell.
getFooterData()
Returns all the data for the footer.
return String[] footer area The data array of the cell.
getGridRowGroup(dataRowIndex)
Returns the GridRowGroup object that maps to a row when its rowIndex is a grouped row.
It can be used when TreeCell is arranged in Grid or when using row groups.
If there are multiple row groups, returns the row group closest to the row.
Parameters
name type description
dataRowIndex Number
return GridRowGroup A GridRowGroup object for the rowIndex.
getHeaderCellIndices(detailCellIndex)
Returns the header cell index in the column corresponding to the detail cell index.
Parameters
name type description
detailCellIndex Number CellIndex of the detail area cell.
return Number[] CellIndex array of header area cells.
getHtmlAttrNames()
declaring typeUIControl
Returns all custom DOM DATA attribute names.
return String[] An array of all custom DOM DATA attribute names.
getInitConfig()
Returns the grid initial setting information.
return GridConfig Grid initial setting information. Information corresponding to grid.init ().
getMaxRowHeight()
Returns the maximum row height set by the user when autoRowHeight is set.
return Number row max height.
getNextControl()
declaring typeUIControl
Returns the control to be moved by Tab Key or by the autoskip property.
return UIControl control.
getOffsetRect(includeWrap)
declaring typeUIControl
The area being displayed is obtained based on the parent container to which it belongs.
Parameters
name type description
includeWrapoptional Boolean defaultfalse If this value is true, the layout of the parent group gets the area of ​​the node surrounding this control. If false, only get the area of ​​the control node.
return Rectangle
getParent()
declaring typeUIControl
Gets the parent control.
return Container Parental control.
getPrevControl()
declaring typeUIControl
Shift + Tab Returns the focus to be moved through the key.
return UIControl control.
getRadioSelection()
Returns the row index in which columnType=radio is currently selected.
return Number The row index where columnType=radio is currently selected.
getRow(rowIndex)
Returns the GridRow object for this row index.
Parameters
name type description
rowIndex Number row index.
return GridRow The GridRow object at the index.
getRowCount()
Returns the number of rows.
return Number Number of rows.
getRowGroup(groupCondition, vloc)
Returns a RowGroup Band that meets the corresponding grouping criteria.
Parameters
name type description
groupCondition #column grouping condition
vloc "gfooter" | "gheader" grid area (header, footer)
return GridRowGroupBand A RowGroup Band object that meets the applicable grouping conditions.
getRowHeight(rowIndex)
If a user-defined row height is applied, the height of the applied row is returned; otherwise, the row height defined at design time is returned. User-defined row height is supported only for grids without automatic row height.
Parameters
name type description
rowIndex Number Index of the row to look up the row height
return Number[]
getRowState(rowIndex)
Returns the state of a specific row index.
Parameters
name type description
rowIndex Number The row index for which you want to know the status.
return RowState Status of the corresponding ROW index.
State type:
CPR.Data.tabledata.rowstate.UNCHANGED: Unchanged state.
CPR.Data.tabledata.rowstate.Inserted: A new row added.
CPR.Data.tabledata.rowstate.updated: The row is modified.
CPR.Data.tabledata.rowstate.deleted: The row is deleted.
CPR.Data.tabledata.rowstate.Insertdeleted: The row has been added and deleted.
getSelectedCellIndices()
Returns the currently selected cell information as an array.
It only works if the selectionUnit property is "cell".
return CellPosition[] Array of objects containing row index and cell index information of selected cells.
getSelectedColumnIndices()
Returns the currently selected column index array.
It only works if the selectionUnit property is "column".
return Number[] The selected column index array.
getSelectedIndices()
Returns the currently selected information.
Returns number [] if selectionUnit is row or column,
If the selectionUnit is cell, {rowIndex: number, cellIndex: number} [] is returned.
return Number[] | cpr.controls.gridpart.selection.CellPosition[] Selected information.
getSelectedRow()
Returns a GridRow object for the currently selected row. When multiple items are selected, the first GridRow object is returned.
Only works if the selectionUnit property is "row".
return GridRow One currently selected GridRow object. If no row is selected, null is returned.
getSelectedRowIndex()
Returns the index of the currently selected row.
If multiple items are selected, the first index is returned.
Only works if the selectionUnit property is "row".
return Number The index of the currently selected row. If no row is selected, -1 is returned.
getSelectedRowIndices()
Returns the currently selected row index array.
It only works if the selectionUnit property is "row".
return Number[] Selected row index array.
getSelectedRows()
Returns a GridRow object of the currently selected rows.
Only works if the selectionUnit property is "row".
return GridRow[] GridRow object of currently selected rows. If no row is selected, an empty array is returned.
getSelectionData(applyFormat)
Returns the currently selected data.
Parameters
name type description
applyFormatoptional Boolean defaultfalse When set to true, it returns a value containing the format of the control.
return String Selected data.
getSort()
Returns the sort conditional expression set on the currently connected data structure.
return #expression sort conditional expression.
getTreeCheckIndices(isAll)
Returns the row index that is checked in the checkbox of the current tree cell.
Returns null if no treecells exist in the grid.
Parameters
name type description
isAlloptional Boolean defaultfalse Whether to return the checked index of the entire row regardless of the tree cell folding state.
return Number[] Array of row indices currently checked in the tree cell.
getUnfilteredRows(targetColumn, sortCondition)
Returns the data list excluding the filter applied to the column in a specific column.
Parameters
name type description
targetColumn String Column name to exclude filtering.
sortCondition String Whether to align. (ASC, DESC)
return DataRows DataRows with no filter applied.
getUserAttrNames()
declaring typeControl
Returns all custom attribute names.
return String[] An array of all custom attribute names.
getViewingEndRowIndex(location)
Returns the index of the last row currently displayed.
Based on data index.
Parameters
name type description
locationoptional String default"middle" The location of the split detail area. (top / middle / bottom)
return Number
getViewingStartRowIndex()
Returns the starting row index of the currently visible rows.
Based on data index.
It is not supported for row anchoring. (topSplit, bottomSplit)
return Number
getVisualParentControl()
declaring typeUIControl
Gets the closest parent UI control. Unlike getParent(), it finds nearby parent controls, including external apps.
return UIControl
getWholeRenderingMode()
Returns whether or not to draw all areas that are not visible due to scrolling.
return String | false | true
hasFooter()
Returns the presence or absence of the footer area.
return Boolean presence or absence of footer area
hasHScroll()
Returns whether horizontal scrolling exists.
return Boolean The presence or absence of horizontal scrolling.
hasVScroll()
Returns whether vertical scrolling exists.
return Boolean The presence or absence of vertical scrolling.
htmlAttr(key, value)
declaring typeUIControl
Specifies custom DOM properties.
Parameters
name type description
key String The attribute name to assign
value String The attribute value to specify.
htmlAttr(key)
declaring typeUIControl
Returns a custom DOM property.
Parameters
name type description
key String The attribute name to get.
return String Custom properties.
htmlAttr(values)
declaring typeUIControl
Specify multiple custom DOM properties at once.
Parameters
name type description
values {[key:string]: String} A JSON object containing custom attribute keys/values.
htmlAttr()
declaring typeUIControl
Get all custom DOM properties in the form of a map.
return {[key:string]: String}
init(gridInfo)
Set grid initial properties and design information.
Previously connected controls are removed and cannot be reused.
Parameters
name type description
gridInfo GridConfig Grid configuration information.
insertColumn(column, cellIndex, after)
Add a column to a specific position on the grid.
The colIndex of the column to be added is written (recommended) based on 0 base, or
It must be written with the colIndex corresponding to the position to be added.
Parameters
name type description
column IGridColumnLayoutConfig The column information you want to add.
cellIndex Number cellIndex of the header cell to be added
after Boolean Whether to add before or after the header cell to be added. (true: after / false: before)
insertRow(rowIndex, after, emitEvent)
Adds a new row to the grid.
Parameters
name type description
rowIndex Number The row index you want to add.
after Boolean Whether to add before or after row index to be added (true: after / false: before)
emitEventoptional Boolean defaulttrue Whether to fire an event (before-insert, insert).
return GridRow The GridRow object for the added Row.
insertRowData(rowIndex, after, rowData, emitEvent)
Adds a new row to the grid.
Parameters
name type description
rowIndex Number The row index you want to add.
after Boolean Whether to add before or after row index to be added (true: after / false: before)
rowDataoptional {[columnName:string]: String} defaultnull The row data to add. (key: header name, json data with value: value)
emitEventoptional Boolean defaulttrue Whether to fire an event (before-insert, insert).
return GridRow The GridRow object for the added Row.
isAvailableBinding(name)
declaring typeUIControl
Returns whether the queried property is bindable and the binding has been configured to obtain a valid value. Even if no binding is configured and a simple value is specified, it is treated as configured so that a valid value is obtained. For example, binding to a row index that does not exist in the DataSet is an invalid binding.
Parameters
name type description
name String
return Boolean
isBindable(name)
declaring typeUIControl
Make sure it is a bindable property.
Parameters
name type description
name String
return Boolean Confirmation.
isCheckColumnEnabled(rowIndex)
deprecatedPlease use isEnabledTypedCell.
Returns whether the checkbox column of a specific row is activated.
Parameters
name type description
rowIndex Number
return Boolean Whether the checkbox is enabled.
isCheckedRow(rowIndex)
Returns whether the checkbox cell of the row of the rowIndex entered is checked.
Parameters
name type description
rowIndex Number Checkbox Row Index to check whether the cell is checked or not.
return Boolean Whether the row index is checked.
isEditing()
Returns whether the grid is currently being edited.
return Boolean Whether the current grid is being edited.
isEnabledTypedCell(columnType, rowIndex)
Returns whether a specific row of the column whose columnType is set is active.
Supported when the columnType is a checkbox or radio column.
Parameters
name type description
columnType String The columnType to return whether activated or not.
rowIndex Number Row index to return whether activated or not.
return Boolean Whether to activate.
isFloated()
declaring typeUIControl
Returns whether the control is floating through an app instance or a specific container.
return Boolean
isHeaderCheckColumnEnabled()
Returns whether the header checkbox column is enabled.
return Boolean Whether the checkbox is enabled.
isRadioColumnEnabled(rowIndex)
deprecatedPlease use isEnabledTypedCell.
Returns whether columnType=radio column of a specific row is enabled.
Parameters
name type description
rowIndex Number
return Boolean Whether radio is enabled.
isRadioSelected(rowIndex)
Returns whether columnType=radio of a specific Row is selected.
Parameters
name type description
rowIndex Number columnType=radi Row Index to check whether or not selected.
return Boolean Whether the corresponding row index is selected.
isSelectionStarted()
Returns whether the current row/column/cell is being selected.
return Boolean Whether you are choosing.
isShowing()
declaring typeUIControl
Returns the status that the screen is showing. Returns false if the visible state of all parents including itself is false.
return Boolean
isTreeChecked(rowIndex)
Returns whether the tricell checkbox present in the row of the input rowIndex is checked.
Returns null if no treecells exist in the grid.
Parameters
name type description
rowIndex Number Row Index to check whether or not the tree cell is checked.
return Boolean Whether the row index is checked.
isVisibleTypedCell(columnType, rowIndex)
Returns the visibility of a specific row of the column for which columnType is set.
Supported when the columnType is a checkbox or radio column.
Parameters
name type description
columnType String The columnType to return whether it is visible or not.
rowIndex Number Row index to return visibility.
return Boolean Visibility.
isWholeRenderingMode()
deprecatedPlease use getWholeRenderingMode.
Sets whether or not to draw all areas up to the invisible area due to scrolling.
true : wholeRenderingMode=true
false : wholeRenderingMode=false, "column"
return Boolean
makeRelativePoint(actualLocation)
declaring typeContainer
Converts browser viewport base coordinates to relative coordinates for this container.
Parameters
name type description
actualLocation Point Coordinate to convert
return Point
moveColumn(sourceHeaderIndex, targetHeaderIndex, before)
Change the location of a specific cell.
The header cell (source cell) to be moved or the header cell (target cell) located in the area to be moved If there are other cells connected by colSpan or rowSpan, all other connected cells move together.
Parameters
name type description
sourceHeaderIndex Number The header cell index to which you want to move.
targetHeaderIndex Number The header cell index located in the area to be moved.
beforeoptional Boolean defaulttrue Whether to move the header located in the moved area before or after.
moveToCell(rowIndex, cellIndex, isContentRowIndex)
Scroll to the location of the input cell.
When the grid is grouped, the RowIndex is an index that includes GroupHeader and GroupFooter. If the argument is an invalid value (rowIndex or cellIndex that does not exist), the scrolling of the corresponding row or cell is not moved. If the argument is the cell currently displayed on the screen, the scroll does not move. Do not move when entering cellIndex with visible = false.
Parameters
name type description
rowIndex Number Row index to move.
cellIndex Number The index of the detail cell to move.
isContentRowIndexoptional Boolean defaulttrue Identifies whether the row index targets the entire row including the rowgroup header/footer or the data row (true is all rows, false is data row).
openFilterDialog(headerCellIndex)
Open the filter popup.
The targetColumn of cell index must be set.
The filter pop-up is opened regardless of the filterable value of the cell index.
Parameters
name type description
headerCellIndex Number The target cell index of the filter popup.
redraw()
declaring typeContainer
Redraw the control.
removeAllEventListeners()
declaring typeControl
Removes all event listeners for the control.
removeAllHtmlAttr()
declaring typeUIControl
Delete all custom DOM DATA attributes.
removeAllUserAttr()
declaring typeControl
Delete all custom attributes.
removeEventListener(type, listener)
declaring typeControl
Remove Listener for each EventType in the control. 
control.removeEventListener ('click', listener);
Parameters
name type description
type String Event type.
listener (e: cpr.events.CEvent)=>Void Event listeners.
removeEventListeners(type)
declaring typeControl
Remove all EventType listeners from the control. 
control.removeEventListeners ('click');
Parameters
name type description
type String Event type.
removeHtmlAttr(key)
declaring typeUIControl
Removes the user-defined DOM DATA attribute for a specific attribute name.
Parameters
name type description
key String The custom DOM DATA attribute name to remove.
removeRadioSelection()
Uncheck columnType=radio.
removeUserAttr(key)
declaring typeControl
Removes user-defined attributes for a specific attribute name.
Parameters
name type description
key String The custom attribute name to remove.
replaceConstraint(child, newConstraint)
Replace the constraints of the control.
Existing constraints are replaced with parameter constraints.
region (grid area) and cellIndex (cell index) cannot be changed.
Parameters
name type description
child UIControl Target Control
newConstraint GridControlLayoutConstraint Constraints to change. (region, cellIndex properties cannot be changed)
return Boolean Successful change?
resetGrid()
Initialize the set Grid information.
Data related information is not initialized.
resizeColumn(cellIndex, width)
Change the width of a specific cell.
When resizing columns, the minimum size is 10px. When set to a size smaller than 10px, it is corrected to 10px.
The minimum size criteria is the rendered size, not the design size.
Parameters
name type description
cellIndex Number The header cell index you want to change.
width String The width to change.
revertData()
Recovers all changed data within the grid.
revertRowData(rowIndex)
Recovers data from specific rows that have changed within the grid.
Parameters
name type description
rowIndex Number Row index
scrollTo(left, top)
If the grid contains scrolling, it will scroll to that position.
Parameters
name type description
left Number The x-coordinate to scroll. (If set to -1, only the y-coordinate passed to top is set.)
top Number The y-coordinate to scroll. (If set to -1, only the x-coordinate passed to left is set.)
select(position, emitEvent)
Select row, column, or cell for the current selectionUnit.
Parameters
name type description
position { rowIndex?: Number, cellIndex?: any } | { rowIndex?: Number, cellIndex?: any }[] Selection information or array of selection information. Format: {rowIndex: number, cellIndex: number | string}
[]: Initialize selection information.
(Other incorrect value): Selection information is not set.
emitEventoptional Boolean defaulttrue Whether to fire an event (before-selection-change, selection-change).
return Boolean
selectCells(positions, emitEvent)
Select specific cells.
Previously selected cells are deselected.
It only works if the selectionMulti property is not "none" and the selectionUnit property is "cell".
Parameters
name type description
positions { rowIndex: Number, cellIndex: any } | { rowIndex: Number, cellIndex: any }[] Array that contains the row index and cell index (or column name) information of the cell to be selected.
[]: Initialize selection information.
(Other incorrect value): Selection information is not set.
emitEventoptional Boolean defaulttrue Whether to fire an event (before-selection-change, selection-change).
return Boolean
selectColumns(colIndices, emitEvent)
Select specific columns.
Previously selected columns are deselected.
It only works if the selectionMulti property is not "none" and the selectionUnit property is "column".
Parameters
name type description
colIndices Number | Number[] | String | String[]
emitEventoptional Boolean defaulttrue Whether to fire an event (before-selection-change, selection-change).
return Boolean
selectRadio(rowIndex)
Select columnType=radio for a specific row.
Parameters
name type description
rowIndex Number The row index to set.
selectRows(rowIndices, emitEvent)
Select specific rows.
Previously selected rows are deselected.
It only works if the selectionMulti property is not "none" and the selectionUnit property is "row".
Parameters
name type description
rowIndices Number | Number[] Row index or index array to select.
[]: Initialize the selected line.
(Other invalid values): Selection row not set.
emitEventoptional Boolean defaulttrue Whether to fire an event (before-selection-change, selection-change).
return Boolean
setActivateRowGroup(groupCondition, activate)
Activate or deactivate a specific group.
When activated (deactivated), the group is reconstructed according to the group criteria to be displayed.
Parameters
name type description
groupCondition #column grouping conditions.
activate Boolean Whether to activate.
setBindContext(context)
declaring typeUIControl
Sets the bind context. 
container.setBindContext({dataControl:grid.dataSet,rowIndex:rowIndex})
Parameters
name type description
context BindContext bind context
setCellValue(rowIndex, cellIndex, value, emitEvent)
Changes the value of a specific cell. (detail area)
Parameters
name type description
rowIndex Number The row index of the cell whose value you want to change.
cellIndex any The cell index of the cell whose value you want to change. (Or bound data column name)
value Object The value you want to change.
emitEventoptional Boolean defaulttrue Whether to trigger an event (before-update, update).
return Boolean Whether the value modification succeeded.
setCheckColumnEnabled(rowIndex, enabled)
deprecatedPlease use setEnabledTypedCell.
Set whether to activate the checkbox column of a specific row.
Parameters
name type description
rowIndex Number The row index to set.
enabled Boolean Whether the checkbox is enabled.
setCheckColumnEnabledForAllRows(enabled)
deprecatedPlease use setEnabledTypedCellForAllRows.
Sets whether to enable all checkboxes whose columnType is checkbox.
Set whether to enable or disable all columnType=checkboxes of header and detail.
Parameters
name type description
enabled Boolean Whether checkbox is enabled
setCheckRowIndex(rowIndex, checked)
Sets the value of the checkbox column for a specific row.
Parameters
name type description
rowIndex Number The row index to set.
checked Boolean The check value to set.
setColumnLayout(layout)
Set grid layout information.
You can set the information obtained through getColumnLayout.
The information to be set is the cell order by cellIndex, the size of the cell, and the visible information of the cell.
The columnLayout to be imported and the grid to be set must match the number of bands and the number of cells in the header, detail, footer, and rowgroup.
Parameters
name type description
layout GridColumnLayout Grid layout information.
setEditRowIndex(rowIndex, isCommit)
Switches the passed line to edit mode.
Parameters
name type description
rowIndex Number Index of the row to switch to edit mode.
-1: Edit line initialization.
(Other invalid values): Edit line is not set.
isCommitoptional Boolean defaulttrue Whether the data currently being edited is reflected in changes.
return Boolean
setEnabledTypedCell(columnType, rowIndex, enabled)
Set whether to activate a specific row of the column whose columnType is set.
Supported when the columnType is a checkbox or radio column.
Parameters
name type description
columnType String The columnType to set whether to enable.
rowIndex Number Row index to set whether to enable or not.
enabled Boolean Enabled or not to set.
setEnabledTypedCellForAllRows(columnType, enabled)
Set whether to activate all rows of the column whose columnType is set.
Supported when the columnType is a checkbox or radio column.
Parameters
name type description
columnType String The columnType to set whether to enable.
enabled Boolean whether to activate
setFilter(condition)
Change the filter condition on the currently connected data structure, and filter. It works the same as the filter method.
Parameters
name type description
condition #expression filter conditional expression.
setFilterDialogMatcher(matcher)
Set the matching method when searching within the grid filter popup.
Parameters
name type description
matcher (label: String, filterText: String, columnName: String)=>Boolean Matching method.
The parameters provided are as follows.
label(string): Data displayed in the filter pop-up list.
filterText(string): The text entered into the search input.
columnName(string): (optional) The column name of the current column.
setFooterData(data)
Change all data in the footer area.
Parameters
name type description
data String[] The data array to change.
setHeaderCheckColumnEnabled(enabled)
Set whether to enable header checkbox column.
Parameters
name type description
enabled Boolean Whether the checkbox is enabled.
setLeftSplitCellIndex(headerCellIndex)
Set leftSplit through header cellIndex.
leftSplit is automatically updated.
Parameters
name type description
headerCellIndex Number Header cellIndex to set.
setMaxRowHeight(height)
Set the maximum row height when setting autoRowHeight.
The maximum row height must be smaller than the height of the area (top, middle, bottom) where the row is placed.
Parameters
name type description
height Number row max height.
setNextControl(nextControl)
declaring typeUIControl
Sets the control to be moved by Tab Key or by the autoskip property.
Parameters
name type description
nextControl UIControl control.
setPrevControl(prevControl)
declaring typeUIControl
Shift + Tab Set the focus to be moved through the key.
Parameters
name type description
prevControl UIControl control.
setRadioColumnEnabled(rowIndex, enabled)
deprecatedPlease use setEnabledTypedCell.
Set whether to enable columnType=radio for a specific row.
Parameters
name type description
rowIndex Number The row index to set.
enabled Boolean Whether to enable radio to set.
setRadioColumnEnabledForAllRows(enabled)
deprecatedPlease use setEnabledTypedCellForAllRows.
Set whether to activate all radios with columnType=radio.
Parameters
name type description
enabled Boolean Whether radio is enabled
setRightSplitCellIndex(headerCellIndex)
Set rightSplit through header cellIndex.
rightSplit is automatically updated.
Parameters
name type description
headerCellIndex Number Header cellIndex to set.
setRowHeight(rowIndex, rowHeight)
User-defined row height is supported only for grids without automatic row height. If the row height to be changed is specified as null, the previously applied value is deleted.
Parameters
name type description
rowIndex Number Index of row to change height
rowHeight Number[] Row height array. If there are multiple grid detail rows, specify the height of each row as an array. (ex. [20], [20, 30])
setRowState(rowIndex, state)
Changes the state of a specific row index.
Parameters
name type description
rowIndex Number The row index you want to change.
state RowState State value to change.
State type:
CPR.Data.tabledata.rowstate.UNCHANGED: Unchanged state.
CPR.Data.tabledata.rowstate.Inserted: A new row added.
CPR.Data.tabledata.rowstate.updated: The row is modified.
CPR.Data.tabledata.rowstate.deleted: The row is deleted.
CPR.Data.tabledata.rowstate.Insertdeleted: The row has been added and deleted.
setTreeCheckIndex(rowIndex, checked, checkMode)
Check or uncheck the tricell checkbox of a specific row in the grid.
Parameters
name type description
rowIndex Number The row index to set.
checked Boolean The check value to set.
checkModeoptional TreeCellCheckMode default"single" Check mode.
[single]: Change only the check status of the set row
[auto]: Change the check status according to the checkType applied to the tree cell.
setVisibleTypedCell(columnType, rowIndex, visible)
Sets the visibility of a specific row of the column for which columnType is set.
Supported when the columnType is a checkbox or radio column.
Parameters
name type description
columnType String The columnType to set visibility to.
rowIndex Number Row index to set visibility.
visible Boolean Whether visibility to set.
setVisibleTypedCellForAllRows(columnType, visible)
Set whether all rows of the column whose columnType is set are visible.
Supported when the columnType is a checkbox or radio column.
Parameters
name type description
columnType String The columnType to set visibility to.
visible Boolean
setWholeRenderingMode(mode)
Set whether to draw all invisible areas outside the scroll viewport.
[true]: Both row and column are drawn to areas that are not visible due to scrolling.
[false]: Areas where rows and columns are not visible due to scrolling are not drawn.
["column"]: Only the column is drawn to the invisible area by scrolling, and the row is not drawn to the invisible area.
Parameters
name type description
mode String | false | true true|false|"column"
sort(condition)
Change the sort condition on the currently connected data structure and sort it.
Parameters
name type description
condition #expression sort conditional expression.
unbind(name)
declaring typeUIControl
Unbind that property.
Parameters
name type description
name String
updateConstraint(child, overridingConstraint)
Change the Control's Constraints.
Only the items included in Parameter Constraints are changed.
region (grid region) and cellIndex (cell index) cannot be changed.
Parameters
name type description
child UIControl Target Control
overridingConstraint GridControlLayoutConstraint Constraints to change. (region, cellIndex properties cannot be changed)
return Boolean Successful change?
updateRow(rowIndex, rowdata, emitEvent)
Changes the data for a specific row.
Parameters
name type description
rowIndex Number The row index you want to change.
rowdata {[columnName:string]: String} The row data you want to change. (ex: {[columnName: string]: string}
emitEventoptional Boolean defaulttrue Whether to trigger an event (before-update, update).
return Boolean Whether the value modification succeeded.
userAttr(key, value)
declaring typeControl
Specifies custom properties.
Parameters
name type description
key String The attribute name to assign
value String The attribute value to specify.
userAttr(key)
declaring typeControl
Returns a user-defined property.
Parameters
name type description
key String The attribute name to get.
return String Custom properties.
userAttr(values)
declaring typeControl
Specify multiple custom properties at once.
Parameters
name type description
values {[key:string]: String} A JSON object containing custom attribute keys/values.
userAttr()
declaring typeControl
Get all custom properties in the form of a map.
return {[key:string]: String}
userData(key, value)
declaring typeControl
Specifies custom data. Unlike user-defined attributes, you can use arbitrary types in addition to strings. When the control is dispose, all custom data is removed.
Parameters
name type description
key String The key of the data to be specified.
value Object Data to specify.
userData(key)
declaring typeControl
get custom data
Parameters
name type description
key String The key of the data to get.
return Object
userData(override)
declaring typeControl
Specifies multiple user-defined data.
Parameters
name type description
override {[key:string]: Object} A JSON object containing user-defined data.
userData()
declaring typeControl
Get all your custom data.
return {[key:string]: Object}
userattr()
declaring typeControl
deprecatedPlease use userAttr.
Returns a user-defined property.
return Object Custom properties.