WebSquare.uiplugin.gridView

The GridView component is to display and to handle a large-volume of data, and is used with a DataList of the DataCollection.
The GridView component provides various features including total/sub-total, column grouping which is to calculate the total of the grouped columns, Excel uploading/downloading, data sorting, and filtering.
The GridView component has div tag at the highest level, and the general data is within the table tag. Other parts use corresponding tags suitable for their characteristics.
The column (or row) ID in major methods of the GridView component means the column id in the body. The ID of the header is indicated as the header id.

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. (The default is 480.)
applyAllColumnStyle: Whether to apply all styles to the column. (The default is false, and only the first style is applied to 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: [default:none, lastColumn, allColumn, none] Fills in the full width of the GridVeiw without generating any horizontal scroll.
autoFitMinWidth: Sets the minimum width of the GridView component (in pixels). Applied when the autoFit property is allColumn.
captionAuto: [default:false] When the captionTitle is defined, combines the captionTitle and the Header Title, and displays it as the table title.
captionTitle: [default:""] Specify the text to put before the header title when the captionAuto is "true".
checkDisabledOnCut: [default:false, true] When cutting data from the GridView by pressing Ctrl (or cmd)+X, decides whether to include the disabled column data in the data to be cut.
checkEditableInputClass: [default: false, true] When inputType is "text" and the cell is readOnly or disabled,
checkReadOnlyOnCut: [default:false, true] When cutting data from the GridView by pressing Ctrl (or cmd)+X, decides whether to include the readOnly column data in the data to be cut.
checkReadOnlyOnPaste: [default:false, true] Pastes the data on the clipboard on the readOnly cell using Ctrl (or Cmd) +V.
checkReadOnlyOnPasteEnable: [default:""]Sets the column ID to paste the data to the column for which the checkReadOnlyOnPaste is "true".
class: Same as the class property in HTML standard. One or more classes defined in the CSS file or in the style block can be applied (through the use of the space as the separator).
columnMove: Allows the user to move the column by dragging the GridView header. The header value will be displayed on the tooltip.
columnMoveWithFooter: [default: false, true] Moves the footer too when dragging columns using the setColumnOrder function or columnMove="true" setting. (Valid only when the footer has the same merge structure with the header and the footer.)
contextMenu: [default: false, true] Uses the context menu.
customFilterBox: [default: false, true] When the groupbyZone is "true" and the groupbyFilterBox is "true"
dataDragDrop: [true, false] Whether to allow data moving between GridView components through dragging-and-dropping. On Firefox, the end user must press the Ctrl key to use this feature.
dataDragSelect: [true, false] Allows the end user to select multiple cells by dragging.
dataList: ID of the DataList to bind with the GridView component data.
defaultCellHeight: Default cell height
disabledBackgroundColor: Background color or the disabled cell or row
disabledFontColor: Text color of the disabled cell or row
disabledScrollHidden: [default:false, true] Hides the scroll when the GridView is disabled.
dragDisplayColumn: Sets the ID of the column to be displayed as a tooltip upon the end user's dragging. Multiple IDs can be entered being separated by comma.
dragEndFunction: The function to be executed upon the end user's completing dragging. To be used in pair with dragStartFunction. Must be defined for two cases when drilling-down is enabled and when disabled.
dragStartFunction: The function to be executed upon the end user's starting dragging.
drilldownToggleScrollFix: [default:false, true] Fixes the scroll upon the end user’s clicking + button on the drilldown column.
dynamic: [default:false, true] Whether the GridView is to be dynamically created by setGridStyle on an empty GridView.
editModeEvent: An event to enter the modification mode
editModeEventIcon: [default:onclick] The event of which occurrence will result in entering the Editing mode when the column viewType is "icon".
enterKeyMove: [default:down, right, none, edit] Sets the focus-moving direction upon the end user's pressing the Enter key.
escape: Converts <>&" characters into HTML Escape characters.
euroMask: [default: ""] 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: [default:false, true] Excludes the deleted rows from subtotaling and totaling (footer) expressions (upon use of deleteRow and deleteRows methods.)
excludeModifiedRows: [default:false, true] Excludes the rows of which status has been changed to “d” by modifyRowStatus API from subtotaling and totaling (footeR) expressions.
fastScroll: Supports fast scrolling in vertical direction. Displays only available data for the time.
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: [default: false, true] Shows the filtering icon first when the width of the column with useFilter=true setting is small.
fixedColumn: Column to fix. To fix the first column, enter 1.
fixedColumnNoMove: [default:false, true] Allows moving (columnMove) of the column that is fixed by fixedColumn property.
fixedColumnScrollHidden: Hides the scroll in the fixed area while the fixedColumn is in use.
fixedColumnWithHidden: [default:true, false] Includes the hiddenColumn when calculating the position of the fixedColumn property.
fixedRow: Location of the first column to fix. To fix the first row, enter “1”.
focusDefaultColumn: [default:false, true] When set as true, both the rowNum and the rowStatus columns can get the focus.
focusFlow: Sets the focus flow linear or two-dimensional (default).
focusMode: [default:cell, row, both, none] The method of displaying the selected (or focused) cell.
focusMove: [default:true, false, vertical, horizontal] Allows focus moving through the key.
footerCaption: [default: ""(null)] Content of the footer.
footerCaption: caption of the grid footer
footerCaptionAuto: [default: false, true] Automatically generates the footer text for the footerCaption property regardless of the captionAuto setting.
footerSummary: [default: ""(null)] Summary of the footer contents
footerSummary: grid footer summary
footerSummaryAuto: [default: ""(빈 값)] Automatically generates footer in the footer summary regardless of the captionAuto setting.
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 label to be added to the groupby FilterBox. (Define the format.) Gets two parameters - data and isGroupby.
groupbyFilterBoxLocation: Location of the filtering condition box (groupbyFilterBox).
groupbyMaxCount: Set the maximum number of the columns to which groupby can be applied.
groupbyZone: Whether to use groupby feature or not.
groupbyZoneHeight: Height of groupbyZone.
groupbyZoneMessage: Message to display when the groupbyZone is in initial state.
hammerEnabled: [default:true, false] Hammers the dbclick event in the mobile environment.
hammerPressTime: Time to keep pressing until the press event is triggered.
hideHeader: [default:false, true] Whether to hide the header or not
id: Component ID
ignoreCellClick: Prevents oncellclick event upon clicking of the toggling image when the drilldown is on.
ignoreNonEditableCell: Ignores Tab or Enter key movement when the cell is not editable.
ignoreNonEditableCellTabEnter: Allows moving between readonly cells when the ignoreNonEditableCell is true.
ignoreToggleOnDisabled: Prevents toggling when the cell is disabled upon clicking of the etoggling image when the drilldown is on.
keepDefaultColumnWidth: [default:false, true] Fixes the widths of rowNum columns and rowStatus columns when the autoFit is true.
keyMoveEditMode: [default:false, true] Directly enters into the editing mode upon focusing moving by the key (Tab and Enter).
loadCount: Triggers the onscrollend event when the vertical scroll reaches the bottom and the number of the remaining rows is same as the loadCount specified here.
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 area.
mergeCol: Specify columns to apply the mergeCells property. Enter the column IDs and use the comma (“ , ”) as the separator.
moveKeyEditMode: Enters the editMode upon pressing of an arrow key.
moveKeyEditModeAll: Enters the editMode upon pressing of an arrow key. Includes the arrowMove feature, and supports following inputType.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
noResultMessage: [default: There is no result.
noResultMessageClass: he name of the class to apply a separate message to noResultMessage (when there is zero data in the DataList). The HTML structure of the message uses div tag and the Text is displayed in the sub section.
noResultMessageStyle: Sets a separate style for the noResultMessage (when there is zero data in the DataList). Instead of the default style, the specified style in this property will be used.
noResultMessageVisible: [default:true, false] Shows the message when there is no search result (0 data in the DataList).
numberMask: [default: ""] Masking value to be applied when the dataType is "number" or when the changeCurrency API is used.
oddEvenColorDisplay: [default:true, false] Uses same colors for odd and even rows respectively.
oddRowBackgroundColor: Background color of the odd rows
overflowX: [default:auto, hidden, scroll] Displays the horizontal scrolling bar.
overflowY: [default:auto, hidden, scroll] Displays the vertical scrolling bar.
pasteOption: [default: "", focus] Specifies how to paste the column data copied by Ctrl (or cmd) + V.
preventAddRowOnPaste: [default: false, true] Prevents adding of a new row upon pasting data from the clipboard through Ctrl (or cmd)+V.
preventAddRowOnPaste: [default: false, true] Prevents adding of a new row upon pasting data from the clipboard through Ctrl (or cmd)+V.
preventCopy: [default: false, true] Prevents copying of the entire GridView data through Ctrl (or cmd)+V.
preventCopyColumn: [default: ""] Prevents copying of the column data of the GridView to the clipboard through Ctrl (or cmd)+V.
preventMultisort: [default:true, false] Prevents multi-sorting.
preventPaste: [default: false, true] Prevents pasting of the GridView data from the clipboard through Ctrl (or cmd)+V.
preventPasteColumn: [default: ""] Prevents copying of the column data of the GridView from the clipboard through Ctrl (or cmd)+V.
readOnly: [default:false, true] nables readOnly property or all cells of the GridView component. In case readOnly is enabled for the body column, the setting of the body column will be prior.
readOnlyBackgroundColor: Background color of the cell of which readOnly property is true.
readOnlyBackgroundImg: Path of the background image for the cell of which readOnly property is true.
readOnlyBackgroundImgCSS: CSS statement for the background image of the cell of which readOnly property is true. Prior to the readOnlyBackgroundImg property.
readOnlyPriority: [default:column, row] Priority in enabling the readOnly property.
readOnlyTabIgnore: [default:false, true] Ignores the cell of which readOnly property is enabled to select the next cell upon the end user's pressing the Tab key on the readOnly-enabled cell.
resize: [default:true, false] Allows resizing of the column width by the end user's dragging the border of the header column.
rowMouseOver: [default:true, false] Displays the background color of the row hovered by the end user.
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 (value) when the rowNumVisible is true.
rowNumLocaleRef: localeRef key to set in the rowNum column.
rowNumStatusResize: [default:false, true] Resizes the number and status column widths.
rowNumStatusUniqueId: [default:false, true] Uses unique ID in each row when the rowNumVisible or the rowNumStatus is enabled.
rowNumVisible: [default:false, true] Displays the row number of the DataList data bound with the GridView.
rowNumWidth: Width of the column when the rowNumVisible is true.
rowStatusHeaderValue: Header text (value) when the rowStatusVisible is true.
rowStatusLocaleRef: localeRef to set in the rowStatus column.
rowStatusVisible: [default:false, true] Displays the status of each row (add, modified, or deleted) through the use of icons.
rowStatusWidth: Width of the column when the rowStatusVisible is true.
rupeeMask: [default: ""] Masking value to be applied when the dataType is "rupee" or when the changeCurrency API is used.
scrollByColumn: [default:false, true] Horizontally scrolls by column.
scrollByColumnAdaptive: [default:false, true] Scrolls by column unit in the adaptive mode.
selectedCellColor: Background color of the selected cell.
selectedCellOverColor: Backgorund of the moused-over cell
selectedRowColor: Background color of the selected row
selectedRowOverColor: Background color to be displayed upon the end user's hovering the mouse over the selected row.
senseReader: [default:false, true] A mode to support web accessibility requirements. When this property is true, the end user can rotate every cell on the GridView by pressing the Tab key.
setCellInputTypeCustom: An option to dynamically change the inputType of the cell of which inputType is custom.
showImageTooltip: [default: false, true] Displays the tooltip when the inputType is "image".
showSortableImage: [default:false, true] Shows the sorting image on the header of the sortable column.
showSortableUseFilter: [default: false, true] Displays the sortable and the useFilterList icons on the header when both the useFilterList and the showSortableImage properties are in use.
sortable: Whether to support data sorting by the end user's clicking the header on the GridView component.
sortedIconPosition: Sets a position to show the sorting images.
sortEvent: [default:ondblclick, onclick] Sets an event to apply the sorting function of the column header of which sortable property is 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.
summaryAuto: Automatically sets the header column name in the summary to support web accessibility.
summaryOnlyAuto: [default: false, true] Sets the summary only with text without tags if the header title includes HTML.
syncScroll: Vertically scrolls multiple GridViews at the same time.
syncScrollId: ID of the GridView to synchronize the scrolling.
tengeMask: [default: ""] Masking value to be applied when the dataType is "tenge" or when the changeCurrency API is used.
titleAuto: [default: false, true] When the inputType of the cell header is "text" and the inputType of the cell is "text, link, checkbox, button, radio, select (with tableRender being "ul"), or secret",
titleFormatter: [default: false, true] When the inputType of the cell header is "text" and the inputType of the cell is "text, link, checkbox, button, radio, select (with tableRender being "ul"), or secret",
tooltipDisplay: [default:false, true] Displays the cell data as a tooltip upon the end user's hovering the mouse over the cell when the cell data is longer than the cell width.
tooltipDisplayColumn: [default: false, true] Sets the column name to display tooltip on certain columns
tooltipFormatter: Name of the user-defined function to format the tooltip contents when the tooltipDisplay is true.
tooltipHeader: [default:false, true] Displays the tooltip on the GridView header. Valid in case of tooltipDisplay = "true" (or tooltipShowAlways="true").
tooltipPositionX: [defulat:20] The X coordinate of the tooltip when the tooltipDisplay property is true. The left end of the body cell is the origin. The calculation is made in pixels.
tooltipPositionY: [defulat:cellHeight+3] The Y coordinate of the tooltip when the tooltipDisplay property is true. The upper-left corner of the body cell is the origin. The calculation is made in pixels.
tooltipShowAlways: [default:false, true] Always displays the tooltip regardless of the Text length. When this property is enabled, the tooltip will be always displayed except when the data is blank (“”).
tooltipShowAlwaysColumns: [default:""] Displays the tooltip for each column. Always shows the tooltip on every column except the column data is blank (“”).
useCtrlKey: [default:true, false] Allows use of the ctrl key to select multiple cells.
useCtrlOnMultisort: [default:true, false] Allows use of the ctrl key to sort multiple columns.
useFilterList: [default: false, true] Displays the filter list. 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.
useFilterListSync: [default: false, true] Synchronizes the filter when the filtering is made by the setFilter API of the dataList when the useFilterList is "true".
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.
wheelRows: [default: 3] Number of the rows changing upon the end user's clicking the vertical scrolling bar each time.
wheelStop: [default:false] Prevents scrolling at the bottom of the GridView.

Event Summary

onaftercolumnmove: Triggered right after a column moving
onaftercolumnresize: Triggered right after column resizing
onafteredit: Triggered upon the end user's moving the focus out of the cell after editing. Triggered after the oneditend event.
onbeforecolumnmove: Triggered right before column moving
onbeforeedit: Triggered before the end user's entering the cell editing mode.
onbeforesort: Triggered right before column sorting
onblankclick: Empty screen 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 the end user's double-clicking the 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.
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 double-clicking of a cell in the Edit mode. (Valid when the inputType is text, textImage, drilldown, or secret.)
oneditend: Triggered upon the end user's finishing editing the cell data. Triggered before the onafteredit.
oneditkeydown: Triggered upon the end user's pressing a key in the edit mode. For Korean characters (2 bytes for each character), the event will be triggered upon completion of the character.
oneditkeyup: Triggered upon the end user's pressing a key in the edit mode. For Korean characters (2 bytes for each character), the event will be triggered upon completion of the character.
oneditkeyup: Triggered upon the end user's releasing a key on the keyboard after pressing the key.
onfilereadend: Triggered after an Excel file is uploaded to the GridView component.
onfooterclick: Triggered upon the end user's clicking of the footer.
onheaderclick: Triggered upon the end user's clicking the header.
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 on the keyboard after pressing the key.
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.
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.

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 , delimeter , decimalDelimeter ): Dynamically changes the monetary unit in the cell displayed on the column basis.
checkAll( colIndex , dataValue ): Selects or unselects all rows with checkboxes.
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 ID of the column of the corresponding index.
getColumnIndex( colIndex ): Returns the index of the column of the corresponding 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 value of the inputType property of the column of the corresponding colIndex.
getColumnVisible( colIndex ): Returns the visible status of the column of the corresponding colIndex.
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 ): Gets the dataType of the specified 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( ): 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 ): Gets 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 value of the disabled property of the row of the corresponding rowIndex.
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. If there is no sorted column, an empty array will be returned.
getTopRowIndex( ): Returns the rowIndex of the top row on the current screen.
getTotalCol( ): Gets the total number of the columns.
getTotalHeaderCol( options ): Returns the visible status of the column of the corresponding colIndex.
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 (not including subtotal and footer 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 whether the GridView component is currently being edited.
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 with the same data in the same row or 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 certain rows from automatic merging of the cells 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 ifile 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 ): Automatically changes the column sizes to fit to the size 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.)
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 ): Checks (when the flag is true) or unchecks (when the flag is false) when the inputType of the cell of the corresponding rowIndex and the colIndex is checkbox or radio.
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.
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 ): Changes the dataType setting of the specified column.
setDisabled( type , rowIndex , colIndex , disableFlag ): Sets the disabled property according to the type.
setDrillDownDragDrop( value ): Set dataDragDrop="true" in the GridView which contains drillDown column, and set in setDrillDownDragDrop function.
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 ): Moves 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 of the header. If the inputType is Text, the displayed string will be accordingly converted.
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 or shows specified 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.
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 property of the SelectBox when the inputType is select in the gridView column.
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.
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. (Opend 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. (The default is 480.)
applyAllColumnStyle: Whether to apply all styles to the column. (The default is false, and only the first style is applied to 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.
true: Allows moving.
false (Default): Does not allow.
Related Property: moveKeyEditMode="true"
autoFit: [default:none, lastColumn, allColumn, none] Fills in the full width of the GridVeiw without generating any horizontal scroll.
allColumn adjusts widths of all columns by evenly distributing blank space to all columns while lastColumn adjusts only the width of the last column. none is not to use the autoFit feature.
autoFitMinWidth: Sets the minimum width of the GridView component (in pixels). Applied when the autoFit property is allColumn.
captionAuto: [default:false] When the captionTitle is defined, combines the captionTitle and the Header Title, and displays it as the table title.
Valid only when the header has inputType="text" setting.
To use this property in the TableLayout, set as tagName="table".
true: Combines the CaptionTitle with the header title of the table and displays it as the table title. false: (Default) Does not display.
When the GridView has header titles of Item 1, Item 2, and Item 3,
"The transaction is a table of Item 1, Item 2, and Item 3"
captionTitle: [default:""] Specify the text to put before the header title when the captionAuto is "true".
checkDisabledOnCut: [default:false, true] When cutting data from the GridView by pressing Ctrl (or cmd)+X, decides whether to include the disabled column data in the data to be cut.
true : Checks the disabled status of the column and does not cut the disabled column data.
false: Does not check the disabled status of the column and cuts the disabled column data.
checkEditableInputClass: [default: false, true] When inputType is "text" and the cell is readOnly or disabled,
Deletes "w2grid_input" class from the nobr tag.
true: Deletes "w2grid_input" class from nobr tag in readOnly or disable state.
false : Applies "w2grid_input" class to nobr tag all the time.
checkReadOnlyOnCut: [default:false, true] When cutting data from the GridView by pressing Ctrl (or cmd)+X, decides whether to include the readOnly column data in the data to be cut.
true : Checks the readOnly status of the column and does not cut the readOnly column data.
false: Does not check the readOnly status of the column and cuts the readOnly column data.
checkReadOnlyOnPaste: [default:false, true] Pastes the data on the clipboard on the readOnly cell using Ctrl (or Cmd) +V.
true : Prevents the data from being pasted to the readOnly column.
false: Allows the data to be pasted on the readOnly columns.
checkReadOnlyOnPasteEnable: [default:""]Sets the column ID to paste the data to the column for which the checkReadOnlyOnPaste is "true".
(Example) checkReadOnlyOnPasteEnable = "col1,col2";
col1 and col2 columns supports data pasting even when readOnly and checkReadOnlyOnPaste are "true" each.
class: Same as the class property in HTML standard. One or more classes defined in the CSS file or in the style block can be applied (through the use of the space as the separator).
As a very complex structured component, the lower components of the GridView should be accessed by the CSS selectors.
WebSquare5 Engine applies different classes to different components. By defining a common class, the common class can be applied to multiple components.
columnMove: Allows the user to move the column by dragging the GridView header. The header value will be displayed on the tooltip.
Cannot be used with the groupby API.
Note the following restrictions.
colSpan : When the column has colSpan setting, the column cannot be moved.
Two rows in the header: The column cannot be moved.
subtotal: The subtotal column is not moved.
footer: The footer column is not moved.
columnMoveWithFooter: [default: false, true] Moves the footer too when dragging columns using the setColumnOrder function or columnMove="true" setting. (Valid only when the footer has the same merge structure with the header and the footer.)
true: Moves the footer.
false (Default): Does not move the footer.
Related functions and properties: setColumnOrder, columnMove="true"
contextMenu: [default: false, true] Uses the context menu.
customFilterBox: [default: false, true] When the groupbyZone is "true" and the groupbyFilterBox is "true"
Additionally set useFilterList and useFilter as true, and filter the header. Then, the filtering conditions will be displayed on the filterBox.
When the conditions are displayed, run the groupby API. The condition will be kept after execution of the groupby. Filtering and grouping can be applied at the same time.
(Added in 5.0_1.2701A.20170714.211228.)
true: The filtering conditions are displayed before groupby, and the condition is kept upon execution of groupby API.
false: Default. Does not display the filtering conditions in the filterBox. The condition is not kept upon execution of groupby API but is initialized instead.
dataDragDrop: [true, false] Whether to allow data moving between GridView components through dragging-and-dropping. On Firefox, the end user must press the Ctrl key to use this feature.
Two GridView must be bound with different DataLists each, and this property must be set for them.
dataDragSelect: [true, false] Allows the end user to select multiple cells by dragging. The useShiftKey option must be enabled. (Cannot be used with dataDragDrop at the same time.)
dataList: ID of the DataList to bind with the GridView component data.
defaultCellHeight: Default cell height
disabledBackgroundColor: Background color or the disabled cell or row
disabledFontColor: Text color of the disabled cell or row
disabledScrollHidden: [default:false, true] Hides the scroll when the GridView is disabled.
Prevents the scroll from being moved when the GridView is disabled in non-IE browsers.
dragDisplayColumn: Sets the ID of the column to be displayed as a tooltip upon the end user's dragging. Multiple IDs can be entered being separated by comma.
Sets the ID of the column to be displayed as a tooltip upon the end user's dragging. Multiple IDs can be entered being separated by comma.
dragEndFunction: The function to be executed upon the end user's completing dragging. To be used in pair with dragStartFunction. Must be defined for two cases when drilling-down is enabled and when disabled.
1) When dragEndFunction is defined, targetRowIndex, rowXml, and infoObj are received as first, second, and third arguments respectively. The second argument rowXML is returned by dragStartFunction, and the third argument infoObj is an object which contains fromColumnId, fromColumnIndex, toColumnId, and toColumnIndex .
ragEndFunction is to implement a logic to insert a row to targetRowIndex. When "true" is returned, the row of the rowIndex where drag-and-drop was initiated will be deleted.
function end( targetRowIndex, rowXml, info ) {
var fromColumnId = info.fromColumnId;
var fromColumnIndex = info.fromColumnIndex;
var toColumnId = info.toColumnId;
var toColumnIndex = info.toColumnIndex;
.
.
.
return true; // Only when true is returned, the row of the rowIndex where drag-and-drop was initiated will be deleted.
}
2) In case drilling-down is enabled for the grid, true must be given as the first argument of setDrillDownDragDrop. In this case, dragStartFunction will receive toIndex, rowXml, and infoObj as first, second, and third arguments.
As the first index, toIndex is given. Since drilling-down is enabled, the toIndex is the realRowIndex of the targetIndex.
As the third argument, an object containing removedData, removedRowIndex, insertedData, insertedRowIndex, fromRowIndex, toRowIndex will be given. Unlike the cases above, the return value does not have any relevance.
function end( toIndex, rowXml, info ) {
var removedData = info.removedData;
var removedRowIndex = info.removedRowIndex;
var insertedData = info.insertedData;
var insertedRowIndex = info.insertedRowIndex;
var fromRowIndex = info.fromRowIndex;
var toRowIndex = info.toRowIndex;
.
.
.
}
dragStartFunction: The function to be executed upon the end user's starting dragging. To be used in pair with dragEndFunction. Must be defined for two cases when drilling-down is enabled and when disabled.
drilldownToggleScrollFix: [default:false, true] Fixes the scroll upon the end user’s clicking + button on the drilldown column.
dynamic: [default:false, true] Whether the GridView is to be dynamically created by setGridStyle on an empty GridView.
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: An event to enter the modification mode
editModeEventIcon: [default:onclick] The event of which occurrence will result in entering the Editing mode when the column viewType is "icon".
When the editModeEventIcon is enabled for the column, the editModeEventIcon enabled for the GridView will be ignored.
In case the editModeEventIcon is not set for column nor for the GridView, the default "onclick" will be used.
enterKeyMove: [default:down, right, none, edit] Sets the focus-moving direction upon the end user's pressing the Enter key.
escape: Converts <>&" characters into HTML Escape characters.
euroMask: [default: ""] 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: [default:false, true] Excludes the deleted rows from subtotaling and totaling (footer) expressions (upon use of deleteRow and deleteRows methods.)
excludeModifiedRows: [default:false, true] Excludes the rows of which status has been changed to “d” by modifyRowStatus API from subtotaling and totaling (footeR) expressions. (When modifyRowStatus is used.)
fastScroll: Supports fast scrolling in vertical direction. Displays only available data for the time.
The notification message will be displayed while the data is being loaded.
filterBoxvisibleRowNum: Number of the conditions to be displayed on the filtering condition list
Related Property: groupbyFilterBox="true"
filterFocusMode: Whether to remove the focus or not on the selected cell or row in the body before the sorting event is triggered.
outfocus : Removes the focus from the body, and sorts the data.
infocus : Keeps the focus and sorts the data.
followfocus : Sorts the currently focused data while keeping the focus to the currently focused item in the new sorting result. At this time, the scrollend event is not triggered.
filterShowAlways: [default: false, true] Shows the filtering icon first when the width of the column with useFilter=true setting is small.
fixedColumn: Column to fix. To fix the first column, enter 1.
fixedColumnNoMove: [default:false, true] Allows moving (columnMove) of the column that is fixed by fixedColumn property.
fixedColumnScrollHidden: Hides the scroll in the fixed area while the fixedColumn is in use.
fixedColumnWithHidden: [default:true, false] Includes the hiddenColumn when calculating the position of the fixedColumn property.
fixedRow: Location of the first column to fix. To fix the first row, enter “1”.
focusDefaultColumn: [default:false, true] When set as true, both the rowNum and the rowStatus columns can get the focus.
The rowNum is displayed when the rowNumVisible property is enabled, and the rowStatus is displayed when the rowStatusVisible is enabled.
focusFlow: Sets the focus flow linear or two-dimensional (default).
linear: Linear
default (Default): Two-dimensional
focusMode: [default:cell, row, both, none] The method of displaying the selected (or focused) cell.
focusMove: [default:true, false, vertical, horizontal] Allows focus moving through the key.
true : Allows moving in up, down, right, left directions.
false : Does not allow moving at all.
vertical : Allows vertical moving only.
horizontal : Allows horizontal moving only.
footerCaption: [default: ""(null)] Content of the footer.
footerCaption: caption of the grid footer
footerCaptionAuto: [default: false, true] Automatically generates the footer text for the footerCaption property regardless of the captionAuto setting.
Related Property: captionTitle, footerCaption
footerSummary: [default: ""(null)] Summary of the footer contents
footerSummary: grid footer summary
footerSummaryAuto: [default: ""(빈 값)] Automatically generates footer in the footer summary regardless of the captionAuto setting.
Related Properties: captionTitle, footerSummary
groupbyFilterBox: Displays the filtering conditions when using the groupby (filtering) feature. The end user can select one of the filtering conditions from the list.
true: Display.
false (Default): Not display.
Related Property: groupbyFilterBoxLocation (Location to display the filtering condition list), filterBoxvisibleRowNum (Number of filtering conditions to display)
groupbyFilterBoxFormatter: Formats the label to be added to the groupby FilterBox. (Define the format.) Gets two parameters - data and isGroupby.
data : Contains information about the filter to be added to the groupby filterbox. Has header and filter child objects.
data.header: Header label of the column to filter
data.filter : Object containing filtering conditions
data.filter.operator filter operator
data.filter.values filter value to compare (In case of multiple values, an array is provided.)
data.filter.gate filter conjuctive [undefiend, and, or]
isGroupby : true when groupby is applied, or false.
groupbyFilterBoxLocation: Location of the filtering condition box (groupbyFilterBox).
top: Display at the top.
bottom (Default): Display at the bottom.
Related Property: groupbyFilterBox (Display of the filtering condition list)
groupbyMaxCount: Set the maximum number of the columns to which groupby can be applied.
groupbyZone: Whether to use 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: [default:true, false] Hammers the dbclick event in the mobile environment. Decides whether to handle as the press event of JS or not.
hammerPressTime: Time to keep pressing until the press event is triggered. The unit is ms, and the default is 251ms.
hideHeader: [default:false, true] Whether to hide the header or not
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
ignoreCellClick: Prevents oncellclick event upon clicking of the toggling image when the drilldown is on.
ignoreNonEditableCell: Ignores Tab or Enter key movement when the cell is not editable.
ignoreNonEditableCellTabEnter: Allows moving between readonly cells when the ignoreNonEditableCell is true.
ignoreToggleOnDisabled: Prevents toggling when the cell is disabled upon clicking of the etoggling image when the drilldown is on.
keepDefaultColumnWidth: [default:false, true] Fixes the widths of rowNum columns and rowStatus columns when the autoFit is true.
keyMoveEditMode: [default:false, true] Directly enters into the editing mode upon focusing moving by the key (Tab and Enter).
loadCount: Triggers the onscrollend event when the vertical scroll reaches the bottom and the number of the remaining rows is same as the loadCount specified here.
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.
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.
byrestriccol : Merges the rows when the same data is repeated within the column and the column on the left is merged. (There are n+1 columns, and column n is the upperColumn.)
byrestricrow : Merges the rows when the same data is repeated within the same row and the upper row is merged. (There are n+ rows, and row n is the upperRow.)
mergeCellsFixedCols: Merges adjacent cells with the same data in the fixedColumn.
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.
mergeCellsFixedRows: Merges adjacent cells with the same data in the fixedRow area.
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.
mergeCol: Specify columns to apply the mergeCells property. Enter the column IDs and use the comma (“ , ”) as the separator.
(Example) With mergeCells="byCol" and mergeCol="col1,col3", rows with the same data on col1 and col3 will be merged.
moveKeyEditMode: Enters the editMode upon pressing of an arrow key.
moveKeyEditModeAll: Enters the editMode upon pressing of an arrow key. Includes the arrowMove feature, and supports following inputType.
Supported inputType: text, select, calendar, checkcombobox, secret, textarea
In case of text, calendar, secret, and textarea, moving up and down arrows will move between the cells and moving right and left arrows will move between the characters in the cell. Clicking right or left arrow at the last or first character will move to the previous or next cell.
In case of select and checkcombobox, pressing right or left key will move to the next cell cell and pressing up or down key on the first or last item on the list will move to the next cell.
Not supported because setTimeout causes losing of the focus in inputType=“autoComplete” column.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
noResultMessage: [default: There is no result.] Message to be display when there is no result (0 data match in the DataList.)
noResultMessageClass: he name of the class to apply a separate message to noResultMessage (when there is zero data in the DataList). The HTML structure of the message uses div tag and the Text is displayed in the sub section.
Note that the style is applied as inline. Add !important to each style property in the class.
noResultMessageStyle: Sets a separate style for the noResultMessage (when there is zero data in the DataList). Instead of the default style, the specified style in this property will be used.
The HTML structure of the message uses div tag and the Text is displayed in the sub section. If position and display are not specified, the WebSquare5 Engine will allocate absolute and block values for these properties.
The following is the basic style of the message used by the WebSquare5 Engine. Following properties must be defined for a proper display message on the layout.
(Example) position: absolute; display: block; left: 40%; width: 20%; top: 40%; text-align:center;
noResultMessageVisible: [default:true, false] Shows the message when there is no search result (0 data in the DataList).
numberMask: [default: ""] Masking value to be applied when the dataType is "number" or when the changeCurrency API is used.
oddEvenColorDisplay: [default:true, false] Uses same colors for odd and even rows respectively.
oddRowBackgroundColor: Background color of the odd rows
overflowX: [default:auto, hidden, scroll] Displays the horizontal scrolling bar.
overflowY: [default:auto, hidden, scroll] Displays the vertical scrolling bar.
pasteOption: [default: "", focus] Specifies how to paste the column data copied by Ctrl (or cmd) + V.
preventAddRowOnPaste: [default: false, true] Prevents adding of a new row upon pasting data from the clipboard through Ctrl (or cmd)+V.
preventAddRowOnPaste: [default: false, true] Prevents adding of a new row upon pasting data from the clipboard through Ctrl (or cmd)+V.
preventCopy: [default: false, true] Prevents copying of the entire GridView data through Ctrl (or cmd)+V.
preventCopyColumn: [default: ""] Prevents copying of the column data of the GridView to the clipboard through Ctrl (or cmd)+V.
The preventCopyColumn is applied on the column ID basis.
(Example) preventCopyColumn = "col1,col2";
preventMultisort: [default:true, false] Prevents multi-sorting.
preventPaste: [default: false, true] Prevents pasting of the GridView data from the clipboard through Ctrl (or cmd)+V.
preventPasteColumn: [default: ""] Prevents copying of the column data of the GridView from the clipboard through Ctrl (or cmd)+V.
The preventPasteColumn property is applied on the column ID basis.
(Example) preventPasteColumn = "col1,col2";
readOnly: [default:false, true] nables readOnly property or all cells of the GridView component. In case readOnly is enabled for the body column, the setting of the body column will be prior.
The readOnly property can be selectively applied to GridView, column, row, cell through the use of the APIs, and the application priority is shown below.
gridView < column < row < cell (Column and row priorities can be changed by the readOnlyPriority of the GridView.)
readOnlyBackgroundColor: Background color of the cell of which readOnly property is true.
readOnlyBackgroundImg: Path of the background image for the cell of which readOnly property is true.
readOnlyBackgroundImgCSS: CSS statement for the background image of the cell of which readOnly property is true. Prior to the readOnlyBackgroundImg property.
(Example) background: steelblue url("Image file path") 10px 50% no-repeat;
readOnlyPriority: [default:column, row] Priority in enabling the readOnly property.
The readOnly property can be selectively applied to GridView, column, row, cell through the use of the APIs, and the application priority is shown below.
gridView < column < row < cell (Column and row priorities can be changed by the readOnlyPriority of the GridView.)
readOnlyTabIgnore: [default:false, true] Ignores the cell of which readOnly property is enabled to select the next cell upon the end user's pressing the Tab key on the readOnly-enabled cell.
resize: [default:true, false] Allows resizing of the column width by the end user's dragging the border of the header column.
rowMouseOver: [default:true, false] Displays the background color of the row hovered by the end user.
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 (value) when the rowNumVisible is true.
rowNumLocaleRef: localeRef key to set in the rowNum column.
rowNumStatusResize: [default:false, true] Resizes the number and status column widths.
rowNumStatusUniqueId: [default:false, true] Uses unique ID in each row when the rowNumVisible or the rowNumStatus is enabled.
The default is false. In default, the ID of the rowNum td will be _headerRowNumber, and the ID of the rowStatus td will be _headerStatusNumber.
To pass the W3C validator, set the property as true. In other words, the recommended setting is true.
rowNumVisible: [default:false, true] Displays the row number of the DataList data bound with the GridView.
rowNumWidth: Width of the column when the rowNumVisible is true.
rowStatusHeaderValue: Header text (value) when the rowStatusVisible is true.
rowStatusLocaleRef: localeRef to set in the rowStatus column.
rowStatusVisible: [default:false, true] Displays the status of each row (add, modified, or deleted) through the use of icons.
rowStatusWidth: Width of the column when the rowStatusVisible is true.
rupeeMask: [default: ""] Masking value to be applied when the dataType is "rupee" or when the changeCurrency API is used.
scrollByColumn: [default:false, true] Horizontally scrolls by column.
scrollByColumnAdaptive: [default:false, true] Scrolls by column unit in the adaptive mode.
selectedCellColor: Background color of the selected cell.
selectedCellOverColor: Background color upon the end user's hovering the mouse over the selected cell. (If not specified, the value of the rowMouseOverColor will be used instead.)
selectedRowColor: Background color of the selected row
selectedRowOverColor: Background color to be displayed upon the end user's hovering the mouse over the selected row. (If not specified, the value of the rowMouseOverColor will be used instead.)
senseReader: [default:false, true] A mode to support web accessibility requirements. When this property is true, the end user can rotate every cell on the GridView by pressing the Tab key.
When the inputType is text, select, radio, or checkbox, set the embeddedInput as true to render the input so that the reader can recognize that the input (or select, radio, or checkbox) contained in the cell.
It is recommended to set focusMode as none and focusMove as false.
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: [default: false, true] Displays the tooltip when the inputType is "image".
true: Displays the tooltip when the inputType is "image".
false (Default): Does not display the tooltip when the inputType is "image".
showSortableImage: [default:false, true] Shows the sorting image on the header of the sortable column.
showSortableUseFilter: [default: false, true] Displays the sortable and the useFilterList icons on the header when both the useFilterList and the showSortableImage properties are in use.
Related Property: showSortableImage="true", sortable="true", useFilterList="true"
true: Displays both the user-defined filter icon and the sorting icon.
false (Default): Displays only the sorting icon.
sortable: Whether to support data sorting by the end user's clicking the header on the GridView component.
sortedIconPosition: Sets the position to display sorting images.
sortEvent: [default:ondblclick, onclick] Sets an event to apply the sorting function of the column header of which sortable property is 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. Mostly used to enhance web accessibility.
summaryAuto: Automatically sets the header column name in the summary to support web accessibility.
summaryOnlyAuto: [default: false, true] Sets the summary only with text without tags if the header title includes HTML.
true: Sets the text only without the HTML tag as the summary.
false (Default): Sets the text and the HTML tag as the summary.
Related Property: summaryAuto="true"
syncScroll: Vertically scrolls multiple GridViews at the same time. Valid when the GridViews have a same number of the rows.
syncScrollId: ID of the GridView to synchronize the scrolling.
tengeMask: [default: ""] Masking value to be applied when the dataType is "tenge" or when the changeCurrency API is used.
titleAuto: [default: false, true] When the inputType of the cell header is "text" and the inputType of the cell is "text, link, checkbox, button, radio, select (with tableRender being "ul"), or secret",
Set to display the following in the title of the cell.
For example, if the header title of the cell is "name1", cell data is "1" and the inputType is "text", the title of the cell will be "name1 1".
If the cell data is "", the cell title will be "name text".
titleFormatter: [default: false, true] When the inputType of the cell header is "text" and the inputType of the cell is "text, link, checkbox, button, radio, select (with tableRender being "ul"), or secret",
Allows the developer to customize the cell title. (For web accessibility.)
tooltipDisplay: [default:false, true] Displays the cell data as a tooltip upon the end end user's hovering the mouse over the cell when the cell data is longer than the cell width.
tooltipDisplayColumn: [default: false, true] Sets the column name to display tooltip on certain columns
(Example) tooltipDisplayColumn = "col1,col2";
tooltipFormatter: Name of the user-defined 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.
tooltipHeader: [default:false, true] Displays the tooltip on the GridView header. Valid in case of tooltipDisplay = "true" (or tooltipShowAlways="true").
Functions same as existing tooltip options such as tooltipDisplay and tooltipDisplayTime.
tooltipPositionX: [defulat:20] The X coordinate of the tooltip when the tooltipDisplay property is true. The left end of the body cell is the origin. The calculation is made in pixels.
A coordinate can be inserted to the calculation as well as cellWidth and cellHeight.
(Example) cellWidth/2 : The center of the body cell is the starting point on the X axis for the tooltip.
tooltipPositionY: [defulat:cellHeight+3] The Y coordinate of the tooltip when the tooltipDisplay property is true. The upper-left corner of the body cell is the origin. The calculation is made in pixels.
A coordinate can be inserted to the calculation as well as cellWidth and cellHeight.
(Example) cellHeight : The Y axis starts from where the body cell ends.
Note that margin-top applied to the GridView component will affect the Y axis.
tooltipShowAlways: [default:false, true] Always displays the tooltip regardless of the Text length. When this property is enabled, the tooltip will be always displayed except when the data is blank (“”).
tooltipShowAlwaysColumns: [default:""] Displays the tooltip for each column. Always shows the tooltip on every column except the column data is blank (“”).
For example, tooltipShowAlwaysColumns = "col1,col2" will always show tooltips on col1 and col2 columns
except when the data is blank.
useCtrlKey: [default:true, false] Allows use of the ctrl key to select multiple cells.
useCtrlOnMultisort: [default:true, false] Allows use of the ctrl key to sort multiple columns.
useFilterList: [default: false, true] Displays the filter list. 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.
true: Displays the filtering conditions including the "User-defined Filter”.
false (Default): Does not display the filtering conditions without the “User-defined Filter”.
Related Property: Valid when the gridView.column) uses useFilter="true" setting.
useFilterListSync: [default: false, true] Synchronizes the filter when the filtering is made by the setFilter API of the dataList when the useFilterList is "true".
Set on the entire GridView.
true: Displays the full filter list not only upon the end user’s selecting the filter list but also upon filtering by setFilter or setColumnFilter API of the DataList.
false (Default): When filtering is made by a DataList API, the filter list with removed data will be hidden.
Related property: useFilterList="true"
userData1: User-defined property. Use getUserData("userData3") to get the data.
userData2: User-defined property. Use getUserData("userData2") 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. The option all is to display all row without a scroll bar.
wheelRows: [default: 3] Number of the rows changing upon the end user's clicking the vertical scrolling bar each time.
wheelStop: [default:false] Prevents scrolling at the bottom of the GridView.

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 end user's moving the focus out of the cell after editing. Triggered after the oneditend event.

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 the end user's entering 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

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

onblankclick

Empty screen 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

oncelldblclick

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

Parameter
name	type	description
row	Number	Row index of the cell
col	Number	Column index of the 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 the component to which the data was moved over.)

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 from which dragging started.)

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 the component to which the data is being 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 double-clicking of a cell in the Edit mode. (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

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 a key in the edit mode. For Korean characters (2 bytes for each character), the event will be triggered upon completion of the character.

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

Sample

oneditkeyup

Triggered upon the end user's pressing a key in the edit mode. For Korean characters (2 bytes for each character), the event will be triggered upon completion of the character.

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

Sample

oneditkeyup

Triggered upon the end user's releasing a key on 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 end user's clicking of the footer.

Parameter
name	type	description
footerId	String	ID of the clicked footer

onheaderclick

Triggered upon the end user's clicking the header.

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 on the keyboard after pressing the key.

Parameter
name	type	description
e	Object	Event object

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.

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.

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

Sample

Method Detail

advancedExcelDownload( options , infoArr )

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

Parameter
name	type	required	description
options	Object	Y	Downloading options for the grid data (stored in JSON format) as an Excel file
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

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 , delimeter , decimalDelimeter )

Dynamically changes the monetary unit in the cell displayed on the column basis.

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
displayFormat	String	N	displayFormat for the column
delimeter	String	N	Delimiter
decimalDelimeter	String	N	Decimal point delimeter

Sample

Call the following. 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.) Checked: true, 1, and trueValue, Unchecked: false, 0, and fasleValue

clearGroupby( )

Cancels the groupBy setting.

clearRowVisible( )

Shows all rows hidden by the setRowVisible API.

Sample

gridView1.clearRowVisible(); // Shows all rows hidden by the setRowVisible API.

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) ["IYOU", "19930516", "Patrick Kim", "19780207", "Ray Park", "19930817", "Christina Park", "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. If there is no row, -1 will be returned.

Return
type	description
Number	rowIndex of the bottom row

Sample

// 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) 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).

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 Example) [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. (Supported for selectbox, autoComplete, and checkcombobox columns.)

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

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, an 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 value of the inputType property of the column of the corresponding colIndex.

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 )

Gets the dataType of the specified 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( )

Returns the most right column index among the fixed columns.

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 values - Initial State: "R", Updated: "U", Inserted: "C", Deleted: "D", Inserted and Deleted: "V"

Return
type	description
String	Row status of the currently focused cell (Initial State: "R", Updated: "U", Inserted: "C", Deleted: "D", Inserted and Deleted: "V")

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 )

Gets 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); // Return whether the cell (0, 0) is merged or not.

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.

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

Return
type	description
Boolean	The current readOnly setting

getRealRowIndex( rowIndex )

Returns the rowIndex of the actual data based on the rowIndex displayed on the screen when drilling-down is enabled.

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

Return
type	description
Number	Actual index of the row

getRowBackgroundColor( rowIndex )

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

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

Return
type	description
String	Background color of the row

getRowColor( rowIndex )

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

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

Return
type	description
String	Text color of the row

getRowDisabled( rowIndex )

Returns the value of the disabled property of the row of the corresponding rowIndex.

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

Return
type	description
Boolean	disabled setting of the row

getRowNumVisible( )

Returns the option values of the rowNumVisible.

Return
type	description
Boolean	Settings of the rowNumVisible API

getRowReadOnly( rowIndex )

Returns the value of the readOnly property of the row of the corresponding rowIndex.

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

Return
type	description
Boolean	If not specified, null data will be returned.

getRowVisible( rowIndex )

Hides or shows specified rows.

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the row to check the hidden status.

Return
type	description
Boolean	Visibility of the row. Returns false when hidden, or true when visible.

Sample

gridView1.getRowVisible(30); // Checks the visibility of the row of which index is 30.

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. If there is no sorted column, an empty array will be returned.
The array object contains colID, dataType, and sortOrder. When sortOrder is 1, it is in ascending powers, and when it is -1, it is in descending powers.

Return
type	description
Object	Sorted header information

getTopRowIndex( )

Returns the rowIndex of the top row on the current screen. If there is no data 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","IYOU","19930516"],["0","Patrick Kim","19780207"],["0","Ray Park","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 Example) <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 rows.)
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 whether the GridView component is currently being edited.

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 certain rows from automatic merging of the cells 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 ifile and sets the grid data. (Supported for JDK 1.5 or higher.)

Parameter
name	type	required	description
options	JSON	Y	Uploading options for a CSV file to a JSON GridView

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.

Parameter
name	type	required	description
colIndex	String\|\|Number	Y	Column ID or index
valid	Boolean	N	[defulat:true, false] Whether to process the data according to the validity of the value in the selectbox and the cell when the input.e of the cell 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 )

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

Parameter
name	type	required	description
headerId	Number	Y	header cell ID

saveCSV( options )

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

Parameter
name	type	required	description
options	JSON	Y	Downloading options for the JSON data grid as a CSV file

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 )

Automatically changes the column sizes to fit to the size of the GridView. If autoFit is lastColumn, only the width of the last column will be adjusted. In case of allColum, widths of all columns will be evenly adjusted.

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.)

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 Properties: captionTitle, captionAuto

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

Sample

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 )

Checks (when the flag is true) or unchecks (when the flag is false) when the inputType of the cell of the corresponding rowIndex and the colIndex is checkbox or radio.

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. (When the inputType is "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" }, itemSet : { nodeset: "colorNode/vector", label: "label/@value", value: "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 ID of the birthday column is "birthday", and the dataType of the column is "date". // Change the displayFormat of the "birthday" column into dd-MM yyyy. gridView1.setDisplayFormat("birthday","dd-MM yyyy"); // (Display) Data "19831231" willl 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 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. (Supports only select, autoComplete, and checkcombobox inputType.)

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

// Name, gender, age, and birthday are defined in the GridView, and the body column IDs are name, gender, age, and birthday respectively. // 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 (true is to display, and false is to hide.)

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 )

Changes the dataType setting of the specified column.

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 )

Set dataDragDrop="true" in the GridView which contains drillDown column, and set in setDrillDownDragDrop function.
If set true, drilldown and drag-and-drop will function.

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 )

Moves 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] Sorting status. (1: In ascending powers, -1: In descending powers, 0: Not sorted)
sortOrd	Number	N	[default:0] Sorting priority in case of multi-sorting. If not specified for lower compatibility purposes, the default 0 will be used.

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 of the header. If the inputType is Text, the displayed string will be accordingly converted.
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 or shows specified rows.

Parameter
name	type	required	description
rowIndex	Number	Y	Index of the row to set the hidden status
flag	Boolean	Y	Visibility of the row. true is to show the row, and false is to hide.

Sample

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

setScrollLeft( left )

Moves the horizontal scroll as much as specified. The unit is pixel.

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.
The index is 10 which means from the 11th row will be displayed. Relevant only when the rowNumVisible is set as "true" in the GridView.

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 Example) rowNum will increase 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.

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.)

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