RealGrid2 API
Class
GridView

GridView

GridView 클래스, GridBase 의 자식 클래스이다.

Signature:

export declare class GridView extends GridBase 

Extends: GridBase

Remarks

[상위 클래스]

GridBase

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the GridView class.

Events

PropertyModifiersTypeDescription
onCollapsed(grid: GridView, itemIndex: number) => void그룹핑 된 행이 접힘을 알리는 콜백
onCollapsing(grid: GridView, itemIndex: number) => boolean그룹핑 된 행 접기를 결정하는 콜백
onExpanded(grid: GridView, itemIndex: number) => void그룹핑 된 행이 펼쳐졌음을 알리는 콜백
onExpanding(grid: GridView, itemIndex: number) => boolean그룹핑 된 행 펼치기를 결정하는 콜백
onGrouped(grid: GridView) => void그룹핑했음을 알리는 콜백
onGrouping(grid: GridView, fields: number[]) => boolean그룹핑을 결정하는 콜백
onPageChanged(grid: GridView, page: number) => void그리드가 Paging 상태일 때, 다른 페이지로 이동했음을 알리는 콜백
onPageChanging(grid: GridView, page: number) => boolean그리드가 Paging 상태일 때, 페이지 이동을 결정하는 콜백
onPageCountChanged(grid: GridView, pageCount: number) => void그리드가 Paging 상태일 때, 변경된 페이지 수와 함께 다른 페이지로 이동했음을 알리는 콜백

Properties

PropertyModifiersTypeDescription
filterModeFilterMode데이터 수정 이후 필터의 동작 모드
filterOrboolean컬럼 간 필터 조건을 or 로 할 것인지의 여부
groupingOptionsreadonlyGroupingOptions그리드에 설정되어 있는 행 그룹핑에 관한 설정 정보들
groupPanelreadonlyGroupPanel그리드에 설정되어 있는 Group Panel 모델
groupSummaryModeSummaryMode행 그룹핑된 컬럼의 합계를 계산하는 방식
rowGroupreadonlyRowGroup그리드에 설정되어 있는 행 그룹 모델

Methods

MethodModifiersDescription
beginAppendRow()그리드 마지막 데이터행 이후에 새로운 데이터행을 추가한다.
beginInsertRow(itemIndex, shift)그리드에 인덱스로 입력된 데이터행 앞 또는 뒤에 새로운 데이터행을 생성한다.
beginUpdateRow(itemIndex)입력된 인덱스에 해당하는 데이터 행을 편집상태로 변경한다.
collapseAll(recursive)루트 그룹을 접는다.
collapseGroup(itemIndex, recursive, force)지정한 그룹을 접는다(collapse).
collapseParent(itemIndex, recursive, force)지정한 그룹의 부모를 접는다(collapse).
expandAll(recursive, level)루트 그룹을 펼친다.
expandGroup(itemIndex, recursive, force, level)지정한 그룹을 펼친다(expand).
expandParent(itemIndex, recursive, force, level)지정한 그룹의 부모를 펼친다.
getCheckedItems(rowOnly)체크된 아이템들의 목록을 배열로 반환한다.
getCheckedRows(sort, visibleOnly, allRows)체크된 데이터 행들의 목록을 반환한다.
getDataSource()그리드에 연결되어 있는 DataProvider를 반환한다.
getGroupFieldNames(orginal)그룹핑 된 필드의 이름들을 반환한다.
getGroupFields()그룹핑 된 필드의 인덱스들을 반환한다.
getGroupIndex(itemIndex)자신이 속한 그룹의 인덱스를 반환한다.
getGroupingOptions()그리드 행 그룹핑에 관한 설정 정보들을 반환한다.
getGroupLevel(field)지정한 필드의 그룹 level을 반환한다.
getGroupLevels()현재 몇 level로 그룹핑되어 있는지를 반환한다.
getGroupPanel()그리드의 GroupPanel 을 반환한다.
getGroupSummaryValue(model, column, summaryIndex)GroupFooter의 expression 또는 valueCallback에서 결과값을 가져온다.
getMergedItems(itemIndex, column, dataOnly, force)
getOptions()그리드 옵션 정보를 반환한다.
getPage()Paging 모드에서 현재 페이지 번호를 반환한다.
getPageCount()Paging 모드일 때 전체 페이지 개수를 반환한다.
getPageOfDataRow(dataRow)행이 위치한 페이지를 찾는다.
getRowGroup()그리드의 RowGroup 을 반환한다.
groupBy(fieldNames, sorting, sortDir)지정한 필드 목록에 포함된 순서대로 또는 데이터 정렬 후 순서대로 행 그룹핑을 실행한다.
isGrouped()그리드가 그룹핑되어 있는지 여부를 반환한다.
isGroupItem(itemIndex)지정한 인덱스가 그룹 아이템인지의 여부를 반환한다.
isMergedGrouped()그리드가 mergeMode로 되어 있는지 여부를 반환한다.
isParentVisible(itemIndex)지정한 인덱스의 부모의 표시 여부를 반환한다.
layoutCollapseAll(recursive)그룹Layout의 expandable이 설정된 경우 그룹Layout을 접는다.
layoutExpandAll(recursive)그룹Layout의 expandable이 설정된 경우 그룹Layout을 펼친다.
setGroupingOptions(value)그리드 행 그룹핑에 관한 설정을 한다.
setGroupPanel(value)그리드 GroupPanel 을 설정한다.
setOptions(options)그리드 옵션 정보를 재설정한다.
setPage(page, startItem)Paging 모드일 때 표시할 페이지를 지정한다.
setPageCount(count)Paging 개수를 변경한다.
setPaging(paging, size, maxCount)그리드가 Paging 모드로 실행된다.
setRowGroup(value)그리드의 RowGroup 을 설정한다.

Events Desc

onCollapsed

그룹핑 된 행이 접힘을 알리는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

itemIndex - 접힌 그룹 아이템의 itemIndex

Example:

gridView.onCollapsed = function(grid, itemIndex) {
     console.log('Collapsed at: ' + itemIndex)
};

onCollapsing

그룹핑 된 행 접기를 결정하는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

itemIndex - 접을 그룹 아이템의 itemIndex

Example:

gridView.onCollapsing = function(grid, itemIndex) {
     if (itemIndex % 2 === 0) {
         return false;
     }
};

onExpanded

그룹핑 된 행이 펼쳐졌음을 알리는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

itemIndex - 펼친 그룹 아이템의 id

Example:

gridView.onExpanded = function(grid, itemIndex) {
     console.log('Expanded at: ' + itemIndex)
};

onExpanding

그룹핑 된 행 펼치기를 결정하는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

itemIndex - 펼칠 그룹 아이템의 itemIndex

Example:

gridView.onExpanding = function(grid, itemIndex) {
     if (itemIndex % 2 === 0) {
         return false;
     }
};

onGrouped

그룹핑했음을 알리는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

Example:

gridView.onGrouped = function(grid) {
     console.log("I am Grouped!");
};

onGrouping

그룹핑을 결정하는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

fields - 그룹핑되는 필드의 인덱스들

[반환값] - 그룹핑 실행 여부. false를 반환하면 그룹핑은 취소된다.

Example:

gridView.onGrouping = function(grid, fields) {
     alert("onGrouping 이벤트가 발생했습니다. false를 반환합니다.");
     return false;
};

onPageChanged

그리드가 Paging 상태일 때, 다른 페이지로 이동했음을 알리는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

page - 새로 이동한 페이지 인덱스

Example:

gridView.onPageChanged = function(grid, page) {
     if(page % 2 === 0) {
         console.log('even number changed!')
     }
};

onPageChanging

그리드가 Paging 상태일 때, 페이지 이동을 결정하는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

page - 새로 이동하게 될 페이지 인덱스

[반환값] - false를 반환하면 페이지 이동이 취소된다.

Example:

gridView.onPageChanging = function(grid, page) {
     if(page % 2 === 0) {
         return true;
     }
     return false;
};

onPageCountChanged

그리드가 Paging 상태일 때, 변경된 페이지 수와 함께 다른 페이지로 이동했음을 알리는 콜백

Remarks:

[매개변수 목록]

grid - GridView 컨트롤

pageCount - 변경된 페이지 수

Example:

gridView.onPageCountChanged = function(grid, pageCount) {
     console.log('pageCount: ' + pageCount);
};

Properties Desc

filterMode

데이터 수정 이후 필터의 동작 모드

Remarks:

'explicit' 을 사용하면 필터링 된 데이터가 수정되었을 때 명시적으로 필터링을 수행해야 필터링이 된다.

Example:

gridView.filterMode = 'explicit';

filterOr

컬럼 간 필터 조건을 or 로 할 것인지의 여부

Remarks:

true 로 지정하면 각 컬럼의 필터간 필터링이 or 조건으로 반영되어 표시된다.

Example:

gridView.filterOr = true;

groupingOptions

그리드에 설정되어 있는 행 그룹핑에 관한 설정 정보들

Remarks:

GroupingOptions 객체를 반환한다. GroupingOptions 의 속성을 가져오거나 설정할 수 있다.

Example:

gridView.groupingOptions.linear = true;

groupPanel

그리드에 설정되어 있는 Group Panel 모델

Remarks:

GroupPanel 객체를 반환한다. GroupPanel 의 속성을 가져오거나 설정할 수 있다.

Example:

gridView.groupPanel.visible = true;

groupSummaryMode

행 그룹핑된 컬럼의 합계를 계산하는 방식

Remarks:

값 할당으로 변경할 수 있다. SummaryMode 의 값으로 설정한다.

Example:

gridView.groupSummaryMode = 'aggregate';

rowGroup

그리드에 설정되어 있는 행 그룹 모델

Remarks:

RowGroup 객체를 반환한다. RowGroup 의 속성을 가져오거나 설정할 수 있다.

Example:

gridView.rowGroup.mergeMode = true;

Methods Desc

beginAppendRow

그리드 마지막 데이터행 이후에 새로운 데이터행을 추가한다.

Example:

gridView.beginAppendRow();

beginInsertRow

그리드에 인덱스로 입력된 데이터행 앞 또는 뒤에 새로운 데이터행을 생성한다.

Remarks:

그리드가 편집상태이거나 데이터 건수가 없는 경우 추가되지 않는다. itemIndex를 입력하지 않으면 (-1이 입력되면), 이전에 실행된 beginInsertRow의 itemIndex 앞에 추가되거나 실행된적이 없으면 0번째 itemIndex앞에 추가된다. 0 이상의 값을 입력하면 데이터행 앞에 새로운 데이터행을 생성한다.

Example:

gridView.beginInsertRow();

beginUpdateRow

입력된 인덱스에 해당하는 데이터 행을 편집상태로 변경한다.

Example:

gridView.beginUpdateRow();

collapseAll

루트 그룹을 접는다.

Example:

gridView.collapseAll();

collapseGroup

지정한 그룹을 접는다(collapse).

Remarks:

지정한 아이템이 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다.

Example:

gridView.collapseGroup(2, true);

collapseParent

지정한 그룹의 부모를 접는다(collapse).

Remarks:

지정한 아이템 또는 그 부모가 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다.

Example:

gridView.collapseParent(2, true);

expandAll

루트 그룹을 펼친다.

Remarks:

recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.

Example:

gridView.expandAll();

expandGroup

지정한 그룹을 펼친다(expand).

Remarks:

지정한 아이템이 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다. recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.

Example:

gridView.expandGroup(2, true);

expandParent

지정한 그룹의 부모를 펼친다.

Remarks:

지정한 아이템 또는 그 부모가 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다. recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.

Example:

gridView.expandParent(2, true);

getCheckedItems

체크된 아이템들의 목록을 배열로 반환한다.

Example:

let checkedItems = gridView.getCheckedItems();

getCheckedRows

체크된 데이터 행들의 목록을 반환한다.

Example:

let checkedRows = gridView.getCheckedRows();

getDataSource

그리드에 연결되어 있는 DataProvider를 반환한다.

Example:

let ds = gridView.getDataSource();

getGroupFieldNames

그룹핑 된 필드의 이름들을 반환한다.

Example:

let GFieldNames = gridView.getGroupFieldNames();

getGroupFields

그룹핑 된 필드의 인덱스들을 반환한다.

Example:

let GFields = gridView.getGroupFields();

getGroupIndex

자신이 속한 그룹의 인덱스를 반환한다.

Example:

let GIndex = gridView.getGroupIndex(2);

getGroupingOptions

그리드 행 그룹핑에 관한 설정 정보들을 반환한다.

Example:

let groupingOpts = gridView.getGroupingOptions();
groupingOpts.prompt = "I am Groop";
gridView.setGroupingOptions(groupingOpts);

getGroupLevel

지정한 필드의 그룹 level을 반환한다.

Remarks:

첫번째 그룹 레벨은 1이다.

Example:

let Glevel = gridView.getGroupLevel('field1');

getGroupLevels

현재 몇 level로 그룹핑되어 있는지를 반환한다.

Example:

let Glevels = gridView.getGroupLevels();

getGroupPanel

그리드의 GroupPanel 을 반환한다.

Example:

let groupPanel = gridView.getGroupPanel();
groupPanel.visible = false;
gridView.setGroupPanel(groupPanel);

getGroupSummaryValue

GroupFooter의 expression 또는 valueCallback에서 결과값을 가져온다.

Remarks:

numberFormat, prefix등이 적용되지 않은 값이다. 선택된 footer가 여러개인경우 배열로 리턴된다.

getMergedItems

Remarks:

merge된 셀에 포함되는 itemIndex를 배열로 가져온다.

Example:

let mergeItems = gridView.getMergedItems(1, "column", true, true);
let mergeDataRows = gridView.getRowsOfItems(mergeItems);

getOptions

그리드 옵션 정보를 반환한다.

Remarks:

GridBase.getOptions() 에 반환되는 모델에 grouping 속성이 추가되어 반환된다.

Example:

let options = gridView.getOptions();

getPage

Paging 모드에서 현재 페이지 번호를 반환한다.

Example:

let currPage = gridView.getPaging();

getPageCount

Paging 모드일 때 전체 페이지 개수를 반환한다.

Example:

let pageCount = gridView.getPageCount();

getPageOfDataRow

행이 위치한 페이지를 찾는다.

getRowGroup

그리드의 RowGroup 을 반환한다.

Example:

let rowGroup = gridView.getRowGroup();
rowGroup.levelIndent = false;
gridView.setRowGroup(rowGroup);

groupBy

지정한 필드 목록에 포함된 순서대로 또는 데이터 정렬 후 순서대로 행 그룹핑을 실행한다.

Example:

// 그룹 설정
gridView.groupBy(["field1", "field2"]);
 
// 그룹 해제
gridView.groupBy([]);

isGrouped

그리드가 그룹핑되어 있는지 여부를 반환한다.

Example:

let isGrouped = gridView.isGrouped();

isGroupItem

지정한 인덱스가 그룹 아이템인지의 여부를 반환한다.

Example:

let isGroupItem = gridView.isGroupItem(4);

isMergedGrouped

그리드가 mergeMode로 되어 있는지 여부를 반환한다.

Example:

let isMergedGrouped = gridView.isMergedGrouped();

isParentVisible

지정한 인덱스의 부모의 표시 여부를 반환한다.

Example:

let isParentVis = gridView.isParentVisible(2);

layoutCollapseAll

그룹Layout의 expandable이 설정된 경우 그룹Layout을 접는다.

layoutExpandAll

그룹Layout의 expandable이 설정된 경우 그룹Layout을 펼친다.

setGroupingOptions

그리드 행 그룹핑에 관한 설정을 한다.

Example:

gridView.setGroupingOptions({prompt: "I am Groop"});

setGroupPanel

그리드 GroupPanel 을 설정한다.

Example:

gridView.setGroupPanel({visible: false});

setOptions

그리드 옵션 정보를 재설정한다.

Remarks:

그리드 수준의 정보만을 반환하는 getOptions 와 달리 이 method를 통해 하위 구성 요소 및 다른 실행 정보들을 동시에 재설정할 수 있다.

Example:

let options =  {
    summaryMode: 'aggregate',
    displayOptions: {
        columnResizable : false
    },
    grouping: {
        prompt: 'I am Groop'
    }
};
gridView.setOptions(options);

setPage

Paging 모드일 때 표시할 페이지를 지정한다.

Example:

gridView.setPage(4);

setPageCount

Paging 개수를 변경한다.

Example:

gridView.setPageCount(20);

setPaging

그리드가 Paging 모드로 실행된다.

Example:

gridView.setPaging(true);

setRowGroup

그리드의 RowGroup 을 설정한다.

Example:

gridView.setRowGroup({levelIndent: false});