WebSquare.uiplugin.gridView

GridView. Renders large-volume data on a grid.
The user can display or edit large-volume data on grid.
The GridView must be bound with a DataList.
Provide various features - sub-total, grand-total, dynamic grouping, Excel Upload/Download, sorting, filtering, etc.
The top level uses the <div> tag under which the <table> and other tags are used.
Use column ID or header ID in the APIs of gridView.column.

Type

uiplugin

Property Summary

adaptive: Adaptive web design mode (in which page layouts adapt to the screen sizes and the device types.)
adaptiveThreshold: A threshold at which the layout enters the adaptive mode.
alwaysTriggerScrollStart: Triggers the onscrollstart event every time that the scroll reaches the first row of the GridView. (Options) "true" : Triggers the onscrollstart event every time reaching the first first row of the GridView. "false" (Default) : Triggers only once.</xmp>
applyAllColumnStyle: Applies all styles defined in the column.
arrowMove: Allows the end user to move to the next cell at the last character in the cell or to the previous cell at the first character in the cell using arrow keys. (Options) "true": Allows moving. "false" (Default) : Prevents moving.</xmp></xmp>
autoFit: Evenly distribute all columns of the GridView to fill up the full width of the GridView. [default: none, lastColumn, allColumn]
autoFitMinWidth: Minimum width of the GridView to apply autoFit="allColumn" setting. (Unit: px)
captionAuto: Combines the CaptionTitle with the header title of the table and displays it as the table title. false (Default) : Does not display.
captionTitle: Text to be displayed before the header title.
checkDisabledOnCut: Allows cutting through Ctrl (or cmd)+X in disabled="true" columns.
checkEditableInputClass: Removes "w2grid_input" class from nobr tag in case the cell is readOnly or disabled in the inputType = "text" column.
checkReadOnlyOnCut: Allows cutting through Ctrl (or cmd)+X in readOnly="true" columns.
checkReadOnlyOnPaste: Allows pasting through Ctrl (or cmd)+V in readOnly="true" columns.
checkReadOnlyOnPasteEnable: Set the columns to apply checkReadOnlyOnPaste="false".
class: Same as the class property in HTML.
columnMove: Allows column moving through header dragging.
columnMoveWithFooter: Moves the column and the footer. [default: false, true]
contextMenu: Uses the context menu.
contextMenuAltClick: Displays the context menu upon Alt + mouse left-clicking.
copyOption: When copying Gridview data, decide which value to copy - those defined in the DataList (“dataList”) or those currently display (“display”).
customFilterBox: Keeps the use-defined filter after groupby(); being executed. [default: false, true]
dataDragDrop: Allows dragging-n-dropping between the GridViews. [true, false]
dataDragSelect: Allows cell selection through dragging. [true, false]
dataDragSelectAutoScroll: Allows automatic scrolling when the mouse move out of the browser while multiple cells are dragged and selected (dataDragSelect="true").
dataDragSelectAutoScrollLevel: Time to double the current scrolling speed when the dataDragSelectAutoScroll is enabled. (Unit: ms) [default: 1300]
dataDragSelectAutoScrollPeriod: Scrolling interval when the dataDragSelectAutoScroll is enabled. (Unit: ms) [default: 70]
dataList: ID of the DataList to bind with the GridView component data.
defaultCellHeight: Default cell height
disabledBackgroundColor: Background color of the disabled (disabled="true") cell or row.
disabledFontColor: Font color of the disabled (disabled="true") cell or row.
disabledScrollHidden: Hides the scroll when disabled. [default: false, true]
dragDisplayColumn: Column ID to display on the tooltip when dragging data (dataDragDrop="true").
dragEndFunction: The function to be executed upon the end user's finishing dragging.
dragStartFunction: The function to be executed upon the end user's starting dragging.
drilldownToggleScrollFix: Fixes the scroll upon the end user’s opening the list by clicking + button on the drilldown column.
dynamic: Dynamically thorugh setGridStyle. [default: false, true]
editModeEvent: Mouse action event to edit the cell data.
editModeEventIcon: Mouse action to edit cell data in the viewType="icon" column.
enterKeyMove: Focus-moving direction upon end user’s pressing the Enter in the cell.
escape: Converts <>&" characters into HTML Escape characters.
euroMask: Masking value to be applied when the dataType is "euro" or when the changeCurrency API is used.
evenRowBackgroundColor: Background color of the even rows
excludeDeletedRows: Excludes the deleted rows when calculating subtotal and total in the footer.
excludeModifiedRows: Excludes the rows of which status has been changed to “d” by modifyRowStatus API from subtotaling and totaling (in the foot) expressions.
fastScroll: Adds fast scrolling effects to vertical scrolling.
filterBoxvisibleRowNum: Number of the conditions to be displayed on the filtering condition list
filterFocusMode: Whether to remove the focus or not on the selected cell or row in the body before the sorting event is triggered.
filterShowAlways: Shows the filtering icon first when the width of the column with useFilter=true setting is small.
fixedColumn: Column to fix.
fixedColumnNoMove: Allows moving (columnMove) of the column that is fixed by fixedColumn property.
fixedColumnScrollHidden: Hides the scroll on the fixed columns.
fixedColumnWithHidden: Includes the hiddenColumn when calculating the position of the fixedColumn property.
fixedRow: Rows to fix.
focusDefaultColumn: When set as true, both the rowNum and the rowStatus columns can get the focus.
focusFlow: Sets the focus-flowing directions.
focusMode: Mode to display the focusing in the cell.
focusMove: Ignores the focus upon moving by the arrow keys.
footerCaption: Footer caption.
footerCaption: caption of the grid footer
footerCaptionAuto: Automatically generates the footer text for the footerCaption property regardless of the captionAuto setting. [default: false, true] (Related Property) captionTitle footerCaption</xmp></xmp>
footerSummary: Summary of the footer.
footerSummary: grid footer summary
footerSummaryAuto: Automatically generates footer in the footer summary regardless of the captionAuto setting. [default: ""(Empty string)] (Related Property) captionTitle footerSummary</xmp></xmp>
groupbyFilterBox: Displays the filtering conditions when using the groupby (filtering) feature.
groupbyFilterBoxFormatter: Formats the labels to be displayed on the filtering condition list (groupbyFilterBox).
groupbyFilterBoxLocation: Location of the filtering condition box (groupbyFilterBox). (Options) "top" : Display at the top. “bottom” (Default): Display at the bottom.</xmp></xmp>
groupbyMaxCount: Set the maximum number of the columns to which groupby can be applied.
groupbyZone: Uses groupby feature or not.
groupbyZoneHeight: Height of groupbyZone.
groupbyZoneMessage: Message to display when the groupbyZone is in initial state.
hammerEnabled: Hammers the dblclick event in the mobile.
hammerPressTime: Time to hold until the press event is triggered.
hideHeader: Hides the header.
id: Component ID
ignoreCellClick: Ignore cell clicking.
ignoreNonEditableCell: Ignores Tab or Enter key pressing when cell editing is not allowed.
ignoreNonEditableCellTabEnter: Allows moving between readOnly cells when the ignoreNonEditableCell is “true”.
ignoreToggleOnDisabled: Ignores toggle image clicking on a disabled cell upon drill-down.
initFixedHeightByRowNum: Initializes the GridView height based on the number of the rows of the initially rendered GridView.
keepDefaultColumnWidth: Fixes rowNum and rowStatus columns when autoFit is used.
keyMoveEditMode: Immediately enters the editing mode upon the end user’s pressing Tab or Enter key moving the focus.
loadCount: Number of the remaining rows to trigger the onscrollend event.
mergeCells: Merges adjacent cells of the same data in the same row or on the same column.
mergeCellsFixedCols: Merges adjacent cells with the same data in the fixedColumn.
mergeCellsFixedRows: Merges adjacent cells with the same data in the fixedRow.
mergeCol: Specify columns to apply the mergeCells property.
moveKeyEditMode: Immediately enters the editing mode upon the end user’s pressing Up or Down keys moving the focus.
moveKeyEditModeAll: Enter the editing mode upon the end user’s pressing Up, Down, Left, and Right key moving the focus. [default: false, true] (Options) "true": Enters the editing mode upon the end user’s pressing Up, Down, Left, and Right keys. "false" (Default) : Moves the focus only upon the end user’s pressing Up, Down, Left and Right keys. </xmp></xmp>
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
noResultMessage: Message to display when there is no search result. (When there is 0 data in the DataList.)
noResultMessageClass: Class to apply to the noResultMessage. (When there is 0 data in the DataList.)
noResultMessageStyle: Class to apply to the noResultMessage. (When there is 0 data in the DataList.)
noResultMessageVisible: Message to display when there is no search result. (When the DataList has 0 data.)
noSelect: Prevents cell text selection through mouse dragging (useCtrlKey="true") (useShiftKey="true").
numberMask: Masking value to be applied when the dataType is "number" or when the changeCurrency API is used.
oddEvenColorDisplay: Uses different colors in odd and even rows.
oddRowBackgroundColor: Background color of the odd rows
overflowX: Uses horizontal scrolling.
overflowY: Uses vertical scrolling.
pasteOption: Pastes the data to the clip board through Ctrl (or cmd) + V.
preventAddRowOnPaste: Prevents adding of a new row upon pasting data from the clipboard through Ctrl (or cmd)+V.
preventCopy: Prevents copying of the GridView data through Ctrl (or cmd)+C or Ctrl (or cmd)+X. [default: false, true]
preventCopyColumn: Column ID to prevent copying of the data to the clipboard through Ctrl (or cmd) + C.
preventMultisort: Prevent multiple-sorting.
preventPaste: Prevents pasting of the data to the clip board through Ctrl (or cmd) + V.
preventPasteColumn: Column ID to prevent pasting of the data to the clipboard through Ctrl (or cmd) + V.
readOnly: Allows reading only. [default: false, true]
readOnlyBackgroundColor: Background color of the cell of which readOnly property is true.
readOnlyBackgroundImg: Path of the cell background image of which readOnly property is true.
readOnlyBackgroundImgCSS: Path of the cell background image of which readOnly property is true.
readOnlyPriority
readOnlyTabIgnore: Ignores readOnly cell upon Tab key being pressed.
resize: Allows column width adjustment through column dragging.
rowMouseOver: Displays the background color of the currently moused-over row.
rowMouseOverColor: Background color of the row upon the end user's hovering the mouse over the row.
rowNumBackgroundColor: Background color of the Body column.
rowNumHeaderValue: Header text.
rowNumLocaleRef: localeRef key to set in the rowNum column.
rowNumStatusResize: Allows resizing of the widths of rowNum and rosStatus columns.
rowNumStatusUniqueId: Uses unique IDs when rowNum and rowStatus columns are used. [default: false, true]
rowNumVisible: Displays the row numbers based on the data of the bound DataList.
rowNumWidth: Width of the rowNum column when rowNumVisible is "true".
rowStatusHeaderValue: Header text.
rowStatusLocaleRef: localeRef to set in the rowStatus column.
rowStatusVisible: Displays row status (Add/Modify/Remove) on a separate column.
rowStatusWidth: Width of the rowStatus column when rowStatusVisible is "true".
rupeeMask: Masking value to be applied when the dataType is "rupee" or when the changeCurrency API is used.
scrollByColumn: Horizontally scrolls by column.
scrollByColumnAdaptive: Moves scrolls by column in the adaptive mode.
selectedCellColor: Background color of the selected cell.
selectedCellOverColor: Background color of the cell to be displayed upon the end user’s hovering the mouse over the cell.
selectedRowColor: Background color of the selected cell
selectedRowOverColor: Background color of the row to be displayed upon the end user’s hovering the mouse over the cell.
senseReader: A mode to support web accessibility requirements. [default: false, true] (Options) "false" (Default) "true": Allows the end user to rotate through all cells using the Tab key. </xmp></xmp>
setCellInputTypeCustom: An option to dynamically change the inputType of the cell of which inputType is custom.
showImageTooltip: Displays the tooltip for inputType = "image".
showSortableImage: Shows sorting images on the header of the sortable column.
showSortableUseFilter: Displays the sortable and the useFilterList icons on the header when both the useFilterList and the showSortableImage properties are in use. [default: false, true] (Options) "true": Displays both the user-defined filter icon and the sorting icon. "false" (Default) : Display only the sorting icon.</xmp></xmp>
sortable: Whether to support data sorting by the end user's clicking the header on the GridView component.
sortedIconPosition: Position to show the sorting icon.
sortEvent: Define the sorting events. [default: ondblclick, onclick]
sortOrderReverse: Sorts the data in descending powers first upon user's clicking the header.
summary: Similar to the summary property of the table tag in HTML.
summaryAuto: Automatically sets the header column name in the summary to support web accessibility.
summaryOnlyAuto: Sets the summary only with text without tags if the header title includes HTML. [default: false, true] (Options) "true": Sets the text only without the HTML tag as the summary. "false" (Default) : Sets the text and the HTML tag as the summary.</xmp></xmp>
syncScroll: Scrolls down multiple GridViews at the same time.
syncScrollId: ID of the GridView to synchronize scrolling.
tengeMask: Masking value to be applied when the dataType is "tenge" or when the changeCurrency API is used.
titleAuto: Disable the component. [default: false, true]
titleFormatter: Uses the user-define value as the title. [default: false, true]
tooltipDisplay: Displays hidden data as a tooltip when the data is not fully displayed.
tooltipDisplayColumn: Sets the column name to display tooltip on certain columns
tooltipFormatter: Name of the function to format the tooltip contents when the tooltipDisplay is “true”.
tooltipFormatterHeader: Name of the user-defined function to format the tooltip contents when the tooltipDisplay is “true”.
tooltipHeader: Provides multi-language support. [default: false, true]
tooltipHeaderShowAlways: Always shows the tooltip upon the end user’s hovering the mouse regardless of the text length. [default: false, true]
tooltipPositionX: X coordinate of the tooltip. (Unit: px) [default: 20]
tooltipPositionY: X coordinate of the tooltip. (Unit: px) [default: cellHeight+3]
tooltipShowAlways: Always shows the tooltip. [default: false, true]
tooltipShowAlwaysColumns: Columns to display tooltip always. [default: ""]
useCtrlKey: Allows selection of multiple cells through using the Ctrl key.
useCtrlOnMultisort: Allows selection of multiple columns using Ctrl key to sort multiple columns.
useFilterList: Displays the filter list. [default: false, true]
useFilterListSync: Displays the filter done by setFilter(); or setColumnFilter(); function of the DataList. [default: false, true]
useLocale: Multilanguage support
userData1: User-defined property.
userData2: User-defined property.
userData3: User-defined property.
useShiftKey: Whether to allow selection of multiple cells through the use of the Shift key.
visibleRowNum: Number of the rows to be displayed on the screen.
visibleRowNumFix: Automatically adjusts the initial height of the GridView according to the visibleRowNum or initFixedHeightByRowNum setting. [default: true, false]
wheelRows: Number of the rows changing upon the end user's clicking the vertical scrolling bar each time.
wheelStop: Stops scrolling although the user moves the mouse wheel when the scroll is at the bottom.

Event Summary

onaftercolumnmove: Triggered right after a column moving.
onaftercolumnresize: Triggered right after column resizing.
onafteredit: Triggered upon the focus moving of the cell after editing is done.
onbeforecolumnmove: Triggered right before column moving.
onbeforeedit: Triggered before entering into the cell editing mode.
onbeforesort: Triggered right before column sorting. Returns the sorting status.
onblankclick: Triggered upon end user’s clicking empty part within the GridView.
onbodymouseout: Triggered when the mouse moves out of the GridView body.
onbodymouseover: Triggered upon the end user's hovering the mouse over the body.
oncellclick: Triggered upon the end user's clicking the cell.
oncelldblclick: Triggered upon cell being double-clicked.
oncellindexchange: Triggered upon the end user's selecting a cell and changing the cell through the use of an arrow key, mouse clicking, or a method.
oncolumnindexchange: Triggered upon the end user's selecting a cell and changing the column through the use of an arrow key, mouse clicking, or a method.
oncolumnwidthchange: Triggered upon a change in the column length.
oncustomcopy: Define an event to replace the copy event of the GridView.
oncustompaste: Define an event that will replace the paste event of the GridView.
ondatadragover: Triggered upon data being moved over another Gridview when the dataDragDrop is “true”.
ondatadragstart: Triggered upon data dragging when the dataDragDrop is “true”.
ondatadrop: Triggered upon the data being dropped on another GridView when the dataDragDrop is “true”.
ondateselect: Triggered upon selection of a date when the inputType is “calendar”.
oneditdblclick: Triggered upon the end user’s double-clicking the cell being edited.
oneditend: Triggered upon the end user's finishing editing the cell data. Triggered before the onafteredit.
oneditkeydown: Triggered upon the end user’s pressing the key while a cell is being edited.
oneditkeyup: Triggered upon the end user's releasing a key off the keyboard after pressing the key.
onfilereadend: Triggered after an Excel file is uploaded to the GridView component.
onfooterclick: Triggered upon the footer being clicked.
onheaderclick: Triggered upon the header being clicked.
onheaderdblclick: Triggered upon the end user's double-clicking the header.
onkeydown: Triggered upon the end user's pressing a key on the keyboard.
onkeyup: Triggered upon the end user's releasing a key off the keyboard after pressing the key.
onmonthselect: Triggered upon selection of a date when the inputType is “calendar”.
onrightbuttonclick: Triggered upon the end user's right-clicking the cell in the body part.
onrowindexchange: Triggered upon the end user's selecting a cell and changing the row of the selected cell through the use of an arrow key, mouse clicking, or a method.
onrownumclick: Triggered upon the rowNum column being clicked.
onrowstatusclick: Triggered upon the rowStatus column being clicked.
onscrollend: Triggered when the vertical scrolling reaches the bottom.
onscrollstart: Triggered when the vertical scrolling reaches the top.
onscrollx: Triggered upon the end user's horizontal scrolling.
onscrolly: Triggered upon the end user's vertical scrolling.
onsort: Triggered upon a change in the sorting method by clicking or double-clicking on the sorted header.
onsubtotalclick: Triggered upon clicking of the subtotal.
onsubtotaldblclick: Triggered upon double-clicking of the subtotal.
ontextimageclick: Triggered when the image of which inputType is textImage is clicked.
ontoggleclick: Triggered upon clicking of the toggling button when the inputType is drilldown.
onviewchange: Triggered when the value on the list is changed through keyboard input or mouse clicking.
onyearselect: Triggered upon selection of a date when the inputType is “calendar”.

Method Summary

advancedExcelDownload( options , infoArr ): Saves the grid data as an Excel file.
advancedExcelUpload( options ): Reads an Excel file, and sets the read data in the GridView. (Supported for JDK 1.5 or higher.)
changeCurrency( columnID , dataType , displayFormat , delimiter , decimalDelimiter ): Dynamically changes the monetary unit in the cell displayed on the column basis.
checkAll( colIndex , dataValue ): Selects or unselects all rows with checkboxes.
clearAutoFit( ): Removes the autoFit property.
clearGroupby( ): Cancels the groupBy setting.
clearRowVisible( ): Shows all rows hidden by the setRowVisible API.
drillTo( rowIndex ): Opens all parent rows when showing the row of the given row index through drilldown.
getAllDisplayData( ): Returns the currently displayed data as a one-dimensional array. (displayFormat-applied data.)
getAllDisplayJSON( ): Returns the currently displayed data as JSON data. (displayFormat-applied data.)
getAllDisplayXML( ): Returns the currently displayed data as XML data. (displayFormat-applied data.)
getAllFocusedIndex( ): Returns rowIndex and colIndex of the selected cells.
getAllFocusedRowIndex( ): Returns rowIndex of the focused cells selected by the Ctrl key.
getAllVisibleData( ): Returns the currently displayed data as a one-dimensional array (being filtered).
getAllVisibleJSON( ): Returns the currently displayed data as JSON data. (displayFormat-applied data.)
getAllVisibleXML( ): Returns the currently displayed data as an XML (being filtered).
getAncestorRowIndexArray( rowIndex ): Returns the rowIndex of all parents of the specified row to support drill-down.
getBottomRowIndex( ): Returns rowIndex of the lowest row on the currently visible GridView component.
getCellBackgroundColor( rowIndex , colIndex ): Returns the background color of the cell of the corresponding rowIndex and the corresponding colIndex.
getCellChecked( rowIndex , colIndex ): Returns whether the cell of the corresponding rowIndex and the colIndex is checked or not.
getCellClass( rowIndex , colIndex ): Returns the name of the user class dynamically applied to the Grid cells.
getCellColor( rowIndex , colIndex ): Returns the Text color of the cell of the corresponding colIndex and the rowIndex.
getCellDisabled( rowIndex , colIndex ): Returns the value of the disabled property of the cell of the corresponding colIndex and the rowIndex.
getCellDisplayData( rowIndex , colIndex ): Returns the displayed data of the cell of the corresponding rowIndex and the colIndex (with displayFormat being applied).
getCellPosition( row , colIndex , propertyName ): Returns the position of the cell (top or left).
getCellReadOnly( rowIndex , colIndex ): Returns the value of the readOnly property of the cell of the corresponding colIndex and the rowIndex.
getCellSize( row , colIndex , sizeName ): Returns the cell size (width or height).
getCheckedData( colIndex ): Returns the data of the checked row as an array when the column is of the corresponding colIndex and is a Radio or CheckBox component. If the column is not a Checkbox component, an empty array will be returned.
getCheckedIndex( colIndex ): Returns the index of the checked row as an array when the column is of the corresponding colIndex and the inputType property of the column is Radio or Checkbox.
getCheckedJSON( colIndex ): Returns the JSON data of the checked row as an array when the column of the corresponding colIndex is a Radio or Checkbox.
getCheckedXML( colIndex ): Returns the data of the checked row as an XML when the column of the corresponding colIndex is a Radio or CheckBox.
getChildrenRowIndexArray( rowIndex ): Returns the rowIndex of the children (one-depth below) of the row of the corresponding rowIndex as an array when drilling-down is enabled.
getColIdByHeaderId( headerId ): Returns the columnId of the body corresponding to the columnId of the header.
getColumnBackgroundColor( colIndex ): Returns the background color of the column of the corresponding colIndex.
getColumnColor( colIndex ): Returns the Text color of the column of the corresponding colIndex.
getColumnDataListInfo( colIndex ): Returns the dataList bound with the column of the specified colIndex.
getColumnDisabled( colIndex ): Returns the value of the disabled property of the row of the corresponding colIndex.
getColumnID( colIndex ): Returns the value of the disabled property of the column of the corresponding colIndex.
getColumnIdListMultiRow( ): Returns all column IDs of the GridView as two-dimensional array data.
getColumnIndex( colIndex ): Receives the column ID, and returns the corresponding column index.
getColumnNodeSet( colIndex ): Returns the nodeset of the column when the inputType = "select" or "autoComplete".
getColumnOrder( byName ): Returns the current sequence of the columns as an array.
getColumnReadOnly( colIndex ): Returns the value of the readOnly property of the column of the corresponding colIndex.
getColumnType( colIndex ): Returns the inputType of the colIndex column.
getColumnVisible( colIndex ): colIndex에 해당하는 열의 visible여부를 반환
getDataDragDrop( ): Returns the dataDragDrop setting.
getDataLength( ): [deprecated] Use getRowCount() instead.
getDataList( ): Returns the Id of the currently bound DataList.
getDataListInfo( ): Returns the dataList bound with the component.
getDataType( colID ): Returns the dataType of the column.
getDescendantRowIndexArray( rowIndex ): Returns rowIndex of all children of the specified row to support drill-down.
getDisabled( type , rowIndex , colIndex ): Returns the value of the disabled property according to the type.
getFixedColumnLastIndex( includeDefaultColumn ): Returns the most right column index among the fixed columns.
getFixedRightColumnLastIndex( ): returns the most right column index among the fixed right columns when the FixedRightColumn property is set.
getFixedRow( ): Returns the location of the fixed row when the GridView is horizontally fixed.
getFocusedColumnID( ): Returns the ID of the column of the currently focused cell.
getFocusedColumnIndex( ): Returns the colIndex of the currently focused cell.
getFocusedRowIndex( ): Returns the rowIndex of the currently focused cell.
getFocusedRowStatus( ): Returns the status of the row in which the currently focused cell exists in status string.
getFooterData( footerId , display ): Returns the footerId of the footer.
getFooterStyle( footerId , style ): Gets the style properties of the footer of the corresponding footerId.
getFormattedHeaderValue( headerId , value ): Returns the header value formatted by the dispalyFormat.
getGridReadOnly( ): Returns the readOnly property or the entire GridView.
getHeaderBackgroundColor( headerId ): Returns the background color of the header cell.
getHeaderClass( headerId ): Returns the name of the user class dynamically applied to the header cell of the Grid.
getHeaderColor( headerId ): Gets the Text color of the header cell.
getHeaderID( header ): Returns the header ID through the header index.
getHeaderIndex( header ): Gets the header index through the header ID.
getHeaderPosition( headerId , propertyName ): Returns the position of the header cell (top or left).
getHeaderSize( headerId , sizeName ): Returns the size of the header cell (width or height).
getHeaderValue( headerId ): Returns the value of the header.
getMaxLength( colIndex ): Returns the maxLength of the column.
getMerged( rowIndex , colIndex ): Returns the merging state of the specified cell.
getOpenStatus( rowIndex ): Returns whether the row of the corresponding rowIndex can be drilled down in a Boolean value when the drilling-down is enabled for the entire GridView.
getOverflowX( ): Returns the setting of the overflowX property.
getOverflowY( ): Returns the setting of the overflowY property.
getParentRowIndex( rowIndex ): Returns the rowIndex of the parent row of the row of the corresponding rowIndex when drilling-down is allowed.
getReadOnly( type , rowIndex , colIndex ): Returns the value of the readOnly property depending on the type.
getRealRowIndex( rowIndex ): Returns the rowIndex of the actual data based on the rowIndex displayed on the screen when drilling-down is enabled.
getRowBackgroundColor( rowIndex ): Returns the background color of the row of the corresponding rowIndex.
getRowColor( rowIndex ): Returns the Text color of the row of the corresponding rowIndex.
getRowDisabled( rowIndex ): Returns the disabled setting of the specified row.
getRowNumVisible( ): Returns the option values of the rowNumVisible.
getRowReadOnly( rowIndex ): Returns the value of the readOnly property of the row of the corresponding rowIndex.
getRowVisible( rowIndex ): Hides or shows specified rows.
getSortableArr( ): Returns the sortable status of the header columns as an array.
getSortableStatus( ): Returns header information as an array in the sequence of the sorted columns.
getTopRowIndex( ): Returns the rowIndex of the top row on the current screen.
getTotalCol( ): Gets the total number of the columns.
getTotalHeaderCol( options ): colIndex에 해당하는 열의 visible여부를 반환
getTotalRow( ): Gets the total number of the rows.
getUncheckedData( colIndex ): Returns the data of the unchecked row as an array when the column of the corresponding colIndex is a Radio or CheckBox.
getUncheckedIndex( colIndex ): Returns the index of the unchecked row as an array when the inputType of the column of the corresponding colIndex has a Radio or CheckBox component.
getUncheckedJSON( colIndex ): Converts the data of the unchecked row into JSON data and returns as an array when the column of the corresponding colIndex is radio or checkbox.
getUncheckedXML( colIndex ): Returns the data of the unchecked row as an XML when the inputType of the column of the corresponding colIndex is radio or checkbox.
getVisibleColData( colIndex ): Returns the currently displayed (filtered or sorted) data of the column of the corresponding colIndex as an array.
getVisibleRowNum( ): Returns the number of the visible rows.
groupby( Options ): Groups two or more columns and displays only the grouping result (statistical data).
hasChild( rowIndex ): Returns whether the row of the corresponding rowIndex has a child row or not when drilling-down is enabled.
hideGroupbyZone( ): Hides the groupbyZone area.
initGrid( ): Deletes the entire date and the filtering conditions and initializes the column information (such as the nodeset of the SelectBox component) and returns the data as a one-dimensional array.
isEditing( ): Returns the current editing status of the GridView.
mergeByCol( options ): Merges repetitive data cells within the same column.
mergeByColRec( options ): Executes mergeByCol and mergeByRow for the cells not merged.
mergeByRestriCol( options ): Merges the rows when the same data is repeated within the column and the column on the left is merged.
mergeByRestricRow( options ): Merges the rows when the same data is repeated within the same row and the upper row is merged.
mergeByRow( options ): Merge the cells with the same data within the same row.
mergeByRowRec( options ): Executes mergeByRow and mergeByCol for the cells not merged.
mergeCell( mergeInfo ): Dynamically merges cells.
mergeCells( mergeOptionStr , options ): Merges adjacent cells of the same data in the same row or on the same column.
mergeCellsFixedCols( mergeOptionStr , options ): Executes mergeCells within the fixedColumn area.
mergeCellsFixedRows( mergeOptionStr , options ): Executes mergeCells within the fixedRow area.
mergeClear( ): Unmerges all cynamically merged cells.
mergeCol( colIndex , flag ): Excludes a certain column from automatic merging based on the data.
mergeFocusedCell( ): Merges only the currently focused cells.
mergeRow( rowIndex , flag ): Excludes a certain row from automatic merging based on the data.
mergeSplitFocusedCell( ): Splits the currently focused cell merged.
modifyCheckedStatus( colIndex , status ): Changes the status codes of all checked rows when the inputType of the specified column is checkbox.
modifyUncheckStatus( col , status ): Changes the status codes of unchecked rows when the inputType of the specified column is checkbox.
moveFooterColumn( fromIdx , toIdx ): Moves the footer column from fromIdx to toIdx.
readCSV( options ): Reads a CSV file and sets the grid data.
redrawColumn( colIndex , valid ): Resets the specified column.
refreshCell( rowIndex , colIndex ): Refreshes the cell of the corresponding index.
refreshColumn( colIndex ): Refreshes the column of the specified index.
refreshColumnItemset( col ): Valid only when the inputType is Select. Updates the itemset of the specified column.
refreshRow( rowIndex ): Refreshes the row of the specified index.
removeCellClass( rowIndex , colIndex ): Removes the user-defined class from the Grid cell.
removeFocusedCell( ): Removes focus from all (selected) cells.
removeFocusedMultiCell( startRow , startCol , endRow , endCol ): Removes focuses from the cells within the specified rectangular area.
removeHeaderClass( headerId ): Removes the user class applied to the header cell of the Grid.
saveCSV( options ): Saves the data as a CSV file.
setAutoFit( options ): Sets the autoFit property.
setBottomRowIndex( bottomRowIndex ): Sets the row of the corresponding bottomRowIndex to the bottom of the currently displayed area of the GridView component. (Moves the vertical scroll bar.)
setCaption( htmlStr ): Defines the HTML caption property or the GridView component.
setCaptionAuto( captionTitle ): Sets the captionTitle as the table title.
setCellAllowChar( rowIndex , colIndex , allowChar ): Changes the allowChar setting of a certain cell.
setCellBackgroundColor( rowIndex , colIndex , color ): Sets the background color of the cell of the corresponding rowIndex and the colIndex.
setCellChecked( rowIndex , colIndex , flag ): Selects or unselects the cell in inputType="checkbox" or "radio" column.
setCellClass( rowIndex , colIndex , className ): Dynamically applied the user class to the Grid cell.
setCellColor( rowIndex , colIndex , color ): Sets the Text color of the cell of the corresponding rowIndex and the colIndex.
setCellCustomFormatter( rowIndex , colIndex , formatter ): Changes the setting of the customFormatter property of a certain cell.
setCellDataType( rowIndex , colIndex , dataType ): Changes the setting of the dataType property of the certain cell.
setCellDisabled( rowIndex , colIndex , disabled ): Sets the value of the disabled property of the cell of the corresponding colIndex and the rowIndex.
setCellDisableEdit( rowIndex , colIndex , onoff ): Changes the disableEdit property when the inputType=“custom” cell is autoComplete.
setCellDisplayFormat( rowIndex , colIndex , displayFormat ): Changes the setting of the displayFormat property of a certain cell.
setCellDisplayFormatter( rowIndex , colIndex , formatter ): Changes the setting of the displayFormatter property of a certain cell.
setCellInputType( rowIndex , colIndex , info ): Sets the inputType of the cell of the specified rowIndex and the colIndex.
setCellMaxLength( rowIndex , colIndex , maxLength ): Changes the maxLength setting of the specified cell.
setCellReadOnly( rowIndex , colIndex , readOnly ): Sets the value of the readOnly property of the cell of the corresponding colIndex and the rowIndex.
setColumnBackgroundColor( colIndex , color ): Sets the background color of the column of the corresponding colIndex.
setColumnChooseOption( colIndex , chooseOptionValue , chooseOptionLabel ): Changes the value and the label of the chooseOption property when the inputType is select in the gridView column.
setColumnColor( colIndex , color ): Sets the Text color in the column of the corresponding colIndex.
setColumnDisabled( colIndex , disabled ): Sets the disabled property for all rows of the corresponding colIndex.
setColumnDisableEdit( rowIndex , onoff ): Changes the disableEdit property of the inputType=“autoComplete” column.
setColumnDisplayFormat( colIndex , displayFormat ): Sets the value of the displayFormat property of the column. Replaces the existing setDisplayFormat API.
setColumnDisplayFormatter( colIndex , displayFormatter ): Sets the value of the displayFormatter property of the column.
setColumnGridItemset( colIndex , obj ): Dynamically changes the gridViewItemset when inputType = "select" and gridViewItemset are used.
setColumnIoFormat( colIndex , ioFormat , dateMast ): Sets the ioFormat property of the column.
setColumnNodeSet( colIndex , nodeset , label , value ): Sets the nodeset of the column for which an itemset can be set.
setColumnOrder( columnOrderArray ): Rearranges the order of the columns based on the given array. The columns not specified by the parameter will be put after the columns specified by parameters.
setColumnReadOnly( colIndex , readOnly ): Sets the value of the readOnly property or the column of the corresponding colIndex.
setColumnVisible( colIndex , colVisibleFlag ): Hides or displays the column.
setColumnVisibleColumn( gridColumnId , visibleColumnId , visibleColumnFalseValue ): Hides some of the selection item list of the selected GridView column.
setColumnWidth( colIndex , size ): Changes the width of the column.
setCustomFormatter( colIndex , customFormatter ): Sets the customFormatter setting of the column.
setDataDragDrop( onoff ): Changes the dataDragDrop setting of the Grid.
setDataType( colIndex , dataType ): Sets the dataType of the column.
setDisabled( type , rowIndex , colIndex , disableFlag ): Sets the disabled property according to the type.
setDrillDownDragDrop( value ): Sets drag-n-drop in the drill-down column.
setFixedColumn( fixedColNum ): Fixes the column.
setFixedRightColumn( count ): Dynamically sets the number of the columns to set to the right (fixedRightColun).
setFocusedCell( rowIndex , colIndex , editMode ): Focuses (or selects) the cell and moves to the cell.
setFocusedHeaderObj( headerId ): Sets the focus to the header when the inputType is an object such as selectbox or checkbox, not Text.
setFocusedMultiCell( startRow , startCol , endRow , endCol ): Focuses the cells within the specified rectangular area.
setFooterCaption( htmlStr ): Sets the innerHTML for the footer table caption.
setFooterData( footerId , data ): Sets the data in the footer when the inputType of the footer is Text.
setFooterDisplayFormat( footerId , displayFormat ): Sets the displayFormat of the footer.
setFooterStyle( footerId , style , value ): Sets the style of the footer cell.
setFooterSummary( str ): Sets the summary for the footer table.
setFooterValue( footerId , data ): Sets the data value in the footer when the inputType of the footer is text.
setGridHeight( height ): Sets the height of the GridView.
setGridReadOnly( readOnly ): Enables the readOnly for the entire GridView.
setGridSize( width , height ): Sets the height and the width of the GridView component.
setGridWidth( width ): Sets the width of the GridView.
setHeaderBackgroundColor( headerId , color ): Sets the background color of the header cell.
setHeaderClass( headerId , className ): Dynamically applies the user class to the header cell of the Grid.
setHeaderColor( headerId , color ): Sets the Text color of the header cell.
setHeaderDisabled( headerId , disabled ): Sets the disabled property or the header.
setHeaderHide( hide ): Hides or displays the header.
setHeaderNodeSet( headerId , nodeset , label , value ): Valid when the inputType of the header is select. Sets the nodeSet of the list.
setHeaderSortImage( headerId , orderNum , sortOrd ): Sets the sorting image of the header. Data sorting must be made by the sorting method of the Datalist.
setHeaderStyle( headerId , style , value ): Sets the style for the header cell of the corresponding headerId in the GridView.
setHeaderValue( headerId , value , useFormat ): Sets the value formatted by the displayFormat in the header.
setImageSrc( colIndex , src ): Dynamically changes the image when the inputType is textimage.
setMaxLength( colIndex , len ): Sets the maxLength of the GridView column.
setNoResultMessage( message ): Sets the message to display when there is no data in the GridView component.
setNoResultMessageVisible( visible ): Dynamically sets the noResultMessageVisible.
setReadOnly( type , rowIndex , colIndex , readOnlyFlag ): Controls the "readOnly" property.
setRowBackgroundColor( rowIndex , color ): Sets the background color of the row of the corresponding rowIndex.
setRowColor( rowIndex , color ): Sets the Text color of the row of the corresponding rowIndex.
setRowDisabled( rowIndex , disableFlag ): Sets the disabled property of the row of the corresponding rowIndex.
setRowNumColumnWidth( size ): Changes the width of the rowNum column.
setRowReadOnly( rowIndex , readOnly ): Sets the readOnly property for the row of the corresponding rowIndex.
setRowStatusColumnWidth( size ): Changes the width of the rowStatus column.
setRowVisible( rowIndex , flag ): Hides/Unhides certain rows.
setScrollLeft( left ): Moves the horizontal scroll as much as specified.
setScrollTop( top ): Sets the top style of the div that covers the vertical scroll of the GridView same with the specified top style.
setStartRowNumber( rowIndex ): Sets the index of the starting row displayed on the rowNum column.
setStyleAll( styleObj ): Sets the GridView style.
setSubtotalVisible( flag ): Hides or unhides the subtotal.
setSummary( str ): Sets the HTML summary property or the GridView component.
setTopRowIndex( topRowIndex , noEvent , autoFocus ): Moves the vertical scroll bar in a way that the row of the corresponding topRowIndex is displayed on the first row.
setUseFilter( colId , flag ): Dynamically changes the useFilter setting of the specified header in the GridView.
setUseFilterList( flag ): Dynamically controls the useFilterList setting of the GridView.
showChooseOption( colIndex , chooseOption ): Sets the chooseOption of the SelectBox when the inputType of the gridView column is select.
showCustomFilter2( headerID ): Displays the “Use-defined Filter” popup for the end usr.
showCustomFilterReset( ): Shows the button to initialize the user-defined filter.
showGroupbyZone( ): Shows the groupbyZone area (which was previously hidden by hideGroupbyZone.)
spanAll( openFlag ): Spans or unspans the entire data of the GridView component when drilling-down is enabled.
toggle( rowIndex ): Enables toggling on the row of the corresponding rowIndex when drilling-down is enabled. (Opened for a closed row, and closed for an opened row.)

Property Detail

adaptive: Adaptive web design mode (in which page layouts adapt to the screen sizes and the device types.)
Supports Chrome, Safari, Firefox, Opera, and IE10+.
adaptiveThreshold: A threshold at which the layout enters the adaptive mode. [default: 480]
alwaysTriggerScrollStart: Triggers the onscrollstart event every time that the scroll reaches the first row of the GridView.
applyAllColumnStyle: Applies all styles defined in the column.
arrowMove: Allows the end user to move to the next cell at the last character in the cell or to the previous cell at the first character in the cell using arrow keys.
autoFit: Evenly distribute all columns of the GridView to fill up the full width of the GridView. [default: none, lastColumn, allColumn]
When autoFit is used, no horizontal scroll is displayed.
autoFitMinWidth: Minimum width of the GridView to apply autoFit="allColumn" setting. (Unit: px)
When the GridView width is smaller than the autoFitMinWidth, autoFit="allColumn" setting will not be applied. Instead, a horizontal scroll will be created.
captionAuto: Combines the CaptionTitle with the header title of the table and displays it as the table title. false (Default) : Does not display.
To use this property in the TableLayout, set as tagName="table".
captionTitle: Text to be displayed before the header title. [default: “”]
checkDisabledOnCut: Allows cutting through Ctrl (or cmd) + X in the disabled="true" columns. [default: true, false]
checkEditableInputClass: Removes "w2grid_input" class from nobr tag in case the cell is readOnly or disabled in the inputType = "text" column. [default: false, true]
checkReadOnlyOnCut: Allows cutting through Ctrl (or cmd) + X in the readOnly="true" columns. [default: true, false]
checkReadOnlyOnPaste: Allows pasting through Ctrl (or cmd) + V in the readOnly="true" columns. [default: false, true]
checkReadOnlyOnPasteEnable: Set the columns to apply checkReadOnlyOnPaste="false". [Default: “”]
class: Same as the class property in HTML.
The class defined in the CSS file or style block can be applied. Multiple classes can be defined with being divided by blank space.
WebSquare5 Engine applies different classes to different components. By defining a common class, the common class can be applied to multiple components.
As a very complex structured component, the lower components of the GridView should be accessed by the CSS selectors.
columnMove: Allows column moving through header dragging.
Header value is displayed on the tooltip during dragging.
columnMoveWithFooter: Moves the column and the footer. [default: false, true]
Moves the footer too when the user drags the column by using the setColumnOrder function or when the columnMove is "true". [default: false, true]
(Not supported if the footer and header do not share the same merge structure with the body.)
contextMenu: Uses the context menu. [default: false, true]
contextMenuAltClick: Shows the context menu upon Alt + mouse left-clicking. [default: false, true]
copyOption: When copying Gridview data, decide which value to copy - those defined in the DataList (“dataList”) or those currently display (“display”).
copyOption can be set for each column, and the copyOption setting of the column is prior to that of the entire GridView.
dataDragDrop: Allows dragging-n-dropping between the GridViews. [true, false]
Two GridView must be bound with different DataLists each, and this property must be set for them.
dataDragSelect cannot be used at the same time.
(!!!Warning!!!) Use the Ctrl key in the FireFox.
dataDragSelect: Allows cell selection through dragging. [true, false]
Valid when the useShiftKey is used. Cannot be used with the dataDragDrop property.
dataDragSelectAutoScroll: Allows automatic scrolling when the mouse move out of the browser while multiple cells are dragged and selected (dataDragSelect="true"). [default: false, true]
dataDragSelectAutoScrollLevel: Time to double the current scrolling speed when the dataDragSelectAutoScroll is enabled. (Unit: ms) [default: 1300]
The longer the dragging time, the faster the scrolling speed.
dataDragSelectAutoScrollPeriod: Scrolling interval when the dataDragSelectAutoScroll is enabled. (Unit: ms) [default: 70]
The smaller the value, the faster the scrolling speed doubling
dataList: ID of the DataList to bind with the GridView component data.
defaultCellHeight: Default cell height.
disabledBackgroundColor: Background color of the disabled (disabled="true") cell or row.
disabledFontColor: Font color of the disabled (disabled="true") cell or row.
disabledScrollHidden: Hides the scroll when disabled. [default: false, true]
Prevents the scroll from being moved when the GridView is disabled in non-IE browsers.
dragDisplayColumn: Column ID to display on the tooltip when dragging data (dataDragDrop="true").
Displays the column data on the tooltip.
Use “,” when setting multiple column IDs.
If not specified, the data of the clicked column will be displayed on the tooltip.
dragEndFunction: The function to be executed upon the end user's finishing dragging.
To be used with the dragStartFunction.
Define the function for drill-down case and the other.
dragStartFunction: The function to be executed upon the end user's starting dragging.
To be used with the dragEndFunction.
Define the function for drill-down case and the other.
drilldownToggleScrollFix: Fixes the scroll upon the end user’s opening the list by clicking + button on the drilldown column. [default: false, true]
dynamic: Dynamically thorugh setGridStyle. [default: false, true]
Not display warning messages when there is no w2:header nor w2:body in the GridView in case of the setting of dynamic=true.
editModeEvent: Mouse action event to edit the cell data. [default: ondblclick, onclick, onsecondclick]
editModeEventIcon: Mouse action to edit cell data in the viewType="icon" column. [default: onclick, ondblclick]
enterKeyMove: Sets the focus-moving direction upon the end user's pressing the Enter key. [default:down, right, none, edit, editRight, editDown]
escape: Decodes HTML escape characters as tags.
euroMask: Masking value to be applied when the dataType is "euro" or when the changeCurrency API is used. [default: “”]
evenRowBackgroundColor: Background color of the even rows.
excludeDeletedRows: Excludes the deleted rows when calculating subtotal and total in the footer. [default: false, true]
excludeModifiedRows: Excludes the rows of which status has been changed to “d” by modifyRowStatus API from subtotaling and totaling (in the foot) expressions. [default: false, true]
fastScroll: Adds fast scrolling effects to vertical scrolling.
GridView rendered as allowed for the given time. For the part being rendered, a notification message will be displayed.
filterBoxvisibleRowNum: Number of the conditions to be displayed on the filtering condition list.
filterFocusMode: Whether to remove the focus or not on the selected cell or row in the body before the sorting event is triggered.
filterShowAlways: Shows the filtering icon first when the width of the column with useFilter=“true” setting is small. [default: false, true]
fixedColumn: Column to fix.
fixedColumnNoMove: Allows moving (columnMove) of the column that is fixed by fixedColumn property. [default:false, true]
fixedColumnScrollHidden: Hides the scroll on the fixed columns.
fixedColumnWithHidden: Includes the hiddenColumn when calculating the position of the fixedColumn property. [default:true, false]
fixedRow: Rows to fix.
focusDefaultColumn: When set as true, both the rowNum and the rowStatus columns can get the focus. [default:false, true]
focusMode: The method of displaying the selected (or focused) cell. [default:cell, row, both, none]
focusMove: Allows focus moving through the key. [default: true, false, vertical, horizontal]
footerCaption: Content of the footer. [default: ""(null)]
footerCaption: caption of the grid footer
footerCaptionAuto: Automatically generates the footer text for the footerCaption property regardless of the captionAuto setting. [default: false, true]
footerSummary: Summary of the footer contents. [default: "" (null)]
footerSummary: grid footer summary
footerSummaryAuto: Automatically generates footer in the footer summary regardless of the captionAuto setting. [default: ""(Empty string)]
groupbyFilterBox: Displays the filtering conditions when using the groupby (filtering) feature.
The end user can select one of the filtering conditions from the list.
groupbyFilterBoxFormatter: Formats the labels to be displayed on the filtering condition list (groupbyFilterBox).
Two parameters - data and isGroupby - are received.
groupbyFilterBoxLocation: Location of the filtering condition box (groupbyFilterBox).
groupbyMaxCount: Set the maximum number of the columns to which groupby can be applied.
groupbyZone: Uses groupby feature or not.
groupby is to group the same data within a same column.
groupbyZoneHeight: Height of groupbyZone.
groupbyZoneMessage: Message to display when the groupbyZone is in initial state.
hammerEnabled: Hammers the dbclick event in the mobile environment. Decides whether to handle as the press event of JS or not. [default: true, false]
hammerPressTime: Time to hold until the press event is triggered. (Unit: ms) [default: 251]
hideHeader: Hides the header. [default: false, true]
id: Component ID
The component ID is allocated as a global object.
The script can access each object through the component ID.
ignoreCellClick: Ignore cell clicking.
ignoreNonEditableCell: Ignores Tab or Enter key pressing when cell editing is not allowed.
ignoreNonEditableCellTabEnter: Allows moving between readOnly cells when the ignoreNonEditableCell is “true”.
ignoreToggleOnDisabled: Ignores toggle image clicking on a disabled cell upon drill-down.
initFixedHeightByRowNum: Initializes the GridView height based on the number of the rows of the initially rendered GridView.
Fixes the number of the rows to render on the page.
keepDefaultColumnWidth: Fixes rowNum and rowStatus columns when autoFit is used. [default: false, true]
keyMoveEditMode: Immediately enters the editing mode upon the end user’s pressing Tab or Enter key moving the focus. [default: false, true]
loadCount: Number of the remaining rows to trigger the onscrollend event.
When the specified number of rows remain after vertical scrolling, the onscrollend will be triggered.
If not set, the onscrollend event will be triggered every time the vertical scroll reaches the bottom.
mergeCells: Merges adjacent cells of the same data in the same row or on the same column.
mergeCellsFixedRows: Merges adjacent cells with the same data in the fixedRow.
mergeCol: Specify columns to apply the mergeCells property.
moveKeyEditMode: Enter the editing mode upon the end user’s pressing Up/Down key moving the focus. [default: false, true]
moveKeyEditModeAll: Enter the editing mode upon the end user’s pressing Up, Down, Left, and Right key moving the focus. [default: false, true]
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
noResultMessage: Message to display when there is no search result. (When there is 0 data in the DataList.) [default: No result message.]
noResultMessageClass: Class to apply to the noResultMessage. (When there is 0 data in the DataList.)
The message is displayed within the <div> tag.
noResultMessageStyle: Class to apply to the noResultMessage. (When there is 0 data in the DataList.)
Specified style will be used instead of the default style.
The message is displayed within the <div> tag.
In case the position and the display are not defined, the Engine will decide absolute and block values.
noResultMessageVisible: Shows the message when there is no search result (0 data in the DataList). [default: true, false]
noSelect: Prevents cell text selection through mouse dragging (useCtrlKey="true") (useShiftKey="true").
(Options)
numberMask: Masking value to be applied when the dataType is "number" or when the changeCurrency API is used. [default: “”]
oddEvenColorDisplay: Uses different colors for odd and even rows respectively. [default: true, false]
oddRowBackgroundColor: Background color of the odd rows.
overflowX: Displays the horizontal scrolling bar. [default: auto, hidden, scroll]
overflowY: Displays the vertical scrolling bar. [default: auto, hidden, scroll]
pasteOption: Pastes the data to the clip board through Ctrl (or cmd) + V. [default: "", focus]
preventAddRowOnPaste: Prevents adding of a new row upon pasting data from the clipboard through Ctrl (or cmd)+V. [default: false, true]
preventCopy: Prevents copying of the GridView data through Ctrl (or cmd) + C or Ctrl (or cmd) + X to the clip board. [default: false, true]
preventCopyColumn: Column ID to prevent copying of the data to the clipboard through Ctrl (or cmd) + C. [default: “”]
preventMultisort: Prevent multiple-sorting.
preventPaste: Prevents pasting of the GridView data from the clipboard through Ctrl (or cmd)+V. [default: false, true]
preventPasteColumn: Column ID to prevent pasting of the data to the clipboard through Ctrl (or cmd) + V. [default: “”]
readOnly: Allows reading only. [default: false, true]
In case the readOnly is set for the Body column, the setting of the Body column will be used.
The readOnly property can be selectively applied to GridView, column, row, cell through the use of the APIs.
readOnlyBackgroundColor: Background color of the cell of which readOnly property is true.
readOnlyBackgroundImg: Path of the cell background image of which readOnly property is true.
readOnlyBackgroundImgCSS: Path of the cell background image of which readOnly property is true.
Prior to the readOnlyBackgroundImg.
readOnlyPriority
readOnlyTabIgnore: Ignores readOnly cell upon Tab key being pressed. [default: false, true]
resize: Allows column width resizing through dragging. [default: true, false]
rowMouseOver: Displays the background color of the row hovered by the end user. [default: true, false]
rowMouseOverColor: Background color of the row upon the end user's hovering the mouse over the row.
rowNumBackgroundColor: Background color of the body when the rowNumVisible is true.
rowNumHeaderValue: Header text to be displayed in case of rowNumVisible="true".
rowNumLocaleRef: localeRef key to set in the rowNum column.
rowNumStatusResize: Allows resizing of the widths of rowNum and rosStatus columns. [default: false, true]
rowNumStatusUniqueId: Uses unique IDs when rowNum and rowStatus columns are used. [default: false, true]
To pass the W3C validator, set the property as true.
rowNumVisible: Displays the row number of the DataList data bound with the GridView. [default: false, true]
rowNumWidth: Width of the rowNum column when rowNumVisible is "true".
rowStatusHeaderValue: Header text to be displayed in case of rowStatusVisible="true".
rowStatusLocaleRef: localeRef to set in the rowStatus column.
rowStatusVisible: Displays the status of each row (add, modified, or deleted) through the use of icons. [default: false, true]
rowStatusWidth: Width of the rowStatus column when rowStatusVisible is "true".
rupeeMask: Masking value to be applied when the dataType is "rupee" or when the changeCurrency API is used. [default: “”]
scrollByColumn: Horizontally scrolls by column. [default: false, true]
scrollByColumnAdaptive: Scrolls by column in the adaptive mode. [default: false, true]
selectedCellColor: Background color of the selected cell.
selectedCellOverColor: Background color of the cell to be displayed upon the end user’s hovering the mouse over the cell.
If not specified, the rowMouseOverColor will be used.
selectedRowColor: Background color of the selected cell.
selectedRowOverColor: Background color of the row to be displayed upon the end user’s hovering the mouse over the cell.
If not specified, the rowMouseOverColor will be used.
senseReader: A mode to support web accessibility requirements. [default: false, true]
setCellInputTypeCustom: An option to dynamically change the inputType of the cell of which inputType is custom. (Cannot be used when the typeGetter is in use.)
showImageTooltip: Displays the tooltip when the inputType is "image". [default: false, true]
showSortableImage: Shows sorting images on the header of the sortable column. [default: false, true]
showSortableUseFilter: Displays the sortable and the useFilterList icons on the header when both the useFilterList and the showSortableImage properties are in use. [default: false, true]
sortable: Whether to support data sorting by the end user's clicking the header on the GridView component.
sortedIconPosition: Position to show the sorting icon.
sortEvent: Define the sorting events. [default: ondblclick, onclick]
Valid when sortable="true".
sortOrderReverse: Sorts the data in descending powers first upon user's clicking the header.
summary: Similar to the summary property of the table tag in HTML.
Generally used to comply with the web accessibility requirements.
summaryAuto: Automatically sets the header column name in the summary to support web accessibility.
summaryOnlyAuto: Sets the summary only with text without tags if the header title includes HTML. [default: false, true]
syncScroll: Scrolls down multiple GridViews at the same time.
Note that the GridViews must have a same number of the rows.
syncScrollId: ID of the GridView to synchronize scrolling.
tengeMask: Masking value to be applied when the dataType is "teng" or when the changeCurrency API is used. [default: “”]
titleAuto: Disable the component. [default: false, true]
For the header, inputType="text".
For the cell, inputType="text" (or link, checkbox, button, radio, select (tableRender = "ul"), or secret).
Generates the title of the cell.
titleFormatter: Uses the user-define value as the title. [default: false, true]
For the header, inputType="text".
For the cell, inputType="text" (or link, checkbox, button, radio, select (tableRender = "ul"), or secret).
Uses the defined value as the title. (Supports web accessibility.)
tooltipDisplay: Displays hidden data as a tooltip when the data is not fully displayed. [default: false, true]
tooltipDisplayColumn: Sets the column name to display tooltip on certain columns. [default: false, true]
tooltipFormatter: Name of the function to format the tooltip contents when the tooltipDisplay is “true”.
The user-defined function receives rowIndex, colIndex, label, and isOverflow, and returns a string.
tooltipFormatterHeader: Name of the user-defined function to format the tooltip contents when the tooltipDisplay is “true”.
The customized function receives colId and label, and returns the string data.
tooltipHeader: Provides multi-language support. [default: false, true]
Functions same as existing tooltip options such as tooltipDisplay and tooltipDisplayTime.
tooltipHeaderShowAlways: Always shows the tooltip upon the end user’s hovering the mouse regardless of the text length. [default: false, true]
Always shows the tooltip on the header. Always show except when the data is blank ("").
tooltipPositionX: X coordinate of the tooltip. (Unit: px) [default: 20]
The left of the Body cell is the origin.
Supports expressions using the cellWidth (width) and the cellHeight (height).
tooltipPositionY: X coordinate of the tooltip. (Unit: px) [default: cellHeight+3]
The upper-left corner of the Body cell is the origin.
Supports expressions using the cellWidth (width) and the cellHeight (height).
tooltipShowAlways: Always shows the tooltip. [default: false, true]
In case of "true", the data will be always displayed on the tooltip unless the data is blank (“”).
tooltipShowAlwaysColumns: Columns to display tooltip always. [default: ""]
Always show except when the data is blank ("").
useCtrlKey: Allows multiple column selection through the use of the Ctrl key. [default: true, false]
useCtrlOnMultisort: Allows selection of multiple columns using Ctrl key to sort multiple columns.
useFilterList: Displays the filter list. [default: false, true]
The first item on the list will be “User-defined Filter”.
Upon selection of the "User-defined Filter”, the user-defined filter pop-up will be displayed. Set on the entire GridView.
useFilterListSync: Displays the filter done by setFilter(); or setColumnFilter(); function of the DataList. [default: false, true]
Set on the entire GridView.
useLocale: Multilanguage support
Uses multi-language keys of the client to display label values in multiple languages.
(For more information, see the user guide.)
userData1: User-defined property.
Use getUserData("userData3") to get the data.
userData2: User-defined property.
Use getUserData("userData3") to get the data.
userData3: User-defined property.
Use getUserData("userData3") to get the data.
useShiftKey: Whether to allow selection of multiple cells through the use of the Shift key.
visibleRowNum: Number of the rows to be displayed on the screen.
"all" is to display all rows without a scroll.
visibleRowNumFix: Automatically adjusts the initial height of the GridView according to the visibleRowNum or initFixedHeightByRowNum setting. [default: true, false]
wheelRows: Number of the rows changing upon the end user's clicking the vertical scrolling bar each time. [default: 3]
wheelStop: Prevents scrolling at the bottom of the GridView. [default: false]

Event Detail

onaftercolumnmove

Triggered right after a column moving.

Parameter
name	type	description
info	Object	Returns an object containing startColumnID, startColumnIndex, endColumnID, and endColumnIndex.

onaftercolumnresize

Triggered right after column resizing.

Parameter
name	type	description
info	Object	Returns an object containing colIndex, oldWidth, and newWidth.

onafteredit

Triggered upon the focus moving of the cell after editing is done.
Triggered after the oneditend.

Parameter
name	type	description
row	Number	Row index of the cell
col	Number	Column index of the cell
value	String	Inputted value in the cell

onbeforecolumnmove

Triggered right before column moving.

Parameter
name	type	description
info	Object	Returns an object containing startColumnID, startColumnIndex, endColumnID, and endColumnIndex.

onbeforeedit

Triggered before entering into the cell editing mode.

Parameter
name	type	description
row	Number	Row index of the cell
col	Number	Column index of the cell (Set colIdToColIndex as true in config.xml.)
value	String	Inputted value in the cell

onbeforesort

Triggered right before column sorting. Returns the sorting status.
sortOrder="1" is for sorting in ascending power, and sortOrder="-1" is for sorting in descending power. When sortOrder is "0", no sorting will be made.

Parameter
name	type	description
sortInfo	Object	Returns an object containing headerId, bodyColId, and sortOrder.

onblankclick

Triggered upon end user’s clicking empty part within the GridView.

Parameter
name	type	description
e	Object	event object

onbodymouseout

Triggered when the mouse moves out of the GridView body.

Parameter
name	type	description
info	Object	Returns all objects of the corresponding rowIndex and the colIndex.

Sample

onbodymouseover

Triggered upon the end user's hovering the mouse over the body.

Parameter
name	type	description
info	Object	Returns all objects of the corresponding rowIndex and the colIndex.

Sample

oncellclick

Triggered upon the end user's clicking the cell.

Parameter
name	type	description
row	Number	Row index of the cell
col	Number	Column index of the cell
colId	String	Column ID of the clicked cell

oncelldblclick

Triggered upon cell being double-clicked.

Parameter
name	type	description
row	Number	Row index of the cell
col	Number	Column index of the cell
colId	String	Column ID of the clicked cell

oncellindexchange

Triggered upon the end user's selecting a cell and changing the cell through the use of an arrow key, mouse clicking, or a method.

Parameter
name	type	description
row	Number	Row index of the currently selected cell
col	Number	Column index of the currently selected cell
oldRow	Number	Row index of the previous cell
oldCol	Number	Column index of the previous cell

oncolumnindexchange

Triggered upon the end user's selecting a cell and changing the column through the use of an arrow key, mouse clicking, or a method.

Parameter
name	type	description
col	Number	Column index of the currently selected cell
oldCol	Number	Old column index

oncolumnwidthchange

Triggered upon a change in the column length.

Parameter
name	type	description
info	Object	Returns an object containing columnIndex, columnID, oldWidth, and newWidth.

oncustomcopy

Define an event to replace the copy event of the GridView.
However, to replace the basic copy event, the corresponding event must return false.

Parameter
name	type	description
e	Object	Event object

oncustompaste

Define an event that will replace the paste event of the GridView.
However, to replace the basic paste event, the corresponding event must return false.

Parameter
name	type	description
e	Object	Event object

ondatadragover

Triggered upon data being moved over another Gridview when the dataDragDrop is “true”.
The event is triggered in a data-overlapped component.

Parameter
name	type	description
fromId	String	ID of the GridView from which data is being dragged.
fromRowIndex	Number	Index of the row from which dragging started

ondatadragstart

Triggered upon data dragging when the dataDragDrop is “true”.
The event is triggered in the component where dragging starts.

Parameter
name	type	description
rowIndex	Number	Index of the row to drag

ondatadrop

Triggered upon the data being dropped on another GridView when the dataDragDrop is “true”.
The event is triggered in a component where dragged data is dropped.

Parameter
name	type	description
info	Object	Dropped data information

ondateselect

Triggered upon selection of a date when the inputType is “calendar”.

Parameter
name	type	description
row	Number	Row index of the cell being edited
col	Number	Column index of the cell being edited
dateStr	String	Selected date
dateObj	Date	Date object of the selected date

Sample

// Parameters upon the end user's selecting 2002-Apr-15. row : 2 col : 1 dateStr : "20020415" (String object) dateObj : Mon Apr 15 2002 00:00:00 GMT+0900 (Date object)

oneditdblclick

Triggered upon the end user’s double-clicking the cell being edited.
Valid when the inputType is text, textImage, drilldown, or secret.

Parameter
name	type	description
row	Number	Row index of the double-clicked cell
col	Number	Column index of the double-clicked cell
colId	String	Column ID of the clicked cell

oneditend

Triggered upon the end user's finishing editing the cell data. Triggered before the onafteredit.

Parameter
name	type	description
row	Number	Row number of the cell
col	Number	Column number of the cell
value	String	Inputted value

oneditkeydown

Triggered upon the end user’s pressing the key while a cell is being edited.
For Korean characters (2 bytes for each character), the event will be triggered upon completion of the character in Opera and Firefox.

Parameter
name	type	description
info	Object	Returns all objects of the corresponding rowIndex and the colIndex.

Sample

oneditkeyup

Triggered upon the end user's releasing a key off the keyboard after pressing the key.
JSON object containing rowIndex, colIndex, oldValue, newValue, keyCode, and inputType is received.
Valid when the inputType is [text, textarea, textImage, secret, or calendar].

Parameter
name	type	description
info	JSON	Returns JSON containing rowIndex, colIndex, oldValue, newValue, keyCode, and inputType. info.inputType : InputType of the cell in which the event was triggered

Sample

<w2:gridView id="gridView1" ev:oneditkeyup="scwin.gridView1_oneditkeyup" dataList="dataList1"> ... </w2:gridView> scwin.gridView1_oneditkeyup = function(info) { var logStr = "rowIndex=" + info.rowIndex + ", colIndex=" + info.colIndex + ", colID=" + info.colID + ", inputType=" + info.inputType; logStr += ", oldValue=" + info.oldValue + ", newValue=" + info.newValue + ", keyCode=" + info.keyCode; WebSquare.logger.printLog(logStr); console.log(logStr); }

onfilereadend

Triggered after an Excel file is uploaded to the GridView component.

Parameter
name	type	description
value	String	Name of the uploaded file

Sample

onfooterclick

Triggered upon the footer being clicked.

Parameter
name	type	description
footerId	String	ID of the clicked footer

onheaderclick

Triggered upon the header being clicked.

Parameter
name	type	description
headerId	String	ID of the clicked header

onheaderdblclick

Triggered upon the end user's double-clicking the header.

Parameter
name	type	description
headerId	String	ID of the double-clicked header

onkeydown

Triggered upon the end user's pressing a key on the keyboard.

Parameter
name	type	description
e	Object	Event object

onkeyup

Triggered upon the end user's releasing a key off the keyboard after pressing the key.

Parameter
name	type	description
e	Object	Event object

onmonthselect

Triggered upon selection of a date when the inputType is “calendar”.

Parameter
name	type	description
row	Number	Row index of the cell being edited
col	Number	Column index of the cell being edited
dateObj	Date	Date object of the selected date

Sample

// Parameters upon the end user's selecting 2002-Apr. row : 2 col : 1 dateObj : {"oldValue":"200204","newValue":"200204"}

onrightbuttonclick

Triggered upon the end user's right-clicking the cell in the body part.

Parameter
name	type	description
row	Number	Row index of the cell
col	Number	Column index of the cell

onrowindexchange

Triggered upon the end user's selecting a cell and changing the row of the selected cell through the use of an arrow key, mouse clicking, or a method.

Parameter
name	type	description
row	Number	Row index of the currently selected cell
oldRow	Number	Index of the previous row

onrownumclick

Triggered upon the rowNum column being clicked.

Parameter
name	type	description
row	Number	Row index of the cell

onrowstatusclick

Triggered upon the rowStatus column being clicked.

Parameter
name	type	description
row	Number	Row index of the cell

onscrollend

Triggered when the vertical scrolling reaches the bottom.

onscrollstart

Triggered when the vertical scrolling reaches the top.

onscrollx

Triggered upon the end user's horizontal scrolling.

onscrolly

Triggered upon the end user's vertical scrolling.

onsort

Triggered upon a change in the sorting method by clicking or double-clicking on the sorted header.

onsubtotalclick

Triggered upon clicking of the subtotal.

Parameter
name	type	description
info	JSON	JSON containing colID, startRowIndex, endRowIndex, and element

onsubtotaldblclick

Triggered upon double-clicking of the subtotal.

Parameter
name	type	description
info	JSON	JSON containing colID, startRowIndex, endRowIndex, and element

ontextimageclick

Triggered when the image of which inputType is textImage is clicked.

Parameter
name	type	description
row	Number	Row number of the clicked cell
col	Number	Column number of the clicked cell

ontoggleclick

Triggered upon clicking of the toggling button when the inputType is drilldown.

Parameter
name	type	description
isCollapsed	Boolean	Collapsing or folding
rowIndex	Number	rowIndex of the clicked cell

onviewchange

Triggered when the value on the list is changed through keyboard input or mouse clicking.
In case the change was made by a script, the event will not be triggered. (Similar to the native onchange event.)

Parameter
name	type	description
info	Object	Returns an object containing oldValue, newValue, rowIndex, and colIndex.

Sample

onyearselect

Triggered upon selection of a date when the inputType is “calendar”.

Parameter
name	type	description
row	Number	Row index of the cell being edited
col	Number	Column index of the cell being edited
dateObj	Date	Date object of the selected date

Sample

* |// Parameters upon the end user’s selecting 2002.
* |row : 2
* |col : 1
* |dateObj : {"oldValue":2020,"newValue":2002}

Method Detail

advancedExcelDownload( options , infoArr )

Saves the grid data as an Excel file. (Supported for JDK 1.5 and higher versions.)

Parameter
name	type	required	description
options	Object	Y	Options to download GridView data (stored in JSON format) as an Excel file File information Options related to download request Options related to the data to download Options for the Excel file Options for the style of the Excel file Options for the style of the Excel file - Header Options for the style of the Excel file - Body Options for the style of the Excel file - SubTotal Options for the style of the Excel file - Footer Options for the style of the Excel file - Even/Odd rows. Options for row number display. Options for the style of the Excel file - Header Options for the style of the Excel file - Body Options for the style of the Excel file - Footer Options for the style of the Excel file - Subtotal Options related to downloading of large-volume data Options for line break. Options for display Options for cell merges Options for column moving. Options for filtering. Printing ETC
infoArr	Object	N	An array of GridView information to show it in another cell

Sample

// Download as an Excel without options specified options. var excelOpt = {}; // Downloading options for the Excel file excelOpt.fileName = "excelData.xls"; // The extension "xlsx" can be also used. gridView1.advancedExcelDownload( excelOpt );

advancedExcelUpload( options )

Reads an Excel file, and sets the read data in the GridView. (Supported for JDK 1.5 or higher.)
The Excel file must be of Excel 97 or a higher version. (Excel 5.0/7.0 not supported.)

Parameter
name	type	required	description
options	Object	Y	Excel downloading options for the grid data saved in JSON format Options for file uploading Options for the data to upload. Options for file uploading Options for column setting. Upload popup window ETC

Sample

// Upload an Excel file without options specified. gridView1.advancedExcelUpload( {} ); // Send an empty object when options are not specified to avoid errors.

changeCurrency( columnID , dataType , displayFormat , delimiter , decimalDelimiter )

Dynamically changes the monetary unit in the cell displayed on the column basis.
Valid when the dataType is "number", "tenge", "rupee", or "euro". (Options for gridView.column) dataType="number" dataType="tenge" dataType="rupee" dataType="euro"

Parameter
name	type	required	description
columnID	String	Y	ID of the column to which the monetary unit is to be applied
dataType	String	Y	Monetary unit to apply. (number, euro, rupee, tenge)
displayFormat	String	N	displayFormat for the column
delimiter	String	N	Delimiter
decimalDelimiter	String	N	Decimal point delimeter

Sample

gridView1.changeCurrency("standardAmt", "euro", "#.###,00"); The column ID is "standardAmt" and the cell value is "1234". Then, "1.234,00" will be displayed on the GridView. Set the following option in gridView1. euroMask="#.###,00" Call the following. gridView1.changeCurrency("standardAmt", "euro"); The column ID is "standardAmt" and the cell value is "1234". Then, "1.234,00" will be displayed on the GridView.

checkAll( colIndex , dataValue )

Selects or unselects all rows with checkboxes.

Parameter
name	type	required	description
colIndex	String	Y	Column ID or index of the checkbox
dataValue	String	Y	Checking status (true/false, treuValue/falseValue, or 1/0). (If the value type is not specified, 1 will be for checked and 0 will be for unchecked.)

clearAutoFit( )

Removes the autoFit property.
Cancels autoFit.

Sample

// (Example) gridView1.clearAutoFit();

clearGroupby( )

Cancels the groupBy setting.

clearRowVisible( )

Shows all rows hidden by the setRowVisible API. (Related Function) setRowVisible();

Sample

// (Example) // Display all rows hidden by setRowVisible API. gridView1.clearRowVisible();

drillTo( rowIndex )

Opens all rows to drill-down the row of the specified rowIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to display

getAllDisplayData( )

Returns the currently displayed data as a one-dimensional array. (displayFormat-applied data.)
Ignores the filter. For the filtered data, use getAllVisibleData.

Return
type	description
Array	One-dimensional array containing the data

getAllDisplayJSON( )

Returns the currently displayed data as JSON data. (displayFormat-applied data.)
Ignores the filter and returns the entire data as JSON. Also ignores sorting when filtered.
Related function: getAllVisibleJSON (Return the filtering result as JSON.)
Similar function: getAllDisplayData (Return the entire data as the one-dimensional array), getAllDisplayXML (Return the entire data as XML.)

Return
type	description
JSON	JSON data

Sample

gridView1.getAllDisplayJSON = function () {return JSON;}

getAllDisplayXML( )

Returns the currently displayed data as XML data. (displayFormat-applied data.)
Ignores the filter. For the filtered data, use getAllVisibleXML.

Return
type	description
XML	XML data

getAllFocusedIndex( )

Returns rowIndex and colIndex of the selected cells.
Mostly used when multiple cells are selected through the use of the Ctrl key.

Return
type	description
Array	JSON array containing rowIndex and colIndex of the selected cells

Sample

// Multiple cells are selected through the use of the Ctrl key. gridView1.getAllFocusedIndex(); // (Return) [ {col: 1, row: 2}, {col: 0, row: 4} ]

getAllFocusedRowIndex( )

Returns rowIndex of the focused cells selected by the Ctrl key.

Return
type	description
Array	Array of the rowIndex values of the focused cells

Sample

// Multiple cells are selected through the use of the Ctrl key. gridView1.getAllFocusedRowIndex(); // (Return) [ 0 , 1 ]

getAllVisibleData( )

Returns the currently displayed data as a one-dimensional array (being filtered).

Return
type	description
Array	One-dimensional array containing the data

Sample

// Two columns and four rows of data are set in the DataList. gridView1.getAllVisibleData(); // (Return) ["Chris", "19930516", "John", "19780207", "Jason", "19930817", "Hanna", "19820301"]

getAllVisibleJSON( )

Returns the currently displayed data as JSON data. (displayFormat-applied data.)
If the data is filtered, returns the filtered data as JSON.

Return
type	description
JSON	JSON data

Sample

gridView1.getAllVisibleJSON = function () {return JSON;}

getAllVisibleXML( )

Returns the currently displayed data as an XML (being filtered).

Return
type	description
XML	XML data

getAncestorRowIndexArray( rowIndex )

Returns the rowIndex of all parents of the specified row to support drill-down.

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the row to check the parents

Return
type	description
Array	One-dimensional array containing rowIndex

getBottomRowIndex( )

Returns rowIndex of the lowest row on the currently visible GridView component.
In case no row is rendered, "-1" will be returned.

Return
type	description
Number	rowIndex of the bottom row

Sample

// Total 10 rows are set and four rows are displayed on the screen. // When total 10 rows of data are set and only four rows are visible (or when the height of the grid is too small to display 10 rows and only four rows are displayed) // Do the following: gridView1.getBottomRowIndex(); // (Return) 3

getCellBackgroundColor( rowIndex , colIndex )

Returns the background color of the cell of the corresponding rowIndex and the corresponding colIndex.
If no BackgroundColor is specified, an empty string ("") will be returned.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to return the background color
colIndex	String\|\|Number	Y	Column index or ID to return the background color

Return
type	description
String	Background color of the specified row

getCellChecked( rowIndex , colIndex )

Returns whether the cell of the corresponding rowIndex and the colIndex is checked or not.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index of the cell
colIndex	Number\|\|String	Y	Column index or ID of the cell

Return
type	description
Boolean	Checking status of the cell

getCellClass( rowIndex , colIndex )

Returns the name of the user class dynamically applied to the Grid cells.

Parameter
name	type	required	description
rowIndex	Number	Y	Row number of the cell
colIndex	Number	Y	Row number or column ID of the cell

Return
type	description
String:Y	User-defined class applied to the cell

getCellColor( rowIndex , colIndex )

Returns the Text color of the cell of the corresponding colIndex and the rowIndex.
If the Text color is not specified, an empty string will be returned.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to return the text color
colIndex	String\|\|Number	Y	Column index or ID to return the text color

Return
type	description
String	Text color of the cell

getCellDisabled( rowIndex , colIndex )

Returns the value of the disabled property of the cell of the corresponding colIndex and the rowIndex.
If not specified, an empty string will be returned.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to get the disabled property value
colIndex	String\|\|Number	Y	Column index or ID to get the disabled property value

Return
type	description
Boolean	If not specified, an empty string will be returned.

getCellDisplayData( rowIndex , colIndex )

Returns the displayed data of the cell of the corresponding rowIndex and the colIndex (with displayFormat being applied).
Formatted data by displayFormat and so on.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index of the cell
colIndex	String\|\|Number	Y	Column index or ID of the cell

Return
type	description
String	Data of the cell of the corresponding rowIndex and the colIndex

getCellPosition( row , colIndex , propertyName )

Returns the position of the cell (top or left).

Parameter
name	type	required	description
row	Number	Y	Row index of the cell (The index of the top cell on the current grid is considered as 0 regardless of vertical scrolling position.)
colIndex	String\|\|Number	Y	Column index or ID of the cell
propertyName	String	Y	[top, left] Position of the cell to return

Return
type	description
Number	Position of the cell(top or left)

getCellReadOnly( rowIndex , colIndex )

Returns the value of the readOnly property of the cell of the corresponding colIndex and the rowIndex.
If not specified, empty string will be returned.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to get the readOnly setting
colIndex	String\|\|Number	Y	Column index or ID to get the readOnly setting

Return
type	description
Boolean	The current value of the readOnly property

getCellSize( row , colIndex , sizeName )

Returns the cell size (width or height).

Parameter
name	type	required	description
row	Number	Y	Row index of the cell
colIndex	String\|\|Number	Y	Column index or ID of the cell
sizeName	String	Y	[width, height] Name of the size to return

Return
type	description
Number	Size of the cell (width or height)

Sample

// Three columns and two rows are set in the GridView component. // Getting the width of name column on the first row. var tmpCellWidth = gridView1.getCellSize(0,"name","width"); // (Return) 154 // Getting the height of the second column on the first row var tmpCellHeight = gridView1.getCellSize(0,1,"height"); // (Return) 20

getCheckedData( colIndex )

Returns the data of the checked row as an array when the column is of the corresponding colIndex and is a Radio or CheckBox component. If the column is not a Checkbox component, an empty array will be returned.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID

Return
type	description
Array	Two-dimensional array containing the data

Sample

// The GridView has checkbox, name and birthday columns, and the ID of the checkbox column is "chk". var tmpRs = gridView1.getCheckedData("chk"); // (Return) [["1","Patrick Kim","19780207"],["1","Ray Park","19930817"],["1","Christina Park","19820301"]]

getCheckedIndex( colIndex )

Returns the index of the checked row as an array when the column is of the corresponding colIndex and the inputType property of the column is Radio or Checkbox.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID

Return
type	description
Array	One-dimensional array containing row indices

Sample

// The GridView has checkbox, name and birthday columns, and the ID of the checkbox column is "chk". var tmpRs = gridView1.getCheckedIndex("chk"); // (Return) [1,2,3]

getCheckedJSON( colIndex )

Returns the JSON data of the checked row as an array when the column of the corresponding colIndex is a Radio or Checkbox.
If the column is not a Checkbox component, an empty array will be returned.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID

Return
type	description
Array	One-dimensional array containing JSON data

Sample

// The GridView has checkbox, name and birthday columns, and the ID of the checkbox column is "chk". var tmpRs = gridView1.getCheckedJSON("chk"); // (Return) [{"name":"Patrick Kim","birthday":"19780207","chk":"1","rowStatus":"U"},{"name":"Ray Park","birthday":"19930817","chk":"1","rowStatus":"U"},{"name":"Christina Park","birthday":"19820301","chk":"1","rowStatus":"U"}]

getCheckedXML( colIndex )

Returns the data of the checked row as an XML when the column of the corresponding colIndex is a Radio or CheckBox.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID

Return
type	description
XML	XML Data

Sample

// The GridView has checkbox, name and birthday columns, and the ID of the checkbox column is "chk". var tmpRs = gridView1.getCheckedData("chk"); // (Return Example) <list> <map status="1" statusValue="U" id="1"> <chk>1</chk> <name>John</name> <birthday>19780207</birthday> </map> <map status="1" statusValue="U" id="2"> <chk>1</chk> <name>Jason</name> <birthday>19930817</birthday> </map> </list>

getChildrenRowIndexArray( rowIndex )

Returns the rowIndex of the children (one-depth below) of the row of the corresponding rowIndex as an array when drilling-down is enabled.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to get the child

Return
type	description
Array	One-dimensional array containing rowIndex

getColIdByHeaderId( headerId )

Returns the columnId of the body corresponding to the columnId of the header.

Parameter
name	type	required	description
headerId	String	Y	Header ID

Return
type	description
String	columnId of the body

getColumnBackgroundColor( colIndex )

Returns the background color of the column of the corresponding colIndex.
If not specified, an empty string will be returned.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column index or ID to return the background color

Return
type	description
String	Background color of the column

getColumnColor( colIndex )

Returns the Text color of the column of the corresponding colIndex.
If not specified, an empty string will be returned.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column index or ID to return the text color

Return
type	description
String	Text color of the column

getColumnDataListInfo( colIndex )

Returns the dataList bound with the column of the specified colIndex.
When the inputType of the GridView column is "select", "autoComplete", or "checkcombobox".

Parameter
name	type	required	description
colIndex	Number	Y	Column index

Return
type	description
Object:Y	dataList id

getColumnDisabled( colIndex )

Returns the value of the disabled property of the row of the corresponding colIndex.
If not specified, an empty string will be returned.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column index or ID to get the disabled property value

Return
type	description
Boolean	Setting of the disabled

getColumnID( colIndex )

Returns the value of the disabled property of the column of the corresponding colIndex.

Parameter
name	type	required	description
colIndex	Number	Y	Column index

Return
type	description
String	Column ID

getColumnIdListMultiRow( )

Returns all column IDs of the GridView as two-dimensional array data.
The rowIndex of each multiRow is allocated to the first dimension.
두 번째 차원에는 각 multiRow에 해당하는 column의 ID가 배열 형태로 할당됨.
In case of a single row, two-dimensional data will be returned with the size of the first dimension being 1.

Return
type	description
Array	Returns all column IDs of the GridView as two-dimensional array data.

Sample

// Case1 : There are two multiRows with the first row on col1 and col2 and with the second row on col3 and col4. gridView1.getMultiRowIndex(); // Return: [["col1","col2"], ["col3,col4"]] // Case 2: Single row on col1, col2, and col3. gridView1.getMultiRowIndex(); // Result: [["col1","col2","col3"]]

getColumnIndex( colIndex )

Receives the column ID, and returns the corresponding column index.

Parameter
name	type	required	description
colIndex	String	Y	Column id

Return
type	description
Number	Column index

getColumnNodeSet( colIndex )

Returns the nodeset of the column when the inputType = "select" or "autoComplete".
Pairs with setColumnNodeSet API.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column ID or index

Return
type	description
Object	Object containing the nodeset of the column of the corresponding itemsetObj colIndex. The object contains nodeset, label, and value.

Sample

var itemsetObj = gridView.getColumnNodeSet("col1"); var nodeset = itemsetObj.nodeset; var label = itemsetObj.label; var value = itemsetObj.value;

getColumnOrder( byName )

Returns the current sequence of the columns as an array. Returns an array of column index in default. When byName is true, an array containing column ID will be returned.

Parameter
name	type	required	description
byName	Boolean	N	[defulat:false, true] Whether to use the column ID instead of column index in the column order

Return
type	description
Array	An array containing the order of the current column

getColumnReadOnly( colIndex )

Returns the value of the readOnly property of the column of the corresponding colIndex.
If not specified, empty string will be returned.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column index or ID

Return
type	description
Boolean	Current value of the readOnly

getColumnType( colIndex )

Returns the inpuType of the specified column.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	column id or index

Return
type	description
String	inputType of the column

getColumnVisible( colIndex )

Returns the visible status of the column of the corresponding colIndex.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID to return the visible status

Return
type	description
Boolean	Visible status of the column

getDataDragDrop( )

Returns the dataDragDrop setting.

Return
type	description
Boolean	dataDragDrop

Sample

gridView1.getDataDragDrop(); // Returns the current dataDragDrop setting.

getDataLength( )

[deprecated] Use getRowCount() instead. The number of the rows is returned.

Return
type	description
number	Number of the rows

getDataList( )

Returns the Id of the currently bound DataList. (Property of the DataList)

Return
type	description
String	Data ID

getDataListInfo( )

Returns the dataList bound with the component.

Return
type	description
Object	Returns nodeset, label, and value id as an object.

Sample

// Example gridView1.getDataListInfo();

getDataType( colID )

Returns the dataType of the column.

Parameter
name	type	required	description
colID	String	Y	Column ID

Return
type	description
String	dataType of the column

getDescendantRowIndexArray( rowIndex )

Returns rowIndex of all children of the specified row to support drill-down.

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the row to check the children

Return
type	description
Array	One-dimensional array containing rowIndex

getDisabled( type , rowIndex , colIndex )

Returns the value of the disabled property according to the type. (Description of the types) “all” : Checks the disabled property for the grid, rows, columns, and cells, and returns the disabled setting of the cell. “grid” : Returns the disabled setting of the entire GridView. "row" : Returns the disabled setting of the row. Functions same as getRowDisabled. Returns false if the disabled property is not enabled for the row although the property is enabled for the entire GridView. "column" : Returns the disabled setting of the column. Functions same as getColumnDisabled. Returns false if the disabled property is not enabled for the column although the property is enabled for the entire GridView. "cell" : Returns the disabled setting of the corresponding cell. Functions same as getCellDisabled API. Returns false if the disabled property is not enabled for the row or column of the cell although the property is enabled for the entire GridView.

Parameter
name	type	required	description
type	String	Y	[default:grid, row, column, cell, all] Type to get the disabled setting
rowIndex	Number	Y	Row index to get the disabled property value
colIndex	Number\|\|String	Y	Column index or ID to get the disabled property value

Return
type	description
Boolean	Returns the value of the disabled property according to the type.

getFixedColumnLastIndex( includeDefaultColumn )

Returns the most right column index among the fixed columns.

Parameter
name	type	required	description
includeDefaultColumn	boolean	Y	Whether to include rowNum and rowStatus columns. The default is to include.

Return
type	description
Number	Index of the most right column

getFixedRightColumnLastIndex( )

Returns the most right column index among the fixedrightColum columns.

Return
type	description
Number	Index of the most right column among the fixedRightColumns.

getFixedRow( )

Returns the horizontally fixing location when the GridView is horizontally fixed. For the fist row, returns "1".

getFocusedColumnID( )

Returns the ID of the column of the currently focused cell.

Return
type	description
String	Column ID of the currently focused cell

getFocusedColumnIndex( )

Returns the colIndex of the currently focused cell.

Return
type	description
Number	colIndex of the currently focused cell

getFocusedRowIndex( )

Returns the rowIndex of the currently focused cell.

Return
type	description
Number	rowIndex of the currently focused cell

getFocusedRowStatus( )

Returns the status of the row in which the currently focused cell exists in status string. (Status) Initial Status: "R" Updated: "U" Inserted: "C" Deleted: "D" Inserted and Deleted: "V"

Return
type	description
String	Returns the status of the row in which the currently focused cell exists in status string.

getFooterData( footerId , display )

Returns the footerId of the footer.
Returns the calculation result when the inputType is "expression".

Parameter
name	type	required	description
footerId	String\|\|Number	Y	footer id or index
display	String	N	[displayData] Returns the formatted value for the displayData.

Return
type	description
string	Corresponding footer

getFooterStyle( footerId , style )

Gets the style properties of the footer of the corresponding footerId.

Parameter
name	type	required	description
footerId	Number\|\|String	Y	Grid column index or ID
style	String	Y	Style property

getFormattedHeaderValue( headerId , value )

Returns the header value formatted by the dispalyFormat.

Parameter
name	type	required	description
headerId	String	Y	Header ID
value	String	Y	Value to format

Return
type	description
String	Formatted value for the header

getGridReadOnly( )

Returns the readOnly property or the entire GridView.

Return
type	description
Boolean	readOnly setting of the GridView

getHeaderBackgroundColor( headerId )

Returns the background color of the header cell.

Parameter
name	type	required	description
headerId	String	Y	header cell ID

Return
type	description
String	Background color of the header cell

getHeaderClass( headerId )

Returns the name of the user class dynamically applied to the header cell of the Grid.

Parameter
name	type	required	description
headerId	Number	Y	header cell ID

Return
type	description
String:Y	User-defined class applied to the cell

getHeaderColor( headerId )

Gets the Text color of the header cell.

Parameter
name	type	required	description
headerId	String	Y	header cell ID

Return
type	description
String	Text color of the header cell

getHeaderID( header )

Returns the header ID through the header index.

Parameter
name	type	required	description
header	Number	Y	index

Return
type	description

getHeaderIndex( header )

Gets the header index through the header ID.

Parameter
name	type	required	description
header	String	Y	id

Return
type	description

getHeaderPosition( headerId , propertyName )

Returns the position of the header cell (top or left).

Parameter
name	type	required	description
headerId	String	Y	Header ID
propertyName	String	Y	[top, left] Name of the position information to return

Return
type	description
Number	Position of the header

getHeaderSize( headerId , sizeName )

Returns the size of the header cell (width or height).

Parameter
name	type	required	description
headerId	String	Y	Header ID
sizeName	String	Y	[width, height] Name of the size information to return

Return
type	description
Number	Header size

getHeaderValue( headerId )

Returns the value of the header.

Parameter
name	type	required	description
headerId	String	Y	Header ID

Return
type	description
String	header value

getMaxLength( colIndex )

Returns the maxLength of the column.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID

Return
type	description
Number	maxLength

Sample

gridView1.getMaxLength("a"); // Return the maxLength of the column of which ID is "a".

getMerged( rowIndex , colIndex )

Returns the merging state of the specified cell.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index of the cell to check the merging status
colIndex	Number	Y	Column index of the cell to check the merging status

Sample

gridView1.getMerged(0, 0); // Returns the merging state of (0, 0).

getOpenStatus( rowIndex )

Returns whether the row of the corresponding rowIndex can be drilled down in a Boolean value when the drilling-down is enabled for the entire GridView.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to get openStatus

Return
type	description
Boolean	[true, false] Opening status of drilling-down

getOverflowX( )

Returns the setting of the overflowX property.

Return
type	description
String	[default:auto, hidden, scroll] Current value of the overflowX property

getOverflowY( )

Returns the setting of the overflowY property.

Return
type	description
String	[default:auto, hidden, scroll] Current value of the overflowY property

getParentRowIndex( rowIndex )

Returns the rowIndex of the parent row of the row of the corresponding rowIndex when drilling-down is allowed.

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the row to get the parent

Return
type	description
Number	rowIndex of the parent row

getReadOnly( type , rowIndex , colIndex )

Returns the value of the readOnly property depending on the type. (Description of the types) “grid” : Returns the readOnly setting for the entire GridView. "row" : Returns the readOnly setting for the row. Functions same as getRowReadOnly. Returns false if the readOnly is not set for the row although the readOnly is set for the entire GridView. "column" : Returns the readOnly setting for the column. Functions same as getColumnReadOnly. Returns false if the readOnly is not set for the column although the readOnly is set for the entire GridView. "cell" : Returns the readOnly setting for the cell. Functions same as getCellReadOnly. Returns false if the readOnly is not set for the cell of the column or row although the readOnly is set for the entire GridView. “all” : Checks the readOnly setting for the GridView, rows, columns, and cells, and returns the readOnly setting for the cell.</div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">type</td><td class="row">String</td><td class="row">Y</td><td class="row">[default:grid, row, column, cell, all] Type to get the readOnly setting</td> </tr> <tr> <td class="necessary">rowIndex</td><td class="row">Number</td><td class="row">Y</td><td class="row">Row index or ID to get the readOnly setting</td> </tr> <tr> <td class="necessary">colIndex</td><td class="row">Number||String</td><td class="row">Y</td><td class="row">Column index or ID to get the readOnly setting</td> </tr> </table>  <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">Boolean</td><td class="row">The current readOnly setting</td> </tr> </table> <div class="pdesc"></div> </dd> <a class="anchor" id="getRealRowIndex"></a> <dt class="apiname">getRealRowIndex( rowIndex ) </dt> <dd> <div class="pdesc">Returns the rowIndex of the actual data based on the rowIndex displayed on the screen when drilling-down is enabled.</div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">rowIndex</td><td class="row">Number</td><td class="row">Y</td><td class="row">Index of the currently displayed row</td> </tr> </table>  <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">Number</td><td class="row">Actual index of the row</td> </tr> </table> <div class="pdesc"></div> </dd> <a class="anchor" id="getRowBackgroundColor"></a> <dt class="apiname">getRowBackgroundColor( rowIndex ) </dt> <dd> <div class="pdesc">Returns the background color of the row of the corresponding rowIndex.</div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">rowIndex</td><td class="row">Number</td><td class="row">Y</td><td class="row">Index of the row to get the background color</td> </tr> </table>  <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">String</td><td class="row">Background color of the row</td> </tr> </table> <div class="pdesc"></div> </dd> <a class="anchor" id="getRowColor"></a> <dt class="apiname">getRowColor( rowIndex ) </dt> <dd> <div class="pdesc">Returns the Text color of the row of the corresponding rowIndex.</div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">rowIndex</td><td class="row">Number</td><td class="row">Y</td><td class="row">Index of the row to get the Text color</td> </tr> </table>  <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">String</td><td class="row">Text color of the row</td> </tr> </table> <div class="pdesc"></div> </dd> <a class="anchor" id="getRowDisabled"></a> <dt class="apiname">getRowDisabled( rowIndex ) </dt> <dd> <div class="pdesc">Returns the disabled setting of the specified row.</div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">rowIndex</td><td class="row">Number</td><td class="row">Y</td><td class="row">Row index to get the disabled setting</td> </tr> </table>  <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">Boolean</td><td class="row">disabled setting of the row</td> </tr> </table> <div class="pdesc"></div> </dd> <a class="anchor" id="getRowNumVisible"></a> <dt class="apiname">getRowNumVisible( ) </dt> <dd> <div class="pdesc">Returns the option values of the rowNumVisible.</div>   <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">Boolean</td><td class="row">Settings of the rowNumVisible API</td> </tr> </table> <div class="pdesc"></div> </dd> <a class="anchor" id="getRowReadOnly"></a> <dt class="apiname">getRowReadOnly( rowIndex ) </dt> <dd> <div class="pdesc">Returns the value of the readOnly property of the row of the corresponding rowIndex.</div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">rowIndex</td><td class="row">Number</td><td class="row">Y</td><td class="row">Row index to get the readOnly setting</td> </tr> </table>  <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">Boolean</td><td class="row">If not specified, null data will be returned.</td> </tr> </table> <div class="pdesc"></div> </dd> <a class="anchor" id="getRowVisible"></a> <dt class="apiname">getRowVisible( rowIndex ) </dt> <dd> <div class="pdesc">Hides or shows specified rows.</div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">rowIndex</td><td class="row">Number</td><td class="row">Y</td><td class="row">Index of the row to check the hidden status.</td> </tr> </table>  <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">Boolean</td><td class="row">Visibility of the row. Returns false when hidden, or true when visible.</td> </tr> </table> <div class="caption_sample">Sample</div> <div class="pdesc"><xmp class='js sample'>gridView1.getRowVisible(30); // Returns the visibility of the 30th row.

getSortableArr( )

Returns the sortable status of the header columns as an array.

Return
type	description
Boolean	Sortable status of each column

getSortableStatus( )

Returns header information as an array in the sequence of the sorted columns.
Returns an empty array when there is no sorted column.
Each object in the returned array contains colID, dataType, and sortOrder.
sortOrder="1" is for sorting in ascending orders, and sortableOrder="-1"is for descending orders.

Return
type	description
Object	Sorted header information

getTopRowIndex( )

Returns the rowIndex of the top row on the current screen.
In case no data is displayed on the GridView, "-1" will be returned.

Return
type	description
Number	rowIndex of the top row

getTotalCol( )

Gets the total number of the columns (not including rowNum and rowStatus.)

Return
type	description
Number	Total number of the columns (not including rowNum and rowStatus)

getTotalHeaderCol( options )

Returns the visible status of the column of the corresponding colIndex.

Parameter
name	type	required	description
options	Object	N	Options to get the number of the header columns.

Return
type	description
Number	Number of header columnS

getTotalRow( )

Gets the total number of the rows.

Return
type	description
Number	Total number of the rows

getUncheckedData( colIndex )

Returns the data of the unchecked row as an array when the column of the corresponding colIndex is a Radio or CheckBox.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID to inspect the checking status

Return
type	description
Array	Two-dimensional array containing row data

Sample

// checkbox, name, and birthday are defined in the GridView, and inputType of the column is "checkbox" and the ID of column is "chk". var tmpRs = gridView1.getUncheckedData("chk"); // ID of "checkbox" column is "chk". // (Return) [["0","Chris","19930516"],["0","John","19780207"],["0","Jason","19930817"]]

getUncheckedIndex( colIndex )

Returns the index of the unchecked row as an array when the inputType of the column of the corresponding colIndex has a Radio or CheckBox component.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID

Return
type	description
Array	One-dimensional array containing row indices

Sample

// checkbox, name, and birthday are defined in the GridView, and inputType of the column is "checkbox" and the ID of column is "chk". gridView1.getUncheckedIndex("chk"); // ID of "checkbox" column is "chk". // (Return) [0,2,3]

getUncheckedJSON( colIndex )

Converts the data of the unchecked row into JSON data and returns as an array when the column of the corresponding colIndex is radio or checkbox.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Index or ID of the column to check whether the input of the column is checkbox or not

Return
type	description
Array	One-dimensional array containing JSON data of the row

getUncheckedXML( colIndex )

Returns the data of the unchecked row as an XML when the inputType of the column of the corresponding colIndex is radio or checkbox.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID

Return
type	description
XML	XML Data

Sample

// checkbox, name, and birthday are defined in the GridView, and inputType of the column is "checkbox" and the ID of column is "chk". var tmpRs = gridView1.getUncheckedXML("chk"); // The ID of Checkbox column is chk. // (Return) <list> <map status="0" statusValue="R" id="0"> <chk>0</chk> <name>Chris</name> <birthday>19930516</birthday> </map> <map status="0" statusValue="R" id="1"> <chk>0</chk> <name>John</name> <birthday>19780207</birthday> </map> </list>

getVisibleColData( colIndex )

Returns the currently displayed (filtered or sorted) data of the column of the corresponding colIndex as an array.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID to get the data

Return
type	description
Array	An array of column data of the corresponding colIndex

getVisibleRowNum( )

Returns the number of the visible rows.
Not including subTotal and footer.
If four rows and a scroll bar are displayed on the GridView where 10 rows have been set, 4 will be returned.

Return
type	description
Number	Number of the currently visible rows

groupby( Options )

Groups two or more columns and displays only the grouping result (statistical data).
Cannot be used with the columnMove property at the same time.

Parameter
name	type	required	description
Options	Object	N	Grouping option

Sample

var options = { sortIndex: [2], sortOrder: [1], hideHeader: false, hideFooter: true, groupbyHeader: { depth_0: [{colSpan:"3", value: "Daily Total"}, {inputType: "expression", expression: " SUM('complete')", className:"aaa"}] } }; gridView1.groupby(options);

hasChild( rowIndex )

Returns whether the row of the corresponding rowIndex has a child row or not when drilling-down is enabled.

Parameter
name	type	required	description
rowIndex	Number	Y	rowIndex of the row to check whether it has child rows or not

Return
type	description
Boolean	Whether there are child rows or not

hideGroupbyZone( )

Hides the groupbyZone area.

initGrid( )

Deletes the entire date and the filtering conditions and initializes the column information (such as the nodeset of the SelectBox component) and returns the data as a one-dimensional array.

Return
type	description
array	One-dimensional array containing the entire data

isEditing( )

Returns the current editing status of the GridView.

Return
type	description
Boolean	Editing status

mergeByCol( options )

Merges repetitive data cells within the same column. (Vertical merging)

Parameter
name	type	required	description
options	Object	N	Merge settings

mergeByColRec( options )

Executes mergeByCol and mergeByRow for the cells not merged.
The vertical merging is prior.

Parameter
name	type	required	description
options	JSON	N	Merge settings

mergeByRestriCol( options )

Merges the rows when the same data is repeated within the column and the column on the left is merged.
Among n+1 columns, column n is defined as the upperColumn.

Parameter
name	type	required	description
options	JSON	N	Merge settings

mergeByRestricRow( options )

Merges the rows when the same data is repeated within the same row and the upper row is merged.
Among n+1 rows, row n is defined as the upperRow.

Parameter
name	type	required	description
options	JSON	N	Merge settings

mergeByRow( options )

Merge the cells with the same data within the same row. (Horizontal merging)

Parameter
name	type	required	description
options	JSON	N	Merge settings

mergeByRowRec( options )

Executes mergeByRow and mergeByCol for the cells not merged.
The horizontal merging is prior.

Parameter
name	type	required	description
options	JSON	N	Merge settings

mergeCell( mergeInfo )

Dynamically merges cells.

Parameter
name	type	required	description
mergeInfo	JSON	Y	Object containing information of the cell to merge (rowIndex, colIndex, colSpan, and rowSpan)

Sample

gridView1.mergeCell({"rowIndex" : 3, "colIndex" : 2, "colSpan" : 2, "rowSpan" : 2}); // Execution Result: The cell at (3,2) will be merged at the size of 2*2. // In other words, cells of (3,2), (3,3), (4,2), and (4,3) will be merged, and all the merged cell will have the data of cell (3,2).

mergeCells( mergeOptionStr , options )

Merges adjacent cells of the same data in the same row or on the same column.

Parameter
name	type	required	description
mergeOptionStr	String	Y	Set the automatic merging method. Options are as follows: never: Unmerges cells that have been automatically merged by mergeCells. bycol : Merges the adjacent rows with the same data within the same column. byrow : Merges the adjacent columns with the same data within the same row. “bycolrec” : Conducts bycol and byrow for the unmerged cells. “byrowrec” : Conducts byrow and bycol for the unmerged cells.
options	JSON	N	Merge settings

mergeCellsFixedCols( mergeOptionStr , options )

Executes mergeCells within the fixedColumn area.

Parameter
name	type	required	description
mergeOptionStr	String	Y	Set the automatic merging method. Options are as follows: never: Unmerges cells that have been automatically merged by mergeCells. bycol : Merges the adjacent rows with the same data within the same column. byrow : Merges the adjacent columns with the same data within the same row. “bycolrec” : Conducts bycol and byrow for the unmerged cells. “byrowrec” : Conducts byrow and bycol for the unmerged cells.
options	JSON	N	Merge settings

mergeCellsFixedRows( mergeOptionStr , options )

Executes mergeCells within the fixedRow area.

Parameter
name	type	required	description
mergeOptionStr	String	Y	Set the automatic merging method. Options are as follows: never: Unmerges cells that have been automatically merged by mergeCells. bycol : Merges the adjacent rows with the same data within the same column. byrow : Merges the adjacent columns with the same data within the same row. “bycolrec” : Conducts bycol and byrow for the unmerged cells. “byrowrec” : Conducts byrow and bycol for the unmerged cells.
options	JSON	N	Merge settings

mergeClear( )

Unmerges all cynamically merged cells.
Clears only the cells dynamically merged by mergeCell or mergeCells.

mergeCol( colIndex , flag )

Excludes a certain column from automatic merging based on the data.

Parameter
name	type	required	description
colIndex	Number	Y	Target column to decide whether to use the automatic merging function or not.
flag	Boolean	Y

Sample

grid1.mergeCol(1, false); // Exclude the second column from data-based merging. grid1.mergeByCol(); // Execute mergeByCol on the columns except the second column.

mergeFocusedCell( )

Merges only the currently focused cells.

Sample

Conduct the following while cells of (6,6), (6,7), (7,6), and (7,7) are focused. gridView1.mergeFocusedCell(); // Execution Result: The cell of (6,6) will be merged at the size of 2*2. // In other words, cells of (6,6), (6,7), (7,6), and (7,7) are merged. Then, all merged cells will have the data of cell (6,6).

mergeRow( rowIndex , flag )

Excludes a certain row from automatic merging based on the data.

Parameter
name	type	required	description
rowIndex	Number	Y	Target row to decide whether to use the automatic merging feature or not.
flag	Boolean	Y

Sample

grid1.mergeRow(1, false); // Exclude the second row from the data-based merging. grid1.mergeByRow(); // Execute mergeByRow for the rows except the second row.

mergeSplitFocusedCell( )

Splits the currently focused cell merged.

Sample

Conduct the following while the merged cells of (6,6), (6,7), (7,6), and (7,7) are currently focused. gridView1.mergeFocusedCell(); // Execution Result: Split into (6,6), (6,7), (7,6), and (7,7).

modifyCheckedStatus( colIndex , status )

Changes the status codes of all checked rows when the inputType of the specified column is checkbox.

Parameter
name	type	required	description
colIndex	String	Y	Column index or ID to inspect the checked status
status	String	Y	[R,C,U,D,V] New status code

Sample

// checkbox and name columns are defined and two rows are set on the GridView. The id of the checkbox column is "chk". // The checkbox of the first row is checked, and the checkbox of the second row is not checked. // Change status of all checked columns into D through the use of modifyChecked Status and the checkbox column IDs. gridView1.modifyCheckedStatus("chk","D"); // Get the status of the first row. (When the checkbox is checked.) var tmpRs1 = gridView1.getRowStatus(0); // (Return) "D" // Get the status of the second row. (When the checkbox is not checked.) var tmpRs2 = gridView1.getRowStatus(1); // (Return) "R" // No modification made in the row.

modifyUncheckStatus( col , status )

Changes the status codes of unchecked rows when the inputType of the specified column is checkbox.

Parameter
name	type	required	description
col	String	Y	Column index or ID to check the unchecked status
status	String	Y	[R,C,U,D,V] New status code

Sample

// checkbox and name columns are defined and two rows are set on the GridView. The id of the checkbox column is "chk". // The checkbox of the first row is checked, and the checkbox of the second row is not checked. // Change status of all unchecked columns into D through the use of modifyCheckedStatus and checkbox column IDs. gridView1.modifyUncheckedStatus("chk","D"); // Get the status of the first row. (When the checkbox is checked.) var tmpRs1 = gridView1.getRowStatus(0); // (Return) "R" // No modification made in the row. // Get the status of the second row. (When the checkbox is not checked.) var tmpRs2 = gridView1.getRowStatus(1); // (Return) "D"

moveFooterColumn( fromIdx , toIdx )

Moves the footer column from fromIdx to toIdx.

Parameter
name	type	required	description
fromIdx	String	Y	Footer column ID or index to move
toIdx	String	Y	Footer column ID or index in the destination

Sample

gridView1.moveFooterColumn("column5, "column2"); // Result: column5 is moved to the left of column2 or before column2.

readCSV( options )

Reads a CSV file and sets the grid data. (Supported for JDK 1.5 and higher versions.)

Parameter
name	type	required	description
options	JSON	Y	Uploading options for a CSV file to a JSON GridView Options for file uploading Options for the data. Options for the hidden columns Options for the upload window. Other options

Sample

var options = { type: "1", delim: ",", escapeChar: "'", startRowIndex: 1, append: "0", hidden: "0", fillHidden: "0", skipSpace: "1" }; gridView1.readCSV(options); // Give an empty object as a parameter when no option is specified. gridView1.readCSV({});

redrawColumn( colIndex , valid )

Resets the specified column. (Reset.)

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column ID or index
valid	Boolean	N	[default:true, false] Processes the data based on the cell value when the inputType is “select”.

refreshCell( rowIndex , colIndex )

Refreshes the cell of the corresponding index.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index
colIndex	Number	Y	Column index

refreshColumn( colIndex )

Refreshes the column of the specified index.

Parameter
name	type	required	description
colIndex	Number	Y	Column index

refreshColumnItemset( col )

Valid only when the inputType is Select. Updates the itemset of the specified column.

Parameter
name	type	required	description
col	String	Y	Column ID or index to update

refreshRow( rowIndex )

Refreshes the row of the specified index.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index

removeCellClass( rowIndex , colIndex )

Removes the user-defined class from the Grid cell.

Parameter
name	type	required	description
rowIndex	Number	Y	Row number of the cell
colIndex	Number	Y	Row number or column ID of the cell

removeFocusedCell( )

Removes focus from all (selected) cells.

removeFocusedMultiCell( startRow , startCol , endRow , endCol )

Removes focuses from the cells within the specified rectangular area.

Parameter
name	type	required	description
startRow	Number	Y	Row index of the focusing-starting point. rowIndex at the upper-left corner.
startCol	Number	Y	Column index of the unfocusing-starting point. colIndex at the upper-left corner of the area
endRow	Number	Y	Row index of the unfocusing-ending point rowIndex of the lower-right corner of the area
endCol	Number	Y	Column index of the unfocusing-ending point colIndex of the lower-right corner of the area

Sample

gridView1.removeFocusedMultiCell(3,2,4,3); // Execution Result: (3,2), (3,3), (4,2), and (4,3) cells will be unfocused. Unfocused cells will remain the same.

removeHeaderClass( headerId , class )

Removes the user class applied to the header cell of the Grid.

Parameter
name	type	required	description
headerId	Number	Y	header cell ID
class	String	Y	Class to remove.

saveCSV( options )

Saves the data as a CSV file. (Supported for JDK 1.5 and higher versions.)

Parameter
name	type	required	description
options	JSON	Y	Downloading options for the JSON data grid as a CSV file Options for file downloading Options related to the data to download Options for column moving. Options for drill-down and merges Other options

Sample

// Specify columns to save. var colArr = []; colArr[0] = "name"; colArr[1] = "corp"; // Download options var options = { fileName: "saveCSV.csv", type: "1", delim: ";", saveList: colArr }; gridView1.saveCSV(options); // Give an empty object as a parameter when no option is specified. gridView1.saveCSV({});

setAutoFit( options )

Sets the autoFit property.
Automatically changes the column sizes to fit to the size of the GridView.
options.type : autoFit setting (“lastColumn” is to adjust only the width of the last column, and “allColumn” is to evenly adjust of the widths of all columns.)

Parameter
name	type	required	description
options	Object	N	setAutoFit options for the JSON data grid

Sample

var options = { type : "allColumn", minWidth : 480 } gridView1.setAutoFit( options ); If the width of the GridView is smaller than 480 pixels, the sum of the the widths of the columns will be fixed to 480 pixels and each column width will be adjusted to 480 pixels. If the width of the GridView is larger than 480 pixels, the width of each column will be accordingly adjusted to the width of the GridView.

setBottomRowIndex( bottomRowIndex )

Sets the row of the corresponding bottomRowIndex to the bottom of the currently displayed area of the GridView component. (Moves the vertical scroll bar.)
Moves the vertical scroll bar.

Parameter
name	type	required	description
bottomRowIndex	Number	Y	rowIndex of the bottom

setCaption( htmlStr )

Defines the HTML caption property or the GridView component. (The GridView is a table.)

Parameter
name	type	required	description
htmlStr	String	Y	Caption text. Supports both Text and HTML tag strings.

setCaptionAuto( captionTitle )

Sets the captionTitle as the table title. (Related Property) captionTitle captionAuto

Parameter
name	type	required	description
captionTitle	String	N	New value to set in the captionTitle property

Sample

// Example gridView1.setCaptionAuto("new title");

setCellAllowChar( rowIndex , colIndex , allowChar )

Changes the setting of the allowChar property of a certain cell. (Valid when the inputType="custom".)

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
colIndex	Number	Y	Index of the column to change
allowChar	String	Y	allowChar to set

setCellBackgroundColor( rowIndex , colIndex , color )

Sets the background color of the cell of the corresponding rowIndex and the colIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to set the background color
colIndex	Number\|\|String	Y	Column index or ID to set the background color
color	String	Y	Background color

setCellChecked( rowIndex , colIndex , flag )

Selects or unselects the cell in inputType="checkbox" or "radio" column.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index of the cell
colIndex	String\|\|Number	Y	Column ID or index of the cell
flag	Boolean	Y	[true,false] Whether the cell is checked or no

setCellClass( rowIndex , colIndex , className )

Dynamically applied the user class to the Grid cell.

Parameter
name	type	required	description
rowIndex	Number	Y	Row number of the cell
colIndex	Number	Y	Row number or column ID of the cell
className	String	Y	Class to apply to td

setCellColor( rowIndex , colIndex , color )

Sets the Text color of the cell of the corresponding rowIndex and the colIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index or ID to set the text color
colIndex	Number\|\|String	Y	Column index to set the text color
color	String	Y	Text color

setCellCustomFormatter( rowIndex , colIndex , formatter )

Changes the setting of the customFormatter property of a certain cell. (Valid when the inputType is "custom".)

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
colIndex	Number	Y	Index of the column to change
formatter	String	Y	Name of the new customFormatter

setCellDataType( rowIndex , colIndex , dataType )

Changes the setting of the dataType property of a certain cell. (Valid when the inputType="custom".)

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
colIndex	Number	Y	Index of the column to change
dataType	String	Y	dataType to set

setCellDisabled( rowIndex , colIndex , disabled )

Sets the value of the disabled property of the cell of the corresponding colIndex and the rowIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to set the disabled property
colIndex	Number\|\|String	Y	Column index or ID to set the disabled property
disabled	Boolean	Y	[true,false] Setting of the disabled property

setCellDisableEdit( rowIndex , colIndex , onoff )

Changes the disableEdit property when the inputType=“custom” cell is autoComplete. (Valid when the inputType is “custom”.)

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
colIndex	Number	Y	Index of the column to change
onoff	String	Y	disableEdit property

setCellDisplayFormat( rowIndex , colIndex , displayFormat )

Changes the setting of the displayFormat property of a certain cell. (Valid when the inputType="custom".)

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
colIndex	Number	Y	Index of the column to change
displayFormat	String	Y	displayFormat to set

setCellDisplayFormatter( rowIndex , colIndex , formatter )

Changes the setting of the displayFormatter property of a certain cell. (Valid when the inputType is "custom".)

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
colIndex	Number	Y	Index of the column to change
formatter	String	Y	Name of the new displayFormatter

setCellInputType( rowIndex , colIndex , info )

Sets the inputType of the cell of the specified rowIndex and the colIndex.
Valid for inputType="custom".
Add setCellInputTypeCustom="true" setting to the GridView.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index of the cell
colIndex	String	Y	Column index or ID of the cell
info	Object	Y	inputType information saved in JSON format

Sample

var info = { inputType : "select", options : { selectedData : false, viewType: "icon", chooseOption: true }, itemSet : { nodeset: "data:dataList1", label: "label", value: "value" } } gridView1.setCellInputType(0, "a", info); // Changes the inputType of the cell which is on the first row and colmn "a" into select.

setCellMaxLength( rowIndex , colIndex , maxLength )

Changes the setting of the maxLength property of a certain cell. (Valid when the inputType="custom".)

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
colIndex	Number	Y	Index of the column to change
maxLength	Number\|\|String	Y	maxLength to set

setCellReadOnly( rowIndex , colIndex , readOnly )

Sets the value of the readOnly property of the cell of the corresponding colIndex and the rowIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index or ID to set the readOnly property
colIndex	Number\|\|String	Y	Column index to set the readOnly property
readOnly	Boolean	Y	[true,false] The value of the readOnly property

setColumnBackgroundColor( colIndex , color )

Sets the background color of the column of the corresponding colIndex.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID to set the background color
color	String	Y	Background color

setColumnChooseOption( colIndex , chooseOptionValue , chooseOptionLabel )

Changes the value and the label of the chooseOption property of the SelectBox when the inputType is select in the gridView column.

Parameter
name	type	required	description
colIndex	Number	Y	gridView column index
chooseOptionValue	String	Y	New chooseOption value to set
chooseOptionLabel	String	Y	New chooseOption label to set

Sample

gridView1.setColumnChooseOption(1,"","-Choose-");

setColumnColor( colIndex , color )

Sets the Text color in the column of the corresponding colIndex.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index to set the text color
color	String	Y	Text color

setColumnDisabled( colIndex , disabled )

Sets the disabled property for all rows of the corresponding colIndex.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID to set the disabled property
disabled	Boolean	Y	[true, false] Setting of the disabled property

setColumnDisableEdit( rowIndex , onoff )

Changes the disableEdit property of the inputType=“autoComplete” column.

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the cell to change
onoff	String	Y	disableEdit property

setColumnDisplayFormat( colIndex , displayFormat )

Sets the value of the displayFormat property of the column. Replaces the existing setDisplayFormat API.
displayFormat is applied according to the dataType of the column defined in the DataList.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID
displayFormat	String	Y	displayFormat for the column

Sample

// The colum ID Of the birth date is “birthday”. // The dataType of the birthday column is “date”. // Change the displayFormat of the "birthday" column into dd-MM yyyy. gridView1.setDisplayFormat("birthday","dd-MM yyyy"); // (Display) Data "19831231" will be displayed as "31-12 1983".

setColumnDisplayFormatter( colIndex , displayFormatter )

Sets the value of the displayFormatter property of the column.
Replaces the existing setDisplayFormatter API.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID
displayFormatter	String	Y	Name of the function to apply to the displayFormatter

setColumnGridItemset( colIndex , obj )

Dynamically changes the gridViewItemset when inputType = "select" and gridViewItemset are used.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or id
obj	JSON\|\|XML	Y	Object containing the gridViewItemset to be newly created. JSON or XML object.

Sample

var obj = { "nodeset" : "data:dataList2", "label" : "col1", "value" : "col2", "width" : 400, "height" : 300, "item" : [{"ref" : "col1", "header" : "label"},{"ref" : "col2", "header" : "value"},{"ref" : "col3", "header" : "dummy"}] }; gridView1.setColumnGridItemset("col1", obj);

setColumnIoFormat( colIndex , ioFormat , dateMast )

Sets the ioFormat property of the column.
Valid when the dataType is date.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID
ioFormat	String	Y	ioFormat to set
dateMast	String	N	New dateMask(displayFormat)

setColumnNodeSet( colIndex , nodeset , label , value )

Sets the nodeset of the column for which an itemset can be set.
When the inputType of the GridView column is "select", "autoComplete", or "checkcombobox".

Parameter
name	type	required	description
colIndex	Number	Y	Index or ID of the column to set the nodeset
nodeset	String	N	Node to set. Define the dataList ID following data: prefix.
label	String	N	New label. Column ID of the datalist
value	String	N	New value. Column ID of the dataList

setColumnOrder( columnOrderArray )

Rearranges the order of the columns based on the given array. The columns not specified by the parameter will be put after the columns specified by parameters.

Parameter
name	type	required	description
columnOrderArray	Array	Y	Array of the column orders (by column index or column ID)

Sample

// The GridView has following column IDs. // name, gender, age, and birthday // Change the orders of "age" and "gender" columns. gridView1.setColumnOrder(["age","gender"]); // The columns will be in an order of "age", "gender", "name", and "birthday".

setColumnReadOnly( colIndex , readOnly )

Sets the value of the readOnly property or the column of the corresponding colIndex.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID to set the readonly
readOnly	Boolean	Y	[true, false] Setting of the readonly property

setColumnVisible( colIndex , colVisibleFlag )

Hides or displays the column.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column index or ID to set the hidden property
colVisibleFlag	Boolean	Y	[true, false] visibility

setColumnVisibleColumn( gridColumnId , visibleColumnId , visibleColumnFalseValue )

Hides some of the selection item list of the selected GridView column.
When the inputType of the GridView column is "select", "autoComplete", or "checkcombobox".
Same as setVisibleColumn method of Select, AutoComplete, Radio, CheckBox, and CheckComboBox.
(See description of visibleColumn, visibleColumnFalseValue, and setVisibleColumn APIs of corresponding components.)

Parameter
name	type	required	description
gridColumnId	Number\|\|String	Y	gridView column index or ID.
visibleColumnId	String	Y	DataList column ID bound with the visibleColumnId. (The column has the value that specifies whether to hide or not.)
visibleColumnFalseValue	String	N	Value that indicates to hide.

Sample

// When the inputType of the GridView column is "select", "autoComplete", or "checkcombobox". // The Status column is bound with the DataList. The Type column in the DataList contains values that specify whether to hide or not.) // Do the following: gridView1.setColumnVisibleColumn("Status", "Type", false); // Execution Result: // The rows in the DataList of which Type column has “false” value will not be displayed as selection items on the Status column of gridView1.

setColumnWidth( colIndex , size )

Changes the width of the column.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column index or ID to change the width
size	Number	Y	Width of the column to set (in pixels)

setCustomFormatter( colIndex , customFormatter )

Sets the customFormatter setting of the column.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID
customFormatter	String	Y	Name of the function to use as the customFormatter

setDataDragDrop( onoff )

Changes the dataDragDrop setting of the Grid.

Parameter
name	type	required	description
onoff	Boolean	Y	[true,false] Whether to allow dataDragDrop or not.

Sample

gridView1.setDataDragDrop(false); // Set the dataDragDrop as false.

setDataType( colIndex , dataType )

Sets the dataType of the column.
Valid when the dataType is "number", "tenge", "rupee", or "euro". (Options for gridView.column) dataType="text" dataType="number" dataType="float"

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID
dataType	String	Y	dataType of the column to set

setDisabled( type , rowIndex , colIndex , disableFlag )

Sets the disabled property according to the type.

Parameter
name	type	required	description
type	String	Y	[grid, row, column, cell] Type to set the disabled property
rowIndex	Number	Y	Row index or ID to set the disable property
colIndex	Number\|\|String	Y	Column index or ID to set the disabled property
disableFlag	Boolean	Y	Setting of the disabled property

Sample

// Name, gender and age are defined on the GridView, and column IDs are name, gender, and age respectively. // Disable the entire GridView. gridView1.setDisabled("grid",true); // Disable the first row of the GridView. gridView1.setDisabled("row",0,true); // Disable the "name" column of the GridView. gridView1.setDisabled("column","name",true); // Disable the "age" column on the first row of the GridView. gridView1.setDisabled("cell",0,"age",true);

setDrillDownDragDrop( value )

Sets drag-n-drop in the drill-down column.
Set dataDragDrop="true" in the GridView which contains drillDown column,
and set in setDrillDownDragDrop function.
Drill-down and drag-n-drop will operate.

Parameter
name	type	required	description
value	Boolean	Y	Supports drilldown and drag-and-drop in the GridView including drilldown columns.

Sample

gridView1.setDrillDownDragDrop(true); // Execution Result: Data can be dragged-and-dropped.

setFixedColumn( fixedColNum )

Fixes the column.

Parameter
name	type	required	description
fixedColNum	Number	Y	The number of the columns to fix from the far left. For example, to fix the first column, enter 1.

Sample

// Set the first column vertically. gridView1.setFixedColumn(1); // Set the third column vertically. gridView1.setFixedColumn(3);

setFixedRightColumn( count )

Dynamically sets the number of the columns to set to the right (fixedRightColun). (Related Property) fixedRightColumn (Number of the columns to fix on the right)

Parameter
name	type	required	description
count	Number	Y	Number of the columns to fix from the most right. “2” is to fix two columns.

Sample

// Dynamically fix two most right columns. gridView1.setFixedRightColumn(2); // Unfix the columns. gridView1.setFixedRightColumn(0);

setFocusedCell( rowIndex , colIndex , editMode )

Focuses (or selects) the cell and moves to the cell.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index of the cell to move the focus to
colIndex	Number\|\|String	Y	Column index or ID of the cell to move the focus to
editMode	Boolean	Y	[default:false, true] Enter the editMode.

setFocusedHeaderObj( headerId )

Sets the focus to the header when the inputType is an object such as selectbox or checkbox, not Text.

Parameter
name	type	required	description
headerId	String	Y	Header ID

setFocusedMultiCell( startRow , startCol , endRow , endCol )

Focuses the cells within the specified rectangular area.

Parameter
name	type	required	description
startRow	Number	Y	Row index of the focusing-staring point rowIndex of the upper-left corner of the focusing area
startCol	Number	Y	Column index of the focusing-starting area colIndex of the top-left corner of the focusing area
endRow	Number	Y	Row Index of the focusing-ending point rowIndex of the lower-right corner of the focusing area
endCol	Number	Y	Column index of the focusing-ending point colIndex of the lower-right corner of the focusing area

Sample

gridView1.setFocusedMultiCell(3,2,4,3); // Execution Result: (3,2), (3,3), (4,2), and (4,3) cells will be focused.

setFooterCaption( htmlStr )

Sets the innerHTML for the footer table caption.

Parameter
name	type	required	description
htmlStr	String	Y	innerHTML value for the caption

setFooterData( footerId , data )

Sets the data in the footer when the inputType of the footer is Text.

Parameter
name	type	required	description
footerId	Number\|\|String	Y	Footer index or id
data	String	Y	Footer contents

setFooterDisplayFormat( footerId , displayFormat )

Sets the displayFormat of the footer.
Note that the displayFormat depends on the dataType.

Parameter
name	type	required	description
footerId	Number\|\|String	Y	Column Index or ID
displayFormat	String	Y	displayFormat for the column

setFooterStyle( footerId , style , value )

Sets the style of the footer cell.

Parameter
name	type	required	description
footerId	String\|\|Number	Y	Footer cell ID or index(Set rowNum with "$rowNum", and rowStatus with "$rowStatus".)
style	String	Y	Name of the CSS property
value	String	Y	Value of the CSS property

setFooterSummary( str )

Sets the summary for the footer table.

Parameter
name	type	required	description
str	String	Y	String to be set as the summary

setFooterValue( footerId , data )

Sets the data value in the footer when the inputType of the footer is text.

Parameter
name	type	required	description
footerId	String\|\|Number	Y	Footer id or index
data	String	Y	Footer contents

setGridHeight( height )

Sets the height of the GridView.

Parameter
name	type	required	description
height	Number	Y	Height to set (Unit: pixels)

setGridReadOnly( readOnly )

Enables the readOnly for the entire GridView.

Parameter
name	type	required	description
readOnly	Boolean	Y	[true, false] Setting of the readOnly property

setGridSize( width , height )

Sets the height and the width of the GridView component.

Parameter
name	type	required	description
width	Number	Y	Width to set in pixel
height	Number	Y	Height to set in pixels

setGridWidth( width )

Sets the width of the GridView.

Parameter
name	type	required	description
width	Number	Y	Width to set in pixels

setHeaderBackgroundColor( headerId , color )

Sets the background color of the header cell.

Parameter
name	type	required	description
headerId	String\|\|Number	Y	header cell id or index
color	String	Y	Background color

setHeaderClass( headerId , className )

Dynamically applies the user class to the header cell of the Grid.

Parameter
name	type	required	description
headerId	Number	Y	header cell ID
className	String	Y	Class to apply to td

setHeaderColor( headerId , color )

Sets the Text color of the header cell.

Parameter
name	type	required	description
headerId	String\|\|Number	Y	header cell id or index
color	String	Y	text color

setHeaderDisabled( headerId , disabled )

Sets the disabled property or the header.

Parameter
name	type	required	description
headerId	Number\|\|String	Y	header index or id
disabled	Boolean	Y	[true, false] disabled status of the header

setHeaderHide( hide )

Hides or displays the header.

Parameter
name	type	required	description
hide	Boolean	Y	[true, false] hidden status of the header

setHeaderNodeSet( headerId , nodeset , label , value )

Valid when the inputType of the header is select. Sets the nodeSet of the list.

Parameter
name	type	required	description
headerId	String	Y	Header ID
nodeset	String	N	Node to set. Define the dataList ID following data: prefix.
label	String	N	New label. Column ID of the datalist
value	String	N	New value. Column ID of the dataList

Sample

// A DataList and a GridView are defined as shown below. //DataList - The ID is "dc_gendercode". "disp" column contains the labels and "code" column contains the values. // GridView - The inputType of the header column is "select", and the header ID is "hGender". // Change the selectbox list of the "hGender" header in the GridView. gridView1.setHeaderNodeSet("data:dc_genderCode","disp","code");

setHeaderSortImage( headerId , orderNum , sortOrd )

Sets the sorting image of the header. Data sorting must be made by the sorting method of the Datalist.

Parameter
name	type	required	description
headerId	String	Y	Header ID
orderNum	Number	N	[default: -1, 1, 0] Shows the sorting status.
sortOrd	Number	N	[default:0] Sorting priority in case of multi-sorting. For lower compaitibility. [Default: 0]

setHeaderStyle( headerId , style , value )

Sets the style for the header cell of the corresponding headerId in the GridView.

Parameter
name	type	required	description
headerId	String\|\|Number	Y	Header cell ID or index (Set rowNum with "$rowNum", and rowStatus with "$rowStatus".)
style	String	Y	Name of the CSS property
value	String	Y	Value of the CSS property

setHeaderValue( headerId , value , useFormat )

Sets the value formatted by the displayFormat in the header.
The displayed text will be changed in case of inputType="text".
Related Property: displayFormat

Parameter
name	type	required	description
headerId	String	Y	Header ID
value	String	Y	Header value
useFormat	Boolean	N	Sets the value formatted by the displayFormat in the header. (Default: false)

setImageSrc( colIndex , src )

Dynamically changes the image when the inputType is textimage.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID
src	String	Y	Image URL to apply to the column of the specified colIndex

setMaxLength( colIndex , len )

Sets the maxLength of the GridView column.

Parameter
name	type	required	description
colIndex	Number\|\|String	Y	Column Index or ID
len	number	Y	maxLength to apply to the column

Sample

// Example gridView1.setMaxLength("a", 5); // Change maxLength of column "a" into 5.

setNoResultMessage( message )

Sets the message to display when there is no data in the GridView component.

Parameter
name	type	required	description
message	String	Y	Message to display when there is no data

setNoResultMessageVisible( visible )

Dynamically sets the noResultMessageVisible.

Parameter
name	type	required	description
visible	Boolean	Y	[true,false] Value of the noResultMessageVisible

setReadOnly( type , rowIndex , colIndex , readOnlyFlag )

Controls the "readOnly" property.

Parameter
name	type	required	description
type	String	Y	[grid, row, column, cell] Type to set the readOnly property
rowIndex	Number	Y	Row index or ID to set the readOnly property
colIndex	Number\|\|String	Y	Column index or ID to set the readonly
readOnlyFlag	Boolean	Y	[true, false] readOnly setting

Sample

// Name, gender and age are defined on the GridView, and column IDs are name, gender, and age respectively. // Enable "readOnly" for the entire GridView. gridView1.setReadOnly("grid", true); // Enable "readOnly" for the first row of the entire GridView. gridView1.setReadOnly("row",0,true); // Enable "readOnly" for the "name" column of the entire GridView. gridView1.setReadOnly("column","name",true); // Enable "readOnly" for the "age" column on the first row of the entire GridView. gridView1.setReadOnly("cell",0,"age",true);

setRowBackgroundColor( rowIndex , color )

Sets the background color of the row of the corresponding rowIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index
color	String	Y	Background color

setRowColor( rowIndex , color )

Sets the Text color of the row of the corresponding rowIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index
color	String	Y	Text color

setRowDisabled( rowIndex , disableFlag )

Sets the disabled property of the row of the corresponding rowIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index to set the disabled property
disableFlag	Boolean	Y	[true, false] disabled status

setRowNumColumnWidth( size )

Changes the width of the rowNum column.

Parameter
name	type	required	description
size	Number	Y	Width of the column in pixels

setRowReadOnly( rowIndex , readOnly )

Sets the readOnly property for the row of the corresponding rowIndex.

Parameter
name	type	required	description
rowIndex	Number	Y	Row index or ID to set the readOnly property
readOnly	Boolean	Y	[true, false] readOnly setting

setRowStatusColumnWidth( size )

Changes the width of the rowStatus column.

Parameter
name	type	required	description
size	Number	Y	New column width in pixels

setRowVisible( rowIndex , flag )

Hides/Unhides certain rows.
Hidden rows can be unhidden by clearRowVisible();. (Related Function) clearRowVisible();

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the row to set the hidden status
flag	Boolean	Y	Display of the row.

Sample

// (Example) // Hide the 30th row. gridView1.setRowVisible(30, false);

setScrollLeft( left )

Moves the horizontal scroll as much as specified. (Unit: px)

Parameter
name	type	required	description
left	Number	Y	scrollLeft for the horizontal scrolling.

setScrollTop( top )

Sets the top style of the div that covers the vertical scroll of the GridView same with the specified top style.

Parameter
name	type	required	description
top	Number	Y	top setting in the new style to set

setStartRowNumber( rowIndex )

Sets the index of the starting row displayed on the rowNum column.
Index value. Setting “10” will be starting fro “11” on the screen.
Valid when rowNumVisible="true".

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the starting row

Sample

// The rowNumVisible is "true" in the GridView. gridView1.setStartRowNumber(10); // (Display) The rowNum starts which previously was displayed from 1 will start from 11.

setStyleAll( styleObj )

Sets the GridView style.

Parameter
name	type	required	description
styleObj	JSON	Y	Object containing detailed style settings

Sample

<w2:gridView id='gridView1' fixedColumn='4'/> There are eight columns. var styleObj = {"styleName" : "background-color", "styleValue" : "red", "type" : "row", "target" : "data", "rowIndex" : 5} gridView1.setStyleAll(styleObj); // Execution Result: On the row (5), unfixed area containing cells of (5,4), (5,5), (5,6) and (5,7) will have a red background color.

setSubtotalVisible( flag )

Hides or unhides the subtotal.

Parameter
name	type	required	description
flag	Boolean	Y	Displays the subtotal.

Sample

// Hides the subtotal. gridView1.setSubtotalVisible(false); // Unhides the subtotal. gridView1.setSubtotalVisible(true);

setSummary( str )

Sets the HTML summary property or the GridView component.

Parameter
name	type	required	description
str	String	Y	String for the summary property

setTopRowIndex( topRowIndex , noEvent , autoFocus )

Moves the vertical scroll bar in a way that the row of the corresponding topRowIndex is displayed on the first row.

Parameter
name	type	required	description
topRowIndex	Number	Y	rowIndex of the top row
noEvent	Boolean	N	Returns true in order to avoid onscrollend when the scroll reaches at the end.
autoFocus	Boolean	N	Moves the focus to (0, 0) on the current display after API execution.

setUseFilter( colId , flag )

Dynamically changes the useFilter setting of the specified header in the GridView.

Parameter
name	type	required	description
colId	String	Y	Column ID (of the header or body)
flag	Boolean	Y	Boolean to set the useFilter as true or false.

Return
type	description
Boolean	Returns true if the useFilter property is changed, or returns false.

setUseFilterList( flag )

Dynamically controls the useFilterList setting of the GridView.

Parameter
name	type	required	description
flag	Boolean	Y	Boolean to set the useFilterList property as true or false.

showChooseOption( colIndex , chooseOption )

Sets the chooseOption of the SelectBox when the inputType of the gridView column is select.

Parameter
name	type	required	description
colIndex	Number	Y	gridView column index
chooseOption	Boolean	Y	Setting (true/false)

Sample

gridView1.showChooseOption(1,true);

showCustomFilter2( headerID )

Displays the “Use-defined Filter” popup for the end user.

Parameter
name	type	required	description
headerID	String	Y	Header ID of the column to apply the user-defined filter

showCustomFilterReset( )

Shows the button to initialize the user-defined filter.
true: Display the initialization button.
false (Default): Not display.

showGroupbyZone( )

Shows the groupbyZone area (which was previously hidden by hideGroupbyZone.)

spanAll( openFlag )

Spans or unspans the entire data of the GridView component when drilling-down is enabled.
Spans the data to the depth if the corresponding parameter is given.

Parameter
name	type	required	description
openFlag	Boolean\|\|Number	Y	[true, false] Spanning status. If a number is entered, the data of the correpsonding depth will be spanned.

Sample

gridView1.spanAll(true); // Span all data. gridView1.spanAll(2); // Span all 2-depth data.

toggle( rowIndex )

Enables toggling on the row of the corresponding rowIndex when drilling-down is enabled. (Opened for a closed row, and closed for an opened row.)
Opens the closed rows, and vice versa.

Parameter
name	type	required	description
rowIndex	Number	Y	realRowIndex of the row to toggle