GridBase

그리드의 체크바에 관한 설정 모델

상세 설명

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

예제 코드

gridView.checkBar.visibleOnly = true;

클립보드에 복사하는 것에 대한 설정 모델

상세 설명

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

예제 코드

gridView.copyOptions.singleMode = true;

데이터 drag and drop 과 관련 된 설정 모델

상세 설명

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

예제 코드

gridView.dataDropOptions.dropMode = 'copy';

그리드가 마우스/키보드 이벤트에 대하여 반응안함 상태

상세 설명

값 할당으로 변경할 수 있다.

예제 코드

gridView.disabled = true;

그리드 수준에서 관리되는 표시 정보들에 대한 설정 모델

상세 설명

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

예제 코드

gridView.displayOptions.columnResizable = true;

데이터 편집에 대한 설정 모델

상세 설명

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

예제 코드

gridView.editOptions.deletable = true;

편집기에 대한 설정 모델

상세 설명

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

예제 코드

gridView.editorOptions.yearDisplayFormat = "{Y}년";

데이터 필터링에 대한 설정 모델

상세 설명

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

예제 코드

gridView.filteringOptions.enabled = false;

그리드의 고정 행 및 컬럼에 대한 설정 모델

상세 설명

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

예제 코드

gridView.fixedOptions.colCount = 2;

첫번째 푸터에 관한 설정 모델

상세 설명

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

예제 코드

gridView.footer.styleName = 'custom-footer-1';

푸터들에 관한 설정 모델

상세 설명

GridFooter 의 콜렉션 객체를 반환한다. GridFooterCollection 의 속성을 가져오거나 설정할 수 있다.

예제 코드

gridView.footers.visible = false;

데이터 필드 값의 변환 형식에 대한 설정 모델

상세 설명

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

예제 코드

gridView.formatOptions.datetimeFormat = 'yyyy-mm-dd';

그리드 모바일 화면인 FormView 에 대한 설정 모델

예제 코드

gridView.formOptions.autoClose = true;

그리드의 모바일 전용 화면 모델

예제 코드

form = gridView.formView;

그리드의 헤더 영역에 관한 설정 모델

상세 설명

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

예제 코드

gridView.header.showTooltip = true;

그리드 헤더 영역에 표시되는 Header Summary 에 대한 컬렉션 설정 모델

상세 설명

HeaderSummary 의 콜렉션 객체를 반환한다. HeaderSummaryCollection 의 속성을 가져온다.

예제 코드

gridView.headerSummaries.visible = false;

그리드 헤더 영역에 표시되는 첫번째 Header Summary에 대한 설정 모델

상세 설명

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

예제 코드

gridView.headerSummary.visible = false;

그리드에 설정되어 있는 삭제된 행들의 숨김 여부

상세 설명

값 할당으로 변경할 수 있다.

예제 코드

gridView.hideDeletedRows = true;

모바일 관련 설정 모델

상세 설명

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

예제 코드

gridView.mobileOptions.longTapDuration = false;

form view와 grid view 사이에 활성 상태가 변경될 때 발생한다.

클립보드의 데이터를 붙여 넣는 것에 대한 설정 모델

상세 설명

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

예제 코드

gridView.pasteOptions.enabled = false;

현재상태에서 재실행 가능 여부

예제 코드

gridView.redoing = false

그리드의 인디케이터에 관한 설정 모델

상세 설명

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

예제 코드

gridView.rowIndicator.displayValue = 'row';

스크롤바의 높이를 변경

기본값

16

예제 코드

gridView.scrollBarHeight = 24;

스크롤바의 너비를 변경

기본값

16

예제 코드

gridView.scrollBarWidth = 24;

데이터 정렬에 대한 설정 모델

상세 설명

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

예제 코드

gridView.sortingOptions.style = 'reverse';

데이터 수정 이후 정렬 동작 모드

상세 설명

그리드에 설정되어 있는 SortMode 를 반환한다. 값 할당으로 변경할 수 있다.

예제 코드

gridView.sortMode = "explicit";

그리드의 상태바에 관한 설정 모델

상세 설명

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

예제 코드

gridView.stateBar.mark = 'image';

현재 그리드의 합계를 계산하는 방식

상세 설명

그리드에 설정되어 있는 SummaryMode 를 반환한다. 값 할당으로 변경할 수 있다.

예제 코드

gridView.summaryMode = "aggregate";

실행취소 기능 사용 가능 여부

상세 설명

값 할당으로 변경할 수 있다.

예제 코드

gridView.undoable = false

현재상태에서 실행취소 가능 여부

예제 코드

gridView.undoing = false

컬럼에 등록된 모든 필터들을 적용 또는 해제한다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

• active: boolean

  true: 적용, false: 해제.

예제 코드

gridView.activateAllColumnFilters('행정구역별', true);

컬럼에 등록된 필터들 중, filterNames 에 포함된 필터명을 갖는 필터들을 적용시키거나 해제한다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

• filterNames: string | string[]

  적용 또는 해제할 필터의 이름 혹은 필터들의 이름의 배열

• active: boolean

  true: 적용, false: 해제.

예제 코드

gridView.activateColumnFilters('행정구역별', ['전'], true);

설정된 컬럼들 외에 추가로 컬럼을 설정한다.

매개변수

• column: ConfigObject | string

  추가할 컬럼 (GridColumn 과 같은 오브젝트)

• index: number

  해당 컬럼이 위치할 순서(숨김컬럼 포함). 값을 지정하지 않으면 컬럼의 가장 마지막에 추가된다.

반환값

예제 코드

let col = {
     "name": "EmployeeID",
     "fieldName": "EmployeeID",
     "type": "data",
     "width": "90",
     "header": {
         "text": "Employee ID"
     }
}

gridView.addColumn(col);

가이드

• 컬럼 - 컬럼 만들기

컬럼에 하나 이상의 필터를 등록한다. column.autoFilter가 true인 경우 적용되지 않는다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

• filters: ColumnFilter[]

  등록할 필터 객체의 배열, ColumnFilter 의 배열

• overwrite: boolean

  기본값: false, overwrite가 false 시 중복된 이름의 필터가 있을 경우 에러를 발생시킨다.

예제 코드

gridView.addColumnFilters('행정구역별', [{
         name: "전",
         criteria: "value = '전'"
     }, {
         name: "답",
         criteria: "value = '답'"
     }])

Layout에 컬럼 또는 group을 추가한다.

매개변수

• source: LayoutItem | string

  추가할 컬럼명 또는 layout정보

• index: number

  삽입될 위치

반환값

추가된 layout 정보

상세 설명

layout이 설정되지 않은 경우 사용할수 없다. gridView.setColumnLayout을 이용해서 layout상태로 변경한후 사용해야 한다.

예제 코드

gridView.setColumnLayout([]); // 빈 layout을 추가한다.

const column1 = gridView.addColumn({fieldName: "field1", name: "col1"});
const column2 = gridView.addColumn({fieldName: "field2", name: "col2"});
const column3 = gridView.addColumn({fieldName: "field2", name: "col3"});
gridView.addLayout(column1); // gridView.addLayout("col1")
gridView.addLayout({name: "group0", items: [column2, column3]});

lookup tree에서 사용할 LookupSource 를 추가 등록한다.

매개변수

• source: LookupSource

  LookupSource 오브젝트

상세 설명

기존id에 추가를 원하는 경우는 fillLookupData() 를 사용한다.

예제 코드

let area3codes = {
     id:"area2code",
     levels:3,
     keys: [['11', '11010', '1101053'], ['11', '11010', '1101054']],
     values: ['사직동', '삼청동']
};
gridView.addLookupSource(area3codes);

가이드

• 셀 구성요소 - Lookup 트리

그리드에 Popup Menu를 추가한다.

매개변수

• name: string

  메뉴 이름

• menuItems: PopupMenuItem[]

  PopupMenuItem 형식을 따르는 배열, 계층적 구조의 메뉴 정보

상세 설명

추가된 메뉴는 데이터셀 등에 연결할 수 있다.

예제 코드

let menu = [{
     label: "menu1 입니다.",
     children: [{
         label: "submenu1 입니다."
     }, {
         label: "submenu2 입니다."
     }]
 }, {
     label: "menu2 입니다",
 }, {
     label: "-"
 }, {
     label: "menu3 입니다",
     type: "check",
     checked: true,
     tag: "check_menu"
 }];

gridView.addPopupMenu('menu1', menu);

가이드

• 셀 구성요소 - 팝업 메뉴 버튼

그리드에서 선택할 영역을 추가한다.

매개변수

• item: Selection

  Selection 모델과 같은 설정 정보. 선택하고자 하는 영역의 속성만 전달하면 된다.

상세 설명

selectionMode가 extended인 경우에만 추가된다.

예제 코드

let sel = {
     style: "block",
     startItem: 2,
     startColumn: "지목",
     endItem: 3,
     endColumn: "단위"
}
gridView.addSelection(sel);

CheckBar에 Expression 기준으로 checkable을 적용한다.

예제 코드

gridView.applyCheckables();

가이드

• 그리드 구성요소 - 체크바

column.autoFilter가 true인경우 filter목록을 갱신한다.

매개변수

• columns: string[] | DataColumn[]

  컬럼이름 또는 컬럼 객체의 배열. 입력하지 않는 경우 전체 컬럼.

• applyFilters: boolean

  active된 filter의 적용 여부.

상세 설명

autoFilter의 목록을 갱신할때 호출한다. 또는 사용자가 filter 아이콘을 클릭하면 자동으로 갱신된다.

그리드와 관련된 속성들이 변경될 때마다 update lock 을 걸어 내부적인 변경 처리 호출을 지연시킨다.

상세 설명

endUpdate() 와 같이 사용한다.

예제 코드

gridview.beginUpdate();
try {
    gridview.displayOptions( { ... });
    gridview.selectOptions( { ... });
...
} finally {
    gridview.endUpdate();
}

현재 편집 중인 행의 편집을 취소한다.

반환값

취소 성공 여부

상세 설명

편집 중이 아니라면 아무 일도 하지 않는다. 편집을 완료할 때는 commit() 을 호출해야 한다.

예제 코드

gridView.cancel();

편집을 취소하고 편집기 창을 닫는다.

예제 코드

gridView.cancelEditor();

그리드의 데이터행을 모두 체크,해제한다.

매개변수

• checked: boolean

  기본값: true, true: 체크, false: 체크 해제

• visibleOnly: boolean

  collapse로 인해 접혀서 보이지 않는 행의 포함여부

• checkableOnly: boolean

  체크가능한 행만 체크할 것인지의 여부

• checkEvent: boolean

  기본값: true, onItemChecked() 의 발생 여부

상세 설명

CheckBar 의 exclusive에 영향을 받지않는다.

예제 코드

gridView.checkAll();

가이드

• 그리드 구성요소 - 체크바

지정된 아이템을 체크하거나 해제한다.

매개변수

• itemIndex: number

  아이템의 인덱스

• checked: boolean

  기본값: true, true: 체크, false: 체크 해제

• exclusive: boolean

  기본값: false, true: 체크된 다른아이템이 있는 경우 모두 해제하고 아이템 인덱스로 입력된 아이템만 체크

• checkEvent: boolean

  기본값: true, onItemChecked() 의 발생 여부

예제 코드

gridView.checkItem(4);

가이드

• 그리드 구성요소 - 체크바

입력된 아이템 배열에 해당하는 아이템을 체크하거나 해제한다.

매개변수

• itemIndices: number[]

  아이템 인덱스 배열

• checked: boolean

  기본값: true, true: 체크, false: 체크 해제

• checkEvent: boolean

  기본값: true, onItemChecked() 의 발생 여부

예제 코드

gridView.checkItems([1,2,3,4]);

가이드

• 그리드 구성요소 - 체크바

지정된 데이터 행을 체크하거나 해제한다.

매개변수

• row: number

  행 고유 번호

• checked: boolean

  기본값: true, true: 체크, false: 체크 해제

• exclusive: boolean

  기본값: false, true: 체크된 다른아이템이 있는 경우 모두 해제하고 row로 입력된 아이템만 체크

• checkEvent: boolean

  기본값: true, onItemChecked() 의 발생 여부

예제 코드

gridView.checkRow(4);

가이드

• 그리드 구성요소 - 체크바

입력된 고유 행 번호들과 연결된 Item을 체크하거나 해제한다.

매개변수

• rows: number[]

  고유 행 번호의 배열

• checked: boolean

  기본값: true, true: 체크, false: 체크 해제

• checkEvent: boolean

  기본값: true, onItemChecked() 의 발생 여부

예제 코드

gridView.checkRows([1,2,3,4]);

가이드

• 그리드 구성요소 - 체크바

컬럼에 등록된 필터들을 제거한다. column.autoFilter가 true인 경우 적용되지 않는다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

예제 코드

gridView.clearColumnFilters();

Command Stack 을 초기화한다.

매개변수

• all: boolean

  ?

예제 코드

gridView.clearCommandStack();

focus를 제거한다.

예제 코드

gridView.clearCurrent();

값 검증에 실패한 셀 정보들을 삭제한다.

상세 설명

이 함수는 validateCells() 를 먼저 실행한 후 가져온 검증에 실패한 데이터의 목록을 지울때 사용한다.

예제 코드

gridView.validateCells();
gridView.clearInvalidCells();
let invalids = gridView.getInvalidCells(); // null

지정된 SourceId에 해당하는 lookup source를 clear한다.

매개변수

• sourceId: string

  LookupSource의 id

예제 코드

gridView.clearLookupData('area1code');

변경 적용한 개별 행 높이를 초기값으로 되돌린다.

매개변수

• all: boolean

  true: 전부, false: setRowHeight() 로 바꾼것만 미포함

예제 코드

gridView.clearRowHeights(true);

선택 영역을 모두 제거한다.

예제 코드

gridView.clearSelection();

필터박스 또는 DropDown Editor를 닫는다.

예제 코드

gridView.closeList();

로딩 애니메이션을 숨긴다.

예제 코드

gridView.closeLoading();

프로그레스 바를 닫는다.

예제 코드

gridView.closeProgress();

필드 이름으로 지정되는 데이터필드에 연결되어 있는 첫 번째 컬럼 정보를 반환한다.

매개변수

• fieldName: string

  필드이름

반환값

컬럼 설정 정보나 컬럼이 존재하지 않는 경우 null

예제 코드

let col = gridView.columnByField('fieldName');

가이드

• 컬럼 - 컬럼 만들기
• 컬럼 - 컬럼 속성 동적 변경하기(visible, editable)

컬럼 이름으로 컬럼 설정 정보를 반환한다.

매개변수

• name: string

  컬럼 이름

반환값

컬럼이 존재하지 않는 경우 null

예제 코드

let col = gridView.columnByName('colName');

가이드

• 컬럼 - 컬럼 만들기

입력된 tag값을 가지는 컬럼을 가져온다.

매개변수

• tag: any

  컬럼에 지정한 tag

반환값

컬럼 설정 정보나 컬럼이 존재하지 않는 경우 null

상세 설명

같은 tag를 갖는 컬럼이 하나 이상 존재하면 그 중 첫번째 컬럼을 반환한다. 해당하는 컬럼이 존재하지 않으면 null을 반환한다.

예제 코드

let col = gridView.columnByTag('tag');

입력된 tag값을 가지는 컬럼들을 배열로 가져온다.

매개변수

• tag: any

  컬럼에 지정한 tag

반환값

컬럼 배열, 입력된 tag를 가지는 컬럼이 존재하지 않는 경우 null

예제 코드

let cols = gridVeiw.columnsByTag('tag');

편집 중인 행의 편집을 완료하고 DataProvider에 저장한다.

매개변수

• force: boolean

  기본값: false, true: 입력/편집 중 편집을 취소한 행(RowState 변경은 없고, Indicator 에 편집으로 표시된)을 커밋

반환값

데이터 변경이 발생한 경우 true 반환

예제 코드

gridView.commit();

현재 편집기의 내용을 셀에 반영한다.

매개변수

• hideEditor: boolean

  기본값: true, Editor의 종료 여부

• force: boolean

상세 설명

실행 후 onEditCommit, onEditRowChanged, onCellEditted 이벤트가 순차적으로 발생한다.

예제 코드

gridView.commitEditor();

선택한 영역에 포함된 셀들의 정보를 복사 혹은 반환한다.

매개변수

• selection: Selection

  선택 영역의 정보, 지정하지 않으면 그리드 전체가 복사된다.

• copy: boolean

  기본값: true, true: 클립보드에 복사, false: 반환

반환값

copy 가 false 시 반환

상세 설명

선택된 영역이 여러개인경우 사용할수 없다.

예제 코드

let sel = gridView.getSelection();
let copied = gridView.copyToClipBoard(sel);

현재 선택 영역 안의 행들을 삭제한다.

매개변수

• force: boolean

  true 시 대화 상자 표시 없이 바로 삭제한다. editOptions.deletable이 false여도 삭제된다.

상세 설명

EditOptions.deletable 이 false인 경우 작동하지 않는다.

예제 코드

gridView.deleteSelection(true);

가이드

• CRUD - 행 삭제

그리드를 해제한다.

예제 코드

gridView.destory();

update lock 을 풀고 그리드를 다시 그린다.

매개변수

• force: boolean

  beginUpdate() 의 호출 여부에 상관없이 그리드를 다시 그린다.

상세 설명

beginUpdate() 와 같이 사용한다.

예제 코드

beginUpdate() 참조

선택 영역 안의 셀들의 값을 지운다. 즉, undefined로 값을 변경한다.

매개변수

• force: boolean

  true이면 editOptions.erasable이 false여도 셀의 값을 지운다

상세 설명

EditOptions.erasable이 false인 경우 작동하지 않는다.

예제 코드

gridView.eraseSelection();

사용자렌더러가 있는지 확인한다.

매개변수

• type: string

  등록한 렌더러 이름

반환값

지정된 lookupsource에 지정된 키가 존재하는지 여부를 반환한다.

매개변수

• sourceId: string

  LookupSource의 Id.

• keys: string | string[]

  찾을 키 값, 값들.

반환값

예제 코드

gridView.existsLookupData('area1code', ['12']);

지정한 설정에 따라 현재 그리드의 모양과 데이터를 외부 문서로 내보낸다.

매개변수

• options: GridExportOptions

  GridExportOptions 과 같은 설정 모델.

예제 코드

gridView.exportGrid({
     type: 'csv'
})

가이드

• 엑셀 내보내기 - 엑셀 내보내기
• 엑셀 내보내기 - 행 그룹된 그리드 내보내기
• 엑셀 내보내기 - 여러 레이아웃으로 구성된 그리드 내보내기

입력값과 관련된 항목을 조회하여 리스트에 표시한다. 부분검색 용도로 사용된다.

매개변수

• column: string | GridColumn

  리스트가 표시 될 컬럼 객체 또는 컬럼명

• searchKey: string

  검색 키 값

• values: string[]

  검색된 value 값들

• labels: string[]

  검색된 label 값들

예제 코드

let CustomerNames = ["ALFKI", "ANATR", "ANTON", "AROUT", "BERGS", "BLAUS"];
dataProvider.setFields([
     {fieldName:"code"},
     {fieldName:"codeName"} // 코드 명을 가지고 있는 필드
]);
gridView.setColumns([{
     fieldName:"code",
     name:"code",
     editor:{type:"search",searchLength:1, searchDelay:500, useCtrlEnterKey:true, useEnterKey:true },
     lookupDisplay:true,
     labelField:"codeName"
}]);

// 마지막 키가 입력되고 searchDelay가 지나면 발생되는 이벤트
gridView.onEditSearch = function (grid, index, text) {
     console.log("onEditSearch:" + index.itemIndex + "," + index.column + ", " + text);
     let values = CustomerNames.filter(function (str) {
         return str.indexOf(text) == 0;
     });
     let labels = CustomerNames.filter(function (str) {
         return str.indexOf(text) == 0;
     });
     console.log(values);
     gridView.fillEditSearchItems(index.column, text, values, labels);
};

// searchEditor에서 선택이 되며 발생되는 이벤트
gridView.onGetEditValue = function (grid, index, editResult) {
     if (index.column === "code") {
         grid.setValue(index.itemIndex, "codeName",editResult.text);
     };
};

lookupSource에 lookupData를 추가한다.

매개변수

• sourceId: string

  LookupSource의 id

• data: LookupData

  설정하고자 하는 LookupData

예제 코드

gridView.fillLookupData("lookup1", {keys:[["14"],["15"]], values:["가나다라","일이삼사"]});

셀의 너비를 글자 길이에 맞게 변경한다.

매개변수

• layout: string | LayoutItem

  layout이름 또는 column

• maxWidth: number

  최대 너비

• minWidth: number

  최소 너비

• includeHeaderText: boolean

  header text 포함여부 defalut true

반환값

상세 설명

GroupLayout의 하위 그룹이 있는 경우 자동으로 변경할수 없다. grid.displayOptions.refreshMode 가 "visibleOnly"인 경우 화면에 표시되지 않는 컬럼의 너비는 조정되지 않는다.

예제 코드

gridView.fitLayoutWidth('layout1')

화면에 보여지고 있는 아이템중 일부만 보이는 행을 제외한 갯수를 반환한다.

반환값

상세 설명

현재 화면에 10개의 행이 보여지고 있지만 마지막행이 일부만 보이는 경우 9를 반환한다.

예제 코드

let totalCount = gridView.fullItemCount();

등록된 필터들 중 적용된 필터 또는 해제된 필터의 이름을 반환한다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

• active: boolean

  기본값: true, true: 활성화 된 필터 반환, false: 해제된 필터 반환

반환값

활성화 상태에 해당하는 ColumnFilter 와 같은 모델의 필터 오브젝트의 배열

예제 코드

gridView.getActiveColumnFilters('행정구역별');

그리드에서 지정한 셀의 좌표값을 반환한다.

매개변수

• itemIndex: number

  행의 순서

• column: string | GridColumn

  컬럼 이름이나 컬럼 객체

• outer: boolean

반환값

좌표값, 보이지 않는 영역에 있을 경우 null 을 반환한다.

예제 코드

let bounds = gridView.getCellBounds(3, '행정구역별');

// {x, y, width, height} 반환

그리드 체크바와 관련된 설정 정보를 CheckBar 의 모델로 반환한다.

반환값

예제 코드

let checkBar = gridView.getCheckBar();
checkBar.exclusive = false;
gridView.setStateBar(checkBar);

가이드

• 그리드 구성요소 - 체크바

아이템 모델의 자식 모델을 반환한다.

매개변수

• parentModel: GridItem

  아이템 모델 정보

• index: number

  자식 모델 사이에서의 해당 자식 모델의 인덱스

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 의 형식으로 반환한다.

예제 코드

let model = gridView.getModel(3);
let child = gridView.getChildModel(model, 2);

가이드

• 행과 행 그룹 - 아이템 모델

아이템 모델의 자식 모델들을 반환한다.

매개변수

• parentModel: GridItem

  아이템 모델 정보

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 의 배열 형식으로 반환한다.

예제 코드

let model = gridView.getModel(3);
let childs = gridView.getChildModels(model);

가이드

• 행과 행 그룹 - 아이템 모델

해당하는 index 번째의 컬럼을 반환한다.

매개변수

• index: number

  그리드에서의 순서

반환값

예제 코드

let col = gridView.getColumn(0);

지정한 컬럼에서 필터 이름에 해당하는 필터를 반환한다.

매개변수

• column: string | DataColumn

  지정한 컬럼의 이름 또는 컬럼 객체

• filterName: string

  필터 이름

반환값

- ColumnFilter 와 같은 모델의 필터 오브젝트

예제 코드

gridView.getColumnFilter('행정구역별', ['전']);

지정한 컬럼에서 필터들을 반환한다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

반환값

- ColumnFilter 와 같은 모델의 필터 오브젝트의 배열

예제 코드

gridView.getColumnFilters('행정구역별');

그리드에 설정된 컬럼들을 반환한다.

매개변수

• columnsOnly: boolean

  기본값: false, false면 반환 시 컬럼 그룹들을 포함

• visibleOnly: boolean

  기본값: false, false면 반환 시 숨긴 컬럼들을 포함

반환값

컬럼 이름 배열

예제 코드

let onlyColsNames = gridView.getColumnNames(true, false);

해당 컬럼의 속성을 반환한다.

매개변수

• column: string | GridColumn

  컬럼의 이름 또는 컬럼 객체

• prop: string

  속성 이름

반환값

prop에 입력된 속성명의 값이다.

예제 코드

let colRenderer = getColumnProperty('colName', 'renderer');

가이드

• 컬럼 - 컬럼 속성 동적 변경하기(visible, editable)

그리드에 설정된 컬럼들을 반환한다.

반환값

예제 코드

let cols = gridView.getColumns();

그리드가 위치한 div를 반환한다.

반환값

예제 코드

let gridContainer = gridView.getContainer;

ctrl+c 를 이용해서 그리드를 복사할때 적용되는 설정을 CopyOptions 모델로 반환한다.

반환값

예제 코드

let copy = gridView.getCopyOptions();
copy.enabled = false;
gridView.setCopyOptions(copy);

현재 focus 된 셀의 위치정보를 반환한다.

console.log(JSON.stringify(grid.getCurrent()));

반환값

데이터 drag 앤 drop과 관련 된 설정 정보들을 DataDropOptions 모델로 반환한다.

반환값

예제 코드

let drop = gridView.getDataDropOptions();
drop.dropMode = 'copy'
gridView.setDataDropOptions(drop);

지정한 그리드 행의 고유 번호를 반환한다.

매개변수

• itemIndex: number

  행의 순서

반환값

예제 코드

let row = gridView.getDataRow(0);

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

반환값

예제 코드

let ds = gridView.getDataSource();

아이템 모델의 자손 모델들을 반환한다.

매개변수

• parentModel: GridItem

  아이템 모델 정보

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 의 배열 형식으로 반환한다.

예제 코드

let model = gridView.getModel(3);
let descendants = gridView.getChildModels(model);

현재 보여지고 있는 컬럼들을 반환한다.

반환값

예제 코드

let displayCols = gridView.getDisplayColumns();

그리드 표시와 관련된 설정 정보들을 DisplayOptions 의 모델로 반환한다.

반환값

예제 코드

let display = gridView.getDisplayOptions();
display.rowHeight = 20;
gridView.setDisplayOptions(display);

지정한 행의 데이터 값들을 각종 포맷이나 정규식이 적용된 형태의 JSON객체로 반환한다.

매개변수

• itemIndex: number

  정보를 가져올 행의 순서

• useColumnName: boolean

  true이면 JSON객체의 속성명을 fieldName이 아닌 column.name으로 만든다.

반환값

입력된 itemIndex가 행의 고유 번호와 연결된 행이 아닌경우 null이 출력된다.

예제 코드

gridView.getDisplayValues(3);

가이드

• CRUD - 행/셀 데이터 가져오기

행 고유 번호로 지정한 행의 데이터 값들을 각종 포맷이나 정규식이 적용된 형태의 JSON객체로 반환한다.

매개변수

• dataRow: number

  행의 고유 번호

• useColumnName: boolean

  true이면 JSON객체의 속성명을 fieldName이 아닌 column.name으로 만든다.

반환값

입력된 dataRow가 존재하지 않을 경우 null이 출력된다.

예제 코드

gridView.getDisplayValuesOfRow(42);

가이드

• CRUD - 행/셀 데이터 가져오기

필드의 중복되지 않은 값들을 반환한다.

매개변수

• field: number | string

  필드 명 또는 필드 인덱스

• maxCount: number

  최대 건수, 정렬한 상태에서 위에부터 건수만큼 잘라서 반환한다. 기본값: -1

• sortDir: SortDirection

  정렬 방법, 기본값: SortDirection.ASCENDING

반환값

상세 설명

filtering, softDeleting에 의해서 감춰진 행을 제외하고 지정된 필드에 해당하는 값들을 중복을 배제하여 정렬상태로 반환한다,

예제 코드

gridView.getDistinctItemValues('field1');

그리드가 편집 중인 아이템의 정보를 반환한다.

반환값

편집 중인 그리드 아이템의 정보. 편집 중이 아닌 경우 null 반환. EditingItemInfo 형식.

예제 코드

let eItemInfo = gridView.getEditingItem();

그리드 편집 방식과 관련된 정보들을 EditOptions 모델로 반환한다.

반환값

예제 코드

let edit = gridView.getEditOptions();
edit.editable = true;
gridView.setEditOptions(edit);

편집기 표시 정보를 EditorOptions 모델로 반환한다.

반환값

예제 코드

let editor = gridView.getEditorOptions();
editor.yearDisplayFormat = '{Y} year';
gridView.setEditorOptions(editor);

그리드가 편집 중일때 현재 수정 중인 셀의 값을 반환한다.

반환값

데이터 필드의 값

예제 코드

gridView.getEditValue();

가이드

• CRUD - 행/셀 데이터 가져오기

그리드 필터링과 관련된 설정 정보들을 FilteringOptions 모델로 반환한다.

반환값

예제 코드

let filtering = gridView.getFiteringOptions();
filtering.enabled = false;
gridView.setFiteringOptions(filtering);

그리드 고정 영역에 관한 설정 정보들을 FixedOptions 의 모델로 반환한다.

반환값

예제 코드

let fixed = gridView.getFixedOptions();
fixed.colCount = 1;
gridView.setFixedOptions(fixed);

첫번째 그리드 푸터와 관련된 설정 정보를 GridFooter 모델로 반환한다.

반환값

예제 코드

let footer = gridView.getFooter();
footer.visible = false;
gridView.setFooter(footer);

그리드 푸터들의 설정 정보들을 GridFooterCollection 모델로 반환한다.

반환값

예제 코드

let footers = gridView.getFooters()
footers[0].visible = false;
gridView.setFooters(footers);

그리드의 FormatOptions 를 반환한다.

반환값

예제 코드

let format = gridView.getFormatOptions();
format.booleanFormat = 'X:O';
gridView.setFormatOptions(format);

FormView에 대한 설정 정보들을 FormOptions 모델로 반환한다.

반환값

예제 코드

let formOpts = gridView.getFormOptions();

itemIndex 에 해당하는 그룹 모델을 반환한다.

매개변수

• itemIndex: number

  아이템의 인덱스

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 형식으로 반환한다.

예제 코드

let group = gridView.getGroupModel(1);

지정한 그룹아이템 모델의 합계 정보를 반환한다.

매개변수

• model: GridItem

  아이템 모델 정보

• field: string

  필드명

• statistical: boolean

  기본값: false, summaryMode를 statistical로 할 경우 true, aggregate으로 할 경우 false로 한다.

반환값

상세 설명

숫자형 필드에 대해서만 의미있는 값을 리턴한다.

GroupSummary 형식으로 반환한다.

예제 코드

let group = gridView.getGroupModel(1);
let summary = gridView.getGroupSummary(group, 'fieldName', true);

가이드

• 행과 행 그룹 - 아이템 모델

그리드 헤더와 관련된 설정 정보들을 GridHeader 모델로 반환한다.

반환값

예제 코드

let header = gridView.getHeader();
header.sortable = false;
gridView.setHeader(header);

그리드 header summary 들의 설정 정보들을 HeaderSummaryCollection 모델로 반환한다.

반환값

예제 코드

let headerSummaries = gridView.getHeaderSummaries()
headerSummaries[0].visible = false;
gridView.setHeaderSummaries(headerSummaries);

첫번째 그리드 header summary 와 관련된 설정 정보를 HeaderSummary 모델로 반환한다.

반환값

예제 코드

let headerSummary = gridView.getHeaderSummary();
headerSummary.visible = false;
gridView.setHeaderSummary(headerSummary);

HTMLElemnt가 속한 셀의 위치정보를 반환한다.

매개변수

• element: HTMLElement

  HTMLElement

반환값

element가 속한 Cell의 index

상세 설명

customRenderer에서 사용자가 생성한 element가 속해있는 셀의 index를 찾기위해 사용.

값 검증에 실패한 셀 정보들을 반환한다.

반환값

검증에 실패한 셀 정보들, InvalidCell 의 배열 형식을 따른다.

상세 설명

이 함수는 validateCells() 를 먼저 실행한 후 검증에 실패한 데이터를 수정 후 다시 검증할 때 사용한다.

예제 코드

let invalids = gridView.getInvalidCells();

가이드

• 유효성 검사 - 전체 유효성 검사

그리드에 현재 표시된 Grid Item 개수를 반환한다.

반환값

상세 설명

rowGroup의 header, footer가 있는 경우 itemCount에 포함된다.

예제 코드

let count = gridView.getItemCount();

행의 고유 번호로 행의 순서를 반환한다.

매개변수

• dataRow: number

  행의 고유 번호

  let answerRow = gridView.getItemIndex(42);
  

반환값

입력된 데이터 행들의 고유번호들로 행들의 순서들을 반환한다.

매개변수

• rows: number[]

  행의 고유 번호의 배열

반환값

예제 코드

let harshadRows = getItemsOfRows([10, 12, 18, 142857]);

아이템의 상태값을 반환한다.

매개변수

• itemIndex: number

  상태를 가져오려는 아이템의 인덱스

반환값

그리드 아이템의 상태값

예제 코드

let itemStates = gridView.getItemState(3);

반환값

해당 컬럼의 레이아웃 정보를 반환한다.

매개변수

• column: string | GridColumn

  정보를 얻고자 하는 컬럼의 이름 또는 컬럼 오브젝트

반환값

- CellLayoutColumnItem 오브젝트

예제 코드

let layout = gridView.getLayoutByColumn('OrderID');

가장 왼쪽 화면에 표시되고 있는 컬럼의 x 좌표값을 반환한다.

반환값

예제 코드

let leftPos = gridView.getLeftPos();

모바일과 관련된 설정 정보들을 MobileOptions 모델로 반환한다.

반환값

예제 코드

let mobile = gridView.getMobileOptions();
mobile.longTabDuration = 400;
gridView.setMobileOptions(mobile);

itemIndex 에 해당하는 모델을 반환한다.

매개변수

• itemIndex: number

  아이템의 인덱스

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 형식으로 반환한다.

예제 코드

let model = gridView.getModel(3);

가이드

• 행과 행 그룹 - 아이템 모델

itemIndex 와 itemType 해당하는 모델을 반환한다.

매개변수

• itemIndex: number

  아이템의 인덱스

• itemType: ItemType

  아이템 종류 생략하면 GridBase.getModel()과 동일하다

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 형식으로 반환한다.

예제 코드

let model = gridView.getModelAs(3, 'row');

행 고유번호에 해당하는 아이템 모델을 반환한다.

매개변수

• dataRow: number

  행 고유번호

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 의 형식으로 반환한다.

예제 코드

let row = gridView.getModelOfRow(1);

가이드

• 행과 행 그룹 - 아이템 모델

지정한 아이템의 인덱스들에 해당하는 아이템 모델들을 반홚나다.

매개변수

• itemIndices: number | number[]

  아이템의 인덱스 배열

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 의 배열 형식으로 반환한다.

예제 코드

let models = gridView.getModels([1,2,3]);

가이드

• 행과 행 그룹 - 아이템 모델

행 고유번호들에 해당하는 아이템 모델들을 반환한다.

매개변수

• dataRows: number | number[]

  행 고유번호 배열

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 의 배열 형식으로 반환한다.

예제 코드

let rows = gridView.getModelsOfRows([1,2,3]);

가이드

• 행과 행 그룹 - 아이템 모델

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

반환값

- setOptions 와 다르게 그리드 수준의 정보만을 반환한다.

상세 설명

GridOptions 의 모델로 반환한다.

예제 코드

let options = gridView.getOptions();

아이템 모델의 부모 아이템 모델을 반환한다.

매개변수

• model: GridItem

  아이템 모델 정보

• extended: boolean

  확장정보 포함 여부, 기본값: false

반환값

상세 설명

GridItem 의 형식으로 반환한다.

예제 코드

let model = gridView.getModel(3);
let parent = gridView.getParentModel(model);

가이드

• 행과 행 그룹 - 아이템 모델

그리드에 붙여넣기를 할때 적용되는 설정을 PasteOptions 모델로 반환한다.

반환값

예제 코드

let paste = gridView.getPasteOptions();
paste.enabled = false;
gridView.setPasteOptions(paste);

아이템 모델의 최상위 조상 아이템 모델을 반환한다.

매개변수

• model: GridItem

  모델 정보

• extended: boolean

  확장 정보 포함 여부, 기본값: false

반환값

예제 코드

const idx = gridView.getCurrent();
const item = gridView.getModel(idx.itemIndex);
const root = gridView.getRootModel(item, extended);

가이드

• 행과 행 그룹 - 아이템 모델

행 높이를 반환한다.

매개변수

• itemIndex: number

  높이를 반환할 행의 인덱스

반환값

예제 코드

gridView.getRowHeight(2);

그리드 인디케이터와 관련된 설정 정보들을 RowIndicator 모델로 반환한다.

반환값

예제 코드

let indicator = gridView.getRowIndicator();
indicator.zeroBase = true;
gridView.setRowIndicator(indicator);

가이드

• 그리드 구성요소 - 인디케이터

지정한 그리드 행들의 고유 번호들을 반환한다.

매개변수

• items: number[]

  행의 순서의 배열

반환값

예제 코드

let rows = gridView.getRowsOfItems([0, 2, 4, 6]);

현재 선택 영역 안의 행의 인덱스들을 반환한다.

매개변수

• dataOnly: boolean

  데이터행만 반환한다.

반환값

예제 코드

let selectedItems = gridView.getSelectedItems(true);

현재 선택 영역 안의 데이터 행의 고유번호들을 반환한다.

반환값

예제 코드

let selectedRows = gridView.getSelectedRows();

현재 선택된 영역 정보를 반환한다.

매개변수

• index: number

  선택영역이 여러개인 경우 선택영역의 index

반환값

예제 코드

let sel = gridView.getSelection();
console.log("Selection: ", JSON.stringify(sel, function(key, value) { return key.indexOf("Layout") >= 0 ? value.column : value }));

현재 선택 영역에 포함된 셀들의 값을 반환한다.

매개변수

• maxRows: number

  반환할 최대 행의 개수. 기본값: -1. 0보다 작은 값이면 제한 없이 모든 행을 반환한다.

• index: number

  선택영역의 index 기본값: 0

반환값

셀 데이터들

상세 설명

선택된 영역이 여러개인경우에도 첫번째 선택영역의 data만 반환한다.

예제 코드

let selData = gridView.getSelectionData();

현재 선택된 영역 정보를 배열형태로 반환한다.

반환값

선택된 영역 배열

예제 코드

let sels = gridView.getSelections();
console.log("Selection count: ", sels.length);
sels.forEach((sels) => {
    console.log("Selection: ", JSON.stringify(sel, (key, value) => {return key.indexOf("Layout") >= 0 ? value.column : value}));
})

현재 선택 영역에 포함된 셀들의 값을 반환한다.

반환값

셀 데이터들

상세 설명

선택된 영역이 여러개인경우 사용한다.

현재 정렬되어 있는 필드들의 정렬 정보를 반환한다.

반환값

Sort 필드 정보 배열. 배열의 각 항목은 direction, orgFieldName, fieldName 의 정보를 가지고 있다.

예제 코드

let sFields = gridView.getSortedFields();

console.log(sFields[0]);
//{
// fieldName: "COMPANYNAME"
// orgFieldName: "CompanyName"
// direction: "descending"
//}

그리드 정렬과 관련된 설정 정보들을 SortingOptions 모델로 반환한다.

반환값

예제 코드

let sorting = gridView.getSortingOptions();
sorting.enabled = false;
gridView.setSortingOptions(sorting);

그리드 상태바의 설정 정보를 StateBar 의 모델로 반환한다.

반환값

예제 코드

let stateBar = gridView.getStateBar();
stateBar.errorVisible = false;
gridView.setStateBar(stateBar);

가이드

• 그리드 구성요소 - 상태바

필드의 합계값을 반환한다.

매개변수

• field: string | number

  해당 필드명 혹은 인덱스

• type: SummaryType

  기본값: "sum", 다른 속성값은 SummaryType 참조

반환값

상세 설명

summaryMode 에 따라서 가져올수 있는 값이 다르다.

숫자형 데이터 종류의 필드만 합계값을 가져올수 있다.

summaryMode가 none인 경우 미리 계산을 해 놓지 않는다.

summaryMode가 aggregate인 경우 "sum","avg","min",’max","count", "datacount", "dataavg" 를 가져올수 있다.

statistical인 경우 "var","varp","stdev","stdevp"을 추가적으로 가져올수 있다.

예제 코드

let sum = gridView.getSummary('unitPrice', 'sum');

그리드 맨 위의 지정한 행의 인덱스를 반환한다.

반환값

예제 코드

let topItem = gridView.getTopItem();

행의 순서와 데이터 필드 인덱스로 지정되는 데이터셀의 값을 반환한다.

매개변수

• itemIndex: number

  행의 순서

• field: string | number

  필드 인덱스 또는 필드명

반환값

데이터 필드의 값

상세 설명

지정한 행이 수정중인 경우 수정된 값을 반환한다. 편집이 완료되지 않은 셀의 값은 가져올수 없다.

예제 코드

gridView.getValue(3, 'UnitPrice');

가이드

• CRUD - 행/셀 데이터 가져오기

지정한 행의 데이터 값들을 JSON객체로 반환한다.

매개변수

• itemIndex: number

  정보를 가져올 행의 순서

반환값

입력된 itemIndex가 행의 고유 번호와 연결된 행이 아닌경우 null이 출력된다.

상세 설명

itemIndex와 연결된 행의 고유번호는 반환되는 객체의 __rowId에 담겨있다.

예제 코드

gridView.getValues('3');

가이드

• CRUD - 행/셀 데이터 가져오기

컬럼에 등록된 모든 필터를 숨기거나 보여준다. column.autoFilter가 true인 경우 적용되지 않는다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

• hide: boolean

  기본값: true, true: 숨김, false: 보여줌.

상세 설명

활성화 된 필터를 숨기는 경우 활성화 된 상태로 숨긴다.

예제 코드

gridView.hideAllColumnFilters('행정구역별');

컬럼에 등록된 필터들 중, filterNames 에 포함된 필터명을 갖는 필터들을 숨기거나 표시한다. column.autoFilter가 true인 경우 적용되지 않는다.

매개변수

• column: string | DataColumn

  해당하는 컬럼의 이름 또는 컬럼 객체

• filterNames: string | string[]

  필터의 이름 혹은 필터들의 이름의 배열

• hide: boolean

  기본값: true, true: 숨김, false: 보여줌.

상세 설명

활성화 된 필터를 숨기는 경우 활성화 된 상태로 숨긴다.

예제 코드

gridView.hideColumnFilters('행정구역별', ['전']);

현재 그리드에서 열려진 편집기를 닫는다.

예제 코드

gridView.hideEditor();

Toast 팝업 창을 숨긴다.

매개변수

• action: VoidFunction

  toast 창을 숨긴 뒤 수행할 콜백함수를 지정한다.

예제 코드

const f = function () {
     console.log('hidden toast!');
}
gridView.hideToats(f);

모든 아이템들이 체크되어있는지 여부를 반환한다.

반환값

CheckBar|CheckBar.head의 v 표시가 활성 상태이면 true를 반환한다.

예제 코드

let all = gridView.isAllChecked();

지정한 아이템의 인덱스로 체크바의 체크 가능 여부를 반환한다.

매개변수

• itemIndex: number

  아이템의 인덱스

반환값

체크 가능한지의 여부

예제 코드

let isCheckable = gridView.isCheckable(4);