" + "" + model.value + "
";
* }
*
* column.renderer = {
* type: "html",
* callback: f
* }
* ```
*/
export declare type GetTemplateCallback = (grid: GridBase, model: GridCell, width: number, height: number) => string;
/**
* @public
* GridBase는 {@link GridView}와 {@link TreeView}의 기반 클래스(Base Class)이다.
*
* @remarks
* GridBase 의 모든 속성과 method 는 이를 상속한 하위 클래스들에서만 호출할 수 있다.
*
* [하위 클래스]
*
* {@link GridView}
*
* {@link TreeView}
*
* @warning GridBase 로 직접 설정하거나 호출할 수 없다.
*/
export declare abstract class GridBase {
constructor(container: string | HTMLDivElement, accessibility?: boolean, waiOptions?: WaiOptions);
/**
* 현재 그리드의 합계를 계산하는 방식
*
* @remarks
* 그리드에 설정되어 있는 {@link SummaryMode} 를 반환한다.
* 값 할당으로 변경할 수 있다.
*
* @example
* ```js
* gridView.summaryMode = "aggregate";
* ```
*/
get summaryMode(): SummaryMode;
set summaryMode(value: SummaryMode);
/**
* 그리드에 설정되어 있는 삭제된 행들의 숨김 여부
*
* @remarks
* 값 할당으로 변경할 수 있다.
*
* @example
* ```js
* gridView.hideDeletedRows = true;
* ```
*/
get hideDeletedRows(): boolean;
set hideDeletedRows(value: boolean);
/**
* 데이터 수정 이후 정렬 동작 모드
*
* @remarks
* 그리드에 설정되어 있는 {@link SortMode} 를 반환한다.
* 값 할당으로 변경할 수 있다.
*
* @example
* ```js
* gridView.sortMode = "explicit";
* ```
*/
get sortMode(): SortMode;
set sortMode(value: SortMode);
/**
* 실행취소 기능 사용 가능 여부
* @remarks
* 값 할당으로 변경할 수 있다.
*
* @example
*
* ```js
* gridView.undoable = false
* ```
*/
get undoable(): boolean;
set undoable(value: boolean);
/**
* 현재상태에서 실행취소 가능 여부
*
* @example
*
* ```js
* gridView.undoing = false
* ```
*/
get undoing(): boolean;
/**
* 현재상태에서 재실행 가능 여부
*
* @example
*
* ```js
* gridView.redoing = false
* ```
*/
get redoing(): boolean;
/**
* 그리드가 마우스/키보드 이벤트에 대하여 반응안함 상태
*
* @remarks
* 값 할당으로 변경할 수 있다.
*
* @example
* ```js
* gridView.disabled = true;
* ```
*/
get disabled(): boolean;
set disabled(value: boolean);
/**
* 스크롤바의 너비를 변경
*
* @defaultValue `16`
*
* @example
* ```js
* gridView.scrollBarWidth = 24;
* ```
*/
get scrollBarWidth(): number;
set scrollBarWidth(value: number);
/**
* 스크롤바의 높이를 변경
*
* @defaultValue `16`
*
* @example
* ```js
* gridView.scrollBarHeight = 24;
* ```
*/
get scrollBarHeight(): number;
set scrollBarHeight(value: number);
/**
* 그리드의 고정 행 및 컬럼에 대한 설정 모델
*
* @remarks
* {@link FixedOptions} 객체를 반환한다.
* FixedOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.fixedOptions.colCount = 2;
* ```
*/
get fixedOptions(): FixedOptions;
/**
* 그리드 수준에서 관리되는 표시 정보들에 대한 설정 모델
*
* @remarks
* {@link DisplayOptions} 객체를 반환한다.
* DisplayOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.displayOptions.columnResizable = true;
* ```
*/
get displayOptions(): DisplayOptions;
/**
* 데이터 필드 값의 변환 형식에 대한 설정 모델
*
* @remarks
* {@link FormatOptions} 객체를 반환한다.
* FormatOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.formatOptions.datetimeFormat = 'yyyy-mm-dd';
* ```
*/
get formatOptions(): FormatOptions;
/**
* 데이터 편집에 대한 설정 모델
*
* @remarks
* {@link EditOptions} 객체를 반환한다.
* EditOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.editOptions.deletable = true;
* ```
*/
get editOptions(): EditOptions;
/**
* 편집기에 대한 설정 모델
*
* @remarks
* {@link EditorOptions} 객체를 반환한다.
* EditorOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.editorOptions.yearDisplayFormat = "{Y}년";
* ```
*/
get editorOptions(): EditorOptions;
/**
* 클립보드에 복사하는 것에 대한 설정 모델
*
* @remarks
* {@link CopyOptions} 객체를 반환한다.
* CopyOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.copyOptions.singleMode = true;
* ```
*/
get copyOptions(): CopyOptions;
/**
* 클립보드의 데이터를 붙여 넣는 것에 대한 설정 모델
*
* @remarks
* {@link PasteOptions} 객체를 반환한다.
* PasteOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.pasteOptions.enabled = false;
* ```
*/
get pasteOptions(): PasteOptions;
/**
* 데이터 정렬에 대한 설정 모델
*
* @remarks
* {@link SortingOptions} 객체를 반환한다.
* SortingOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.sortingOptions.style = 'reverse';
* ```
*/
get sortingOptions(): SortingOptions;
/**
* 데이터 필터링에 대한 설정 모델
*
* @remarks
* {@link FilteringOptions} 객체를 반환한다.
* FilteringOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.filteringOptions.enabled = false;
* ```
*/
get filteringOptions(): FilteringOptions;
/**
* 모바일 관련 설정 모델
*
* @remarks
* {@link MobileOptions| mobileOptions} 를 반환한다.
* MobileOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.mobileOptions.longTapDuration = false;
* ```
*/
get mobileOptions(): MobileOptions;
/**
* 데이터 drag and drop 과 관련 된 설정 모델
*
* @remarks
* {@link DataDropOptions| dataDropOptions} 를 반환한다.
* DataDropOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.dataDropOptions.dropMode = 'copy';
* ```
*/
get dataDropOptions(): DataDropOptions;
/**
* 그리드의 인디케이터에 관한 설정 모델
*
* @remarks
* {@link RowIndicator} 객체를 반환한다.
* RowIndicator 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.rowIndicator.displayValue = 'row';
* ```
*/
get rowIndicator(): RowIndicator;
/**
* 그리드의 상태바에 관한 설정 모델
*
* @remarks
* {@link StateBar} 객체를 반환한다.
* StateBar 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.stateBar.mark = 'image';
* ```
*/
get stateBar(): StateBar;
/**
* 그리드의 체크바에 관한 설정 모델
*
* @remarks
* {@link CheckBar} 객체를 반환한다.
* CheckBar 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.checkBar.visibleOnly = true;
* ```
*/
get checkBar(): CheckBar;
/**
* 그리드의 헤더 영역에 관한 설정 모델
*
* @remarks
* {@link GridHeader} 객체를 반환한다.
* GridHeader 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.header.showTooltip = true;
* ```
*/
get header(): GridHeader;
/**
* 첫번째 푸터에 관한 설정 모델
*
* @remarks
* {@link GridFooter} 객체를 반환한다.
* GridFooter 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.footer.styleName = 'custom-footer-1';
* ```
*/
get footer(): GridFooter;
/**
* 푸터들에 관한 설정 모델
*
* @remarks
* {@link GridFooter} 의 콜렉션 객체를 반환한다.
* {@link GridFooterCollection} 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.footers.visible = false;
* ```
*/
get footers(): GridFooterCollection;
/**
* 그리드 헤더 영역에 표시되는 첫번째 Header Summary에 대한 설정 모델
*
* @remarks
* {@link HeaderSummary} 객체를 반환한다.
* HeaderSummary 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.headerSummary.visible = false;
* ```
*/
get headerSummary(): HeaderSummary;
/**
* 그리드 헤더 영역에 표시되는 Header Summary 에 대한 컬렉션 설정 모델
*
* @remarks
* {@link HeaderSummary} 의 콜렉션 객체를 반환한다.
* {@link HeaderSummaryCollection} 의 속성을 가져온다.
*
* @example
* ```js
* gridView.headerSummaries.visible = false;
* ```
*/
get headerSummaries(): HeaderSummaryCollection;
/**
*
*/
get filterPanel(): FilterPanel;
/**
* 그리드의 focus cell 의 위치 변경을 결정하는 콜백
*
* @remarks
* 변경된 후에는 {@link GridBase.onCurrentChanged | onCurrentChanged} 를 호출한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `oldIndex` - 변경 전 셀 위치정보
*
* `newIndex` - 변경 되는 셀 위치정보
*
* [반환값] - callback 함수에서 명시적으로 `false`를 반환하면 current가 변경되지 않음
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCurrentChanging = function (grid, oldIndex, newIndex) {
* console.log(oldIndex);
* console.log(newIndex);
* // return false; 를 하는 경우 위치 변경이 되지 않는다.
* };
* ```
*/
onCurrentChanging?: (grid: GridBase, oldIndex: CellIndex, newIndex: CellIndex) => boolean;
/**
* 그리드의 focus cell 의 위치 변경을 알리는 콜백
*
* @remarks
* 변경되기 직전에는 {@link GridBase.onCurrentChanging | onCurrentChanging} 을 호출
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `newIndex` - 변경된 셀 위치정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCurrentChanged = function (grid, newIndex) {
* console.log(newIndex);
* }
* ```
*/
onCurrentChanged?: (grid: GridBase, newIndex: CellIndex) => void;
/**
* 데이터 행의 위치가 변경됨을 알리는 콜백
*
* @remarks
* {@link GridBase.onCurrentChanged | onCurrentChanged }의 경우 선택된 cell의 itemIndex가 변경되는 경우 발생된다.
* 그러나 {@link GridBase.onCurrentRowChanged | onCurrentRowChanged } 의 경우 선택된 cell의 데이터 행의 index가 변경되는 경우에 발생한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `oldRow` - 변경 전 데이터 행의 위치
*
* `newRow` - 변경 후 데이터 행의 위치, `-1`인 경우 신규행이거나 또는 `dataProvider`가 비워진 경우이다.
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onCurrentRowChanged = function (grid, oldRow, newRow) {
* console.log("oldRow => ", oldRow, "newRow => ", newRow);
* };
* ```
*/
onCurrentRowChanged?: (grid: GridBase, oldRow: number, newRow: number) => void;
/**
* 셀 편집을 완료하고 다른 셀로 이동할때 Javascript를 통한 사용자 검증 결과를 결정하는 콜백
*
* @remarks
* 해당 컬럼 값에 문제가 있다면 검증 에러와 에러 메시지를 그리드에 반환값으로 전달한다.
*
* `level`과 `message` 값을 포함하는 오브젝트를 그리드에 전달하면 검증에 실패한 것으로 판단한다.
*
* {@link ValidationError} 형태로 반환해야 한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `column` - 컬럼 오브젝트
*
* `inserting` - `true`: 열 추가 중, `false`: 열 수정 중
*
* `value` - 입력된 필드의 값
*
* `itemIndex` - 셀편집된 행의 순서
*
* `dataRow` - 셀편집된 행의 고유 번호.
*
* [반환값] - {@link ValidationError}
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onValidateColumn = function (grid, column, inserting, value, itemIndex, dataRow) {
* if (column.name != "Knock Knock") {
* return {
* level: 'warning';
* messsage: "It's a dad joke! Do not " + JSON.stringify(column);
* }
* }
* };
* ```
*/
onValidateColumn?: (grid: GridBase, column: DataColumn, inserting: boolean, value: any, itemIndex: number, dataRow: number) => ValidationError | undefined;
/**
* Javascript를 통한 행 단위 사용자 검증 결과를 결정하는 콜백
*
* @remarks
* 해당 행의 값들에 문제가 있다면 검증 에러와 에러 메시지를 그리드에 반환값으로 전달한다.
*
* `level`과 `message` 값을 포함하는 오브젝트를 그리드에 전달하면 검증에 실패한 것으로 판단한다.
*
* {@link ValidationError} 형태로 반환해야 한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 검증하는 행의 순서
*
* `dataRow` - 검증하는 행의 고유 번호
*
* `inserting` - true: 열 추가 중, false: 열 수정 중
*
* `values` - 입력된 필드들의 값
*
* [반환값] - {@link ValidationError}
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onValidateRow = function (grid, itemIndex, dataRow, inserting, values) {
* if (dataRow % 2 === 0) {
* return {
* level: 'info';
* messsage: "even!";
* }
* }
* };
* ```
*/
onValidateRow?: (grid: GridBase, itemIndex: number, dataRow: number, inserting: boolean, values: any[]) => ValidationError;
/**
* validation 실패시 발생하는 콜백
*
* @remarks
* 콜백함수에서 별도의 에러 처리가 가능하고, err 객체를 return 하면 자체 Validation 메세지가 표시되고 그 외의 경우 표시되지 않는다.
*
* `level`과 `message` 값을 포함하는 오브젝트를 그리드에 전달하면 검증에 실패한 것으로 판단한다.
*
* {@link ValidationError} 형태로 반환해야 한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 검증하는 행의 인덱스
*
* `column` - 컬럼 오브젝트
*
* `error` - 검증 결과
*
* [반환값] - {@link ValidationError}
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onValidationFail = function (grid, itemIndex, column, err) {
* console.log("onValidationFail:" + itemIndex + "," + JSON.stringify(column) + "," + JSON.stringify(err));
* if (column.name != "Mortal") {
* var editValue = grid.getEditValue();
* err.message = "입력된 "+editValue+" 는 잘못된 값입니다";
* return err;
* }
* }
* ```
*
*/
onValidationFail?: (grid: GridBase, itemIndex: number, column: GridColumn, error: ValidationError) => ValidationError;
/**
* 사용자의 컬럼 헤더 체크박스를 클릭을 알리는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `column` - 컬럼 오브젝트
*
* `checked` - 체크 여부
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onColumnCheckedChanged = function (grid, col, chk) {
* console.log(col.name + "was checked as: " + chk);
* };
* ```
*/
onColumnCheckedChanged?: (grid: GridBase, column: GridColumn, checked: boolean) => void;
/**
* 추가한 팝업메뉴 항목의 클릭을 알리는 콜백
*
* @remarks
* MenuItem에 {@link PopupMenuItem.callback | callback} 이 지정된 경우 호출되지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `item` - MenuItem 객체
*
* `clickData` - 클릭 된 아이템의 정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onMenuItemClicked = function (grid, item, clickData) {
* console.log(item.label + "was clicked.");
* };
* ```
*/
onMenuItemClicked?: (grid: GridBase, item: PopupMenuItem, clickData: ClickData) => void;
/**
* 좌표와 함께 ContextMenu 표시를 결정하는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `x` - ContextMenu 가 호출된 x좌표값
*
* `y` - ContextMenu 가 호출된 y좌표값
*
* `clickData` - 클릭 된 아이템의 정보
*
* `menu` - menuName
*
* `rightClick` - 오른쪽 버튼 클릭여부
*
* [반환값] - `false`를 반환하면 컨텍스트 메뉴가 표시되지 않는다. 또 menuName을 return하는 경우 해당 menu가 표시된다.
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onContextMenuPopup = function (grid, x, y, clickData, menu, rightClick) {
* console.log(clickData);
* };
* ```
*/
onContextMenuPopup?: (grid: GridBase, x: number, y: number, clickData: ClickData, menu: string, rightClick: boolean) => boolean | string;
/**
* {@link GridBase.setContextMenu | setContextMenu()} 를 통해 추가한 컨텍스트 메뉴 항목 클릭을 알리는 콜백
*
* @remarks
* MenuItem에 callback이 지정된 경우 호출되지 않는다.
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `item` - 클릭된 메뉴 항목의 정보
*
* `clickData` - 클릭 된 아이템의 정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onContextMenuItemClicked = function (grid, item, clickData) {
* console.log(clickData);
* };
* ```
*/
onContextMenuItemClicked?: (grid: GridBase, item: PopupMenuItem, clickData: ClickData) => void;
/**
* 사용자가 데이터 셀 내부의 action 버튼을 클릭했을 때 호출한다.
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 데이터 셀이 포함된 아이템의 위치정보
*
* `column` - 데이터 셀에 연결된 컬럼
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCellButtonClicked = function (grid, index, col) {
* console.log(index);
* };
* ```
*/
onCellButtonClicked?: (grid: GridBase, index: CellIndex, column: GridColumn) => void;
/**
* 사용자가 키보드나 스크롤 바 등을 조작하여 그리드에 마지막 행이 표시될 때 호출되는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onScrollToBottom = function (grid) {
* var data = {"SearchKey":"searchData"},
* $.ajax({
* url:"/loadData.do",
* data: data,
* type:"post",
* async:false,
* success: function (data, textStatus) {
* grid.fillJsonData(data.dataList, {fillMode:"append"});
* }
* })
* });
* ```
*/
onScrollToBottom?: (grid: GridBase) => void;
/**
* 수직 스크롤 바의 위치가 변경됨을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 스크롤 중일때 그리드 상단에 표시되는 itemIndex 값
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onTopIndexChanged = function (grid, idx) {
* console.log(idx + "was changed!");
* }
* ```
*/
onTopIndexChanged?: (grid: GridBase, itemIndex: number) => void;
/**
* gridView.topIndex가 변경될때 호출되는 콜백
*
* @remarks
*
* 스크롤할때 사용자가 지정한 값만큼 이동할때 사용한다.
* 페이지에 보여지는 값 이상을 return하지 말아야 한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `currentTop` - 변경되기전 topIndex
*
* `delta` - 변경값
*
* `focusing` - 포커스 변경에 의해서 topIndex가 변경되는 경우 `true`
*
* `adjust` - 그리드 내부에서 위치를 조정하는 경우 `true`
*
* [반환값] - `number`를 return하면 해당 값만큼 topIndex를 이동한다.
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* var userSetTopItem = false;
* grid.onTopIndexChanging = function(_grid, current, delta, focusing, adjust) {
* // mergeCell을 block처럼 사용하는 경우 스크롤도 block단위로 이동하기 위해서 사용한다.
* // setTopItem의 경우 이벤트에서는 구분할수 없기 때문에 외부에서 구분할수 있는 값을 주어야 한다.
* // rowGrouping된 경우는 아래 코드를 그대로 사용할수는 없다.
*
* var fcnt = _grid.fixedOptions.rowCount;
* // 첫행으로 이동하거나 마지막행으로 이동되는 경우 또는 그리드 내부에서 위치를 보정하는 경우 'null'을 return하면 원래 이동하려는 delta값 만큼 이동한다.
* if (current + delta + _grid.fullItemCount() + fcnt >= _grid.getItemCount() || current + delta === 0 || (adjust && !focusing)) {
* console.log(current, delta, `scroll bottom or Top or adjust = ${adjust}`);
* return;
* }
*
* var top = current + delta; // 그리드가 이동하려는 topIndex
* var items = _grid.getMergedItems(top + fcnt, "merge컬럼", true, true); // 이동할 block의 items
* var curItems = _grid.getMergedItems(current + fcnt, "merge컬럼", true, true); // 현재 top block의 items
*
* if (delta < 0 || top === items[0] + fcnt || userSetTopItem) { // 위로 스크롤하거나 fixedRow가 있으면서 최상단으로 이동 또는 사용자가 setTopItem을 했을때
* top = items[0]; // 블록의 첫번째 행이 topIndex
* } else { // 아래쪽으로 스크롤 했을때
* top = items[0] === curItems[0] ? items[items.length - 1] + 1 : top = items[0]
* }
*
* return top - current - fcnt;
* }
*
* function setTop(index) {
* userSetTopItem = true;
* grid.setTopItem(index);
* userSetTopItem = false;
* }
* ```
*/
onTopIndexChanging?: (grid: GridBase, currentTop: number, delta: number, focusing: boolean, adjust: boolean) => number;
/**
* 수평 스크롤 바의 위치가 변경됨을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `pos` - 스크롤 중일때 그리드 왼쪽 위치
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onLeftPosChanged = function (grid, pos) {
* console.log(pos + " was changed!");
* }
* ```
*/
onLeftPosChanged?: (grid: GridBase, pos: number) => void;
/**
* 사용자가 Ctrl+Del 키를 누르거나 {@link GridBase.deleteSelection | deleteSelection() } 으로 삭제할 때, 실제 삭제를 결정하는 콜백
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `rows` - 삭제하려는 행들의 데이터 행 순서들의 배열
*
* [반환값] - null이 아닌 값을 반환하면 지정 텍스트를 표시하고 삭제를 취소한다.
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onRowsDeleting = function (grid, rows) {
* console.log('Deleted: ' + rows.join());
* }
* ```
*/
onRowsDeleting?: (grid: GridBase, rows: number[]) => boolean;
/**
* 사용자가 Insert 키를 눌러 새로운 행을 삽입하거나, 마지막 행에서 아래 화살표를 눌러 행을 추가하는 것을 결정하는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 행 삽입 위치의 순서
*
* `dataRow` - 행 삽입 위치의 고유 id
*
* [반환값] - 행 추가를 금지 시킬 때 사용자에게 표시할 메시지
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onRowInserting = function (grid, itemIndex, dataRow) {
* console.log('Inserted: ' + dataRow + ' at ' + itemIndex);
* }
* ```
*/
onRowInserting?: (grid: GridBase, itemIndex: number, dataRow: number) => boolean;
/**
* 사용자가 마우스나 키보드로 선택 영역을 변경했을때 기존 선택 영역이 제거 되었음을 알리는 콜백
*
* @remarks
* 기존 선택영역이 없는 경우 발생하지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onSelectionCleared = function (grid) {
* console.log('Selection cleared');
* }
* ```
*/
onSelectionCleared?: (grid: GridBase) => void;
/**
* 사용자가 마우스나 키보드로 선택 영역의 크기를 변경했음을 알리는 콜백
*
* @remarks
* 변경 중인 선택 영역의 정보는 {@link GridBase.getSelectionData | getSelectionData} 함수로 알 수 있다.
* {@link DisplayOptions.selectionStyle | GridBase.displayOptions.selectionStyle} 이 {@link SelectionStyle.NONE} 인 경우 발생하지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
* `selection` - 선택 영역 정보
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onSelectionChanged = function (grid) {
* console.log('Selection changed!');
* }
* ```
*/
onSelectionChanged?: (grid: GridBase, selection: Selection) => void;
/**
* 선택 영역이 새로 추가됨을 알리는 콜백
* @deprecated
* 2.6.0 버전 이후 제거될 예정
*
* @remarks
* 변경 중인 선택 영역의 정보는 {@link GridBase.getSelectionData | getSelectionData} 함수로 알 수 있다.
* {@link Selection.style | GridBase.getSelection().style} 이 {@link SelectionStyle.NONE} 인 경우 발생하지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `selection` - 선택 영역 정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onSelectionAdded = function (grid, selection) {
* console.log(selection);
* }
* ```
*/
onSelectionAdded?: (grid: GridBase, selection: Selection) => void;
/**
* 사용자가 마우스로 선택 영역 변경 완료를 알리는 콜백
* @deprecated
* 2.6.0 버전 이후 제거될 예정
*
* @remarks
* 변경된 선택 영역의 정보는 {@link GridBase.getSelection | getSelection} 함수로 알수 있고 선택영역의 데이터는 {@link GridBase.getSelectionData | getSelectionData} 함수로 알 수 있다.
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
* `selection` - 선택 영역 정보
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onSelectionEnded = function (grid) {
* let cells = grid.getSelectionData();
* console.log(cells);
* }
* ```
*/
onSelectionEnded?: (grid: GridBase, selection: Selection) => void;
/**
* Cell 별로 열리는 Editor 의 표시를 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 편집기가 열리려는 셀의 위치정보
*
* `props` - {@link CellEditor | 셀 편집기} 설정 정보
*
* `attrs` - 내부 편집기 element attributes. 사용자가 임의로 지정할 수 있는 값들.
*
* [반환값] - false 를 return하면 Editor가 표시되지 않는다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onShowEditor = function (grid, index, props, attrs) {
* console.log("onShowEditor:" + index.itemIndex + "," + index.column);
* if (index.column == "OrderID") {
* props.textCase = 'upper';
* }
* }
* ```
*/
onShowEditor?: (grid: GridBase, index: CellIndex, props: any, attrs: any) => boolean;
/**
* mobile에서 표시되는 editCommand의 표시여부를 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 편집기가 열리려는 셀의 위치정보
*
* [반환값] - false 를 return하면 EditCommand가 표시되지 않는다.
* @defaultValue `null`
* @eventProperty
*/
onShowEditCommand?: (grid: GridBase, index: CellIndex) => boolean;
/**
* 편집이 완료되고 편집기가 사라진 것을 알리는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 편집된 셀의 위치정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onHideEditor = function (grid, index) {
* console.log("onHideEditor:" + index.itemIndex + "," + index.column);
* }
* ```
*/
onHideEditor?: (grid: GridBase, index: CellIndex) => void;
/**
* 아이템이 사용자의 Key 입력 등으로 값이 변경되었음을 알리는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 현재 focus 된 셀의 위치정보
*
* `value` - 편집 중인 셀의 데이터 값
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onEditChange = function (grid, index, value) {
* console.log("grid.onEditChange driven, " + index.column + ' at ' + index.dataRow + ' was replaced by value: ' + value);
* }
* ```
*/
onEditChange?: (grid: GridBase, index: CellIndex, value: any) => void;
/**
* 셀 편집이 완료되었을 때 셀의 위치와 편집결과를 갖고 있는 콜백
*
* @remarks
* DropDownCellEditor, SearchCellEditor, MultiCheckCellEditor의 경우 editResult.text에는 labels에 해당하는 값이 출력되고 editResult.value에는 values에 해당하는 값이 출력된다.
*
* DateCellEditor의 경우에는 editResult.text에는 editor의 datetimeFormat으로 Formatting된 값이 출력되고 editResult.value에는 Date객체가 출력된다.
*
* 다른 Editor의 경우 text와 value에 동일한 값이 출력된다.
*
* `boolean`을 return하면 {@link GridBase.onEditCommit}이 호출되지 않는다.
*
* {@link EditResult} 의 형태로 출력된다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 편집된 셀의 위치정보
*
* `editResult` - 편집된 셀의 text와 value를 속성으로 갖는 단순한 객체, 셀 편집기의 종류에 따라 출력되는 값이 달라진다.
*
* [반환값] - `false` 를 반환 시 셀에 반영되지 않는다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onGetEditValue = function (grid, index, editResult) {
* console.log(editResult);
* }
* ```
*/
onGetEditValue?: (grid: GridBase, index: CellIndex, editResult: EditResult) => boolean | void;
/**
* 사용자 입력이 셀에 반영함을 결정하는 콜백
*
* @remarks
* 편집 중인 셀에서 다른 셀로 이동하거나 또는 {@link GridBase.commitEditor | commitEditor()} 를 호출하면 발생한다.
* {@link GridBase.setValue | setValue()} 등 사용자 코드로 변경될때는 발생하지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 변경된 셀의 위치 정보
*
* `oldValue` - 편집전 셀의 데이터 값
*
* `newValue` - 편집후 셀의 데이터 값
*
* [반환값] - `false` 를 반환 시 셀에 반영되지 않는다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onEditCommit = function (grid, index, oldValue, newValue) {
* if (newValue === '') {
* return false;
* }
* console.log(oldValue + 'was changed to ' + newValue);
* }
* ```
*/
onEditCommit?: (grid: GridBase, index: CellIndex, oldValue: any, newValue: any) => boolean;
/**
* 사용자가 편집중 ESCAPE 키를 입력하거나 {@link GridBase.cancel | cancel()} 이 호출되어 편집이 취소됨을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 편집이 취소된 데이터 셀의 위치정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onEditCanceled = function (grid, index) {
* console.log("Edit Cannceled at " + index.column);
* }
* ```
*/
onEditCanceled?: (grid: GridBase, index: CellIndex) => void;
/**
* 사용자가 행 편집을 취소했음을 알리는 콜백
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 편집이 취소된 행의 순서
*
* `state` - 편집 취소된 행의 상태
*
* @eventProperty
*
* @example
* ```js
* gridView.onItemEditCanceled = function (grid, itemIndex, state) {
* console.log(state);
* }
* ```
*/
onItemEditCanceled?: (grid: GridBase, itemIndex: number, state: string) => void;
/**
* 사용자가 행 편집을 취소를 결정하는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 편집이 취소된 행의 순서
*
* `state` - 편집 취소된 행의 상태이다. updating, inserting, appending 이 반환된다.
*
* [반환값] - 기본값: `true`, `false` 를 반환하면 행 편집 취소가 취소된다. (계속 편집 상태)
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onItemEditCancel = function (grid, itemIndex, state) {
* console.log(state);
* if (itemIndex % 5 === 0) {
* return false;
* }
* }
* ```
*/
onItemEditCancel?: (grid: GridBase, itemIndex: number, state: string) => boolean;
/**
* 검색을 했음을 알리는 콜백
*
* @remarks
* {@link SearchCellEditor}에서 {@link SearchCellEditor.searchLength | searchLenght} 와 {@link SearchCellEditor.searchDelay | searchDelay} 조건이 만족하면 발생한다. 또는 Ctrl+Enter 키 또는 Enter 키를 입력시 발생한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 변경된 셀 위치정보
*
* `text` - 셀에 입력된 값
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onEditSearch = function (grid, index, text) {
* console.log(text + ' was searched!');
* }
* ```
*
*/
onEditSearch?: (grid: GridBase, index: CellIndex, text: string) => void;
/**
* {@link SearchCellEditor} 에서 버튼을 클릭했음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 클릭된 셀 위치정보
*
* `text` - 셀에 입력된 값
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onSearchCellButtonClick = function (grid, index, text) {
* console.log(text + ' button was clicked!');
* }
* ```
*
*/
onSearchCellButtonClick?: (grid: GridBase, index: CellIndex, text: string) => void;
/**
* 수정이나 추가 중인 편집 아이템의 한 필드값이 편집 완료되었음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 편집 중인 행의 순서
*
* `row` - 편집 중인 행의 고유 번호
*
* `field` - 방금 편집된 필드의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCellEdited = function (grid, itemIndex, row, field) {
* console.log('Edit done! at ' + itemIndex + ', ' + field);
* }
* ```
*
*/
onCellEdited?: (grid: GridBase, itemIndex: number, row: number, field: number) => void;
/**
* 사용자 입력으로 변경된 값이 행에 반영되었음을 알리는 콜백
*
* @remarks
* {@link PasteOptions.noEditEvent | pasteOptions.noEditEvent} 가 `true` 면 발생하지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 변경된 행의 순서
*
* `row` - 변경된 행의 고유 번호
*
* `field` - 변경된 필드의 인덱스
*
* `oldValue` - 편집전 셀의 데이터 값
*
* `newValue` - 편집후 셀의 데이터 값
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onEditRowChanged = function (grid, itemIndex, dataRow, field, oldValue, newValue) {
* let v = grid.getValue(itemIndex, field);
* console.log("onEditRowChanged, " + field + ": " + oldValue + " => " + newValue);
* };
* ```
*/
onEditRowChanged?: (grid: GridBase, itemIndex: number, row: number, field: number, oldValue: any, newValue: any) => void;
/**
* 그리드 셀에 붙여넣기 했음을 알리는 콜백
*
* @remarks
* 여러 행을 붙여넣기 할때는 {@link GridBase.onRowsPasted | onRowsPasted} 참조
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 변경된 행의 순서
*
* `row` - 변경된 행의 고유 번호
*
* `fields` - 필드의 인덱스들
*
* `oldValues` - 편집전 셀의 데이터 값들
*
* `newValues` - 편집후 셀의 데이터 값들
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onEditRowPasted = function (grid, itemIndex, row, fields, oldValues, newValues) {
* console.log('Row pasted!: {' + newValues.join() + '}');
* };
* ```
*/
onEditRowPasted?: (grid: GridBase, itemIndex: number, row: number, fields: number[], oldValues: any[], newValues: any[]) => void;
/**
* 여러 행을 붙여넣기 했음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `items` - 붙여넣기된 행들의 그리드에서의 순서
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onRowsPasted = function (grid, items) {
* console.log('Rows pasted!: ' + items.join());
* };
* ```
*
*/
onRowsPasted?: (grid: GridBase, items: number[]) => void;
/**
* 셀에 붙여넣기를 결정하는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 클릭된 데이터 셀의 위치정보
*
* `value` - 붙여넣기 중인 데이터 값
*
* [반환값] - `false`를 반환하면 그 셀에는 붙여넣기가 되지 않는다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCellPasting = function (grid, index, value) {
* if (value === 'hello') {
* return false;
* }
* };
* ```
*/
onCellPasting?: (grid: GridBase, index: CellIndex, value: any, editResult: EditResult) => boolean;
/**
* 사용자가 checkBar의 체크박스를 클릭하거나 checkItem을 호출하여 체크를 변경했음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 체크된 데이터 행의 순서
*
* `checked` - 체크가 되었으면 `true`, 해제되었으면 `false`가 출력
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onItemChecked = function (grid, itemIndex, checked) {
* console.log('Checked as ' + checked + ' at ' + itemIndex);
* };
* ```
*/
onItemChecked?: (grid: GridBase, itemIndex: number, checked: boolean) => void;
/**
* 사용자가 checkBar의 Header를 클릭하여 전체선택, 해제를 하거나 또는 checkAll `true` / `false` 을 입력하여 전체선택, 해제를 했음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `checked` - 체크가 되었으면 true, 해제가 되었으면 false가 출력
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onItemAllChecked = function (grid, checked) {
* console.log('All checked as ' + checked);
* };
* ```
*/
onItemAllChecked?: (grid: GridBase, checked: boolean) => void;
/**
* 그리드에 발생한 에러창을 클릭했음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `error` - 에러 메세지
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onErrorClicked = function (grid, error) {
* console.log(error);
* }
* ```
*/
onErrorClicked?: (grid: GridBase, error: string) => void;
/**
* 정렬을 결정하는 콜백
*
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `fields` - 정렬하는 필드의 목록
*
* `direction` - 각 필드에 대한 정렬 방식 목록
*
* [반환값] - `false` 를 반환하면 정렬은 취소된다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onSorting = function (grid) {
* if (fields.length > 5) {
* return false;
* }
* }
* ```
*/
onSorting?: (grid: GridBase, fields: number[], directions: string[]) => boolean;
/**
* 정렬했음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onSortingChanged = function (grid) {
* console.log('Sorted! ');
* }
* ```
*
*/
onSortingChanged?: (grid: GridBase) => void;
/**
* 필터링을 결정하는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
* `column` - filter Selector가 표시되는 경우 전달된다. filter의 active등을 변경하는 경우에는 전달되지 않는다.
*
* [반환값] - 기본값: `true`, 필터링 실행 여부를 지정한다. `false` 를 반환하면 필터링은 취소된다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onFiltering = function (grid, column) {
* if (column && column.name === "column") {
* return false; // 특정 컬럼은 filter Selector를 통한 filtering을 하지 못하도록 막는다.
* }
* return true;
* }
* ```
*/
onFiltering?: (grid: GridBase, column: DataColumn) => boolean;
/**
* 컬럼에 필터들이 설정되어 있고, 그 필터의 상태가 변경되었음을 알리는 콜백
*
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `column` - 필터링된 컬럼 정보
*
* `filter` - 해당 필터의 정보
*
* `reset` - 초기화 클릭 여부
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onFilteringChanged = function (grid, column, filter) {
* console.log('Filter changed!');
* }
* ```
*/
onFilteringChanged?: (grid: GridBase, column: GridColumn, filter: ColumnFilter, reset: boolean) => void;
/**
* Wheel Event가 발생했음을 알리는 콜백
*
* @remarks
* Mouse Wheel을 돌리면 발생한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `event` - WheelEvent
*
* [반환값] - Wheel Event를 무시하려면 false 를 반환한다/
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onWheel = function (grid, event) {
* console.log('You wheeled... ' + event);
* }
* ```
*/
onWheel?: (grid: GridBase, event: WheelEvent) => boolean;
/**
* 키 입력을 결정하는 콜백
*
* @remarks
* KeyDown 될 때 발생한다.
* 키를 입력하고 있는 동안 계속 발생된다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `event` - KeyboardEvent
*
* [반환값] - 키 입력을 금지할때 false 를 반환한다/
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onKeyDown = function (grid, event) {
* console.log('You pressed... ' + event);
* }
* ```
*/
onKeyDown?: (grid: GridBase, event: KeyboardEvent) => boolean;
/**
* 키가 입력되고 있음을 알리는 콜백
*
* @remarks
* KeyPress 될 때 발생한다.
* 키를 입력하고 있는 동안 계속 발생된다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `event` - KeyboardEvent
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onKeypress = function (grid, event) {
* console.log('You are pressing... ' + event);
* }
* ```
*/
onKeyPress?: (grid: GridBase, event: KeyboardEvent) => void;
/**
* 키를 입력하였음을 알리는 콜백.
*
* @remarks
* KeyUp 될 때 발생한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `event` - KeyboardEvent
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onKeyUp = function (grid, event) {
* console.log('You pressed... ' + event);
* }
* ```
*/
onKeyUp?: (grid: GridBase, event: KeyboardEvent) => void;
/**
* 데이터 셀의 툴팁이 표시되었음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤.
*
* `index` - 마우스 포인터가 위치한 영역의 셀 위치정보
*
* `value` - 마우스 포인터가 위치한 데이터
*
* [반환값] - 툴팁에 표시할 값. 아무것도 return 하지 않으면 Tooltip이 표시되지 않는다.
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onShowTooltip = function (grid, index, value) {
* if (index % 7 === 0) {
* return '7-multiple Row!'
* }
* }
* ```
*/
onShowTooltip?: (grid: GridBase, index: CellIndex, value: any) => boolean | string;
/**
* 컬럼 헤더의 툴팁이 표시되었음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `column` - 툴팁이 표시될 컬럼 GroupHeader이면 해당 Group의 첫번째 Column
*
* `value` - 툴팁에 표시될 값. 기본값으로 컬럼헤더 text가 전달된다.
*
* `layout` - 툴팁이 표시될 컬럼의 layout
*
* [반환값] - 툴팁에 표시할 값. 아무것도 return 하지 않으면 Tooltip이 표시되지 않는다.
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onShowHeaderTooltip = function (grid, column, value, layout) {
* return 'header-tooltip: ' + value;
* }
* ```
*/
onShowHeaderTooltip?: (grid: GridBase, column: GridColumn, value: any, layout: CellLayoutItem) => string;
/**
*
* @deprecated
* 컬럼의 속성 중 width, displayIndex, visible 속성값이 변경되었음을 알리는 콜백
* {@link GridBase.onLayoutPropertyChanged}로 대체
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `column` - 변경된 컬럼의 정보
*
* `property` - 컬럼의 displayWidth, displayIndex, visible 속성 중 변경된 것
*
* `value` - 변경된 값이 전달된다.
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onColumnPropertyChanged = function (grid, column, property, newValue, oldValue) {
*
* console.log(column + "s props werer changed!");
* }
* ```
*/
onColumnPropertyChanged?: (grid: GridBase, column: GridColumn, property: string, newValue: any, oldValue: any) => void;
/**
*
* Layout의 속성 중 displayWidth, displayIndex, visible 속성값이 변경되었음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `layout` - 변경된 layout의 정보
*
* `property` - 컬럼의 displayWidth, displayIndex, visible 속성 중 변경된 것
*
* `newValue` - 변경후 값이 전달된다.
*
* `oldValue` - 변경전 값이 전달된다.
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onLayoutPropertyChanged = function (grid, layout, property, newValue, oldValue) {
*
* console.log(layout + "s props werer changed!");
* }
* ```
*/
onLayoutPropertyChanged?: (grid: GridBase, layout: CellLayoutItem, property: string, newValue: any, oldValue: any) => void;
/**
* 그리드가 선택되었음을 알리는 콜백
*
* @remarks
* grid를 전역변수에 저장해서 사용하는 것이 좋다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onGridActivated = function (grid) {
* alert('Selected!');
* }
* ```
*/
onGridActivated?: (grid: GridBase) => void;
/**
* 그리드가 focus를 가지거나 잃었음을 알리는 콜백
*
* [매개변수 목록]
* `grid` - GridBase 컨트롤
* `focused` - focus 여부
* `event` - event객체
*/
onGridFocusChanged?: (grid: GridBase, focused: boolean, event: Event) => void;
/**
* control + c 키로 복사하기를 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `selection` - 선택 영역 정보
*
* `event` - 이벤트 정보 ({@link https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent| ClipboardEvent})
*
* [반환값] - `false`를 반환하면 복사하기가 취소된다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCopy = function(grid, selection, event) {
* let data = JSON.stringify(grid.getSelectionData());
* if (data) {
* data = 'onCopy\r\n' + data;
* if (window.clipboardData) {
* window.clipboardData.setData("Text", data);
* } else {
* event.clipboardData.setData('text/plain', data);
* }
* }
* return false;
* }
* ```
*/
onCopy?: (grid: GridBase, selection: Selection | Selection[], event: ClipboardEvent) => boolean;
/**
* control + x 키로 잘라내기를 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `selection` - 선택 영역 정보
*
* `event` - 이벤트 정보 ({@link https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent| ClipboardEvent})
*
* [반환값] - `false`를 반환하면 잘라내기가 취소된다.
* @defaultValue `null`
* @eventProperty
*/
onCut?: (grid: GridBase, selection: Selection | Selection[], event: ClipboardEvent) => boolean;
/**
* 그리드에 붙여넣기를 결정하는 콜백
*
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 셀 위치정보
*
* `event` - 이벤트 정보 ({@link https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent| ClipboardEvent})
*
* [반환값] - `false`를 반환하면 붙여넣기가 취소된다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onPaste = function (grid, index, event){
* console.log("Pasting Starts!");
* }
* ```
*/
onPaste?: (grid: GridBase, index: CellIndex, event: ClipboardEvent) => boolean;
/**
* 그리드에 붙여넣기 했음을 알리는 콜백
*
* @remarks
* 입력 편집기가 표시된 상태에서는 발생하지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onPasted = function (grid){
* console.log("Pasted!");
* }
* ```
*/
onPasted?: (grid: GridBase) => void;
/**
* 사용자가 checkBar의 체크박스를 클릭하거나 checkItem을 호출하여 체크를 변경했음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `items` - 체크된 데이터 행의 순서
*
* `checked` - `true`: 체크, `false`: 해제
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onItemsChecked = function (grid, items, checked){
* console.log(items.join() + ' are checked as ' + checked);
* }
* ```
*/
onItemsChecked?: (grid: GridBase, items: number[], checked: boolean) => void;
/**
* 그리드 셀이 클릭되었음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `clickData` - 클릭된 셀 정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCellClicked = function (grid, clickData) {
* console.log(clickData);
* }
* ```
*/
onCellClicked?: (grid: GridBase, clickData: ClickData) => void;
/**
* 그리드 셀이 더블 클릭되었음을 알리는 콜백
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `clickData` - 클릭된 셀 정보
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCellDblClicked = function (grid, clickData) {
* console.log(clickData);
* }
* ```
*/
onCellDblClicked?: (grid: GridBase, clickData: ClickData) => void;
/**
* 그리드 셀에 포함된 엘리먼트가 클릭되었음을 알리는 콜백
*
* @remarks
* 이 이벤트 내에서 클릭을 처리했다면 반드시 `false`를 리턴해야 element의 기본 동작을 실행하지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `index` - 클릭된 데이터 셀의 위치정보
*
* `clickData` - 클릭된 셀 정보
*
* @defaultValue `null`
* @eventProperty
* @example
* ```js
* gridView.onCellItemClicked = function (grid, index, clickData) {
* console.log(clickData);
* return true;
* }
* ```
*/
onCellItemClicked?: (grid: GridBase, index: CellIndex, clickData: ClickData) => boolean;
/**
* CommandStack이 바뀌었음을 알리는 콜백
*
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `undoable` - 뒤로
*
* `redoable` - 앞으로
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCommandStackChanged = function (grid, undoable, redoable) {
* if (undoable === true) {
* console.log('You can undo now!');
* }
* };
* ```
*/
onCommandStackChanged?: (grid: GridBase, undoable: boolean, redoable: boolean) => void;
/**
* dataProvider.setRows()를 실행한 이후 그리드 refresh가 완료된 후 발생하는 콜백
*
* @remarks
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onDataLoadComplated = function (grid) {
* console.log("Grid DataLoadComplated")
* };
* ```
*/
onDataLoadComplated?: (grid: GridBase) => void;
/**
* 그룹 Layout 펼치기를 결정하는 콜백
*
* @remarks
* `false`를 return 하면 펼치기가 취소된다.
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `layout` - 펼칠 그룹 layout
*
* @defaultValue `null`
* @eventProperty
*
* @example
*
* ```js
* gridView.onLayoutExpanding = function(grid, layout) {
* if (layout.name === "group0") {
* return false;
* }
* }
* ```
*/
onLayoutExpanding?: (grid: GridBase, layout: CellLayoutGroupItem) => boolean;
/**
* 그룹 Layout이 펼쳐졌음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
* `grid` - GridBase 컨트롤
*
* `layout` - 펼칠 그룹 layout
*
* @defaultValue `null`
* @eventProperty
*
* @example
*
* ```js
* gridView.onLayoutExpanded = function(grid, layout) {
* console.log("Layout Expanded => " + layout.name)
* }
* ```
*/
onLayoutExpanded?: (grid: GridBase, layout: CellLayoutGroupItem) => void;
/**
* 그룹 Layout 접기를 결정하는 콜백
*
* @remarks
* `false`를 return 하면 접기가 취소된다.
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `layout` - 접는 그룹 layout
*
* @defaultValue `null`
* @eventProperty
*
* @example
*
* ```js
* gridView.onLayoutCollapsing = function(grid, layout) {
* if (layout.name === "group0") {
* return false;
* }
* }
* ```
*/
onLayoutCollapsing?: (grid: GridBase, layout: CellLayoutGroupItem) => boolean;
/**
* 그룹 Layout이 접혔음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
* `grid` - GridBase 컨트롤
*
* `layout` - 접힌 그룹 layout
*
* @defaultValue `null`
* @eventProperty
*
* @example
*
* ```js
* gridView.onLayoutCollapsed = function(grid, layout) {
* console.log("Layout Collapsed => " + layout.name)
* }
* ```
*/
onLayoutCollapsed?: (grid: GridBase, layout: CellLayoutGroupItem) => void;
/**
* alert 창에 입력된 메시지를 표시한다.
*
* @param message - 입력된 메세지
* @example
*
* ```
* gridView.ping("테스트");
* ```
*/
ping(message: any): void;
/**
* 그리드를 내부적으로 새로 그린다.
*
* @example
* ```
* gridView.refresh()
* ```
*/
refresh(force?: boolean): void;
/**
* 그리드와 관련된 속성들이 변경될 때마다 update lock 을 걸어 내부적인 변경 처리 호출을 지연시킨다.
*
* @remarks
* {@link GridBase.endUpdate | endUpdate()} 와 같이 사용한다.
*
* @example
*
* ```js
* gridview.beginUpdate();
* try {
* gridview.displayOptions( { ... });
* gridview.selectOptions( { ... });
* ...
* } finally {
* gridview.endUpdate();
* }
* ```
*/
beginUpdate(): void;
/**
* update lock 을 풀고 그리드를 다시 그린다.
*
* @remarks
* {@link GridBase.beginUpdate | beginUpdate()} 와 같이 사용한다.
*
* @param force - beginUpdate() 의 호출 여부에 상관없이 그리드를 다시 그린다.
*
* @example
* {@link GridBase.beginUpdate | beginUpdate()} 참조
*/
endUpdate(force: boolean): void;
/**
* 그리드가 표시된 상태면 `true` 를 반환한다.
*
* @example
* ```js
* let visible = gridView.isVisible();
* ```
*/
isVisible(): boolean;
/**
* 그리드를 표시하거나 감춘다.
*
* @param value - `true`: 그리드 표시, `false`: 그리드 감추기
*
* @example
* ```js
* gridView.setVisible(false);
* ```
*/
setVisible(value: boolean): void;
/**
* 그리드에 현재 표시된 Grid Item 개수를 반환한다.
*
* @remarks
* rowGroup의 header, footer가 있는 경우 itemCount에 포함된다.
*
* @example
* ```js
* let count = gridView.getItemCount();
* ```
*/
getItemCount(): number;
/**
* 지정한 그리드 행의 고유 번호를 반환한다.
*
* @param itemIndex - 행의 순서
*
* @example
* ```js
* let row = gridView.getDataRow(0);
* ```
*/
getDataRow(itemIndex: number): number;
/**
* 지정한 그리드 행들의 고유 번호들을 반환한다.
*
* @param items - 행의 순서의 배열
*
* @example
* ```js
* let rows = gridView.getRowsOfItems([0, 2, 4, 6]);
* ```
*/
getRowsOfItems(items: number[]): number[];
/**
* 행의 고유 번호로 행의 순서를 반환한다.
*
* @param dataRow - 행의 고유 번호
*
* ```
* let answerRow = gridView.getItemIndex(42);
* ```
*/
getItemIndex(dataRow: number): number;
/**
* 입력된 데이터 행들의 고유번호들로 행들의 순서들을 반환한다.
*
* @param rows - 행의 고유 번호의 배열
*
* @example
* let harshadRows = getItemsOfRows([10, 12, 18, 142857]);
*
*/
getItemsOfRows(rows: number[]): number[];
/**
* 그리드의 칼럼위치를 최초상태로 되돌린다.
*
* @example
* ```js
* gridView.restoreColumns();
* ```
*
*/
restoreColumns(): void;
/**
* 그리드에 연결되어 있는 DataProvider를 반환한다.
* @example
* ```js
* let ds = gridView.getDataSource();
* ```
*/
getDataSource(): LocalDataProvider | LocalTreeDataProvider;
/**
* 그리드에 Data Provider를 연결한다.
*
* @param dataProvider - DataProvider 객체.
*
* @example
* ```js
* let dataProvider = new RealGrid.LocalDataProvider();
* gridView = new RealGrid.GridView("realgrid");
* gridView.setDataSource(dataProvider);
* ```
*/
setDataSource(dataProvider: LocalDataProvider | LocalTreeDataProvider): void;
/**
* 그리드 옵션 정보를 반환한다.
*
* @remarks
* {@link GridOptions} 의 모델로 반환한다.
*
* @returns - {@link GridBase.setOptions | setOptions} 와 다르게 그리드 수준의 정보만을 반환한다.
*
* @example
* ```js
* let options = gridView.getOptions();
* ```
*/
getOptions(): GridOptions;
/**
* 그리드 옵션 정보를 재설정한다.
*
* @remarks
* 그리드 수준의 정보만을 반환하는 {@link GridBase.getOptions | getOptions } 와 달리 이 method를 통해 하위 구성 요소 및 다른 실행 정보들을 동시에 재설정할 수 있다.
* {@link GridOptions} 의 모델로 설정한다.
*
* @param options - 설정 정보
* @example
* ```js
* let options = {
* summaryMode: 'aggregate',
* displayOptions: {
* columnResizable : false
* }
* };
* gridView.setOptions(options);
* ```
*/
setOptions(options: GridOptions): void;
/**
* 그리드 고정 영역에 관한 설정 정보들을 {@link FixedOptions} 의 모델로 반환한다.
*
* @example
* ```js
* let fixed = gridView.getFixedOptions();
* fixed.colCount = 1;
* gridView.setFixedOptions(fixed);
* ```
*/
getFixedOptions(): FixedOptions;
/**
* 그리드 고정 영역에 관한 정보를 {@link FixedOptions} 의 모델로 설정한다.
*
* @param options - {@link FixedOptions} 모델과 같은 설정 정보. 변경하고자 하는 값들만 전달하면 된다.
* @example
*
* ```js
* gridView.setFixedOptions({colCount: 2});
* ```
*/
setFixedOptions(options: FixedOptions): void;
/**
* 그리드 표시와 관련된 설정 정보들을 {@link DisplayOptions} 의 모델로 반환한다.
*
* @example
* ```js
* let display = gridView.getDisplayOptions();
* display.rowHeight = 20;
* gridView.setDisplayOptions(display);
* ```
*/
getDisplayOptions(): DisplayOptions;
/**
* 그리드 표시 정보를 {@link DisplayOptions} 모델로 설정한다.
*
* @param options - {@link DisplayOptions} 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
* ```js
* gridView.setDisplayOptions({rowResizable: true});
* ```
*/
setDisplayOptions(options: DisplayOptions): void;
/**
* 그리드의 {@link FormatOptions} 를 반환한다.
*
* @example
* ```js
* let format = gridView.getFormatOptions();
* format.booleanFormat = 'X:O';
* gridView.setFormatOptions(format);
* ```
*/
getFormatOptions(): FormatOptions;
/**
* 그리드의 {@link FormatOptions} 를 설정한다.
*
*
* @param options - {@link FormatOptions} 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
* ```js
* gridView.setFormatOptions({booleanFormat: 'wrong:correct'});
* ```
*/
setFormatOptions(options: FormatOptions): void;
/**
* 그리드 편집 방식과 관련된 정보들을 {@link EditOptions} 모델로 반환한다.
* @example
* ```js
* let edit = gridView.getEditOptions();
* edit.editable = true;
* gridView.setEditOptions(edit);
* ```
*/
getEditOptions(): EditOptions;
/**
* 그리드 편집 방식과 관련된 정보들을 {@link EditOptions} 모델로 재설정한다.
*
* @param options - {@link EditOptions} 모델과 같은 설정 정보. 변경하고자 하는 값들만 전달하면 된다.
*
* @example
* ```js
* gridView.setEditOptions({editable: false});
* ```
*/
setEditOptions(options: EditOptions): void;
/**
* 편집기 표시 정보를 {@link EditorOptions} 모델로 반환한다.
* @example
* ```js
* let editor = gridView.getEditorOptions();
* editor.yearDisplayFormat = '{Y} year';
* gridView.setEditorOptions(editor);
* ```
*/
getEditorOptions(): EditorOptions;
/**
* 편집기 표시 정보를 {@link EditorOptions} 모델로 설정한다.
*
* @remarks
* 날자 편집기의 표시형태를 변경하는 경우 달력 팝업이 최초 실행(생성)되기 전에 먼저 설정되어야 한다(한번 실행되고난 후 중간에 변경할 수 없음).
*
* @param options - {@link EditorOptions} 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
*
* ```js
* gridView.setEditorOptions({yearDisplayFormat: "{Y} year"});
* ```
*/
setEditorOptions(options: EditorOptions): void;
/**
* ctrl+c 를 이용해서 그리드를 복사할때 적용되는 설정을 {@link CopyOptions} 모델로 반환한다.
*
* @example
* ```js
* let copy = gridView.getCopyOptions();
* copy.enabled = false;
* gridView.setCopyOptions(copy);
* ```
*/
getCopyOptions(): CopyOptions;
/**
* 복사 정보를 {@link CopyOptions} 모델로 설정한다.
*
* @param options - {@link CopyOptions} 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
* ```js
* gridView.setCopyOptions({enabled: false});
* ```
*/
setCopyOptions(options: CopyOptions): void;
/**
* 그리드에 붙여넣기를 할때 적용되는 설정을 {@link PasteOptions} 모델로 반환한다.
* @example
* ```js
* let paste = gridView.getPasteOptions();
* paste.enabled = false;
* gridView.setPasteOptions(paste);
* ```
*/
getPasteOptions(): PasteOptions;
/**
* 그리드에 {@link PasteOptions} 모델로 붙여넣기 정보를 설정한다.
*
* @param options - PasteOptions 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
*
* ```js
* gridView.setPasteOptions({enabled: false});
* ```
*/
setPasteOptions(options: PasteOptions): void;
/**
* 그리드 정렬과 관련된 설정 정보들을 {@link SortingOptions} 모델로 반환한다.
* @example
* ```js
* let sorting = gridView.getSortingOptions();
* sorting.enabled = false;
* gridView.setSortingOptions(sorting);
* ```
*/
getSortingOptions(): SortingOptions;
/**
* 그리드 정렬과 관련된 정보들을 {@link SortingOptions} 모델로 설정한다.
*
* @remarks
* {@link ToastOptions} 는 속성으로 직접 접근해서 수정해야한다.
*
* @param options - {@link SortingOptions} 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
* ```js
* gridView.setSortingOptions({enabled: false});
* ```
*/
setSortingOptions(options: SortingOptions): void;
/**
* 그리드 필터링과 관련된 설정 정보들을 {@link FilteringOptions} 모델로 반환한다.
* @example
* ```js
* let filtering = gridView.getFiteringOptions();
* filtering.enabled = false;
* gridView.setFiteringOptions(filtering);
* ```
*/
getFilteringOptions(): FilteringOptions;
/**
* 그리드 필터링과 관련된 정보들을 {@link FilteringOptions} 모델로 설정한다.
*
* @remarks
* {@link FilterSelectorOptions}, {@link FilterAutomatingOptions}, {@link ToastOptions} 는 속성으로 직접 접근해서 수정해야한다.
*
* @param options - {@link FilteringOptions} 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
*
* ```js
* gridView.setFilteringOptions({enabled: false});
* ```
*/
setFilteringOptions(options: FilteringOptions): void;
/**
* 모바일과 관련된 설정 정보들을 {@link MobileOptions} 모델로 반환한다.
* @example
* ```js
* let mobile = gridView.getMobileOptions();
* mobile.longTabDuration = 400;
* gridView.setMobileOptions(mobile);
* ```
*/
getMobileOptions(): MobileOptions;
/**
* 모바일과 관련된 설정 정보들을 {@link MobileOptions} 모델로 설정한다.
*
* @param options - {@link MobileOptions} 모델과 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
*
* ```js
* gridView.setMobileOptions({longTapDuration: 300});
* ```
*/
setMobileOptions(options: MobileOptions): void;
/**
* 데이터 drag 앤 drop과 관련 된 설정 정보들을 {@link DataDropOptions} 모델로 반환한다.
*
* @example
* ```js
* let drop = gridView.getDataDropOptions();
* drop.dropMode = 'copy'
* gridView.setDataDropOptions(drop);
* ```
*/
getDataDropOptions(): DataDropOptions;
/**
* 데이터 drag 앤 drop과 관련 된 설정 정보들을 {@link DataDropOptions} 모델로 설정한다.
*
* @param options - {@link DataDropOptions} 와 같은 설정 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
* ```js
* gridView.setDataDropOptions({dropMode: 'copy'});
* ```
*/
setDataDropOptions(options: DataDropOptions): void;
/**
* 그리드 인디케이터와 관련된 설정 정보들을 {@link RowIndicator} 모델로 반환한다.
* @example
* ```js
* let indicator = gridView.getRowIndicator();
* indicator.zeroBase = true;
* gridView.setRowIndicator(indicator);
* ```
*/
getRowIndicator(): RowIndicator;
/**
* 그리드 인디케이터와 관련된 설정 정보들을 {@link RowIndicator} 모델로 설정한다.
*
* @param value - RowIndicator 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
*
* ```js
* gridView.setRowIndicator({zeroBase: true});
* ```
*/
setRowIndicator(value: RowIndicator): void;
/**
* 그리드 상태바의 설정 정보를 {@link StateBar} 의 모델로 반환한다.
* @example
* ```js
* let stateBar = gridView.getStateBar();
* stateBar.errorVisible = false;
* gridView.setStateBar(stateBar);
* ```
*/
getStateBar(): StateBar;
/**
* 그리드 상태바의 설정 정보를 {@link StateBar} 의 모델로 설정한다.
*
* @param value - {@link StateBar} 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* gridView.setStateBar({errorVisible: true});
* ```
*/
setStateBar(value: StateBar): void;
/**
* 그리드 체크바와 관련된 설정 정보를 {@link CheckBar} 의 모델로 반환한다.
* @example
* ```js
* let checkBar = gridView.getCheckBar();
* checkBar.exclusive = false;
* gridView.setStateBar(checkBar);
* ```
*/
getCheckBar(): CheckBar;
/**
* 그리드 체크바의 설정 정보를 {@link CheckBar} 의 모델로 설정한다.
*
* @param value - {@link CheckBar} 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* gridView.setCheckBar({exclusive: true});
* ```
*/
setCheckBar(value: CheckBar): void;
/**
* 그리드 헤더와 관련된 설정 정보들을 {@link GridHeader} 모델로 반환한다.
* @example
* ```js
* let header = gridView.getHeader();
* header.sortable = false;
* gridView.setHeader(header);
* ```
*/
getHeader(): GridHeader;
/**
* 그리드 헤더의 설정 정보를 {@link GridHeader} 모델로 설정한다.
*
* @param value - {@link GridHeader} 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* gridView.setHeader({sortable: false});
* ```
*/
setHeader(value: GridHeader): void;
/**
* 첫번째 그리드 푸터와 관련된 설정 정보를 {@link GridFooter} 모델로 반환한다.
* @example
* ```js
* let footer = gridView.getFooter();
* footer.visible = false;
* gridView.setFooter(footer);
* ```
*/
getFooter(): GridFooter;
/**
* 첫번째 그리드 푸터의 설정 정보를 {@link GridFooter} 모델로 설정한다.
*
* @param value - {@link GridFooter} 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* gridView.setFooter({className: 'custom-footer-1'});
* ```
*/
setFooter(value: GridFooter): void;
/**
* 그리드 푸터들의 설정 정보들을 {@link GridFooterCollection} 모델로 반환한다.
*
* @example
* ```js
* let footers = gridView.getFooters()
* footers[0].visible = false;
* gridView.setFooters(footers);
* ```
*/
getFooters(): GridFooterCollection;
/**
* 그리드 푸터들의 설정 정보들을 {@link GridFooter} 의 컬렉션 모델로 설정한다.
*
* @param value - GridFooterCollection 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
* ```js
* // object
* gridView.setFooters({
* visible: false;
* items: [
* {
* styleName: 'custom-footer-1';
* },
* {
* styleName: 'custom-footer-2';
* },
* ]
* });
*
* // array
* gridView.setFooters([
* {
* styleName: 'custom-footer-1';
* },
* {
* styleName: 'custom-footer-2';
* },
* ]);
* ```
*/
setFooters(value: GridFooterCollection | GridFooter[]): void;
/**
* 첫번째 그리드 header summary 와 관련된 설정 정보를 {@link HeaderSummary} 모델로 반환한다.
*
* @example
* ```js
* let headerSummary = gridView.getHeaderSummary();
* headerSummary.visible = false;
* gridView.setHeaderSummary(headerSummary);
* ```
*/
getHeaderSummary(): HeaderSummary;
/**
* 첫번째 그리드 header summary 의 설정 정보를 {@link HeaderSummary} 모델로 설정한다.
*
* @param value - {@link HeaderSummary} 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* gridView.setHeaderSummary({styleName: 'custom-hsummary-1'});
* ```
*/
setHeaderSummary(value: HeaderSummary): void;
/**
* 그리드 header summary 들의 설정 정보들을 {@link HeaderSummaryCollection} 모델로 반환한다.
*
* @example
* ```js
* let headerSummaries = gridView.getHeaderSummaries()
* headerSummaries[0].visible = false;
* gridView.setHeaderSummaries(headerSummaries);
* ```
*/
getHeaderSummaries(): HeaderSummaryCollection;
/**
* 그리드 header summary 들을 {@link HeaderSummaryCollection} 모델로 설정한다.
*
* @param value - {@link HeaderSummaryCollection} 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* // object
* gridView.setHeaderSummaries({
* visible: false;
* items: [
* {
* styleName: 'custom-hsumarry-1';
* },
* {
* styleName: 'custom-hsumarry-2';
* },
* ]
* });
*
* // array
* gridView.setFooters([
* {
* styleName: 'custom-hsumarry-1';
* },
* {
* styleName: 'custom-hsumarry-2';
* },
* ]);
* ```
*/
setHeaderSummaries(value: HeaderSummaryCollection | HeaderSummary[]): void;
/**
* 필터 판넬의 설정 정보를 {@link FilterPanel} 모델로 설정한다.
*
* @param value - {@link FilterPanel} 모델과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* gridView.setFilterPanel({height: 30, visible: true, filterDelay: 500});
* ```
*/
setFilterPanel(value: FilterPanel): void;
/**
* 셀 스타일을 변경한다.
*
* @remarks
* 컬럼 당 설정을 위해서는 {@link ValueColumn.styleCallback | 컬럼의 styleCallback} 을 사용해야 한다.
*
* {@link ColumnFooter | 푸터} 나 {@link ColumnHeaderSummary | header summary} 당 설정을 위해서는 해당 모델의 {@link ColumnSummary.styleCallback | styleCallback} 속성을 사용해야 한다.
*
* @param f - 셀 스타일을 특정하기 위한 콜백
*
* @example
* ```js
* const f = function (grid, cell) {
* return {
* styleName: 'custom-cell'
* editor: 'text'
* }
* }
* gridView.setCellStyleCallback(f);
* ```
*/
setCellStyleCallback(f: CellStyleCallback | undefined): void;
/**
* 행 스타일을 변경한다.
*
* @param f - 행 스타일을 특정하기 위한 콜백
*
* @example
* ```js
* const f = function(grid, item, fixed) {
* if (fixed) {
* return 'custom-fixed-row';
* }
* else {
* return 'custom-data-row';
* }
* }
* gridView.setRowStyleCallback(f)
* ```
*/
setRowStyleCallback(f?: RowStyleCallback): void;
/**
* 셀의 스타일을 지정한다.
*
* @remarks
* 셀의 스타일을 지정하기 위한 규칙을 만들수 없는 경우 스타일을 적용하기 위해 사용한다.
* column에 `-1`을 입력하면 행 전체에 적용된다.
*
*
* @param dataRow - 행의 고유번호
* @param column - 열의 이름
* @param style - string 또는 {@link ColumnStyleObject}
*/
addUserCellStyle(dataRow: number, column: string | -1, style: string | ColumnStyleObject): void;
/**
* addUserCellStyle로 지정한 스타일을 제거한다.
*
* @remarks
* `null`을 입력하면 셀과 행에 적용된 스타일을 모두 제거한다.
*
* @param dataRow - 행의 고유번호
* @param column - 열의 이름
*/
removeUserCellStyle(dataRow?: number | null, column?: string | -1 | null): void;
/**
* addUserCellStyle로 지정한 스타일을 가져온다.
*
* @param dataRow - 행의 고유번호
* @param column - 열의 이름
*/
getUserCellStyle(dataRow: number, column: string | -1): string | ColumnStyleObject;
/**
* 하나 이상의 데이터 필드를 기준으로 Grid Item들을 정렬한다.
*
* @remarks
*
* 정렬은 Item Model 수준에서 실행되고, Data Provider 행들의 실제 위치는 변경되지 않는다.
*
* @param fieldNames - 정렬한 필드 이름 목록
* @param sortDirs - 각 필드에 대한 정렬 방식 목록
* @param textCases - 대소문자 구분
*
* @example
* ```js
* gridView.orderBy(['fruit'], ['descending'], ['insensitive']);
*
* gridView.orderBy("fruit", "descending");
* ```
*/
orderBy(fieldNames?: string[] | string, sortDirs?: SortDirection[] | SortDirection, textCases?: SortCase[] | SortCase): void;
/**
* 현재 정렬되어 있는 필드들의 정렬 정보를 반환한다.
*
* @returns Sort 필드 정보 배열. 배열의 각 항목은 `direction`, `orgFieldName`, `fieldName` 의 정보를 가지고 있다.
*
* @example
* ```js
* let sFields = gridView.getSortedFields();
*
* console.log(sFields[0]);
* //{
* // fieldName: "COMPANYNAME"
* // orgFieldName: "CompanyName"
* // direction: "descending"
* //}
* ```
*/
getSortedFields(): SortedFields[];
/**
* 그리드가 focus된다.
*
* @example
* ```js
* gridView.setFocus();
* ```
*/
setFocus(): void;
/**
* 해당하는 index 번째의 컬럼을 반환한다.
*
* @param index - 그리드에서의 순서
*
* @example
* ```js
* let col = gridView.getColumn(0);
* ```
*/
getColumn(index: number): GridColumn;
/**
* 그리드에 설정된 컬럼들을 반환한다.
*
* @param vOnly - 기본값: `false`, 표시된 컬럼만 가져올 건지의 여부.
*
* @example
* ```js
* let cols = gridView.getColumns();
* ```
*/
getColumns(): GridColumn[];
/**
* 기존에 설정된 컬럼들을 모두 제거하고 새로운 컬럼들로 그리드를 재구성한다.
*
* @param columns - {@link GridColumn | GridColumn} 과 같은 오브젝트의 컬럼 설정 정보 배열
*
* @example
* ```js
* let cols = [{
* "name": "EmployeeID",
* "fieldName": "EmployeeID",
* "type": "data",
* "width": "90",
* "header": {
* "text": "Employee ID"
* }
* }, {
* "name": "OrderDate",
* "fieldName": "OrderDate",
* "type": "data",
* "width": "130",
* "header": {
* "text": "Order Date"
* }
* }]
*
* gridView.setColumns(cols);
* ```
*/
setColumns(columns: (DataColumn | SeriesColumn | LiteralColumn | ConfigObject | string)[]): void;
/**
* 설정된 컬럼들 외에 추가로 컬럼을 설정한다.
*
* @param column - 추가할 컬럼 ({@link GridColumn | GridColumn} 과 같은 오브젝트)
* @param index - 해당 컬럼이 위치할 순서(숨김컬럼 포함). 값을 지정하지 않으면 컬럼의 가장 마지막에 추가된다.
*
* @example
* ```js
*let col = {
* "name": "EmployeeID",
* "fieldName": "EmployeeID",
* "type": "data",
* "width": "90",
* "header": {
* "text": "Employee ID"
* }
* }
*
* gridView.addColumn(col);
* ```
*/
addColumn(column: ConfigObject | string, index?: number): GridColumn;
/**
* 해당 컬럼을 제거한다.
*
* @param column - 제거할 컬럼 이름
*
* @example
* ```js
* gridView.removeColumn('KorName');
* ```
*
*/
removeColumn(name: string): boolean;
/**
* Layout에 컬럼 또는 group을 추가한다.
*
* @remarks
*
* layout이 설정되지 않은 경우 사용할수 없다. gridView.setColumnLayout을 이용해서 layout상태로 변경한후 사용해야 한다.
*
* @param source - 추가할 컬럼명 또는 layout정보
* @param index - 삽입될 위치
* @returns 추가된 layout 정보
*
* @example
* ```js
* 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]});
* ```
*/
addLayout(source: LayoutItem | string, index?: number): LayoutItem;
/**
* layout을 제거한다.
*
* layout이 설정되지 않은 경우 사용할수 없다. gridView.setColumnLayout을 이용해서 layout상태로 변경한후 사용해야 한다.
*
* @param layout - layout또는 layout의 이름
*
* @example
* ```js
* gridView.removeLayout("group0");
* gridView.removeLayout("column");
* ```
*/
removeLayout(layout: LayoutItem | string): void;
/**
* 컬럼명을 이용해서 컬럼의 layout설정정보를 찾아온다.
*
* @param column - 컬럼의 name
* @returns column의 layout설정정보
* @example
* ```js
* let layout = gridView.layoutByName("column");
* ```
*/
layoutByColumn(column: string): CellLayoutColumnItem;
/**
* layout의 이름을 이용해서 layout설정정보를 찾아온다.
*
* @param name - layout의 이름
* @returns 컬럼 또는 Group의 layout설정정보
* @example
* ```js
* let group = gridView.layoutByName("group");
* group.direction = "vertical"
* ```
*/
layoutByName(name: string): LayoutItem;
/**
* 그리드에 설정된 컬럼들을 반환한다.
*
* @param columnsOnly - 기본값: `false`, false면 반환 시 컬럼 그룹들을 포함
* @param visibleOnly - 기본값: `false`, false면 반환 시 숨긴 컬럼들을 포함
* @returns 컬럼 이름 배열
*
* @example
*
* ```js
* let onlyColsNames = gridView.getColumnNames(true, false);
* ```
*/
getColumnNames(columnsOnly?: boolean, visibleOnly?: boolean): string[];
/**
* 컬럼 이름으로 컬럼 설정 정보를 반환한다.
*
* @param name - 컬럼 이름
* @returns 컬럼이 존재하지 않는 경우 `null`
*
* @example
* ```js
* let col = gridView.columnByName('colName');
* ```
*/
columnByName(name: string): DataColumn;
/**
* 필드 이름으로 지정되는 데이터필드에 연결되어 있는 첫 번째 컬럼 정보를 반환한다.
*
* @param fieldName - 필드이름
* @returns 컬럼 설정 정보나 컬럼이 존재하지 않는 경우 `null`
*
* @example
* ```js
* let col = gridView.columnByField('fieldName');
* ```
*/
columnByField(fieldName: string): DataColumn;
/**
* 입력된 tag값을 가지는 컬럼을 가져온다.
*
* @remarks
* 같은 tag를 갖는 컬럼이 하나 이상 존재하면 그 중 첫번째 컬럼을 반환한다.
* 해당하는 컬럼이 존재하지 않으면 null을 반환한다.
*
* @param tag - 컬럼에 지정한 tag
* @returns 컬럼 설정 정보나 컬럼이 존재하지 않는 경우 `null`
*
* @example
* ```js
* let col = gridView.columnByTag('tag');
* ```
*/
columnByTag(tag: any): GridColumn;
/**
* 입력된 tag값을 가지는 컬럼들을 배열로 가져온다.
*
* @param tag - 컬럼에 지정한 tag
* @returns 컬럼 배열, 입력된 tag를 가지는 컬럼이 존재하지 않는 경우 `null`
*
* @example
* ```js
* let cols = gridVeiw.columnsByTag('tag');
* ```
*/
columnsByTag(tag: any): GridColumn[];
/**
* 해당 컬럼의 속성을 반환한다.
*
* @param column - 컬럼의 이름 또는 컬럼 객체
* @param prop - 속성 이름
* @returns `prop`에 입력된 속성명의 값이다.
*
* @example
* ```js
* let colRenderer = getColumnProperty('colName', 'renderer');
* ```
*/
getColumnProperty(column: string | GridColumn, prop: string): any;
/**
* 그리드에 설정된 컬럼의 특정 속성 정보를 변경한다.
*
* @remarks
* editor 속성 안에 있는 속성을 변경하려는 경우 editor 전체를 다시 지정해야 한다.
*
* `values`, `labels`를 변경하는 경우 {@link GridBase.setColumnProperty | setColumnProperty()} 로 변경할 수 없으며 {@link GridBase.setColumn | setColumn()} 으로 컬럼을 재지정해야 한다.
*
* @param column - 컬럼의 이름 또는 컬럼 객체
* @param prop - 속성 이름
* @param value - 변경 값
*
* @example
* ```js
* gridView.setColumnProperty('colName', 'editor', {
* type: 'text'
* });
* ```
*/
setColumnProperty(column: string | GridColumn, prop: string, value: any): void;
/**
* 그리드에 설정된 컬럼의 정보를 변경한다.
*
* @remarks
* 컬럼 정보를 재설정하기 위해서는 먼저 {@link GridBase.columnByName | columnByName} 등으로 먼저 기존 설정 정보를 가져와야 한다.
*
* @param value - 변경할 정보. 컬럼의 이름 또는 {@link GridColumn} 과 같은 모델의 오브젝트.
*
* @example
* ```js
* let col = {
* name: 'existed column'
* }
* col.editor = {
* type: 'text'
* }
* gridView.setColumn(col);
* ```
*/
setColumn(value: ConfigObject): void;
/**
* 현재 보여지고 있는 컬럼들을 반환한다.
*
* @example
* ```js
* let displayCols = gridView.getDisplayColumns();
* ```
*/
getDisplayColumns(): GridColumn[];
/**
* 그리드의 컬럼 레이아웃을 설정한다.
*
* @remarks
* `string` 으로 입력할 경우 미리 등록되어 있는 레이아웃으로 설정한다.
*
* @param layout - 변경할 레이아웃 정보
*
* @example
* ```js
* layout = [{
* "OrderID",
* {
* name: "companyGroup",
* items: [
* "Country",
* 50,
* 50,
* {
* column: "CompanyName",
* cellSpan: 2
* },
* 50,
* 50
* ],
* header: {
* text: "Company Group",
* visible: true
* }
* }
* }
* ];
* gridView.setColumnLayout(layout)
* ```
*/
setColumnLayout(layout?: string | (string | LayoutItem)[]): void;
/** @deprecated */
/**
* 해당 컬럼의 레이아웃 정보를 반환한다.
* @param column - 정보를 얻고자 하는 컬럼의 이름 또는 컬럼 오브젝트
*
* @returns - {@link CellLayoutColumnItem} 오브젝트
*
* @example
*
* ```js
* let layout = gridView.getLayoutByColumn('OrderID');
* ```
*/
getLayoutByColumn(column: string | GridColumn): CellLayoutColumnItem;
/**
* 현재 화면의 레이아웃 정보를 반환한다.
*
* @example
* ```js
* let layouts = gridView.saveColumnLayout();
* ```
*/
saveColumnLayout(): LayoutInfo[];
/**
* 컬럼 그룹들을 모두 제거하고 데이터 값을 표시하는 컬럼들만 일렬로 배치한다.
*
* @param sortProp - 컬럼 순서 정렬을 지정하기 위한 정보
*
* @example
* ```js
* gridView.linearizeColumns();
* ```
*/
linearizeColumns(sortProps?: string[]): void;
/**
* 컬럼 레이아웃들을 미리 등록한다.
*
* @remarks
* 등록한 layout은 {@link GridBase.setColumnLayout}을 이용해서 그리드에 적용한다.
*
* @param layouts - 컬럼 레이아웃 배열
*
* @example
* ```js
* let layouts =
* [{ "name": "layout1", // 등록하려는 layout정보의 이름.
* "items": ["text1", "text2"] // 컬럼 또는 그룹의 설정 정보
* },
* { "name": "layout2",
* "items": [{
* name: "group1", // CellLayoutGroupItem의 이름.
* type: "group",
* items:[...]}]
* }
* ...
* ];
* ```
*/
registerColumnLayouts(layouts: {
name: string;
items: (string | LayoutItem)[];
}[]): void;
/**
* 셀의 너비를 글자 길이에 맞게 변경한다.
*
* @remarks
* GroupLayout의 하위 그룹이 있는 경우 자동으로 변경할수 없다.
* grid.displayOptions.refreshMode 가 "visibleOnly"인 경우 화면에 표시되지 않는 컬럼의 너비는 조정되지 않는다.
*
* @param layout - layout이름 또는 column
* @param maxWidth - 최대 너비
* @param minWidth - 최소 너비
* @param includeHeaderText - header text 포함여부 defalut `true`
*
* @example
* ```js
* gridView.fitLayoutWidth('layout1')
* ```
*/
fitLayoutWidth(layout?: string | LayoutItem, maxWidth?: number, minWidth?: number, includeHeaderText?: boolean, includeFooterText?: boolean): number;
/**
* 행 높이를 지정한 높이로 변경한다.
*
*
* @param itemIndex - 높이 변경할 행의 순서
* @param height - 기본값: `0`, 행 높이. `0`으로 지정시 {@link DisplayOptions | displayOptions}.minRowHeight, maxRowHeight 에 맞게 행 높이가 변경된다.
* @param refresh - 기본값: `true`, 변경한 행 높이를 바로 화면에 반영할 것인지의 여부
*
* @example
* ```js
* gridView.setRowHeight(2, 40);
* ```
*/
setRowHeight(itemIndex: number, height?: number, refresh?: boolean): void;
/**
* 행 높이를 반환한다.
*
* @param itemIndex - 높이를 반환할 행의 인덱스
* @example
* ```js
* gridView.getRowHeight(2);
* ```
*/
getRowHeight(itemIndex: number): number;
/**
* 변경 적용한 개별 행 높이를 초기값으로 되돌린다.
*
* @param all - `true`: 전부, `false`: `setRowHeight()` 로 바꾼것만 미포함
* @example
* ```js
* gridView.clearRowHeights(true);
* ```
*/
clearRowHeights(all: boolean): void;
/**
* 현재 focus 된 셀의 위치정보를 반환한다.
*
* @example
* ```js
* console.log(JSON.stringify(grid.getCurrent()));
* ```
*/
getCurrent(): CellIndex;
/**
* focus cell 의 위치를 지정한다.
*
* @remarks
* 행의 경우 itemIndex, dataRow 중 하나 지정할 수 있고, 컬럼의 경우 column(컬럼명), fieldIndex, fieldName 중 하나로 지정할 수 있다.
*
* 단, 중복 적용될 경우 뒤부터 순서대로 우선 적용된다.
*
* @param current - 셀 위치정보
* @param select - 선택 영역 초기화 여부
*
* @example
*
* ```js
* gridView.setCurrent({ itemIndex: 1, column: '행정구역별' });
* ```
*/
setCurrent(current: CellIndex, select?: boolean): void;
/**
* focus cell 의 위치를 첫번째 행, 첫번째 열로 초기화한다.
*
* @example
* ```js
* gridView.resetCurrent();
* ```
*/
resetCurrent(): void;
/**
* focus를 제거한다.
*
* @example
* ```js
* gridView.clearCurrent();
* ```
*/
clearCurrent(): void;
/**
* (x, y) 좌표에 해당하는 셀의 위치정보를 반환한다.
*
* @remarks
* 그리드 생성시 입력한 `div`요소의 top-left를 `0`으로 계산한다.
* `coordinateByBody`를 `true`로 입력하면 body의 top-left를 `0`으로 계산한다.
*
* @param x - x 좌표
* @param y - y 좌표
* @param coordianteByBody - body의 top-left를 기준으로 좌표를 전달하는 경우 `true`로 설정한다.
* @returns 셀 위치정보, {@link CellIndex} 또는 존재하지 않을 경우 `null` 을 반환한다.
*
* @example
* ```js
* console.log(gridView.mouseToIndex(10, 10));
* ```
*/
mouseToIndex(x: number, y: number, coordianteByBody?: boolean): ConfigObject;
/**
* 그리드에서 지정한 셀의 좌표값을 반환한다.
*
* @param itemIndex - 행의 순서
* @param column - 컬럼 이름이나 컬럼 객체
* @param outer - `false`이면 그리드 container를 기준으로하는 좌표값을 반환한다.
* @returns 좌표값, 보이지 않는 영역에 있을 경우 `null` 을 반환한다.
*
* @example
* ```js
* let bounds = gridView.getCellBounds(3, '행정구역별');
*
* // {x, y, width, height} 반환
* ```
*/
getCellBounds(itemIndex: number, column: string | GridColumn, outer?: boolean): Rectangle;
/**
* HTMLElemnt가 속한 셀의 위치정보를 반환한다.
*
* @remarks
* customRenderer에서 사용자가 생성한 element가 속해있는 셀의 index를 찾기위해 사용.
*
* @param element - HTMLElement
* @returns element가 속한 Cell의 index
*/
getIndexOfElement(element: HTMLElement): CellIndex;
/**
* 셀의 편집가능 여부를 반환한다.
*
* @param itemIndex - 정보를 가져올 행의 순서
* @param column - 컬럼의 이름 또는 컬럼 객체
* @returns 셀의 편집가능 여부
*/
getWritable(itemIndex: number, column: string): boolean;
/**
* 그리드 컬럼에 필터를 설정한다.
*
* @remarks
* 사용가능한 Operator와 variables는 Expression 참조
*
* @param column - 설정 될 컬럼의 이름 또는 컬럼 객체
* @param filters - 필터 객체의 배열, {@link ColumnFilter} 의 배열
*
* @example
* ```js
* let filters = [{
* name: "전",
* criteria: "value = '전'"
* }, {
* name: "답",
* criteria: "value = '답'"
* }, {
* name: "'임야' or '공장용지'",
* criteria: "(value = '임야') or (value = '공장용지')"
* }, {
* name: "대지: value > '대지'",
* criteria: "value > '대지'"
* }];
*
* gridView.setColumnFilters('지목', filters);
* ```
*/
setColumnFilters(column: string | DataColumn, filters: ColumnFilter[]): void;
/**
* 컬럼에 등록된 필터들을 제거한다.
* column.autoFilter가 true인 경우 적용되지 않는다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
*
* @example
* ```js
* gridView.clearColumnFilters();
* ```
*/
clearColumnFilters(column: string | DataColumn): void;
/**
* 컬럼에 하나 이상의 필터를 등록한다.
* column.autoFilter가 true인 경우 적용되지 않는다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param filters - 등록할 필터 객체의 배열, {@link ColumnFilter} 의 배열
* @param overwrite - 기본값: `false`, overwrite가 `false` 시 중복된 이름의 필터가 있을 경우 에러를 발생시킨다.
*
* @example
*
* ```js
* gridView.addColumnFilters('행정구역별', [{
* name: "전",
* criteria: "value = '전'"
* }, {
* name: "답",
* criteria: "value = '답'"
* }])
* ```
*
*/
addColumnFilters(column: string | DataColumn, filters: ColumnFilter[], overwrite?: boolean): void;
/**
* 컬럼에 등록되어 있는 필터들 중 `filterNames`에 포함된 필터명을 갖는 필터들을 제거한다.
* column.autoFilter가 true인 경우 적용되지 않는다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param filterNames - 제거할 필터의 이름 또는 필터들의 이름의 배열
*
* @example
*
* ```js
* gridView.removeColumnFilters('행정구역별', ['전']);
* ```
*/
removeColumnFilters(column: string | DataColumn, filterNames: string | string[]): void;
/**
* 컬럼에 등록된 필터들 중, `filterNames` 에 포함된 필터명을 갖는 필터들을 적용시키거나 해제한다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param filterNames - 적용 또는 해제할 필터의 이름 혹은 필터들의 이름의 배열
* @param active - `true`: 적용, `false`: 해제.
*
* @example
*
* ```js
* gridView.activateColumnFilters('행정구역별', ['전'], true);
* ```
*
*/
activateColumnFilters(column: string | DataColumn, filterNames: string | string[], active: boolean): void;
/**
* 컬럼에 등록된 모든 필터들을 적용 또는 해제한다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param active - `true`: 적용, `false`: 해제.
*
* @example
*
* ```js
* gridView.activateAllColumnFilters('행정구역별', true);
* ```
*/
activateAllColumnFilters(column: string | DataColumn, active: boolean): void;
/**
* 그리드의 모든 컬럼에 등록된 필터들을 해제한다.
*
* @example
*
* ```js
* gridView.resetFilters();
* ```
*/
resetFilters(): void;
/**
* 컬럼에 등록된 필터들 중, `filterNames` 에 포함된 필터명을 갖는 필터들을 숨기거나 표시한다.
* column.autoFilter가 true인 경우 적용되지 않는다.
*
* @remarks
* 활성화 된 필터를 숨기는 경우 활성화 된 상태로 숨긴다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param filterNames - 필터의 이름 혹은 필터들의 이름의 배열
* @param hide - 기본값: `true`, `true`: 숨김, `false`: 보여줌.
*
* @example
*
* ```js
* gridView.hideColumnFilters('행정구역별', ['전']);
* ```
*/
hideColumnFilters(column: string | DataColumn, filterNames: string | string[], hide?: boolean): void;
/**
* 컬럼에 등록된 모든 필터를 숨기거나 보여준다.
* column.autoFilter가 true인 경우 적용되지 않는다.
*
* @remarks
* 활성화 된 필터를 숨기는 경우 활성화 된 상태로 숨긴다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param hide - 기본값: `true`, `true`: 숨김, `false`: 보여줌.
*
* @example
* ```js
* gridView.hideAllColumnFilters('행정구역별');
* ```
*/
hideAllColumnFilters(column: string | DataColumn, hide?: boolean): void;
/**
* 해당 컬럼의 지정한 필터들을 토글한다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param filterNames - 토글할 필터의 이름 혹은 필터들의 이름의 배열
*
* @example
*
* ```js
* gridView.toggleColumnFilters('행정구역별', ['전', '답']);
* ```
*/
toggleColumnFilters(column: string | DataColumn, filterNames: string | string[]): void;
/**
* 해당 컬럼의 지정한 모든 필터들을 토글한다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
*
* @example
*
* ```js
* gridView.toggleAllColumnFilters('행정구역별', ['전']);
* ```
*/
toggleAllColumnFilters(column: string | DataColumn): void;
/**
* 지정한 컬럼에서 필터 이름에 해당하는 필터를 반환한다.
*
* @param column - 지정한 컬럼의 이름 또는 컬럼 객체
* @param filterName - 필터 이름
* @returns - {@link ColumnFilter} 와 같은 모델의 필터 오브젝트
*
* @example
*
* ```js
* gridView.getColumnFilter('행정구역별', ['전']);
* ```
*/
getColumnFilter(column: string | DataColumn, filterName: string): ColumnFilter;
/**
* 지정한 컬럼에서 필터들을 반환한다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @returns - {@link ColumnFilter} 와 같은 모델의 필터 오브젝트의 배열
*
* @example
*
* ```js
* gridView.getColumnFilters('행정구역별');
* ```
*/
getColumnFilters(column: string | DataColumn): ColumnFilter[];
/**
* 등록된 필터들 중 적용된 필터 또는 해제된 필터의 이름을 반환한다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @param active - 기본값: true, `true`: 활성화 된 필터 반환, `false`: 해제된 필터 반환
* @returns 활성화 상태에 해당하는 {@link ColumnFilter} 와 같은 모델의 필터 오브젝트의 배열
*
* @example
* ```js
* gridView.getActiveColumnFilters('행정구역별');
* ```
*/
getActiveColumnFilters(column: string | DataColumn, active?: boolean): ColumnFilter[];
/**
* 그리드의 특정 컬럼이 필터링 되어 있는지 여부를 반환한다.
*
* @remarks
*
* 컬럼을 생략하면 필터링이 되어있는 컬럼이 있으면 `true`를 return하고 없으면 `false`를 return한다.
*
* @param column - 해당하는 컬럼의 이름 또는 컬럼 객체
* @returns 필터링 여부
*
* @example
* ```js
* gridView.isFiltered('행정구역별');
* //
* gridView.isFiltered();
* ```
*/
isFiltered(column?: string | DataColumn): boolean;
/**
* column.autoFilter가 true인경우 filter목록을 갱신한다.
*
* @param columns - 컬럼이름 또는 컬럼 객체의 배열. 입력하지 않는 경우 전체 컬럼.
* @param applyFilters - active된 filter의 적용 여부.
*
* @remarks
* autoFilter의 목록을 갱신할때 호출한다.
* 또는 사용자가 filter 아이콘을 클릭하면 자동으로 갱신된다.
*/
autoFiltersRefresh(columns: string[] | DataColumn[], applyFilters: boolean): void;
/**
* filter Selector를 표시한다.
*
* @remarks
* column에 filter가 없는 경우에는 표시하지 않는다.
*
* @param column - filter Selector 가 표시 될 컬럼 객체 또는 컬럼명
* @param searchText - 검색하려는 문자열을 입력
* @returns filter Selector표시 여부
*/
showFilterSelector(column: string, searchText?: string): boolean;
/**
* filter panel에 있는 input에 포커스가 된다.
*
* @param column - inline filter에 포커스를 줄 컬럼명
*
* @example
* ```js
* gridView.inlineFilterFocus("KorName");
* ```
*/
inlineFilterFocus(column: string): void;
/**
* 지정한 행의 데이터 값들을 JSON객체로 반환한다.
*
* @remarks
* itemIndex와 연결된 행의 고유번호는 반환되는 객체의 __rowId에 담겨있다.
*
* @param itemIndex - 정보를 가져올 행의 순서
* @returns 입력된 `itemIndex`가 행의 고유 번호와 연결된 행이 아닌경우 `null`이 출력된다.
*
* @example
* ```js
* gridView.getValues('3');
* ```
*/
getValues(itemIndex: number): object;
/**
* 지정한 행의 데이터 값들을 각종 포맷이나 정규식이 적용된 형태의 JSON객체로 반환한다.
*
* @param itemIndex - 정보를 가져올 행의 순서
* @param useColumnName - `true`이면 JSON객체의 속성명을 fieldName이 아닌 column.name으로 만든다.
* @returns 입력된 `itemIndex`가 행의 고유 번호와 연결된 행이 아닌경우 `null`이 출력된다.
*
* @example
* ```js
* gridView.getDisplayValues(3);
* ```
*/
getDisplayValues(itemIndex: number, useColumnName?: boolean): object;
/**
* 행 고유 번호로 지정한 행의 데이터 값들을 각종 포맷이나 정규식이 적용된 형태의 JSON객체로 반환한다.
*
* @param dataRow - 행의 고유 번호
* @param useColumnName - `true`이면 JSON객체의 속성명을 fieldName이 아닌 column.name으로 만든다.
* @returns 입력된 `dataRow`가 존재하지 않을 경우 `null`이 출력된다.
*
* @example
* ```js
* gridView.getDisplayValuesOfRow(42);
* ```
*/
getDisplayValuesOfRow(dataRow: number, useColumnName?: boolean): object;
getJsonRows(): object[];
/**
* 지정한 행의 여러 필드의 값을 수정한다.
*
* @param itemIndex - 정보를 가져올 행의 인덱스
* @param values - 수정할 필드의 데이터 값들
* @param strict - 기본값: `false`, `true` 일때 필드의 값을 `undefined` 로 지정한 경우 기존의 값을 유지한다.
*
* @example
* ```js
* gridView.setValues(3, [123, 142, 'happy', 133]);
* ```
*/
setValues(itemIndex: number, values: any[] | object, strict?: boolean): void;
/**
* 행의 순서와 데이터 필드 인덱스로 지정되는 데이터셀의 값을 반환한다.
*
* @remarks
* 지정한 행이 수정중인 경우 수정된 값을 반환한다. 편집이 완료되지 않은 셀의 값은 가져올수 없다.
*
* @param itemIndex - 행의 순서
* @param field - 필드 인덱스 또는 필드명
* @param editing - 현재 편집중인 경우, 편집중인 값을 가지고 올지에 대한 유무
* @returns 데이터 필드의 값
* @example
* ```js
* gridView.getValue(3, 'UnitPrice');
* ```
*/
getValue(itemIndex: number, field: string | number, editing?: boolean): any;
/**
* 행의 순서와 데이터 필드 인덱스로 지정되는 데이터 셀의 값을 변경한다.
*
* @remarks
* 그리드가 편집 중인 경우 편집 중인 itemIndex 의 값만 변경할수 있으며 편집이 완료된후 dataProvider에 값이 반영되고 편집중이 아닌경우 dataProvider에 즉시 반영된다.
*
* @param itemIndex - 행의 순서
* @param field - 필드 인덱스 또는 필드명
* @param value - 필드에 설정할 값
*
* @example
* ```js
* gridView.setValue(3, 'UnitPrice', 52);
* ```
*/
setValue(itemIndex: number, field: string | number, value: any): void;
/**
* 그리드가 편집 중일때 현재 수정 중인 셀의 값을 반환한다.
*
* @returns 데이터 필드의 값
*
* @example
* ```js
* gridView.getEditValue();
* ```
*/
getEditValue(): any;
/**
* focus가 위치한 셀에 값을 설정한다.
*
* @param value - 설정하려는 값
* @param startEdit - 기본값: `false`, `true`: 셀이 편집중이 아닌 경우 값을 설정하고 편집기를 표시. `false`: 값을 설정하지 않음.
* @param dropdown - 기본값: `true`, `false`: dropdownCellEditor, dateCellEditor등과 같이 dropdown이 되는 editor의 경우 dropdown을 표시하지 않는다.
*
* @example
* ```js
* gridView.setEditValue('newValue');
* ```
*/
setEditValue(value: any, startEdit?: boolean, dropdown?: boolean): void;
/**
* 사용자 지정의 렌더러를 등록한다.
*
* @param type - 사용자가 지정한 렌더러 종류 (이름)
* @param renderer - {@link CustomCellRenderer} 객체
*
* @example
* ```js
* // CustomCellRenderer 모델
* gridView.registerCustomRenderer("renderer01", {
* initContent(parent) {
* var span = this._span = document.createElement("span");
* parent.append(span);
* }
* })
* ```
*/
registerCustomRenderer(type: string, renderer: CustomCellRenderer): void;
/**
* 사용자 지정의 렌더러를 등록 해제 한다.
*
* @param type - 해제 할 렌더러 종류 (이름)
*
* @example
* ```js
* gridView.unregisterCustomRenderer('Renderer01');
* ```
*/
unregisterCustomRenderer(type: string): void;
/**
* 사용자렌더러가 있는지 확인한다.
* @param type - 등록한 렌더러 이름
*/
existsCustomRenderer(type: string): boolean;
/**
* 모든 사용자 지정의 렌더러를 등록 해제 한다.
*
* @example
* ```js
* gridView.unregisterAllCustomRenderer('Renderer01');
* ```
*/
unregisterAllCustomRenderer(): void;
/**
* 그리드에 Popup Menu를 추가한다.
*
* @remarks
* 추가된 메뉴는 데이터셀 등에 연결할 수 있다.
*
* @param name - 메뉴 이름
* @param menuItems - {@link PopupMenuItem} 형식을 따르는 배열, 계층적 구조의 메뉴 정보
*
* @example
* ```js
* 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);
* ```
*/
addPopupMenu(name: string, menuItems: (PopupMenu | PopupMenuItem)[]): void;
/**
* @public
* 팝업 메뉴 설정 정보를 반환한다.
*
* @remarks
* contextMenu를 가져오는 경우 `gridContextMenu`를 입력한다.
*
* @param name - 메뉴 이름
* @returns - 메뉴가 존재하지 않는 경우 `null`
*/
getPopupMenu(name: string): PopupMenu;
/**
* 그리드에서 특정 Popup Menu 를 제거한다.
*
* @param name - 제거할 Popup Menu 의 이름
*
* @example
* ```js
* gridView.removePopupMenu('menu1');
* ```
*/
removePopupMenu(name: string): void;
/**
* 그리드에서 오른쪽 마우스를 클릭했을때 표시되는 컨텍스트 메뉴에 추가할 메뉴 항목들을 지정한다.
*
* @remarks
* 메뉴가 클릭되면 {@link GridBase.onContextMenuItemClicked | onContextMenuItemClicked} 콜백을 호출한다
*
* @param menuItems - 메뉴 정보 배열
*
* @example
* ```js
* let menu = [{
* label: "menu1 입니다.",
* children: [{
* label: "submenu1 입니다."
* }, {
* label: "submenu2 입니다."
* }]
* }, {
* label: "menu2 입니다",
* }, {
* label: "-"
* }, {
* label: "menu3 입니다",
* type: "check",
* checked: true,
* tag: "check_menu"
* }];
*
* gridView.setContextMenu(menu);
* ```
*/
setContextMenu(menuItems: (PopupMenu | PopupMenuItem)[]): PopupMenu;
/**
* 현재 선택된 영역 정보를 반환한다.
*
* @param index - 선택영역이 여러개인 경우 선택영역의 index
*
* @example
* ```js
* let sel = gridView.getSelection();
* console.log("Selection: ", JSON.stringify(sel, function(key, value) { return key.indexOf("Layout") >= 0 ? value.column : value }));
* ```
*/
getSelection(index?: number): Selection;
/**
* 현재 선택된 영역 정보를 배열형태로 반환한다.
*
* @example
* ```js
* 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}));
* })
* ```
*
* @returns 선택된 영역 배열
*/
getSelections(): Selection[];
/**
* 그리드에서 선택할 영역을 지정한다.
*
* @remarks
* 기존 선택영역이 있는 경우 제거된다.
*
* @param item - {@link Selection} 모델과 같은 설정 정보. 선택하고자 하는 영역의 속성만 전달하면 된다.
* @param eventFire - selection관련 이벤트를 발생시키지 않는다.
*
* @example
* ```js
* let sel = {
* style: "block",
* startItem: 2,
* startColumn: "지목",
* endItem: 3,
* endColumn: "단위"
* }
* gridView.setSelection(sel);
* ```
*/
setSelection(item: Selection, eventFire?: boolean): void;
/**
* 그리드에서 선택할 영역을 추가한다.
*
* @remarks
* {@link DisplayOptions.selectionMode | selectionMode}가 {@link SelectionMode.EXTENDED | extended}인 경우에만 추가된다.
*
* @param item - {@link Selection} 모델과 같은 설정 정보. 선택하고자 하는 영역의 속성만 전달하면 된다.
*
* @example
* ```js
* let sel = {
* style: "block",
* startItem: 2,
* startColumn: "지목",
* endItem: 3,
* endColumn: "단위"
* }
* gridView.addSelection(sel);
* ```
*/
addSelection(item: Selection, eventFire?: boolean): void;
/**
* 선택 영역을 모두 제거한다.
*
* @example
* ```js
* gridView.clearSelection();
* ```
*/
clearSelection(): void;
/**
* 현재 선택 영역 안의 행의 인덱스들을 반환한다.
*
* @param dataOnly - 데이터행만 반환한다.
*
* @example
* ```js
* let selectedItems = gridView.getSelectedItems(true);
* ```
*/
getSelectedItems(dataOnly: boolean): number[];
/**
* 현재 선택 영역 안의 데이터 행의 고유번호들을 반환한다.
*
* @example
* ```js
* let selectedRows = gridView.getSelectedRows();
* ```
*/
getSelectedRows(): number[];
/**
* 현재 선택 영역 안의 행들을 삭제한다.
*
* @remarks
* {@link EditOptions.deletable} 이 false인 경우 작동하지 않는다.
*
* @param force - `true` 시 대화 상자 표시 없이 바로 삭제한다. `editOptions.deletable`이 `false`여도 삭제된다.
*
* @example
* ```js
* gridView.deleteSelection(true);
* ```
*/
deleteSelection(force?: boolean): void;
/**
* 선택 영역 안의 셀들의 값을 지운다. 즉, undefined로 값을 변경한다.
*
* @remarks
* {@link EditOptions.erasable}이 false인 경우 작동하지 않는다.
*
* @param force - `true`이면 `editOptions.erasable`이 `false`여도 셀의 값을 지운다
*
* @example
* ```js
* gridView.eraseSelection();
* ```
*/
eraseSelection(force?: boolean): void;
/**
* 현재 선택 영역에 포함된 셀들의 값을 반환한다.
*
* @remarks
* 선택된 영역이 여러개인경우에도 첫번째 선택영역의 data만 반환한다.
*
* @param maxRows - 반환할 최대 행의 개수. 기본값: `-1`. `0`보다 작은 값이면 제한 없이 모든 행을 반환한다.
* @param index - 선택영역의 index 기본값: `0`
* @returns 셀 데이터들
*
* @example
* ```js
* let selData = gridView.getSelectionData();
* ```
*/
getSelectionData(maxRows?: number, index?: number): RowObject[];
/**
* 현재 선택 영역에 포함된 셀들의 값을 반환한다.
*
* @remarks
* 선택된 영역이 여러개인경우 사용한다.
*
* @returns 셀 데이터들
*/
getSelectionsData(): RowObject[][];
/**
* 선택한 영역에 포함된 셀들의 정보를 복사 혹은 반환한다.
*
* @remarks
* 선택된 영역이 여러개인경우 사용할수 없다.
*
* @param selection - 선택 영역의 정보, 지정하지 않으면 그리드 전체가 복사된다.
* @param copy - 기본값: `true`, `true:` 클립보드에 복사, `false`: 반환
* @returns `copy` 가 `false` 시 반환
*
* @example
* ```js
* let sel = gridView.getSelection();
* let copied = gridView.copyToClipboard(sel);
* ```
*/
copyToClipboard(selection: Selection, copy?: boolean): string;
/**
* 현재 편집기의 내용을 셀에 반영한다.
*
* @remarks
* 실행 후 {@link GridBase.onEditCommit | onEditCommit}, {@link GridBase.onEditRowChanged | onEditRowChanged}, {@link GridBase.onCellEdited | onCellEditted} 이벤트가 순차적으로 발생한다.
*
* @param hideEditor - 기본값: `true`, Editor의 종료 여부
* @param force - 기본값: `true`, `true`설정 시, {@link GridBase.onEditCommit | onEditCommit}이 호출되지 않는다.
*
* @returns commit이 완료되면 `true` 반환
*
* @example
* ```js
* gridView.commitEditor();
* ```
*/
commitEditor(hideEditor?: boolean, force?: boolean): boolean;
/**
* 편집 중인 행의 편집을 완료하고 DataProvider에 저장한다.
*
* @param force - 기본값: `false`, `true`: 입력/편집 중 편집을 취소한 행(RowState 변경은 없고, Indicator 에 편집으로 표시된)을 커밋
* @returns 데이터 변경이 발생한 경우 `true` 반환
*
* @example
* ```js
* gridView.commit();
* ```
*/
commit(force?: boolean): boolean;
/**
* 현재 편집 중인 행의 편집을 취소한다.
*
* @remarks
* 편집 중이 아니라면 아무 일도 하지 않는다.
* 편집을 완료할 때는 {@link GridBase.commit | commit()} 을 호출해야 한다.
*
* @returns 취소 성공 여부
*
* @example
* ```js
* gridView.cancel();
* ```
*/
cancel(): boolean;
/**
* 입력값과 관련된 항목을 조회하여 리스트에 표시한다. 부분검색 용도로 사용된다.
*
* @param column - 리스트가 표시 될 컬럼 객체 또는 컬럼명
* @param searchKey - 검색 키 값
* @param values - 검색된 value 값들
* @param labels - 검색된 label 값들
* @param items - templateCallback으로 전달할 추가정보 배열
*
* @example
* ```js
* 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);
* };
* };
* ```
*/
fillEditSearchItems(column: string | GridColumn, searchKey: string, values?: string[], labels?: string[], items?: ListResult): void;
/**
* 셀 편집은 끝났으나 커밋은 하지 않았을 때, 편집 중이면 `true` 를 반환한다.
*
* @example
* ```js
* let isItemEditing = gridView.isItemEditing();
* ```
*/
isItemEditing(): boolean;
/**
* isItemEdited?
*/
/**
* 셀이 현재 편집중이면 `true` 를 반환한다.
*
* @example
* ```js
* let isEditing = gridView.isEditing();
* ```
*/
isEditing(): boolean;
/**
* 현재 위치한 셀에서 그리드의 편집기를 표시한다.
*
* @remarks
* 그리드가 편집 불가 상태(editable: false)라면 편집기는 표시되지 않는다.
*
* @example
* ```js
* gridView.showEditor();
* ```
*/
showEditor(dropdown?: boolean): void;
/**
* 현재 그리드에서 열려진 편집기를 닫는다.
*
* @example
* ```js
* gridView.hideEditor();
* ```
*/
hideEditor(): void;
/**
* 편집을 취소하고 편집기 창을 닫는다.
*
* @example
* ```js
* gridView.cancelEditor();
* ```
*/
cancelEditor(): void;
/**
* 행 수준의 편집 검증 조건의 목록을 설정한다.
*
* @param value - {@link EditValidation} 모델과 같은 설정 정보들의 배열 또는 검증식
*
* @example
* ```js
* // 문자열
* gridView.setValidations("values['UnitPrice'] > 100");
*
* // 오브젝트
* gridView.setValidations({
* message: 'Too expensive!',
* criteria: "values['UnitPrice'] > 100"
* })
*
* // 배열
* gridView.setValidations([{
* message: 'Too expensive!',
* criteria: "values['UnitPrice'] > 100"
* }])
* ```
*/
setValidations(value: EditValidation[] | EditValidation | string | string[]): void;
/**
* 입력시 검증하는 것이 아닌 그리드에 있는 데이터들을 대상으로 일괄로 검증을 수행한다.
*
* @remarks
* column validation을 사용하여 검증을 수행하며 row validation은 하지 않는다.
*
* @param itemIndices - 그리드의 행 인덱스들, `null`로 지정하면 그리드 전체 행을 대상으로 검증을 수행
* @param visibleOnly - 기본값: `true`, `false` 이면 트리 그리드의 접혀있는 노드 등 보이지 않는 행들도 검증 대상에 포함한다. `false`는 전체 행을 체크하는 경우에만 적용한다.
* @param pageAllItems - `true`이면 현재 페이지가 아닌 전체 행을 대상으로 검증을 수행한다 기본값: `false`,
* @param columns - 검증을 수행할 컬럼의 이름 또는 배열을 지정하면 입력된 컬럼만 검증을 수행
* @returns 검증에 실패한 셀 정보들
*
* @example
* ```js
* gridView.validateCells(null, false);
* ```
*/
validateCells(itemIndices: number | number[] | null, visibleOnly?: boolean, pageAllItems?: boolean, columns?: string | string[]): object;
/**
* 값 검증에 실패한 셀 정보들을 반환한다.
*
* @remarks
* 이 함수는 {@link GridBase.validateCells | validateCells()} 를 먼저 실행한 후 검증에 실패한 데이터를 수정 후 다시 검증할 때 사용한다.
* @returns 검증에 실패한 셀 정보들, {@link InvalidCell} 의 배열 형식을 따른다.
*
* @param itemIndex - 행의 고유 번호 입력하면 해당하는 행의 셀 정보만 반환한다.
*
* @example
* ```js
* let invalids = gridView.getInvalidCells();
* ```
*
*/
getInvalidCells(itemIndex?: number): InvalidCell[];
/**
* 값 검증에 실행한 셀 정보중 입력한 dataRow에 해당하는 정보를 반환한다.
*
* @remarks
*
* @param dataRow - 행의 dataRow
* @returns 검증에 실패한 셀 정보들, {@link InvalidCell} 의 배열 형식을 따른다.
*/
getInvalidCellsOfRow(dataRow: number): InvalidCell[];
/**
* 값 검증에 실패한 셀 정보들을 삭제한다.
*
* @remarks
* 이 함수는 {@link GridBase.validateCells | validateCells()} 를 실행했을때 검증에 실패한 데이터의 목록을 지울때 사용한다.
*
* @example
* ```js
* gridView.validateCells();
* gridView.clearInvalidCells();
* let invalids = gridView.getInvalidCells(); // null
* ```
*/
clearInvalidCells(): void;
/**
* 그리드가 편집 중인 아이템의 정보를 반환한다.
*
* @returns 편집 중인 그리드 아이템의 정보. 편집 중이 아닌 경우 `null` 반환. {@link EditingItemInfo} 형식.
*
* @example
* ```js
* let eItemInfo = gridView.getEditingItem();
* ```
*/
getEditingItem(): EditingItemInfo;
/**
* 아이템의 상태값을 반환한다.
*
* @param itemIndex - 상태를 가져오려는 아이템의 인덱스
* @returns 그리드 아이템의 상태값
*
* @example
* ```js
* let itemStates = gridView.getItemState(3);
* ```
*/
getItemState(itemIndex: number): ItemState;
/**
* Toast 팝업 창을 표시한다.
*
* @param options - 메시지와 메시지 표시여부를 지정, {@link ToastOptions} 와 같은 모델의 오브젝트. 기본적으로 메시지만 지정해도 된다.
* @param force - 기존 toast 창이 표시되어 있을때 강제로 다시 표시 여부를 지정한다.
*
* @example
* ```js
* let config = {
* message: 'Toast!'
* }
* gridView.showToast(config, true);
* ```
*/
showToast(options: ToastOptions, force?: boolean): void;
/**
* Toast 팝업 창을 숨긴다.
*
* @param action - toast 창을 숨긴 뒤 수행할 콜백함수를 지정한다.
*
* @example
* ```js
* const f = function () {
* console.log('hidden toast!');
* }
* gridView.hideToats(f);
* ```
*/
hideToast(action: VoidFunction): void;
/**
* 화면에 셀 또는 지정하는 위치에 메세지를 표시한다.
*
* @remarks
* x, y를 `number`로 지정하면 그리드의 왼쪽상단에서 지정된 위치만큼 떨어진 위치에 표시한다.
* x를 {@link CellIndex}형식으로 지정하면 해당셀의 왼쪽 하단에 표시된다.
*
* @param message - 화면에 표시될 메세지를 string 또는 {@link TooltipOptions} 형식으로 지정한다.
* @param x - `x`축의 값을 `number`또는 {@link CellIndex}형식으로 지정한다.
* @param y - `y`축의 값을 지정한다.
*
* @example
* ```js
* // 현재 선택된 셀의 왼쪽하단에 메세지를 표시
* gridView.showMessage("user message", grid.getCurrent());
*
* // 그리드 의 특정위치에 메세지를 표시
* gridView.showMessage("User\nMessage", 100, 100);
*
* // 지정된 시간이후 사라지는 메세지
* gridView.showMessage({message: "자동으로 사라지는 메세지", hideDuration: 10000}, grid.getCurrent());
* ```
*
*/
showMessage(message: string | TooltipOptions, x: number | CellIndex, y?: number): void;
/**
* lookup tree 에서 사용할 lookup source 들을 등록한다.
*
* @remarks
* 기존id에 추가를 원하는 경우는 {@link GridBase.fillLookupData | fillLookupData()} 를 사용한다.
*
* @param sources - {@link LookupSource} 오브젝트 배열
*
* @example
* ```js
* let area1codes = {
* id: "area1code",
* levels: 1,
* keys: ['11', '21'],
* values: ['서울특별시', '부산광역시']
* }
*
* let area2codes = {
* id:"area2code",
* levels:2,
* keys: [['11', '11010'], ['11', '11020']],
* values: ['종로구', '중구']
* };
*
* gridView.setLookups([area1codes, area2codes]);
* ```
*/
setLookups(sources: LookupSource[]): void;
/**
* lookup tree에서 사용할 {@link LookupSource} 를 추가 등록한다.
*
* @remarks
*
* 기존id에 추가를 원하는 경우는 {@link GridBase.fillLookupData | fillLookupData()} 를 사용한다.
*
* @param source - {@link LookupSource} 오브젝트
*
* @example
* ```js
* let area3codes = {
* id:"area2code",
* levels:3,
* keys: [['11', '11010', '1101053'], ['11', '11010', '1101054']],
* values: ['사직동', '삼청동']
* };
* gridView.addLookupSource(area3codes);
* ```
*/
addLookupSource(source: LookupSource): void;
/**
* 지정한 룩업 소스를 삭제한다.
*
* @param sourceId - 삭제할 LookupSource id
*
* @example
* ```js
* gridView.removeLookupSource('area1code');
* ```
*/
removeLookupSource(sourceId: string): void;
/**
* 지정된 lookupsource에 지정된 키가 존재하는지 여부를 반환한다.
*
* @param sourceId - LookupSource의 Id.
* @param keys - 찾을 키 값, 값들.
*
* @example
* ```js
* gridView.existsLookupData('area1code', ['12']);
* ```
*/
existsLookupData(sourceId: string, keys: string | string[]): boolean;
/**
* lookupSource에 lookupData를 추가한다.
*
* @param sourceId - LookupSource의 id
* @param data - 설정하고자 하는 {@link LookupData}
*
* @example
* ```js
* gridView.fillLookupData("lookup1", {keys:[["14"],["15"]], values:["가나다라","일이삼사"]});
* ```
*/
fillLookupData(sourceId: string, data: LookupData): void;
/**
* 지정된 lookupSource에 지정된 키가 있으면 keys, values 를 반환한다.
*
* @param sourceId - LookupSource의 id
* @param keys - 찾을 키 값
* @returns - fillLookupData로 설정한 data
*
*/
getLookupData(sourceId: string, keys: string | string[]): LookupDataKeyValues;
/**
* 지정된 SourceId에 해당하는 lookup source를 clear한다.
*
* @param sourceId - LookupSource의 id
*
* @example
* ```js
* gridView.clearLookupData('area1code');
* ```
*/
clearLookupData(sourceId: string): void;
/**
* 지정한 아이템의 인덱스로 체크바의 체크 가능 여부를 반환한다.
*
* @param itemIndex - 아이템의 인덱스
* @returns 체크 가능한지의 여부
*
* @example
* ```js
* let isCheckable = gridView.isCheckable(4);
* ```
*/
isCheckable(itemIndex: number): boolean;
/**
* 지정한 아이템의 고유 번호로 체크바의 체크 가능 여부를 반환한다.
*
* @param dataRow - 아이템의 dataRow
* @returns 체크 가능한지의 여부
*
* @example
* ```js
* gridView.isCheckableOfRow(4);
* ```
*/
isCheckableOfRow(dataRow: number): boolean;
/**
* 지정한 아이템의 체크바의 체크 가능성 여부를 지정한다.
*
* @param itemIndex - 아이템의 인덱스
* @param value - 체크 가능한지의 여부
*
* @example
* ```js
* gridView.setCheckable(4, false);
* ```
*/
setCheckable(itemIndex: number, value: boolean): void;
/**
* 지정한 행의 체크바의 체크 가능성 여부를 지정한다.
*
* @param dataRow - 아이템의 dataRow
* @param value - 체크 가능한지의 여부
*
*/
setCheckableOfRow(dataRow: number, value: boolean): void;
/**
* 해당 체크바가 indeterminate상태면 `true` 를 반환한다.
*
* @param itemIndex - 아이템의 인덱스
*
* @example
* ```js
* gridView.isIndeterminateItem(4);
* ```
*/
isIndeterminateItem(itemIndex: number): boolean;
/**
* 해당 체크바에 체크가 되어있으면 `true` 를 반환한다.
*
* @param itemIndex - 아이템의 인덱스
*
* @example
* ```js
* gridView.isCheckedItem(4);
* ```
*/
isCheckedItem(itemIndex: number): boolean;
/**
* 행이 indeterminate상태인지 여부
*
* @param row - 행 고유 번호
*
* @example
* ```js
* gridView.isIndeterminateRow(4);
* ```
*/
isIndeterminateRow(row: number): boolean;
/**
* 행이 체크되어있는지 여부
*
* @param row - 행 고유 번호
*
* @example
* ```js
* gridView.isCheckedRow(4);
* ```
*/
isCheckedRow(row: number): boolean;
/**
* 지정된 아이템을 indeterminate 상태로 변경하거나 해제한다.
*
* @param itemIndex - 아이템의 인덱스
* @param indeterminate - 기본값: `true`, `true`: indeterminate 상태, `false`: indeterminate 상태 해제
*
* @example
* ```js
* gridView.indeterminateItem(4, true);
* ```
*/
indeterminateItem(itemIndex: number, indeterminate?: boolean): void;
/**
* 지정된 아이템을 체크하거나 해제한다.
*
* @param itemIndex - 아이템의 인덱스
* @param checked - 기본값: `true`, `true`: 체크, `false`: 체크 해제
* @param exclusive - 기본값: `false`, `true`: 체크된 다른아이템이 있는 경우 모두 해제하고 아이템 인덱스로 입력된 아이템만 체크
* @param checkEvent - 기본값: `true`, {@link GridBase.onItemChecked | onItemChecked()} 의 발생 여부
*
* @example
* ```js
* gridView.checkItem(4);
* ```
*/
checkItem(itemIndex: number, checked?: boolean, exclusive?: boolean, checkEvent?: boolean): void;
/**
* 지정된 데이터 행을 indeterminate 상태로 변경하거나 해제한다.
*
* @param row - 행 고유 번호
* @param indeterminate - 기본값: `true`, `true`: indeterminate 상태, `false`: indeterminate 상태 해제
*
* @example
* ```js
* gridView.checkRow(4);
* ```
*/
indeterminateRow(row: number, indeterminate?: boolean): void;
/**
* 지정된 데이터 행을 체크하거나 해제한다.
*
* @param row - 행 고유 번호
* @param checked - 기본값: `true`, `true`: 체크, `false`: 체크 해제
* @param exclusive - 기본값: `false`, `true`: 체크된 다른아이템이 있는 경우 모두 해제하고 row로 입력된 아이템만 체크
* @param checkEvent - 기본값: `true`, {@link GridBase.onItemChecked | onItemChecked()} 의 발생 여부
*
* @example
* ```js
* gridView.checkRow(4);
* ```
*/
checkRow(row: number, checked?: boolean, exclusive?: boolean, checkEvent?: boolean): void;
/**
* 지정된 GridItem을 체크하거나 해제한다.
*
* @remarks
* 숨겨진 그룹의 header의 체크를 변경할때 사용한다.
*
* @param model - GridItem
* @param checked - 기본값: `true`, `true`: 체크, `false`: 체크 해제
* @param exclusive - 기본값: `false`, `true`: 체크된 다른아이템이 있는 경우 모두 해제하고 row로 입력된 아이템만 체크
* @param checkEvent - 기본값: `true`, {@link GridBase.onItemChecked | onItemChecked()} 의 발생 여부
*/
checkModel(model: GridItem, checked?: boolean, exclusive?: boolean, checkEvent?: boolean): void;
/**
* 지정된 GridItem이 체크되어있는지 여부
*
* @param model - GridItem
*/
isCheckedModel(model: GridItem): boolean;
/**
* 지정된 GridItem의 체크 가능여부를 반환한다.
* @param model - GridItem
*/
isCheckableModel(model: GridItem): boolean;
/**
* 해당 모델의 indeterminate상태를 변경한다.
*
* @param model - GridItem
* @param indeterminate - `indeterminate` 값을 입력한다.
*/
indeterminateModel(model: GridItem, indeterminate: boolean): void;
/**
* 해당 체크바가 indeterminate상태면 `true` 를 반환한다.
* @param model - GridItem
*/
isIndeterminateModel(model: GridItem): boolean;
/**
* 입력된 아이템 배열에 해당하는 아이템을 체크하거나 해제한다.
*
* @param itemIndices - 아이템 인덱스 배열
* @param checked - 기본값: `true`, `true`: 체크, `false`: 체크 해제
* @param checkEvent - 기본값: `true`, {@link GridBase.onItemChecked | onItemChecked()} 의 발생 여부
*
* @example
* ```js
* gridView.checkItems([1,2,3,4]);
* ```
*/
checkItems(itemIndices: number[], checked?: boolean, checkEvent?: boolean): void;
/**
* 입력된 고유 행 번호들과 연결된 Item을 체크하거나 해제한다.
*
* @param rows - 고유 행 번호의 배열
* @param checked - 기본값: `true`, `true`: 체크, `false`: 체크 해제
* @param checkEvent - 기본값: `true`, {@link GridBase.onItemChecked | onItemChecked()} 의 발생 여부
*
* @example
* ```js
* gridView.checkRows([1,2,3,4]);
* ```
*/
checkRows(rows: number[], checked?: boolean, checkEvent?: boolean): void;
/**
* 그리드의 데이터행을 모두 체크,해제한다.
*
* @remarks
* {@link CheckBar} 의 exclusive에 영향을 받지않는다.
*
* @param checked - 기본값: `true`, `true`: 체크, `false`: 체크 해제
* @param visibleOnly - collapse로 인해 접혀서 보이지 않는 행의 포함여부
* @param checkableOnly - 체크가능한 행만 체크할 것인지의 여부
* @param checkEvent - 기본값: true, {@link GridBase.onItemChecked | onItemChecked()} 의 발생 여부
*
* @example
* ```js
* gridView.checkAll();
* ```
*/
checkAll(checked?: boolean, visibleOnly?: boolean, checkableOnly?: boolean, checkEvent?: boolean): void;
/**
* CheckBar에 설정된 옵션으로 그리드의 데이터행을 모두 체크 또는 해제한다.
*
* @remarks
* {@link CheckBar} 의 exclusive에 영향을 받지않는다.
* {@link GridBase.onItemChecked | onItemChecked()} 는 발생하지 않는다.
* CheckBar|CheckBar.head의 v 표시를 활성 상태로 적용시킨다.
*
* @param checked - 기본값: true, true: 체크, false, 해제
* @param itemChecked - 기본값: true, CheckBar.head의 v표시 활성 여부
*
* @example
* ```js
* gridView.setAllCheck();
* ```
*/
setAllCheck(checked?: boolean, itemChecked?: boolean): void;
/**
* 모든 아이템들이 체크되어있는지 여부를 반환한다.
*
* @returns CheckBar|CheckBar.head의 v 표시가 활성 상태이면 true를 반환한다.
*
* @example
* ```js
* let all = gridView.isAllChecked();
* ```
*/
isAllChecked(): boolean;
/**
* CheckBar에 적용된 모든 행의 Checkable 상태를 초기화한다.
*
* @param clearExpression - CheckBar의 checkableExpression을 clear 실행 여부
*
*/
resetCheckables(clearExpression: boolean): void;
/**
* CheckBar에 Expression 기준으로 checkable을 적용한다.
*
* @example
* ```js
* gridView.applyCheckables();
* ```
*/
applyCheckables(): void;
/**
* CheckBar에 checkableExpression 설정한 후 적용을 한다. 혹은 동시수행 한다.
*
* @param expression - 체크 가능 여부의 수식
* @param apply - 기본값: true, 즉시 적용 여부
* @example
* ```js
* gridView.setCheckableExpression("row % 2 = 1");
* ```
*/
setCheckableExpression(expression: string, apply?: boolean): void;
/**
* CheckBar에 checkableCallback 설정한 후 적용을 한다. 혹은 동시수행 한다.
*
* @param callback - 체크 가능 여부의 콜백
* @param apply - 기본값: true, 즉시 적용 여부
*
* @example
* ```js
* const f = function(dataSource, item) {
* console.log("checked!")
* return true;
* }
* gridView.setCheckableCallback(f);
* ```
*/
setCheckableCallback(callback?: CheckableCallback, apply?: boolean): void;
/**
*
* @param sort - 기본값: `true`, `true`: 오름차순으로 반환, `false`: 화면에 보이는 순서대로 반환.
* @returns filtering된 행들의 dataRow목록을 반환한다.
*
* @example
* ```js
* let filteredRow = gridView.getFilteredRows();
* ```
*/
getFilteredRows(sort?: boolean): number[];
/**
* 필드의 합계값을 반환한다.
*
* @remarks
* {@link GridBase.summaryMode | summaryMode} 에 따라서 가져올수 있는 값이 다르다.
*
* 숫자형 데이터 종류의 필드만 합계값을 가져올수 있다.
*
* summaryMode가 {@link SummaryMode.NONE | none}인 경우 미리 계산을 해 놓지 않는다.
*
* summaryMode가 {@link SummaryMode.AGGREGATE | aggregate}인 경우 "sum","avg","min",’max","count", "datacount", "dataavg" 를 가져올수 있다.
*
* {@link SummaryMode.STATISTICAL | statistical}인 경우 "var","varp","stdev","stdevp"을 추가적으로 가져올수 있다.
*
* @param field - 해당 필드명 혹은 인덱스
* @param type - 기본값: "sum", 다른 속성값은 {@link SummaryType} 참조
*
* @example
*
* ```js
* let sum = gridView.getSummary('unitPrice', 'sum');
* ```
*/
getSummary(field: string | number, type: SummaryType): number;
/**
* itemIndex 에 해당하는 모델을 반환한다.
*
* @remarks
* {@link GridItem} 형식으로 반환한다.
*
* @param itemIndex - 아이템의 인덱스
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let model = gridView.getModel(3);
* ```
*/
getModel(itemIndex: number, extended?: boolean): GridItem;
/**
* itemIndex 와 itemType 해당하는 모델을 반환한다.
*
* @remarks
* {@link GridItem} 형식으로 반환한다.
*
* @param itemIndex - 아이템의 인덱스
* @param itemType - {@link ItemType | 아이템 종류} 생략하면 {@link GridBase.getModel}과 동일하다
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let model = gridView.getModelAs(3, 'row');
* ```
*/
getModelAs(itemIndex: number, itemType?: ItemType, extended?: boolean): GridItem;
/**
* itemIndex 에 해당하는 그룹 모델을 반환한다.
*
* @remarks
* {@link GridItem} 형식으로 반환한다.
*
* @param itemIndex - 아이템의 인덱스
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let group = gridView.getGroupModel(1);
* ```
*/
getGroupModel(itemIndex: number, extended?: boolean): GridItem;
/**
* 아이템 모델의 최상위 조상 아이템 모델을 반환한다.
*
* @param model - 모델 정보
* @param extended - 확장 정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* const idx = gridView.getCurrent();
* const item = gridView.getModel(idx.itemIndex);
* const root = gridView.getRootModel(item, extended);
* ```
*/
getRootModel(model: GridItem, extended?: boolean): GridItem;
/**
* 지정한 아이템의 인덱스들에 해당하는 아이템 모델들을 반홚나다.
*
* @remarks
* {@link GridItem} 의 배열 형식으로 반환한다.
*
* @param itemIndices - 아이템의 인덱스 배열
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let models = gridView.getModels([1,2,3]);
* ```
*/
getModels(itemIndices: number | number[], extended?: boolean): GridItem[];
/**
* 행 고유번호에 해당하는 아이템 모델을 반환한다.
*
* @remarks
* {@link GridItem} 의 형식으로 반환한다.
*
* @param dataRow - 행 고유번호
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let row = gridView.getModelOfRow(1);
* ```
*/
getModelOfRow(dataRow: number, extended?: boolean): GridItem;
/**
* 행 고유번호들에 해당하는 아이템 모델들을 반환한다.
*
* @remarks
* {@link GridItem} 의 배열 형식으로 반환한다.
*
* @param dataRows - 행 고유번호 배열
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let rows = gridView.getModelsOfRows([1,2,3]);
* ```
*/
getModelsOfRows(dataRows: number | number[], extended?: boolean): GridItem[];
/**
* 아이템 모델의 부모 아이템 모델을 반환한다.
*
* @remarks
* {@link GridItem} 의 형식으로 반환한다.
*
* @param model - 아이템 모델 정보
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let model = gridView.getModel(3);
* let parent = gridView.getParentModel(model);
* ```
*/
getParentModel(model: GridItem, extended?: boolean): GridItem;
/**
* 아이템 모델의 자식 모델을 반환한다.
*
* @remarks
* {@link GridItem} 의 형식으로 반환한다.
*
* @param parentModel - 아이템 모델 정보
* @param index - 자식 모델 사이에서의 해당 자식 모델의 인덱스
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let model = gridView.getModel(3);
* let child = gridView.getChildModel(model, 2);
* ```
*/
getChildModel(parentModel: GridItem, index: number, extended?: boolean): GridItem;
/**
* 아이템 모델의 자식 모델들을 반환한다.
*
* @remarks
* {@link GridItem} 의 배열 형식으로 반환한다.
*
* @param parentModel - 아이템 모델 정보
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let model = gridView.getModel(3);
* let childs = gridView.getChildModels(model);
* ```
*/
getChildModels(parentModel: GridItem, extended?: boolean): GridItem[];
/**
* 아이템 모델의 자손 모델들을 반환한다.
*
* @remarks
* {@link GridItem} 의 배열 형식으로 반환한다.
*
* @param parentModel - 아이템 모델 정보
* @param extended - 확장정보 포함 여부, 기본값: `false`
*
* @example
* ```js
* let model = gridView.getModel(3);
* let descendants = gridView.getChildModels(model);
* ```
*/
getDescendantModels(parentModel: GridItem, extended?: boolean): GridItem[];
/**
* 지정한 그룹아이템 모델의 합계 정보를 반환한다.
*
* @remarks
* 숫자형 필드에 대해서만 의미있는 값을 리턴한다.
*
* {@link GroupSummary} 형식으로 반환한다.
*
* @param model - 아이템 모델 정보
* @param field - 필드명
* @param statistical - 기본값: `false`, {@link GridBase.summaryMode | summaryMode}를 {@link SummaryMode.STATISTICAL | statistical}로 할 경우 `true`, {@link SummaryMode.AGGREGATE | aggregate}으로 할 경우 `false`로 한다.
*
* @example
* ```js
* let group = gridView.getGroupModel(1);
* let summary = gridView.getGroupSummary(group, 'fieldName', true);
* ```
*/
getGroupSummary(model: GridItem, field: string, statistical?: boolean): GroupSummary;
/**
* 필드의 중복되지 않은 값들을 반환한다.
*
* @remarks
* filtering, softDeleting에 의해서 감춰진 행을 제외하고 지정된 필드에 해당하는 값들을 중복을 배제하여 정렬상태로 반환한다,
*
* @param field - 필드 명 또는 필드 인덱스
* @param maxCount - 최대 건수, 정렬한 상태에서 위에부터 건수만큼 잘라서 반환한다. 기본값: `-1`
* @param sortDir - 정렬 방법, 기본값: {@link SortDirection.ASCENDING}
*
* @example
* ```js
* gridView.getDistinctItemValues('field1');
* ```
*/
getDistinctItemValues(field: number | string, maxCount?: number, sortDir?: SortDirection): any[];
/**
* 프로그레스 바를 표시한다.
*
* @remarks
* 진척 상태를 알리는 Progress Bar를 화면에 표시한다.
*
* 진척 값과 문자열 정보는 {@link GridBase.setProgress | setProgress()}를 통해 설정한다.
*
* @example
* ```js
* gridView.showProgress();
* ```
*/
showProgress(): void;
/**
* 프로그레스 바의 상태를 설정한다.
*
* @remarks
* 화면에 표시될 진척의 최소/최대값 현재값, 표시 문자을 설정한다.
*
* @param min - 최소 값
* @param max - 최대 값
* @param position - 최소 값과 최대 값 사이의 현재 값
* @param message - Progress Bar 하단에 표시할 문자열, 미 지정시 기본 문자열 출력
*
* @example
* ```js
* gridView.setProgress(0, 100, 50);
* ```
*/
setProgress(min: number, max: number, position: number, message?: string): void;
/**
* 프로그레스 바를 닫는다.
*
* @example
* ```js
* gridView.closeProgress();
* ```
*/
closeProgress(): void;
/**
* 로딩 애니메이션을 표시한다.
*
* @param disabled - true이면 마우스와 키보드의 동작을 막는다. - 기본값: `false`,
* @example
* ```js
* gridView.showLoading();
* ```
*/
showLoading(disabled?: boolean): void;
/**
* 로딩 애니메이션을 숨긴다.
*
* @example
* ```js
* gridView.closeLoading();
* ```
*/
closeLoading(): void;
/**
* 지정한 필드들의 값에 해당하는 첫번째 행을 찾아 행의 번호를 반환한다.
*
* @param options - {@link SearchOptions} 형태의 설정 정보 모델
*
* @example
*
* ```js
* function searchItemHandler() {
* let values = ["PR20012392", "QF24212112"]
* let fields = [ "RequestType", "ServiceCode" ];
* let startFieldIndex = fields.indexOf(gridView.getCurrent().fieldName) + 1;
* let options = {
* fields : fields,
* values: values,
* startIndex : gridView.getCurrent().itemIndex,
* startFieldIndex : startFieldIndex,
* wrap : true,
* caseSensitive : false,
* partialMatch : true
* }
* let index = gridView.searchCell(options);
* gridView.setCurrent(index);
* }
* ```
*/
searchItem(options: SearchOptions): number;
/**
* 지정한 필드들의 값에 해당하는 셀을 찾아 {@link CellIndex}를 반환한다.
*
* @param options - {@link SearchCellOptions} 형태의 설정 정보 모델
*
*
* @example
* ```js
* function searchCellHandler() {
* let value = "PR20012392"
* let fields = [ "RequestType", "ServiceCode" ];
* let startFieldIndex = fields.indexOf(gridView.getCurrent().fieldName) + 1;
* let options = {
* fields : fields,
* value : value,
* startIndex : gridView.getCurrent().itemIndex,
* startFieldIndex : startFieldIndex,
* wrap : true,
* caseSensitive : false,
* partialMatch : true
* }
* let index = gridView.searchCell(options);
* gridView.setCurrent(index);
* }
* ```
*/
searchCell(options: SearchCellOptions): any;
/**
* 그리드 상위 DIV 영역의 크기를 변경했는데 그리드의 크기가 변경되지 않을때 명시적으로 변경한다.
*
* @remarks
* 그리드가 올라갈 element의 크기가 결정되기 전에 그리드가 생성되거나 element의 style.display속성이 none이어서 그리드의 크기가 0 인 경우,
*
* 그리드 상위 DIV 영역의 크기를 변경했는데 그리드의 크기가 변경되지 않을때 사용한다.
*
* @param callback - 크기가 재설정 된 후 실행될 콜백
*
* @example
* ```js
* const f = function() {
* console.log('resized1')
* }
* gridView.resetSize(f)
* ```
*/
resetSize(callback?: any): void;
/**
* 필터박스 또는 DropDown Editor를 닫는다.
*
* @example
* ```js
* gridView.closeList();
* ```
*/
closeList(): void;
/**
* 지정한 설정에 따라 현재 그리드의 모양과 데이터를 외부 문서로 내보낸다.
*
* @param options - {@link GridExportOptions} 과 같은 설정 모델.
*
* @example
* ```js
* gridView.exportGrid({
* type: 'csv'
* })
* ```
*/
exportGrid(options: GridExportOptions): void;
/**
* 현재를 기준으로 페이지를 이동한다.
*
* @param offset - 현재를 기준으로 이동하려는 페이지 수. 이전 페이지는 음수.
*
* @example
* ```js
* gridView.scrollPage(3);
* ```
*/
scrollPage(offset: number): void;
/**
* 그리드 맨 위의 지정한 행의 인덱스를 반환한다.
*
* @example
* ```js
* let topItem = gridView.getTopItem();
* ```
*/
getTopItem(): number;
/**
* 그리드 맨 위에 지정한 행으로 위치한다.
*
* @param itemIndex - 기본값: 0, 그리드 상단에 위치하고자 하는 행의 인덱스
*
* @example
* ```js
* gridView.setTopItem();
* ```
*/
setTopItem(itemIndex?: number): void;
/**
* 가장 왼쪽 화면에 표시되고 있는 컬럼의 x 좌표값을 반환한다.
*
* @example
* ```js
* let leftPos = gridView.getLeftPos();
* ```
*/
getLeftPos(): number;
/**
* 그리드 왼쪽 경계가 지정한 값에 위치한다.
*
* @param position - x좌표 값
*
* @example
* ```js
* gridView.setLeftPos(10);
* ```
*/
setLeftPos(position: number): void;
/**
* 그리드 왼쪽 경계에 지정한 컬럼이 위치한다.
*
* @param column - 컬럼의 이름 또는 index
*
* @example
* ```js
* gridView.setLeftCol(10);
* ```
*/
setLeftCol(column: string | number): void;
/**
* 그리드가 위치한 div를 반환한다.
*
* @example
* ```js
* let gridContainer = gridView.getContainer;
* ```
*/
getContainer(): HTMLDivElement;
/**
* 편집이 완료된 후 화면이 다시 그려질때 셀의 편집기를 갱신한다.
*
* @remarks
* 셀의 값에 따라 편집기의 속성을 바꾸는 경우 사용한다.
*
* @example
* ```js
* gridView.onCellEdited =function (grid, dataRow, itemIndex, fieldIndex) {
* if (fieldIndex === 3) {
* const val = grid.getValue(itemIndex, fieldIndex);
* if (val === "1") {
* grid.columnByName("columnName").editor = {type:"dropdown", textReadOnly: true}
* } else {
* grid.columnByName("columnName").editor = {type:"dropdown", textReadOnly: false}
* }
* grid.requestPrepareEditor();
* }
* }
* ```
*/
requestPrepareEditor(): void;
/**
* 그리드를 해제한다.
*
* @example
* ```js
* gridView.destroy();
* ```
*/
destroy(): any;
/**
* 화면에 보여지고 있는 아이템중 일부만 보이는 행을 제외한 갯수를 반환한다.
*
* @remarks
* 현재 화면에 `10`개의 행이 보여지고 있지만 마지막행이 일부만 보이는 경우 `9`를 반환한다.
*
* @example
* ```js
* let totalCount = gridView.fullItemCount();
* ```
*/
fullItemCount(): number;
/**
* 그리드에 연결되어 있는 datasource를 이전 상태로 되돌린다.
*
* @example
* ```js
* gridView.undo();
* ```
*/
undo(): boolean;
/**
* 그리드에 연결되어 있는 datasource를 undo했을 때, 다시 수정 후 상태로 되돌린다.
*
* @example
* ```js
* gridView.redo();
* ```
*/
redo(): boolean;
/**
* Command Stack 을 초기화한다.
*
* @param all - ?
*
* @example
* ```js
* gridView.clearCommandStack();
* ```
*/
clearCommandStack(all?: boolean): void;
}
/**
* @remarks
* 그리드의 셀 관련 모델의 기반 클래스
*
* [하위 클래스]
*
* {@link StyledCell}
*
* {@link ValueCell}
*
* - {@link DataCell}
*/
export declare interface GridCell {
/**
* 셀의 위치정보
*
* @remarks
* {@link CellIndex} 와는 다르게 proxy처리되지 않은 내부 객체가 그대로 전달된다.
*/
index?: CellIndex;
/**
* 셀이 위치한 아이템의 정보 모델
*/
item?: GridItem;
/**
* 셀이 참조하는 Column정보
*/
valueColumn?: ValueColumn;
/**
* 셀이 참조하는 DataColumn정보
*/
dataColumn?: DataColumn;
/**
* 화면에 표시되는 text
*
* @remarks
* 그리드 body영역을 제외한 나머지 셀에 표시되는 text
*/
text?: string;
/**
* 참조하고 있는 data
*
* @remarks
* 그리드 body영역에 위치한 셀의 value
*
*/
value?: any;
/**
* RowGroup관련 셀인 경우 참조하고 있는 item의 level
* @defaultValue `0`
*/
level?: number;
}
/**
* @public
*
* 그리드의 셀 종류
*
* @remarks
* {@link ClickData} 등에서 사용된다.
*
* @example
* ```js
* gridView.onMenuItemClicked = function (grid, item, clickData) {
* console.log(item.label + "was clicked.");
* console.log("cellType is: " + clickData.cellType);
* };
* ```
*/
export declare enum GridCellType {
/**
* 데이터
*/
DATA = "data",
/**
* 헤더
*/
HEADER = "header",
/**
* 푸터
*/
FOOTER = "footer",
/**
* Summary
*/
SUMMARY = "summary",
/**
* 인디케이터
*/
INDICATOR = "indicator",
/**
* 상태 바
*/
STATE = "state",
/**
* 체크 바
*/
CHECK = "check",
/**
* head
*/
HEAD = "head",
/**
* foot
*/
FOOT = "foot",
/**
* sum
*/
SUM = "sum",
/**
* 고정 바
*/
FIXED_BAR = "fixedbar",
/**
* 그룹 헤더
*/
GROUP_HEADER = "groupHeader",
/**
* 그룹 푸터
*/
GROUP_FOOTER = "groupFooter",
/**
* 그룹 바
*/
GROUP_BAR = "groupBar",
/**
* group head
*/
GROUP_HEAD = "groupHead",
/**
* group foot
*/
GROUP_FOOT = "groupFoot",
/**
* 그룹 패널
*/
GROUP_PANEL = "groupPanel",
/**
* 그룹 컬럼
*/
GROUP_COLUMN = "groupColumn",
/**
* 빈 그리드
*/
GRID_EMPTY = "gridEmpty",
/**
* Column Group의 Header
*/
LAYOUT_HEADER = "layoutHeader",
/**
* filter rowIndicator영역
*/
FILTER = "filter",
/**
* inline-filter body영역
*/
INLINE_FILTER = "inlineFilter",
/**
* 스크롤바 영역
*/
SCROLL_BAR = "scrollBar",
/**
* 스크롤바의 track영역
*/
SCROLL_TRACK = "scrollTrack",
/**
* 스크롤바의 thumb영역
*/
SCROLL_THUMB = "scrollThumb",
/**
* 스크롤바의 버튼
*/
SCROLL_BUTTON = "scrollButton",
/**
* 스크롤바 오른쪽 하단
*/
SCROLL_EDGE = "scrollEdge"
}
/**
* @public
* 컬럼 정보 모델
*
* @remarks
* 실질적으로 GridColumn의 자손 클래스인 {@link DataColumn} 또는 {@link SeriesColumn} 이 사용된다.
*
* [하위 클래스]
*
* {@link ValueColumn}
*
* - {@link DataColumn}
*
* - {@link SeriesColumn}
*/
export declare interface GridColumn {
/**
* 컬럼 이름
*/
name?: string;
/**
* 컬럼 표시 여부
*
* @remarks
* `false` 이면 연결된 layout의 visible이 `true` 여도 표시되지 않는다.
* 즉, layout과 컬럼의 visible이 모두 `true` 여야 한다.
*/
visible?: boolean;
/**
* 컬럼 너비
*/
width?: number;
/**
* 컬럼 그룹 내 너비
*
* @remarks
* 비율로 지정된다.
*
* @defaultValue `NaN`
*/
fillWidth?: number;
/**
* 컬럼 너비 조절 가능 여부
*
* @defaultValue `true`
*/
resizable?: boolean;
/**
* 컬럼 이동 가능 여부
*
* @defaultValue `true`
*/
movable?: boolean;
/**
* 체크 여부
*
* @remarks
*
* {@link ColumnHeader.checkLocation | column.header.checkLocation}이 `none`이 아닌경우 체크상태가 화면에 표시된다.
*/
checked?: boolean;
/**
* indeterminate 상태여부
*/
indeterminate?: boolean;
/**
* 컬럼 헤더
*/
header?: ColumnHeader;
/**
* 컬럼 푸터 컬렉션 오브젝트
*
*/
footers?: ColumnFooterCollection;
/**
* 컬럼 푸터 설정
*
* @remarks
* footer가 여러줄인경우 스타일과 expression등을 설정한다.
*
* @param footers - 푸터 설정정보 배열
*
* @example
* ```js
* gridView.setFooters([{styleName:"footer-style1"}, {styleName:"footer-style2"}]);
* gridView.columnByName("column").setFooters([
* {styleName:"footer-cell-style1", expression: "sum"},
* {styleName:"footer-cell-style2", expression: "max"}
* ]);
* ```
*/
setFooters?(footers: any[]): void;
/**
* 컬럼 푸터 (여러 개 있을 경우 첫 번째 아이템)
*/
footer?: ColumnFooter;
/**
* 헤더 Summary 컬렉션 오브젝트.
*
*/
headerSummaries?: ColumnHeaderSummaryCollection;
/**
* 컬럼 HeaderSummary 설정
*
* @remarks
* headerSummary가 여러줄인 경우 스타일과 expression등을 설정한다.
*
* @param summaries - headerSummary 설정정보 배열
*
* @example
* ```js
* gridView.setHeaderSummaries([{styleName:"summary-style1"}, {styleName:"summary-style2"}]);
* gridView.columnByName("column").setHeaderSummaries([
* {styleName:"summary-cell-style1", expression: "sum"},
* {styleName:"summary-cell-style2", expression: "max"}
* ]);
* ```
*/
setHeaderSummaries?(summaries: any[]): void;
/**
* 헤더 Summary (여러 개일 경우 첫 번째 아이템)
*/
headerSummary?: ColumnHeaderSummary;
/**
* 그룹 푸터 컬렉션 오브젝트.
*/
groupFooters?: ColumnFooterCollection;
/**
* 컬럼 groupFooter 설정
*
* @remarks
* groupFooter가 여러줄인 경우 스타일과 expression등을 설정한다.
*
* @param footers - footer 설정정보 배열
*
* @example
* ```js
* gridView.rowGroup.setFooters([{styleName:"footer-style1"}, {styleName:"footer-style2"}]);
* gridView.columnByName("column").setGroupFooters([
* {styleName:"footer-cell-style1", expression: "sum"},
* {styleName:"footer-cell-style2", expression: "max"}
* ]);
* ```
*/
setGroupFooters?(footers: ColumnSummary[]): void;
/**
* 그룹 푸터 (여러 개일 경우 첫번째 아이템)
*/
groupFooter?: ColumnSummary;
/**
* 순서
* @readonly
*/
index?: number;
/**
* 컬럼이 속한 컬럼그룹내에서 컬럼의 표시 텍스트
* @remarks
* 읽기만 가능한 값이다.
* @readonly
*/
displayText?: string;
/**
* 컬럼이 속한 컬럼그룹내에서 컬럼의 표시 너비
* @remarks
* 읽기만 가능한 값이다.
* @readonly
*/
displayWidth?: number;
/**
* 컬럼이 속한 컬럼그룹내에서 컬럼의 표시 순서를 나타낸다.
* @remarks
* 읽기만 가능한 값이다.
* @readonly
*/
displayIndex?: number;
/**
* 레이아웃 아이템 객체
*
* @remarks
* 속성으로 접근하여 설정할 수 있다.
*
* @example
* ```js
* column.layout.spanCallback = function (grid, layout, itemIndex) {
* var value = grid.getValue(itemIndex, layout.column.name);
* if (value) {
* return value[0] === "B" ? 2 : value[0] === "F" ? 3 : 1;
* }
* };
* ```
*/
layout?: CellLayoutColumnItem;
/**
* 컬럼 푸터를 가져온다.
*
* @param index - 순번
*/
getFooter?(index: number): ColumnFooter;
/**
* 컬럼 headerSummary를 가져온다.
* @param index - 순번
*/
getHeaderSummary?(index: number): ColumnHeaderSummary;
}
/**
* 그리드 내보내기에 관한 설정 모델
*
* @remarks
* {@link ExportOptions} 를 상속한다.
*
* [상위 클래스]
*
* {@link ExportOptions}
*/
export declare interface GridExportOptions extends ExportOptions {
/**
* 내보내기 시 엑셀 문서의 제목
*/
documentTitle?: DocumentTitle;
/**
* 내보내기 시 엑셀 문서의 부제목
*/
documentSubtitle?: DocumentTitle;
/**
* 내보내기 시 엑셀 문서의 꼬릿말
*/
documentTail?: DocumentTitle;
/**
* 컬럼 그룹을 해제하고 엑셀로 내보내기 할 것인지의 여부
*
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
linear?: boolean;
/**
* 숨겨진 컬럼들도 엑셀로 내보내기 할 것인지의 여부
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
allColumns?: boolean;
/**
* 숨겨진 행들도 엑셀로 내보내기 할 것인지의 여부
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
*
* @defaultValue `true`
*/
allItems?: boolean;
/**
* 체크한 행들만 엑셀로 내보내기 할 것인지의 여부
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @remarks
* 그룹핑 된 행이나 {@link TreeView} 에서는 지원하지 않는다.
*
* @defaultValue `false`
*/
onlyCheckedItems?: boolean;
/**
* 엑셀로 내보내기 시 페이징되어 보이지 않는 데이터를 포함한 모든 데이터를 내보내기 할 것인지의 여부
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
pagingAllItems?: boolean;
/**
* 그리드 인디케이터 영역을 포함시킬 것인지의 여부
*
* @remarks
* `'default'` 일 때는 현재 그리드에 표시된 상태에 따라 포함, `'hidden'` 이면 포함 안함, `'visible'` 이면 포함한다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `'default'`
*
*/
indicator?: string;
/**
* 그리드 체크바 영역을 포함시킬 것인지의 여부
*
* @remarks
* `'default'` 일 때는 현재 그리드에 표시된 상태에 따라 포함, `'hidden'` 이면 포함 안함, `'visible'` 이면 포함한다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `'default'`
*
*/
checkBar?: string;
/**
* 그리드 헤더 영역을 포함시킬 것인지의 여부
*
* @remarks
* `'default'` 일 때는 현재 그리드에 표시된 상태에 따라 포함, `'hidden'` 이면 포함 안함, `'visible'` 이면 포함한다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `'default'`
*
*/
header?: string;
/**
* 그리드 푸터 영역을 포함시킬 것인지의 여부
*
* @remarks
* `'default'` 일 때는 현재 그리드에 표시된 상태에 따라 포함, `'hidden'` 이면 포함 안함, `'visible'` 이면 포함한다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `'default'`
*
*/
footer?: string;
/**
* 그리드 Header Summary 영역을 포함시킬 것인지의 여부
*
* @remarks
* `'default'` 일 때는 현재 그리드에 표시된 상태에 따라 포함, `'hidden'` 이면 포함 안함, `'visible'` 이면 포함한다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `'default'`
*/
headerSummary?: string;
/**
* 그리드 인디케이터 영역을 내보내기 했을 때, 해당 영역의 값의 표시 방법
*
* @remarks
* `'default'` 일 때는 현재 그리드에 표시된 상태에 따라, `'row'` 이면 행의 고유번호로, `'item'` 이면 1부터 시작하여 표시한다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `'default'`
*/
indicatorValue?: string;
/**
* 그리드 체크바 영역을 내보내기 했을 때, 선택 값의 표시 방법
*
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `'v'`
*/
checkMark?: string;
/**
* 그리드 체크바 영역을 내보내기 했을 때, 선택 해제된 값의 표시 방법
*
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `''`
*/
unCheckMark?: string;
/**
* 행 그룹핑 및 트리 그리드 자료를 내보내기 시 들여쓰기 여부
*
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `true`
*/
indenting?: boolean;
/**
* 엑셀 내보내기 시 병합 해제 여부
*
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
separateRows?: boolean;
/**
* 그리드가 행병합 그룹핑 상태이면서 {@link GridExportOptions.separateRows}가 `true`일때 GroupFooter또는 GroupSummary셀의 값 출력여부
*
* @defaultValue `false`
*/
fillMergeFooterValue?: boolean;
/**
* 컬럼의 lookupDisplay 값을 표시된 값으로의 내보내기 여부
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
lookupDisplay?: boolean;
/**
* 행 그룹핑 된 자료를 내보내기 시 엑셀 왼쪽에 위치한 그룹간 묶음선 표시여부
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
showLevelOutline?: boolean;
/**
* {@link GridFitStyle} 로 적용된 너비로 내보내기 여부
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*
*/
applyFitStyle?: boolean;
/**
* Dynamic Styles 을 적용하여 내보내기 것인지의 여부
*
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
applyDynamicStyles?: boolean;
/**
* fixed된 컬럼 또는 row가 있는 경우 틀고정 여부
*
* @remarks
* fixed Column 또는 fixed Row가 있으면 엑셀로 내보내기 할때 `틀고정`을 설정한다.
*
* @defaultValue `false`
*/
applyFixed?: boolean;
/**
* expandable이 설정된 컬럼을 export할때 expand여부
*
* @remarks
* 화면의 expand상태에 상관없이 접거나 펼친 상태로 export할때 설정한다.
*
* @defaultValue `ignore`
*/
layoutExpand?: ExportLayoutExpand | string;
/**
* 엑셀 sheet 명
*
* @remarks
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*/
sheetName?: string;
/**
* {@link SeriesColumn | 시리즈}컬럼을 내보내기 할 것인지의 여부
*
* @remarks
* `true`로 지정하면 `sparkLine`, `sparkColumn`, `sparkWinLoss` 컬럼들이 내보내기 된다.
*
* 스파크 컬럼들이 참조하고 있는 {@link DataColumn}들을 반드시 포함하여 내보내기 해야하며 `DataColumn`의 `name` 속성은 반드시 지정되어 있어야 한다.
*
* 또한 `DataColumn`은 참조한 순서대로 표시되어 있어야 한다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*
*/
exportSeriesColumn?: boolean;
/**
* 엑셀로 내보내기 하고자 하는 컬럼의 배열
*
* @remarks
* `visible`이 `false`이지만 내보내기를 하고 싶은 컬럼을 지정한다.
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*/
showColumns?: string[];
/**
* 엑셀로 내보내기 안하고자 하는 컬럼을 배열
*
* @remarks
* `visible`이 `true`이지만 내보내기를 하고 싶지 않은 컬럼을 지정한다.
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*/
hideColumns?: string[];
/**
*
* 엑셀의 hidden Column
*
* @remarks
* 엑셀로 export되었을때 hidden상태로 내보내기 되는 컬럼을 지정한다.
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*/
hiddenColumns?: string[];
/**
* LinkCellRenderer의 url을 내보내기 할것인지 여부
* @remarks
* `true`로 지정하면 url의 HYPERLINK로 내보내기 한다.
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
exportLink?: boolean;
/**
* TemplateCellRenderer를 내보내기 할것인지 여부
*
* @remarks
* `true`로 지정하면 TemplateCellRenderer가 renderering한 HTML에서 Tag를 제거한 문자열을 내보내기 한다.
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*
* @defaultValue `false`
*/
exportTemplate?: boolean;
/**
* 엑셀로 내보내기 하려는 모양이 화면과 다를때 사용하는 layout
*
* @remarks
* 원하는 layout을 지정하여 excel로 내보내기 한다.
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*/
exportLayout?: ConfigObject[];
/**
* 내보내기를 할 그리드의 GridBase 컨트롤과 내보내기의 대상이 되는 엑셀 sheet 의 이름
*
* @remarks
* 지정하지 않으면 메소드를 호출한 그리드 인스턴스가 GridBase 컨트롤로 지정되어 `'sheet1'` 에 내보내기된다.
*
* {@link ExportBaseOptions."type" | 내보내기 종류}가 {@link ExportType.EXCEL | 엑셀}일 때만 사용 가능하다.
*/
exportGrids?: {
grid: GridBase;
sheetName: string;
}[];
/**
* 왼쪽 여백컬럼의 수를 지정한다.
*
* @remarks
* 그리드를 출력할때 지정된 컬럼수 이후부터 출력한다.
*/
xOffset?: number;
/**
* 왼쪽 여백컬럼의 너비를 지정한다.
*
* @remarks
* pixel단위로 지정한다.
*
* @defaultValue `100`
*/
xOffsetWidth?: number;
/**
* 위쪽 여백행의 수를 지정한다.
*
* @remarks
* 그리드를 출력할때 지정된 행수 이후부터 출력한다.
*/
yOffset?: number;
/**
* 엑셀로 내보내기 할때 sheet에 추가할 attribute
*
* @remarks
* json 형식으로 입력된 값을 sheetView element의 attribute로 추가한다.
*
* @example
* ```js
* var sheetAttrs = {
* showGridLines: "0", // 눈금선 감추기
* view: "pageBreakPreview" // 페이지 나누기 미리 보기
* }
* gridView.exportGrid({type:"excel", target:"local", sheetAttrs:sheetAttrs})
* ```
*/
sheetAttrs?: ConfigObject;
/**
* 엑셀로 내보내기 할때 스타일 찾기위한 접두어가 있는 경우 사용
*
* @remarks
* 제공된 스타일에 영역을 제한하기 위한 className이 있는 경우 사용한다.
*/
stylePrefix?: string;
/**
* excel로 export할때 image 포함 여부
*
* @remarks
* `true`이면 imageRenderer, iconRenderer를 이용해서 표시한 image를 excel에 포함한다.
* displayOptions.rowHeight가 -1인경우 셀의 상단에 표시.
* IE의 경우 Promise 관련 polyFill을 추가해야 한다.
*
* @defaultValue `false`
*/
exportImage?: boolean;
/**
* excel로 export할때 ActualTargetBullt 렌더러와 Bar렌더러의 도형 포함 여부
*
* @remarks
* `true`면 ActualTargetBullt 렌더러와 Bar렌더러를 내보낼 때, 도형으로 내보낸다.
*
* @defaultValue `false`
*/
exportShape?: boolean;
/**
* excel에 포함시킬 이미지를 download할때 하나씩 다운로드하거나 일괄 다운로드 한다.
*
* @remarks
* `true`이면 일괄 다운로드하고 `false`이면 하나씩 다운로드 한다.
*
* @defaultValue `true`
*/
bulkImageDownload?: boolean;
/**
* 사용자 지정 출력
*
* @remarks
* export되는 엑셀파일에 그리드 이외의 내용을 출력할때 사용한다.
*
* 그리드가 출력하는 영역은 사용을 자제해야한다.
*
* @defaultValue `undefined`
*/
userCells?: UserExportCell[];
/**
* 사용자 출력셀을 만들기 위해 호출되는 callback userCells가 지정되어있으면 callback은 무시된다.
*
* @remarks
* 출력되는 column과 row의 갯수를 참조해서 cell의 위치를 변경할때 사용한다.
*
* @defaultValue `undefined`
*/
userCellsCallback?: UserCellsCallback;
/**
* 잠긴 셀의 내용과 워크시트 보호
*
* @remarks
* 다른 사용자가 잠긴 셀을 수정하지 못하도록 시트 보호를 설정한다.
*/
sheetProtect?: boolean;
/**
* 시트 보호를 사용할때 해제 암호를 입력한다.
*
* @remarks
* 영문/숫자/특수문자만 입력해야한다. 한글을 입력하는 경우 시트보호를 해제할수 없다.
*/
protectPassword?: string;
/**
* 시트 보호를 사용할때 허용하거나 잠글 속성을 지정한다.
*/
protectProperties?: SheetProtectProperties;
}
/**
* @public
*
* 컬럼들의 표시 방식을 조정하는 상수
*
* @remarks
* {@link DisplayOptions.fitStyle} 등에서 쓰인다.
*
* @example
*
* ```js
* grid.displayOptions.fitStyle = 'even'
* ```
*/
export declare enum GridFitStyle {
/**
* 조정하지 않고 컬럼 너비대로 표시
*/
NONE = "none",
/**
* 표시한 컬럼들의 전체 너비가 그리드 너비보다 작을 경우 비율에 맞춰 남는 크기를 분배
*/
EVEN = "even",
/**
* 항상 그리드 너비에 맞게 늘리거나 축소 (컬럼의 width를 이용)
*/
EVEN_FILL = "evenFill",
/**
* fillWidth가 설정되었다면 이를 이용하여, 그렇지 않다면 even과 동일한 방식으로 그리드를 채움
*/
FILL = "fill"
}
declare class GridFootCellElement extends SectionCellElement {
constructor(doc: Document);
}
/**
* @public
*
* 푸터 영역의 단일 설정 모델
*
* @remarks
*
* 그리드는 별도의 설정이 없는 경우 하나의 푸터를 자동으로 생성하고 {@link GridBase.footer}는 첫번째 푸터를 반환한다..
*
* {@link GridBase.setFooter | setFooter()}를 이용해서 속성을 변경하거나 또는 {@link GridBase.footer}를 이용해서 원하는 속성만 지정한다.
*
* @example
*
* ```js
* gridView.setFooter({styleName: 'custom-footer'});
* // 또는
* gridView.footer.styleName = 'custom-footer';
* ```
*/
export declare interface GridFooter extends GridSummaryObject {
/**
* 스타일 클래스 이름
*/
styleName?: string;
/**
* 최소 높이
*
* @defaultValue `23`
*/
minHeight?: number;
/**
* 높이
*
* @remarks
* `0`이면 자동으로 계산하여 지정한다. `0` 이상이면 minHeight와 비교하여 더 큰 값으로 지정한다.
*
* @defaultValue `0`
*/
height?: number;
/**
* 여러행으로 구성된 footer Row의 TR별 높이를 배열로 지정한다.
*
* @remarks
* heights가 지정되면 height는 무시된다.
*/
heights?: number[];
/**
* 셀 스타일을 지정하기 위한 콜백
* @eventProperty
*
* @remarks
* `string` 형태의 css 클래스 명 또는 {@link ColumnSummaryStyleObject} 형태로 지정가능하다.
*
* @example
* ```js
* // 푸터 적용
* const f = function (grid, cell) {
* if (cell.value > 10) {
* return {
* styleName: 'custom-footer'
* }
* }
* }
* footer.cellStyleCallback = f;
* ```
*
*/
cellStyleCallback?: CellStyleCallback;
/**
* 표시 여부
*/
visible?: boolean;
/**
* 푸터의 콜렉션 내에서의 순서
*
* @readonly
*/
footerIndex?: number;
/**
* valueCallback 또는 expression에서 계산된 값을 보관한다.
*
* @readonly
*/
value?: any;
}
/**
* @public
*
* 그리드 푸터 영역에 관한 콜렉션 모델
*
* @remarks
*
* 그리드의 footer를 표시하거나 여러개의 푸터를 생성하고 관리한다.
*
* {@link GridBase.footers} 에서 반환되는 객체이다.
*
* @example
* ```js
* // object
* gridView.setFooters({
* visible: true,
* items:[
* {
* styleName: 'custom-footer-1'
* }, {
* styleName: 'custom-footer-2'
* }
* ]
* })
* // 또는 array형태로 지정
* gridView.setFooters([
* {
* styleName: 'custom-footer-1'
* }, {
* styleName: 'custom-footer-2'
* }
* ])
* ```
*/
export declare interface GridFooterCollection {
/**
* 표시여부
*
* @defaultValue `true`
*/
visible?: boolean;
/**
* 현재 설정된 footer의 갯수를 반환한다.
*
* @readonly
*/
readonly count?: number;
/**
* 현재 설정된 footer중 visible이 `true`인 footer의 갯수를 반환한다.
*
* @readonly
*/
readonly visibleCount?: number;
/**
* gridFooter를 설정한다.
*/
items?: GridFooter[];
/**
* 해당하는 인덱스의 푸터를 반환한다.
*
* @remarks
* {@link GridFooter}를 반환한다.
*
* @param index - footer의 index
*/
get?(index: number): GridFooter;
/**
* 보여지는 순서에 해당하는 푸터를 가져온다.
*
* @remarks
* {@link GridFooter}를 반환한다.
*
* @param index - 보여지는 순서 `0`부터 시작한다.
*/
getVisible?(index: number): GridFooter;
}
/**
* 헤더 영역의 설정 모델
*
* @remarks
* {@link GridBase.setHeader} 사용시 필요한 정보만 입력하면 된다.
*
* @example
*
* ```js
* gridView.setHeader({sortable = false});
* ```
*/
export declare interface GridHeader {
/**
* 헤더 행의 최소 높이
*
* @defaultValue `21`
*/
minRowHeight?: number;
/**
* 헤더의 최소 높이
*
* @defaultValue `23`
*/
minHeight?: number;
/**
* 헤더의 높이
*
* @remarks
* 1. `0`: 기본 스타일로 tr의 높이를 계산해서 지정(table row의 최소 높이가 됨),
* 전체 헤더 높이가 커지면 row들이 다 표시되도록 element container의 높이를 보정한다.
*
* 2. `0` 초과: 지정한 높이로 전체 높이를 설정, tr 높이는 minRowHeight 높이로 설정한다.
* container 높이가 tr들의 높이합보다 큰 경우 배분한다.
* container 높이를 보정하지 않는다.
*
* 3. `0` 미만: 브라우저가 계산한 높이
*
* heights 속성에 각 table row의 높이를 지정할 수 있다.
*
* 전체 높이가 minHeight보다 작을 수 없다.
*
* 개별 tr의 높이는 minRowHeight보다 작을 수 없다.
*
* @defaultValue `0`
*
*/
height?: number;
/**
* 헤더가 여러줄일때 각행의 높이
*
* @remarks
* 각 table row의 높이를 지정한다.
*
* @example
*
* ```js
* gridView.header.heights = [50, 30, 30]
* ```
*/
heights?: number[];
/**
* 높이 변경 가능 여부
*
* @remarks
* 사용자가 헤더 왼쪽 셀의 위쪽을 마우스 드래깅해서 헤더의 높이를 변경하게 할 것인지의 여부
*
* @defaultValue `false`
*/
resizable?: boolean;
/**
* 헤더 테두리와 체크박스나 이미지와의 간격
*
* @defaultValue `2`
*/
itemOffset?: number;
/**
* 텍스트와 체크박스나 이미지와의 간격
*
* @defaultValue `2`
*/
itemGap?: number;
/**
* 툴팁 표시 여부
*
* @remarks
* 값이 `undefined`인경우 {@link ColumnHeader.showTooltip}이 `true`인 컬럼의 `tooltip`만 표시된다.
*
* @defaultValue `false`
*/
showTooltip?: boolean;
/**
* ellipsis상태인 셀의 툴팁 표시여부
*
* @defaultValue `false`
*/
tooltipEllipsisOnly?: boolean;
/**
* 선택 영역 표시 여부
*
* @remarks
* `true` 시 데이터 선택 영역에 맞춰 관련된 셀들에 선택 영역을 지정한다.
*
* @defaultValue `false`
*/
showSelection?: boolean;
/**
* 헤더의 정렬 {@link HandleVisibility | 핸들} 너비
*
* @defaultValue `16`
*/
sortWidth?: number;
/**
* 헤더의 정렬 {@link HandleVisibility | 핸들} 높이
*
* @defaultValue `16`
*/
sortHeight?: number;
/**
* 헤더의 필터 {@link HandleVisibility | 핸들} 너비
*
* @defaultValue `16`
*/
filterWidth?: number;
/**
* 헤더의 필터 {@link HandleVisibility | 핸들} 높이
*
* @defaultValue `16`
*/
filterHeight?: number;
/**
* 헤더의 팝업 메뉴 {@link HandleVisibility | 핸들} 너비
*
* @defaultValue `16`
*/
popupWidth?: number;
/**
* 헤더의 팝업 메뉴 {@link HandleVisibility | 핸들} 높이
*
* @defaultValue `16`
*/
popupHeight?: number;
/**
* 헤더에 popupMenuName이 설정된 경우 팝업 메뉴 핸들을 표시한다.
* @defaultValue {@link HandleVisibility.VISIBLE}
*/
showPopupMenu?: HandleVisibility;
/**
* 헤더의 체크 박스 너비
*
* @defaultValue `16`
*/
checkWidth?: number;
/**
* 헤더의 체크 박스 높이
*
* @defaultValue `16`
*/
checkHeight?: number;
/**
* 표시 여부
*/
visible?: boolean;
/**
* 스타일 명
*/
styleName?: string;
/**
* excel로 export될때 적용될 스타일 명
*/
exportStyleName?: string;
}
/**
* 아이템의 정보 모델
*
* @remarks
* {@link GridBase.getModel}, {@link GridBase.getModelAs} 등으로 아이템의 모델을 반환할 때의 형식이다.
*
* 아이템의 모델을 반환 할 때, 해당 method 에 `extended` 매개변수가 `true` 냐 `false` 냐에 따라 반환되는 모델의 형식이 다를 수 있다.
*
* @example
* ```js
* let model = gridView.getModelAs(3, 'row'); // GridItem 모델 반환
* ```
*/
export declare interface GridItem {
/**
* 종류
*/
type: undefined | 'row' | 'group' | 'tree' | 'footer';
/**
* 아이템 id
*/
id: number;
/**
* 부모의 id
*/
parentId?: number;
/**
* 그리드 상에서의 순서
*/
index: number;
/**
* 그리드 상에서의 순서
*
* @remarks
* RealGridJS와 호환성을 위해서 남겨둔 속성
*/
itemIndex?: number;
/**
* 행 고유번호
*/
dataRow: number;
/**
* 체크 여부
*/
checked: boolean;
/**
* indeterminate상태 여부
*/
indeterminate: boolean;
/**
* 선택가능 여부
*/
checkable: boolean;
/**
* 하위 아이템의 개수
*/
count?: number;
/**
* 펼쳐짐 여부
*
* @remarks
* {@link TreeView} 의 아이템일나 그룹 아이템일 때 해당 정보를 얻을 수 있다.
*/
expanded?: boolean;
/**
* 푸터 id
*/
footerId?: number;
/**
* 자신의 부모를 기준으로한 자신의 순서
*
* @remarks
* `extended` 가 `true` 여야 정보를 얻을 수 있다.
*/
childIndex?: number;
/**
* 수준
*
* @remarks
* {@link TreeView} 의 행이라면 트리의 수준이다.
*
* `extended` 가 `true` 여야 정보를 얻을 수 있다.
*/
level?: number;
/**
* 그룹아이템일 경우 처음 아이템
*
* @remarks
* `extended` 가 `true` 여야 정보를 얻을 수 있다.
*/
firstItem?: GridItem;
/**
* 그룹아이템일 경우 처음 데이터 아이템
*
* @remarks
* `extended` 가 `true` 여야 정보를 얻을 수 있다.
*/
firstDataItem?: GridItem;
/**
* 그룹아이템일 경우 하위 행들의 인덱스
*
* @remarks
* `extended` 가 `true` 여야 정보를 얻을 수 있다.
*/
dataRows?: number[];
/**
* 행의 상태값
*/
rowState?: RowState;
/**
* type이 "row" 또는 "tree" 인 경우 입력된 field의 값을 가져온다.
*/
getData?: (field: string | number) => any;
}
/**
* 그리드의 전체 설정 정보들
*
* @remarks
* {@link GridBase.getOptions} 시 하위 구성 요소를 재설정하는 것이 불가능하다.
*
* {@link GridBase.setOptions} 시 하위 구성 요소를 재설정하는 것이 가능하다.
*
* 실질적인 사용은 {@link GridView}, {@link TreeView} 에서 한다.
*
* @example
* ```js
* let options = {
* summaryMode: 'aggregate',
* display: {
* columnResizable : false
* }
* };
* gridView.setOptions(options);
* ```
*/
export declare interface GridOptions {
summaryMode?: SummaryMode;
fixed?: FixedOptions;
display?: DisplayOptions;
format?: FormatOptions;
edit?: EditOptions;
editor?: EditorOptions;
copy?: CopyOptions;
paste?: PasteOptions;
sorting?: SortingOptions;
filtering?: FilteringOptions;
dataDrop?: DataDropOptions;
rowIndicator?: RowIndicator;
checkBar?: CheckBar;
stateBar?: StateBar;
header?: GridHeader;
footer?: GridFooter;
footers?: GridFooterCollection;
headerSummary?: HeaderSummary;
headerSummaries?: HeaderSummaryCollection;
filterPanel?: FilterPanel;
/**
*
*/
hideDeletedRows?: boolean;
/**
*
*/
sortMode?: SortMode;
filterMode?: FilterMode;
mobile?: MobileOptions;
}
declare interface GridSummarizer {
getCount(field: number): number;
getSum(field: number): number;
getMax(field: number): number;
getMin(field: number): number;
getAvg(field: number): number;
getVar(field: number): number;
getVarp(field: number): number;
getStdev(field: number): number;
getStdevp(field: number): number;
getDataAvg(field: number): number;
getDataCount(field: number): number;
}
/**
*
*/
declare interface GridSummaryObject {
}
/**
* @public
* GridView 클래스, {@link GridBase} 의 자식 클래스이다.
*
* @remarks
* [상위 클래스]
*
* {@link GridBase}
*/
export declare class GridView extends GridBase {
/**
* 그리드에 설정되어 있는 행 그룹 모델
*
* @remarks
* {@link RowGroup} 객체를 반환한다.
* RowGroup 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.rowGroup.mergeMode = true;
* ```
*/
get rowGroup(): RowGroup;
/**
* 그리드에 설정되어 있는 Group Panel 모델
*
* @remarks
* {@link GroupPanel} 객체를 반환한다.
* GroupPanel 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.groupPanel.visible = true;
* ```
*/
get groupPanel(): GroupPanel;
/**
* 데이터 수정 이후 필터의 동작 모드
*
* @remarks
* `'explicit'` 을 사용하면 필터링 된 데이터가 수정되었을 때 명시적으로 필터링을 수행해야 필터링이 된다.
*
* @example
* ```js
* gridView.filterMode = 'explicit';
* ```
*/
get filterMode(): FilterMode;
set filterMode(value: FilterMode);
/**
* 컬럼 간 필터 조건을 or 로 할 것인지의 여부
*
* @remarks
* `true` 로 지정하면 각 컬럼의 필터간 필터링이 or 조건으로 반영되어 표시된다.
*
* @example
* ```js
* gridView.filterOr = true;
* ```
*/
get filterOr(): boolean;
set filterOr(value: boolean);
/**
* 행 그룹핑된 컬럼의 합계를 계산하는 방식
*
* @remarks
* 값 할당으로 변경할 수 있다.
* {@link SummaryMode} 의 값으로 설정한다.
*
* @example
* ```js
* gridView.groupSummaryMode = 'aggregate';
* ```
*/
get groupSummaryMode(): SummaryMode;
set groupSummaryMode(value: SummaryMode);
/**
* 그리드에 설정되어 있는 행 그룹핑에 관한 설정 정보들
*
* @remarks
* {@link GroupingOptions} 객체를 반환한다.
* GroupingOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* gridView.groupingOptions.linear = true;
* ```
*/
get groupingOptions(): GroupingOptions;
/**
* @public
*
* 그리드에 연결되어 있는 DataProvider를 반환한다.
* @example
* ```js
* let ds = gridView.getDataSource();
* ```
*/
getDataSource(): LocalDataProvider;
/**
* 그리드가 Paging 상태일 때, 페이지 이동을 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `page` - 새로 이동하게 될 페이지 인덱스
*
* [반환값] - false를 반환하면 페이지 이동이 취소된다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onPageChanging = function(grid, page) {
* if(page % 2 === 0) {
* return true;
* }
* return false;
* };
* ```
*/
onPageChanging?: (grid: GridView, page: number) => boolean;
/**
* 그리드가 Paging 상태일 때, 다른 페이지로 이동했음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `page` - 새로 이동한 페이지 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onPageChanged = function(grid, page) {
* if(page % 2 === 0) {
* console.log('even number changed!')
* }
* };
* ```
*/
onPageChanged?: (grid: GridView, page: number) => void;
/**
* 그리드가 Paging 상태일 때, 변경된 페이지 수와 함께 다른 페이지로 이동했음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `pageCount` - 변경된 페이지 수
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onPageCountChanged = function(grid, pageCount) {
* console.log('pageCount: ' + pageCount);
* };
* ```
*/
onPageCountChanged?: (grid: GridView, pageCount: number) => void;
/**
* 그룹핑을 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `fields` - 그룹핑되는 필드의 인덱스들
*
* [반환값] - 그룹핑 실행 여부. false를 반환하면 그룹핑은 취소된다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onGrouping = function(grid, fields) {
* alert("onGrouping 이벤트가 발생했습니다. false를 반환합니다.");
* return false;
* };
* ```
*/
onGrouping?: (grid: GridView, fields: number[]) => boolean;
/**
* 그룹핑했음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onGrouped = function(grid) {
* console.log("I am Grouped!");
* };
* ```
*/
onGrouped?: (grid: GridView) => void;
/**
* 그룹핑 된 행 펼치기를 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `itemIndex` - 펼칠 그룹 아이템의 itemIndex
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onExpanding = function(grid, itemIndex) {
* if (itemIndex % 2 === 0) {
* return false;
* }
* };
* ```
*/
onExpanding?: (grid: GridView, itemIndex: number) => boolean;
/**
* 그룹핑 된 행이 펼쳐졌음을 알리는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `itemIndex` - 펼친 그룹 아이템의 id
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onExpanded = function(grid, itemIndex) {
* console.log('Expanded at: ' + itemIndex)
* };
* ```
*/
onExpanded?: (grid: GridView, itemIndex: number) => void;
/**
* 그룹핑 된 행 접기를 결정하는 콜백
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `itemIndex` - 접을 그룹 아이템의 itemIndex
*
* @eventProperty
* @example
* ```js
* gridView.onCollapsing = function(grid, itemIndex) {
* if (itemIndex % 2 === 0) {
* return false;
* }
* };
* ```
*/
onCollapsing?: (grid: GridView, itemIndex: number) => boolean;
/**
* 그룹핑 된 행이 접힘을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridView 컨트롤
*
* `itemIndex` - 접힌 그룹 아이템의 itemIndex
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* gridView.onCollapsed = function(grid, itemIndex) {
* console.log('Collapsed at: ' + itemIndex)
* };
* ```
*/
onCollapsed?: (grid: GridView, itemIndex: number) => void;
/**
* 그리드의 {@link RowGroup} 을 반환한다.
* @example
*
* ```js
* let rowGroup = gridView.getRowGroup();
* rowGroup.levelIndent = false;
* gridView.setRowGroup(rowGroup);
* ```
*/
getRowGroup(): RowGroup;
/**
* 그리드의 {@link RowGroup} 을 설정한다.
*
* @param value - {@link RowGroup} 모델과 같은 설정정보. 변경하고자 하는 속성만 전달하면 된다.
* @example
*
* ```js
* gridView.setRowGroup({levelIndent: false});
* ```
*/
setRowGroup(value: RowGroup | ConfigObject): void;
/**
* 그리드의 {@link GroupPanel} 을 반환한다.
*
* @example
* ```js
* let groupPanel = gridView.getGroupPanel();
* groupPanel.visible = false;
* gridView.setGroupPanel(groupPanel);
* ```
*/
getGroupPanel(): GroupPanel;
/**
* 그리드 {@link GroupPanel} 을 설정한다.
*
* @param value - {@link GroupPanel} 과 같은 정보. 변경하고자 하는 속성만 전달하면 된다.
*
* @example
*
* ```js
* gridView.setGroupPanel({visible: false});
* ```
*/
setGroupPanel(value: GroupPanel): void;
/**
* 그리드 옵션 정보를 반환한다.
*
* @remarks
* {@link GridBase.getOptions} 에 반환되는 모델에 grouping 속성이 추가되어 반환된다.
*
* @returns - {@link GridView.setOptions | setOptions()} 와 다르게 GridOptions 에서 선언된 그리드 수준의 정보만을 반환한다.
* @example
* ```js
* let options = gridView.getOptions();
* ```
*/
getOptions(): ViewOptions;
/**
* 그리드 옵션 정보를 재설정한다.
*
* @remarks
* 그리드 수준의 정보만을 반환하는 {@link GridView.getOptions | getOptions} 와 달리 이 method를 통해 하위 구성 요소 및 다른 실행 정보들을 동시에 재설정할 수 있다.
*
* @param options - 설정 정보. GridBase의 {@link GridBase.setOptions | setOptions()}의 value 와 동일한 모델에서 grouping 속성이 추가되었다.
*
* @example
* ```js
* let options = {
* summaryMode: 'aggregate',
* displayOptions: {
* columnResizable : false
* },
* grouping: {
* prompt: 'I am Groop'
* }
* };
* gridView.setOptions(options);
* ```
*/
setOptions(options: ViewOptions): void;
/**
* 그리드 행 그룹핑에 관한 설정 정보들을 반환한다.
*
* @returns -{@link GroupingOptions} 와 동일한 모델이다.
*
* @example
* ```js
* let groupingOpts = gridView.getGroupingOptions();
* groupingOpts.prompt = "I am Groop";
* gridView.setGroupingOptions(groupingOpts);
* ```
*/
getGroupingOptions(): GroupingOptions;
/**
* 그리드 행 그룹핑에 관한 설정을 한다.
*
* @param value - 설정하고자 하는 정보. {@link GroupingOptions} 와 동일한 모델이다.
*
* @example
*
* ```js
* gridView.setGroupingOptions({prompt: "I am Groop"});
* ```
*
*/
setGroupingOptions(value: GroupingOptions): void;
/**
* 지정한 필드 목록에 포함된 순서대로 또는 데이터 정렬 후 순서대로 행 그룹핑을 실행한다.
*
* @param fieldNames - 필드 이름 목록. 그룹을 해제하려는 경우 빈 배열을 입력해야 한다.
* @param sorting - 정렬 여부
* @param sortDirs - 정렬 방식
*
* @example
* ```js
* // 그룹 설정
* gridView.groupBy(["field1", "field2"]);
*
* // 그룹 해제
* gridView.groupBy([]);
* ```
*/
groupBy(fieldNames: string[], sorting?: boolean, sortDir?: SortDirection): void;
/**
* 그리드가 그룹핑되어 있는지 여부를 반환한다.
*
* @example
* ```js
* let isGrouped = gridView.isGrouped();
* ```
*/
isGrouped(): boolean;
/**
* 그리드가 mergeMode로 되어 있는지 여부를 반환한다.
*
* @returns 그리드의 {@link RowGroup.mergeMode} 의 설정값
*
* @example
* ```js
* let isMergedGrouped = gridView.isMergedGrouped();
* ```
*/
isMergedGrouped(): boolean;
/**
* 그룹핑 된 필드의 인덱스들을 반환한다.
*
* @example
* ```js
* let GFields = gridView.getGroupFields();
* ```
*/
getGroupFields(): number[];
/**
* 그룹핑 된 필드의 이름들을 반환한다.
*
* @param orginal - 기본값: true, true: 지정한 이름으로 반환, false: 대문자로 반환
* @returns 필드들의 이름들. DataProvider가 연결되어 있지 않으면, 필드들의 인덱스들을 반환한다.
*
* @example
* ```js
* let GFieldNames = gridView.getGroupFieldNames();
* ```
*/
getGroupFieldNames(orginal?: boolean): string[] | number[];
/**
* 현재 몇 level로 그룹핑되어 있는지를 반환한다.
*
* @returns group level의 깊이
*
* @example
* ```js
* let Glevels = gridView.getGroupLevels();
* ```
*/
getGroupLevels(): number;
/**
* 지정한 필드의 그룹 level을 반환한다.
*
* @remarks
* 첫번째 그룹 레벨은 1이다.
*
* @param field - 필드명 또는 인덱스
* @returns 해당 필드로 그룹핑되지 않았다면 `0`을 반환한다, 없는 필드명이 지정됐을 경우 `-1`이 반환된다.
*
* @example
* ```js
* let Glevel = gridView.getGroupLevel('field1');
* ```
*/
getGroupLevel(field: string | number): number;
/**
* 자신이 속한 그룹의 인덱스를 반환한다.
*
* @param itemIndex - 그리드 상의 인덱스
* @returns 그룹이 없거나, 그룹이 있을 경우 가장 첫 행의 결과는 `-1`이다.
*
* @example
* ```js
* let GIndex = gridView.getGroupIndex(2);
* ```
*/
getGroupIndex(itemIndex: number): number;
/**
* 지정한 인덱스가 그룹 아이템인지의 여부를 반환한다.
*
* @param itemIndex - 그리드 상의 인덱스
*
* @example
* ```js
* let isGroupItem = gridView.isGroupItem(4);
* ```
*/
isGroupItem(itemIndex: number): boolean;
/**
* 지정한 인덱스의 부모의 표시 여부를 반환한다.
*
* @param itemIndex - 그리드 상의 인덱스
* @returns 해당 아이템이 존재하지 않거나, 해당 아이템의 부모가 존재하지 않으면 `false`를 반환한다.
*
* @example
* ```js
* let isParentVis = gridView.isParentVisible(2);
* ```
*/
isParentVisible(itemIndex: number): boolean;
/**
* 지정한 그룹을 펼친다(expand).
*
* @remarks
* 지정한 아이템이 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다.
* recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.
*
* @param itemIndex - 해당 그룹의 그리드 상의 인덱스
* @param recursive - 그룹에 포함된 자손 그룹의 펼침 여부
* @param force - 기본값: `false`, 이미 expanded 상태라도 recursive가 true일 때 자손들의 펼침 여부
* @param level - 기본값: `0`, 0일 때 recursive가 true면 모든 자손을 펼친다.
*
* @example
* ```js
* gridView.expandGroup(2, true);
* ```
*/
expandGroup(itemIndex: number, recursive?: boolean, force?: boolean, level?: number): void;
/**
* 지정한 그룹을 접는다(collapse).
*
* @remarks
* 지정한 아이템이 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다.
*
* @param itemIndex - 해당 그룹의 그리드 상의 인덱스
* @param recursive - 그룹에 포함된 자손 그룹의 접힘여부. true 일때 이미 collapsed 상태라면 아무일도 하지 않는다.
* @param force - 기본값: `false`, 이미 collapsed 상태라도 recursive가 true일 때 자손들의 접힘여부.
*
* @example
* ```js
* gridView.collapseGroup(2, true);
* ```
*/
collapseGroup(itemIndex: number, recursive: boolean, force?: boolean): void;
/**
* 지정한 그룹의 부모를 펼친다.
*
* @remarks
* 지정한 아이템 또는 그 부모가 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다.
* recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.
*
* @param itemIndex - 해당 그룹의 그리드 상의 인덱스
* @param recursive - 부모 그룹에 포함된 자손 그룹의 펼침여부
* @param force - 기본값: `false`, 이미 expanded 상태라도 recursive가 true일 때 부모 그룹의 자손들의 펼침여부
* @param level - 기본값: `0`, 0일 때 recursive가 true면 모든 자손 expand.
*
* @example
* ```js
* gridView.expandParent(2, true);
* ```
*/
expandParent(itemIndex: number, recursive: boolean, force?: boolean, level?: number): void;
/**
* 지정한 그룹의 부모를 접는다(collapse).
*
* @remarks
* 지정한 아이템 또는 그 부모가 존재하지 않거나, 그룹이 아니라면 아무 일도 일어나지 않는다.
*
* @param itemIndex - 해당 그룹의 그리드 상의 인덱스
* @param recursive - 부모 그룹에 포함된 자손 그룹의 접힘여부. true 일때 이미 collapsed 상태라면 아무일도 하지 않는다.
* @param force - 기본값: `false`, 이미 collapsed 상태라도 recursive가 true일 때 부모 그룹의 자손들의 접힘여부
*
* @example
* ```js
* gridView.collapseParent(2, true);
* ```
*/
collapseParent(itemIndex: number, recursive: boolean, force?: boolean): void;
/**
* 지정한 itemIndex의 그룹을 접는다.
*
* @remarks
* 지정한 행이 row이거나 footer이면 행의 그룹을 접는다.
* 그룹이 접혀있는 경우 상위 그룹을 접는다.
*
* @param itemIndex - 행의 인덱스
* @param level - `-1`이면 선택된 행을 포함하는 그룹중 접혀있지 않은 그룹을 접는다. `1`이상의 값이 입력되면 입력된 level에 해당하는 그룹을 접는다.
*/
collapse(itemIndex: number, level?: number): void;
/**
* 지정한 행의 그룹을 펼친다.
*
* @remarks
* 지정한 행이 그룹아이템이 아니면 상위 그룹을 펼친다.
*
*
* @param itemIndex - 행의 인덱스
* @param level - level을 지정하면 해당 level까지 펼친다.
*/
expand(itemIndex: number, level?: number): void;
/**
* 루트 그룹을 펼친다.
*
* @remarks
* recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.
*
* @param recursive - 기본값: `false`, 그룹에 포함된 자손 그룹의 펼침여부.
* @param level - 기본값: `undefined`, `undefined`: recursive가 true시 모든 자손 expand.
*
* @example
* ```js
* gridView.expandAll();
* ```
*/
expandAll(recursive?: boolean, level?: number): void;
/**
* 루트 그룹을 접는다.
*
* @param recursive - 기본값: `false`, 그룹에 포함된 자손 그룹의 접힘여부. `true`일 때 그룹에 포함된 자손 그룹도 접힌 상태가 된다.
*
* @example
* ```js
* gridView.collapseAll();
* ```
*/
collapseAll(recursive?: boolean): void;
/**
* GroupFooter의 {@link ColumnSummary.expression | expression} 또는 {@link ColumnSummary.valueCallback | valueCallback}에서 결과값을 가져온다.
*
* @remarks
* numberFormat, prefix등이 적용되지 않은 값이다.
* 선택된 footer가 여러개인경우 배열로 리턴된다.
*
* @param model - 아이템 모델 정보
* @param column - 컬럼
* @param summaryIndex - summary의 index
* @returns - any
*/
getGroupSummaryValue(model: GridItem, column: string | DataColumn, summaryIndex?: number): any | any[];
/**
* 그룹Layout의 expandable이 설정된 경우 그룹Layout을 펼친다.
*
* @param recursive - 하위 그룹이 있는 경우 하위 그룹도 펼친다.
*/
layoutExpandAll(recursive: boolean): void;
/**
* 그룹Layout의 expandable이 설정된 경우 그룹Layout을 접는다.
*
* @param recursive - 하위 그룹이 있는 경우 하위 그룹도 접는다.
*/
layoutCollapseAll(recursive: boolean): void;
/**
* 그리드에 인덱스로 입력된 데이터행 앞 또는 뒤에 새로운 데이터행을 생성한다.
*
* @remarks
* 그리드가 편집상태이거나 데이터 건수가 없는 경우 추가되지 않는다.
* itemIndex를 입력하지 않거나 -1을 입력하면 현재 선택된 행에 생성한다.
*
* @param itemIndex - 기본값: `-1`, 기준 데이터 행. 이 행 앞에 새로운 데이터행을 생성한다.
* @param shift - 기본값: `false`, `true`: 데이터 행 뒤에 생성
* @param data - 기본값: null, 신규행에 추가될 data
* @returns 입력가능한 상태이면 신규행의 index를 return하고 입력가능한 상태가 아니면 `-1`을 return한다.
*
* @example
* ```js
* gridView.beginInsertRow();
* ```
*/
beginInsertRow(itemIndex?: number, shift?: boolean, data?: DataValues): number;
/**
* 그리드 마지막 데이터행 이후에 새로운 데이터행을 추가한다.
*
* @param data - 기본값: null, 신규행에 추가될 data
* @returns 입력가능한 상태이면 신규행의 index를 return하고 입력가능한 상태가 아니면 `-1`을 return한다.
*
* @example
* ```js
* gridView.beginAppendRow();
* ```
*/
beginAppendRow(data?: DataValues): number;
/**
* 입력된 인덱스에 해당하는 데이터 행을 편집상태로 변경한다.
*
* @param itemIndex - 행의 인덱스. 지정하지 않으면 focuse 행.
*
* @example
* ```js
* gridView.beginUpdateRow();
* ```
*/
beginUpdateRow(itemIndex?: number): void;
/**
* 그리드가 Paging 모드로 실행된다.
*
* @param paging - true 시 페이징 모드
* @param size - 기본값: `10`, 한 페이지에 표시할 행의 개수
* @param maxCount - 기본값: `-1`, 최대 페이지 개수
*
* @example
* ```js
* gridView.setPaging(true);
* ```
*/
setPaging(paging: boolean, size?: number, maxCount?: number): void;
/**
* Paging 모드에서 현재 페이지 번호를 반환한다.
* @example
* ```js
* let currPage = gridView.getPaging();
* ```
*/
getPage(): number;
/**
* Paging 모드일 때 표시할 페이지를 지정한다.
*
* @param page - 페이지 번호
* @param startItem - 기본값: `-1`, 이 페이지에 표시할 첫번째 행의 인덱스. -1이면 {@link GridView.setPaging | setPaging} 에 지정한 페이지 크기에 따라 결정된다.
*
* @example
* ```js
* gridView.setPage(4);
* ```
*/
setPage(page: number, startItem?: number): void;
/**
* Paging 모드일 때 전체 페이지 개수를 반환한다.
*
* @example
* ```js
* let pageCount = gridView.getPageCount();
* ```
*/
getPageCount(): number;
/**
* Paging 개수를 변경한다.
*
* @param count - 새 페이지 개수
*
* @example
* ```js
* gridView.setPageCount(20);
* ```
*/
setPageCount(count: number): void;
/**
* @public
* 행이 위치한 페이지를 찾는다.
*
* @param dataRow - 찾을려고 하는 행의 dataRow
* @returns 행이 위치한 페이지번호 찾지 못하는 경우 `-1`을 return한다.
*/
getPageOfDataRow(dataRow: number): number;
/**
* 체크된 아이템들의 목록을 배열로 반환한다.
*
* @param rowOnly - 기본값: `true`, `true`: 행만 반환, `false`: 그룹푸터 등 비데이터 영역도 반환
*
* @example
* ```js
* let checkedItems = gridView.getCheckedItems();
* ```
*/
getCheckedItems(rowOnly?: boolean): number[];
/**
* 체크된 데이터 행들의 목록을 반환한다.
*
* @param sort - 기본값: `true`, `true`: 오름차순으로 반환, `false`: 화면에 보이는 순서대로 반환.
* @param visibleOnly - 기본값: `false`, `true`로 입력하면 collapse 되거나 페이징시 보이지 않는 행들은 제외한다.
* @param allRows - 기본값: `false`, `true`로 입력하면 페이징 처리시 보이지 않는 페이지들의 체크된 행들도 반환한다.
* @example
* ```js
* let checkedRows = gridView.getCheckedRows();
* ```
*/
getCheckedRows(sort?: boolean, visibleOnly?: boolean, allRows?: boolean): number[];
/**
* @remarks
* merge된 셀에 포함되는 itemIndex를 배열로 가져온다.
*
* @param itemIndex - 그리드 행의 itemIndex
* @param column - column의 이름
* @param dataOnly - 데이터행만 가져올지 여부 default `true`
* @param force - `true`이면 merge된 셀이 아니어도 입력된 itemIndex를 포함하는 배열로 return한다. default `true`
*
* @returns merge된 셀의 itemIndex 배열
*
* @example
* ```js
* let mergeItems = gridView.getMergedItems(1, "column", true, true);
* let mergeDataRows = gridView.getRowsOfItems(mergeItems);
* ```
*/
getMergedItems(itemIndex: number, column: string, dataOnly?: boolean, force?: boolean): number[];
/**
* {@link DataColumn.mergeCallback}에 의해서 return되는 값이 변경될때 내부 merge정보를 갱신하도록 한다.
*
* @param refresh - `true`이면 내부 merge정보를 갱신후 그리드를 다시 그린다. default `true`
*/
populateMerges(refresh?: boolean): void;
}
/**
* @public
* 사용자 지정의 groupFooter spanning을 설정하기 위한 콜백
*
* @remarks
* {@link CellLayoutColumnItem} 에서 사용된다.
*
* [매개변수 목록]
* `grid` - GridBase 컨트롤
*
* `layout` - 레이아웃 아이템
*
* `itemIndex` - 행의 인덱스
*
* `footerIndex` - groupFooter의 index
*
*/
export declare type GroupFooterCellSpanCallback = (grid: GridBase, layout: CellLayoutColumnItem, itemIndex: number, footerIndex: number) => number;
/**
* 그리드 그룹 푸터 행의 스타일을 지정하기 위한 콜백
*
* @remarks
* {@link RowGroupFooter.styleCallback}에서 사용되는 형식이다.
*
* [매개변수 목록]
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 푸터의 itemIndex
*
* `footerIndex` - 그룹에 푸터가 여러개 있는 경우 footer의 index
*
* @example
* ```js
* var f = function(grid, itemIndex, footerIndex) {
* var dataRow = grid.getGroupModel(itemIndex, true).firstDataItem.dataRow;
* var value = grid.getDataSource().getValue(dataRow, "area2name");
* return value && value.indexOf("군") >= 0 ? `style-1-${footerIndex}` : undefined;
* };
*
* gridView.rowGroup.setFooters([{styleCallback: f},{styleCallback: f}]);
* ```
*/
export declare type GroupFooterStyleCallback = (grid: GridBase, itemIndex: number, footerIndex: number) => string;
/**
* @public
* 사용자 지정 groupFooterUser span을 설정하기 위한 콜백
*
* @remarks
* {@link CellLayoutColumnItem} 에서 사용된다.
*
* [매개변수 목록]
* `grid` - GridBase 컨트롤
*
* `layout` - 레이아웃 아이템
*
* `model` - GroupModel
*
* `itemIndex` - 행의 인덱스
*
* `footerIndex` - groupFooter의 index
*/
export declare type GroupFooterUserSpanCallback = (grid: GridBase, layout: CellLayoutColumnItem, model: GroupItem, itemIndex: number, footerIndex: number) => UserSpan;
/**
* 행 그룹핑에 관련된 설정 모델
*
* @remarks
* 행 그룹핑은 데이터 행들을 하나 이상의 지정한 컬럼의 값을 기준으로 구분 시켜 계층적인 구조로 표시한다.
*
* {@link GridBase | 그리드} 에서 옵션으로 설정할 때는 필요한 정보만 넣으면 된다.
*
* @example
*
* ```js
* grid.setGroupingOptions({prompt: "I am Groop"});
* ```
*/
export declare interface GroupingOptions {
/**
* 그룹핑 활성화 여부
*/
enabled?: boolean;
/**
* 패널에 표시될 메시지
*
* @defaultValue `'컬럼 헤더를 이 곳으로 끌어다 놓으면 그 컬럼으로 그룹핑합니다.'`
*/
prompt?: string;
/**
* 그룹핑 시 그룹의 펼침 여부
*
* @defaultValue `true`
*/
expandWhenGrouping?: boolean;
/**
* @deprecated
* 그룹핑 전 커밋 여부
*
* @defaultValue `true`
*/
commitBeforeGrouping?: boolean;
/**
* @deprecated
* 그룹 펼치기 전 커밋 여부
*
* @defaultValue `true`
*/
commitBeforeExpand?: boolean;
/**
* @deprecated
* 그룹 접기 전 커밋 여부
*
* @defaultValue `true`
*/
commitBeforeCollapse?: boolean;
/**
* toast 관련 설정
*
* @defaultValue `{visible: false, message: "Grouping..."}`
*/
toast?: ToastOptions;
}
/**
* @public
* 그룹 아이템의 정보 모델
*
* [상위 클래스]
*
* {@link GridItem}
*
* 콜백의 파라메터로 전달될때만 사용된다.
*/
export declare interface GroupItem extends GridItem {
/**
* 자손 dataRow의 건수
*/
descendantCount?: number;
/**
* footer의 건수
*/
footerCount?: number;
/**
* 마지막 데이터 아이템
*/
lastDataItem?: GridItem;
/**
* 그룹에 속해있는 데이터 아이템의 dataRow 배열
*/
getRows(): number[];
/**
* 그룹에 속해있는 데이터의 건수
*
* @param field - 필드명 또는 필드 인덱스
*/
getNumber(field: number | string): number;
/**
* 필드의 dataType이 number인 경우 값의 합계
*
* @param field - 필드명 또는 필드 인덱스
*/
getSum(field: number | string): number;
/**
*
* @param field - 필드명 또는 필드 인덱스
*/
getMax(field: number | string): any;
/**
*
* @param field - 필드명 또는 필드 인덱스
*/
getMin(field: number | string): any;
/**
*
* @param field - 필드명 또는 필드 인덱스
*/
getAvg(field: number | string): number;
/**
*
* @param field - 필드명 또는 필드 인덱스
*/
getVar(field: number | string): number;
/**
*
* @param field - 필드명 또는 필드 인덱스
*/
getStdev(field: number | string): number;
/**
*
* @param field - 필드명 또는 필드 인덱스
*/
getStdevp(field: number | string): number;
/**
* 값이 없는 행을 제외한 숫자
*
* @param field - 필드명 또는 필드 인덱스
*/
getDataCount(field: number | string): number;
/**
* 입력된 필드의 dataType이 `number`인 경우 값이 없는 행을 제외한 나머지 행들의 평균
*
* @param field - 필드명 또는 필드 인덱스
*/
getDataAvg(field: number | string): number;
}
/**
* @public
* 설정된 레이아웃이 {@link CellLayoutGroupItem} 모델일 경우, {@link GridBase.saveColumnLayout} 에서 반환되는 오브젝트
*
* @remarks
* {@link LayoutInfo} 의 한 종류이다.
*
* @example
* ```js
* {
* name: "countryGroup"
* items: [
* {column: "Country", visible: true, width: 100},
* {column: "Phone", visible: true, width: 100}
* ]
* visible: true,
* direction: "horizontal",
* width: 250,
* header: {visible: true, text: "Country Group"}
* }
* ```
*/
export declare interface GroupLayoutInfo {
/**
* layout 명
*/
name: string;
/**
* 하위 layout 들
*/
items: (ColumnLayoutInfo | GroupLayoutInfo)[];
/**
* 표시 여부
*/
visible: boolean;
/**
* layout 배치 방향
*/
direction: ColumnLayoutDirection;
/**
* 셀 너비
*/
width: number;
/**
* 헤더 레이아웃 정보
*
* @remarks
* [속성 목록]
*
* `visible` - 표시 여부
*
* `text` - 헤더 텍스트
*/
header: {
visible: boolean;
text: string;
};
}
/**
* 그리드 Group Panel 표시 정보들에 대한 설정 정보
*
* @remarks
* {@link GridView.setGroupPanel} 사용 시 필요한 정보만 입력하면 된다.
*
* @example
*
* ```js
* gridView.setGroupPanel({visible: false});
* ```
*/
export declare interface GroupPanel {
/**
* Group Panel 의 표시 여부
*/
visible?: boolean;
/**
* Group Panel 의 최소 높이
*/
minHeight?: number;
/**
* Group Panel 의 높이
*
* @readonly
*/
height?: number;
}
/**
* @public
*
* 그룹컬럼을 접거나 펼쳤을때 보여질것인가를 결정한다.
*
* {@link CellLayoutItem.groupShowMode}에서 설정한다.
*
* @remarks
* 상위 layout의 expand상태에 따라서 보이거나 숨도록 한다.
*/
export declare enum GroupShowMode {
/**
* 그룹을 펼쳤을때 보여진다.
*/
"EXPAND" = "expand",
/**
* 그룹을 접었을때 보여진다.
*/
"COLLAPSE" = "collapse",
/**
* 항상 보여진다.
*/
"ALWAYS" = "always"
}
/**
* @public
*
* {@link GridBase.getGroupSummary} 에서 반환되는 오브젝트 형식
*
* @remarks
* `getGroupSummary` 에 `statistical` 을 `true` 로 하면, `var`, `varp`, `stdev`, `stdevp` 가 추가된다.
*/
export declare interface GroupSummary {
/**
* 행 갯수
*/
count: number;
/**
* 합
*/
sum: number;
/**
* 최대값
*/
max: number;
/**
* 최소값
*/
min: number;
/**
* 평균
*/
avg: number;
/**
* 값이 지정되어 잇는 데이터 개수 (null 이 아닌)
*/
datacount: number;
/**
* `datacount` 로 나눈 평균
*/
dataavg: number;
/**
* 표본집단 분산
*/
var?: number;
/**
* 모집단 분산
*/
varp?: number;
/**
* 표본집단 표준편차
*/
stdev?: number;
/**
* 모집단 표준편차
*/
stdevp?: number;
}
/**
* @public
*
* 핸들의 표시 방법
*
* @remarks
* 소팅(sorting), 필터링(filtering) 시 컬럼 헤더에 표시되는 기능 아이콘을 핸들(Handle)이라고 한다.
*
* HandleVisiblity는 {@link SortingOptions }, {@link FilteringOptions } 의 handleVisibility 속성으로 구현되어 있다.
*
* @example
*
* ```js
* grid.sortingOptions.handleVisibility = 'visible';
* ```
*/
export declare enum HandleVisibility {
/**
* 표시
*/
VISIBLE = "visible",
/**
* 호버링 된 경우만 표시
*/
HOVERED = "hovered",
/**
* 항상 표시
*/
ALWAYS = "always",
/**
* 숨김
*/
HIDDEN = "hidden",
/**
* active상태이거나 호버링 된경우 표시
*
* @remarks
* filterIcon에만 적용된다.
*/
ACTIVE_OR_HOVERED = "activeOrHovered"
}
/**
* 행 그룹 Header에 표시되는 Text를 return 하는 Callback
* @remarks
* {@link RowGroup.headerCallback} 에서 사용되는 형식이다.
* {@link RowGroup.headerStatement}가 있는 경우 무시된다.
*
* [매개변수 목록]
* `grid` - GridBase 컨트롤
*
* `group` - 그룹 아이템
*
*
* @example
* ```js
* gridView.rowGroup.headerStatement = undefined;
* gridView.rowGroup.headerCallback = function(grid, group) {
* var ds = grid.getDataSource()
* if (group.level === 1) {
* return ds.getOrgFieldName(group.groupField) + " - " + group.firstDataItem.getData(group.groupField) + " - " + group.descendantCount + " rows"
* } else if (group.level === 2) {
* var sum = group.getSum("number");
* return isNaN(sum) ? "합계 없음" : ("합계 => "+ sum.toString());
* } else {
* return "GroupLevel => "+group.level.toString()
* }
* }
* ```
*/
export declare type HeaderCallback = (grid: GridView, group: GroupItem) => string;
/**
* @public
*
* Header Summary 영역의 단일 설정 모델
*
* @remarks
* 그리드는 별도의 설정이 없는 경우 하나의 summary를 자동으로 생성하고 {@link GridBase.headerSummary}는 첫번째 summary를 반환한다..
*
* {@link GridBase.setHeaderSummary | setHeaderSummary()}를 이용해서 속성을 변경하거나 또는 {@link GridBase.headerSummary}를 이용해서 원하는 속성만 지정한다.
*
* @example
*
* ```js
* gridView.setHeaderSummary({styleName: 'custom-hsummary-1'});
* // 또는
* gridView.headerSummary.styleName = 'custom-hsummary-1';
* ```
*/
export declare interface HeaderSummary extends GridSummaryObject {
/**
* 스타일 클래스 이름
*/
styleName?: string;
/**
* 최소 높이
*
* @defaultValue `23`
*/
minHeight?: number;
/**
* 높이
*
* @remarks
* `0`이면 자동으로 계산하여 지정한다. `0` 이상이면 minHeight와 비교하여 더 큰 값으로 지정한다.
*
* @defaultValue `0`
*/
height?: number;
/**
* 셀 스타일을 지정하기 위한 콜백
* @eventProperty
*
* @remarks
* `string` 형태의 css 클래스 명 또는 {@link ColumnSummaryStyleObject} 형태로 지정가능하다.
*
* @example
* ```js
* // 푸터 적용
* const f = function (grid, cell) {
* if (cell.value > 10) {
* return {
* styleName: 'custom-summary'
* }
* }
* }
* headerSummary.cellStyleCallback = f;
* ```
*/
cellStyleCallback?: CellStyleCallback;
/**
* 표시 여부
*/
visible?: boolean;
/**
* summary 콜렉션 내에서의 순서
*
* @readonly
*/
summaryIndex?: number;
/**
* valueCallback 또는 expression에서 계산한 값을 보관한다.
*
* @readonly
*/
value?: any;
}
/**
* @public
*
* Header summary 영역에 관한 콜렉션 모델 오브젝트
*
* @remarks
*
* 그리드의 headerSummary를 표시하거나 여러개의 headerSummary를 생성하고 관리한다.
*
* {@link GridBase.headerSummaries} 에서 반환되는 객체다.
*
* @example
* ```js
* // object
* gridView.setHeaderSummaries({
* visible: true,
* items:[
* {
* styleName: 'custom-headerSummary-1'
* }, {
* styleName: 'custom-headerSummary-2'
* }
* ]
* })
* // 또는 array형태로 지정
* gridView.setFooters([
* {
* styleName: 'custom-headerSummary-1'
* }, {
* styleName: 'custom-headerSummary-2'
* }
* ])
* ```
*/
export declare interface HeaderSummaryCollection {
/**
* 표시 여부
*/
visible?: boolean;
/**
* 현재 설정된 headerSummary의 갯수를 반환한다.
*
* @readonly
*/
readonly count?: number;
/**
* 현재 설정된 headerSummary중 visible이 `true`인 headerSummary의 갯수를 반환한다.
*
* @readonly
*/
readonly visibleCount?: number;
/**
* headerSummary를 설정한다.
*/
items?: HeaderSummary[];
/**
* 해당하는 인덱스의 headerSummary를 반환한다.
*
* @remarks
* {@link HeaderSummary}를 반환한다.
*
* @param index - headerSummary의 index
*/
readonly get?: (index: number) => HeaderSummary;
/**
* 보여지는 순서에 해당하는 headerSummary를 가져온다.
*
* @remarks
* {@link HeaderSummary}를 반환한다.
*
* @param index - 보여지는 순서 `0`부터 시작한다.
*/
readonly getVisible?: (index: number) => HeaderSummary;
}
/**
* {@link ColumnHeader} 또는 {@link CellLayoutGroupHeader}의 template 이벤트 설정정보
*
* @remarks
* `renderCallback`은 header가 다시 그려질때 호출된다.
*
* [상위 클래스]
*
* {@link TemplateEvent}
*
* @example
* ```js
* const header = column.header;
* header.template = ``;
* header.templateEvents = [{
* selector: 'input[type="button"]',
* event: {},
* renderCallback(grid, header, element) {
* element.value = header.displayText
* }
* }]
* ```
*/
export declare interface HeaderTemplateEvent extends TemplateEvent {
/**
* header가 다시 그려질때 호출되는 콜백
*
* @remarks
* 수시로 호출되기 때문에 시간이 많이 걸리는 작업을 하는 경우 성능이 저하 될 수 있다.
*/
renderCallback?: HeaderTemplateEventCallback;
}
/**
* @public
*
* {@link ColumnHeader.templateEvents.renderCallback} 또는 {@link CellLayoutGroupHeader.templateEvents.renderCallback}에 사용되는 콜백 형식
*
* @remarks
* 컬럼 헤더가 갱신될때 호출된다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `header` - 컬럼의 header 또는 그룹 Layout의 header
*
* `element` - HTMLElement
*
* `initialize` - element가 생성된 직후 호출되는 경우는 `true`이고 화면 갱신시 호출되는 경우 `false`이다.
*
* @example
*
* ```js
* column.header.template = ``;
* column.header.templateEvents = {
* selector: ``,
* event: {
* renderCallback(grid, header, element) {
* }
* }
* }
* ```
*/
declare type HeaderTemplateEventCallback = (grid: GridBase, header: ColumnHeader | CellLayoutGroupHeader, element: HTMLElement, initialize: boolean) => void;
/**
* 공휴일 지정을 위한 설정 모델
*
* @remarks
* {@link GridBase.setEditorOptions} 을 이용하여 지정하거나 {@link EditorOptions.holidays | grid.editorOptions.holidays} 에 직접 지정할 때 사용된다.
*
* {@link DateCellEditor} 에서 사용되기도 한다.
*
* @example
* ```js
* holidays: [
* {
* type : "date",
* dates : ["2020-01-24","2020-01-25","2020-01-26","2020-01-27"],
* styleName: "seollal",
* tooltips : ["설날1","설날2","설날3","설날4"]
* },
* ...
* ]
* ```
*/
export declare type Holidays = (DateHoliday | DayHoliday)[];
/**
* @public
*
* 아이콘 렌더러
*
* @remarks
* 이미지 아이콘과 텍스트를 같이 표시한다.
*
* url을 직접 지정하여 표시할 수도 있다.
*
* {@link CellRenderer} 를 상속한다.
*
* [제한 사항]
*
* 1. iconLocation = RIGHT: 텍스트가 길면 아이콘이 표시되지 않을 수 있다.
*
* 2. 자동 높이에서 `TOP_EDGE`, `BOTTOM_EDGE`를 사용할 수 없다.
*
* [상위 클래스]
*
* {@link CellRenderer}
*
* @example
* ```js
* // string type
* column.renderer = 'icon';
*
* // object type
* column.renderer = {
* "type": "icon",
* "iconMap": {
* "UPQRK": "images/particles/uquark.png",
* "DOWNQRK": "images/particles/dquark.png",
* "ELECTRN": "images/particles/e.png",
* "ELECNEU": "images/particles/eneutrino.png",
* },
* "iconHeight": 11
* },
* ```
*/
export declare interface IconCellRenderer extends CellRenderer {
/**
* 종류: 아이콘
*/
type?: "icon";
/**
* 셀 값과 해당 셀 값에 대응시킬 url 의 키-값 쌍
*
* @remarks
* {@link IconCellRenderer.iconCallback} 이 할당되어 있지 않거나 `undefined`를 반환한 경우 적용된다.
*
*
* @example
* ```js
* column.renderer = {
* type: 'icon'
* iconMap: {
* value1: 'images/e_equals_mc_square.jpg'
* }
* }
* ```
*/
iconMap?: {
[value: string]: string;
};
/**
* 아이콘 이미지의 렌더링을 위한 콜백
*
* @remarks
* `undefined` 반환 시 해당 콜백에 의한 렌더링이 취소된다.
*
* {@link GetImageCallback} 의 형식을 따른다.
* @eventProperty
*
* @example
*
* ```js
* column.renderer = {
* "type": "icon",
* "iconCallback": function (grid, cell) {
* return "images/teraforming/mars.jpg";
* }
* }
* ```
*/
iconCallback?: GetImageCallback;
/**
* 이미지의 alt 텍스트를 설정하기 위한 콜백
*
* @remarks
* 설정할 alt 텍스트를 반환해야 한다.
*
* {@link GetCellTitleCallback} 의 형식을 따른다.
* @eventProperty
*
* @example
* ```js
* const f = function(grid, model) {
* return 'cat image'
* }
* column.renderer = {
* type: 'icon',
* titleCallback: f
* }
* ```
*/
titleCallback?: GetCellTitleCallback;
/**
* 보여줄 아이콘 이미지의 url
*
* @remarks
* {@link IconCellRenderer.iconMap} 이 설정된 경우, 해당 설정된 값은 무시된다.
*/
iconUrl?: string;
/**
* 아이콘 이미지 렌더링을 위해 url 값으로 읽어올 필드의 필드명
*
* @remarks
* {@link IconCellRenderer.iconCallback} 이 할당되어 있지 않거나 `undefined`를 반환한 경우 적용된다.
*
* @example
* ```js
* column.renderer = {
* "type": "icon",
* "iconField": "Cats"
* }
* ```
*/
iconField?: string;
/**
* 렌더링되는 아이콘의 위치
*/
iconLocation?: IconLocation;
/**
* true이면 스페이스바를 입력했을때 onCellItemClicked 가 실행된다.
*
* @defaultValue `false`
*/
spaceKey?: boolean;
/**
* true이면 enterKey를 입력했을때 onCellItemClicked 가 실행된다.
*
* @defaultValue `false`
*/
enterKey?: boolean;
/**
* true이면 excel로 이미지를 export한다.
*
* @remarks
* {@link GridExportOptions.exportImage}가 `false`이면 출력되지 않는다.
*
* @defaultValue `undefined`
*/
exportImage?: boolean;
}
/**
* @public
*
* 렌더링하는 아이콘, 체크박스, 도형 등의 위치
*
* @remarks
* {@link IconCellRenderer}, {@link CheckCellRenderer}, {@link ShapeCellRenderer} 에서 사용된다.
*
* @example
* ```js
* ...
* "renderer": {
* "type": "check",
* "checkLocation": "right"
* },
* ...
* ```
*/
export declare enum IconLocation {
/**
* 텍스트 왼쪽에 표시
*/
LEFT = "left",
/**
* 텍스트 오른쪽에 표시
*/
RIGHT = "right",
/**
* 셀 왼쪽 모서리에 표시
*/
LEFT_EDGE = "leftEdge",
/**
* 셀 오른쪽 모서리에 표시
*/
RIGHT_EDGE = "rightEdge",
/**
* 텍스트 위쪽에 표시
*/
TOP = "top",
/**
* 텍스트 아래쪽에 표시
*/
BOTTOM = "bottom",
/**
* 셀 위쪽 모서리에 표시
*/
TOP_EDGE = "topEdge",
/**
* 셀 아래쪽 모서리에 표시
*/
BOTTOM_EDGE = "bottomEdge",
/**
* 셀 중앙에 표시
*/
CENTER = "center"
}
/**
* @public
*
* 이미지 렌더러
*
* @remarks
* 데이터 셀의 값을 url 로 해석해서 그 이미지를 내려받고 표시한다.
*
* [상위 클래스]
*
* {@link CellRenderer}
*
* @example
*
* ```js
* // string type
* column.renderer = 'image';
*
* // object type
* column.renderer = {
* type: "image",
* imageMap: {
* "value1": "images/apple.jpg",
* "value2": "images/banana.jpg"
* },
* titleField: "fruits"
* }
* ```
*/
export declare interface ImageCellRenderer extends CellRenderer {
/**
* 종류: 이미지
*/
type?: "image";
/**
* 셀 값과 해당 셀 값에 대응시킬 url 의 키-값 쌍
*
* @remarks
* {@link ImageCellRenderer.imageCallback} 이 할당되어 있지 않거나 `undefined`를 반환한 경우 적용된다.
*
*
* @example
* ```js
* column.renderer = {
* type: 'image',
* imageMap: {
* value1: 'images/e_equals_mc_square.jpg'
* }
* }
* ```
*/
imageMap?: {
[value: string]: string;
};
/**
* 이미지를 렌더링을 위해 이미지의 경로를 지정하는 콜백
*
* @remarks
* `false` 반환 시 해당 콜백에 의한 렌더링이 취소된다.
*
* {@link GetImageCallback} 의 형식을 따른다.
*
* [프로퍼티 목록]
*
* `grid` - GridBase 컨트롤
*
* `model` - 그리드의 셀
*
* @eventProperty
* @example
* ```js
* const f = function(grid, model) {
* const base = '/images/';
* if (jpgSet.indexOf(model.value)){
* return base + model.value + '.jpg';
* }
* else base + 'default.jpg';
* }
*
* column.renderer = {
* type: 'image',
* imageCallback: f
* }
* ```
*/
imageCallback?: GetImageCallback;
/**
* 이미지 렌더링을 위해 url 값으로 읽어올 필드의 필드명
*
* @remarks
* {@link ImageCellRenderer.imageCallback} 이 할당되어 있지 않거나 `undefined`를 반환한 경우 적용된다.
*
* @example
*
* ```js
* column.renderer = {
* "type": "image",
* "imageField": "Cats"
* }
* ```
*/
imageField?: string;
/**
* 이미지의 alt 텍스트 값으로 읽어올 필드의 필드명
*
* @example
* ```js
* column.renderer = {
* "type": "image",
* "imageMap": {
* "value1": "images/fatcat.jpg",
* "value2": "images/bluecat.jpg"
* },
* "titleField": "CatName"
* }
* ```
*/
titleField?: string;
/**
* 이미지의 alt 텍스트를 설정하기 위한 콜백
*
* @remarks
* 설정할 alt 텍스트를 반환해야 한다.
*
* {@link GetCellTitleCallback} 의 형식을 따른다.
* @eventProperty
*
* @example
* ```js
* const f = function(grid, model) {
* return 'cat image'
* }
* column.renderer = {
* type: 'image',
* imageMap: {
* value1: 'images/fatcat.jpg',
* value2: 'images/bluecat.jpg'
* },
* titleCallback: f
* }
* ```
*/
titleCallback?: GetCellTitleCallback;
/**
* 이미지 높이
*/
imageHeight?: number;
/**
* 이미지 너비
*/
imageWidth?: number;
/**
* true이면 스페이스바를 입력했을때 onCellItemClicked가 실행된다.
*
* @defaultValue `false`
*/
spaceKey?: boolean;
/**
* true이면 enterKey를 입력했을때 onCellItemClicked가 실행된다.
*
* @defaultValue `false`
*/
enterKey?: boolean;
/**
* true이면 excel로 이미지를 export한다.
*
* @remarks
* {@link GridExportOptions.exportImage}가 `false`이면 출력되지 않는다.
*
* @defaultValue `undefined`
*/
exportImage?: boolean;
}
/**
* @public
*
* 인디케이터에 표시될 내용 종류
*/
export declare enum IndicatorValue {
/**
* 없음
*/
NONE = "none",
/**
* 행 순서
*/
INDEX = "index",
/**
* 행 순서를 역순으로 표시
*/
REVERSE = "reverse",
/**
* 행 고유 번호
*/
ROW = "row"
}
/**
* @public
*
* {@link FilterPanel}에서 사용할수 있는 연산자의 종류이다.
*
* @remarks
* {@link DataColumn.valueType}에 따라서 사용할수 있는 연산자에 제한이 있다.
*/
export declare enum InlineFilterOperator {
/**
* 입력된 값과 동일한 Data
*/
EQUAL = "equal",
/**
* 입력된 값과 다른 Data
*/
NOT_EQUAL = "notEqual",
/**
* 입력된 값을 포함하고 있는 Data
*/
CONTAINS = "contains",
/**
* 입력된 값을 포함하고 있지 않은 Data
*/
NOT_CONTAINS = "notContains",
/**
* 입력된 값으로 시작하는 Data
*/
STARTS_WITH = "startsWith",
/**
* 입력된 값으로 끝나는 Data
*/
ENDS_WITH = "endsWith",
/**
* 입력된 값을 지우고 filter를 비활성화 시킨다.
*/
RESET = "reset",
/**
* 입력된 값보다 큰 Data
*/
GREATER = "greater",
/**
* 입력된 값보다 크거나 같은 Data
*/
GREATER_EQUAL = "greaterEqual",
/**
* 입력된 값보다 작은 Data
*/
LOWER = "lower",
/**
* 입력된 값보다 작거나 같은 Data
*/
LOWER_EQUAL = "lowerEqual",
/**
* 범위를 지정한다.
*
* @remarks
* `~`를 구분자로 해서 `value1 ~ value2`와 같은 형태로 지정한다.
*/
BETWEEN = "between",
/**
* 값이 없는 Data를 검색
*/
EMPTY = "empty"
}
/**
* @public
*
* {@link GridBase.getInvalidCells} 에서 반환되는 오브젝트 형식
*/
export declare interface InvalidCell {
/**
* 컬럼 명
*/
column: string;
/**
* 행의 고유 번호
*/
dataRow: number;
/**
* 설정한 메시지
*/
message: string;
/**
* 설정한 데이터 검증 결과 수준
*/
level: ValidationLevel;
/**
* 필드 명
*/
fieldName: string;
}
/**
* @public
*
* 아이템의 상태
*/
export declare enum ItemState {
/**
* 편집, 추가, 입력 중이 아닌 경우
*/
NORMAL = "normal",
/**
* 입력된 인덱스가 현재 편집 중인 아이템의 인덱스인 경우
*/
FOCUSED = "focused",
/**
* 편집 중인 경우
*/
UPDATING = "updating",
/**
* 삽입 중인 경우
*/
INSERTING = "inserting",
/**
* 추가 중인 경우
*/
APPENDING = "appending",
/**
* 더미
*/
DUMMY = "dummy"
}
/**
* @public
*
* 그리드에서 아이템의 종류
*
* @remarks
* {@link GridBase.getModelAs | getModelAs()} 등에서 사용한다.
*
* @example
* ```js
* let model = gridView.getModelAs(3, 'row');
* ```
*/
export declare enum ItemType {
/**
* 행
*/
ROW = "row",
/**
* 그룹 아이템
*/
GROUP = "group",
/**
* 그룹 푸터
*/
FOOTER = "footer",
/**
* 트리 아이템
*/
TREE = "tree"
}
/**
* item의 배치방향
*/
export declare enum LayoutDirection {
/**
* item을 수직으로 배치한다.
*/
VERTICAL = "vertical",
/**
* item을 수평으로 배치한다.
*/
HORIZONTAL = "horizontal"
}
/**
* @public
* {@link GridBase.saveColumnLayout} 에서 반환되는 레이아웃의 정보 모델
*
* @example
* ```js
* // array of LayoutInfo
* [
* {column: "OrderID", visible: true, width: 80},
* {column: "CustomerID", visible: true, width: 90},
* {
* name: "companyGroup"
* items: [
* {
* name: "countryGroup"
* items: [
* {column: "Country", visible: true, width: 100},
* {column: "Phone", visible: true, width: 100}
* ]
* visible: true,
* direction: "horizontal",
* width: 250,
* header: {visible: true, text: "Country Group"}
* },
* {column: "CompanyName", visible: true, width: 100}
* ]
* visible: true,
* direction: "vertical",
* width: 250,
* header: {visible: true, text: "Company Group"}
* },
* {column: "EmployeeID", visible: true, width: 90}
* ]
* ```
*/
export declare type LayoutInfo = ColumnLayoutInfo | GroupLayoutInfo;
/**
* @public
* 원하는 형태의 컬럼을 만들 수 있는 레이아웃 아이템 모델의 타입
*
* @remarks
* {@link GridBase.setColumnLayout} 에서 사용된다.
*
* [개념 설명]
*
* span 은 {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td#attr-colspan | html table의 colspan} 과 비슷한 개념이다.
*
* span 개수와 컬럼 개수로 영역을 분할하며, `width`와 뒤의 수들을 더한 만큼 영역을 한다.
*
* layout 단위로 span 한다. 즉, 다음 layout이 그룹이면 그 그룹 전체를 span 한다.
*
* 그룹을 벗어나서 span 할 수 없다.
*
* 그룹은 span할 수 없다.
*
* 왼쪽에서 오른쪽으로, 위에서 아래로 진행한다.
*
* 상위 layout부터 먼저 span 한다(top-down).
*
* 그룹이 다음 layout들을 span 한 경우 새로 추가된 셀들을 하위 layout들에 배분한다.
*
* (배분 방식: 하위 layout의 cell 개수 비율에 따라 마지막 layout부터 배분한다.)
*
* 행 병합 상태일 경우 span 하려는 다음 layout들과 행 어긋남이 없어야 한다.
*
* fixed, rightFixed 경계를 넘어갈 수 없다.
*
* @example
* ```js
* [
* {
* name: "companyGroup",
* items: [
* {
* column: "Country",
* cellSpan: 3
* },
* 20,20,
* {
* column: "CompanyName",
* cellSpan: 3
* },
* 20,20,
* ],
* header: true
* },
* ...
* ];
* ```
*/
export declare type LayoutItem = CellLayoutGroupItem | CellLayoutColumnItem;
/**
* @public
* 한 줄 입력을 받을 수 있는 텍스트 편집기
*
* @remarks
* RealGrid의 기본편집기. 컬럼에 editor 속성을 지정하지 않거나 `'line'` / `'text'` 를 지정하면 LineCellEditor가 사용된다.
* {@link TextCellEditor} 를 상속한다.
*
* [상위 클래스]
*
* {@link CellEditor} - {@link TextCellEditor}
*
* @example
* ```js
* // string type
* column.editor = "line"
*
* // object type
* column.editor = { type: "line", maxLength: 1}
* ```
*/
export declare interface LineCellEditor extends TextCellEditor {
/**
* 셀 편집기 종류: 한 줄
*/
type?: "line" | "text";
/**
* 입력시 허용하는 문자열
*
* @remarks
* 편집시 영문 또는 숫자등 특정집합만 입력가능하도록 하는 경우 허용할 문자을 입력한다.
*
*
* @example
* ```js
* // 영문만 입력가능.
* column.editor = {type:"line", inputCharacters:"A-Za-z"};
*
* // 한글만 입력가능
* column.editor = {type:"line", inputCharacters:"ㄱ-힣"};
* ```
*/
inputCharacters?: string;
/**
* 입력시 제외하는 문자열
*
* @remarks
* 편집시 특정문자는 제한하는 경우 제한할 문자열을 입력한다.
*
* @example
* ```js
* // 영문만 입력가능하고 ABCD는 입력제외 abcd는 입력가능.
* column.editor = {type:"line", inputCharacters:"A-Za-z", ignoreCharacters:"ABCD"}
* ```
*/
ignoreCharacters?: string;
}
/**
* @public
*
* 하이퍼링크를 표시하는 렌더러
*
* @remarks
* [상위 클래스]
*
* {@link CellRenderer}
*
* @example
* ```js
* // string type
* column.renderer = 'link';
*
* // object type
* column.renderer = {
* "type": "link",
* "urlCallback": function (grid, cell) {
* return "http://realgrid.com";
* },
* "titleField": "CompanyName"
* }
* ```
*/
export declare interface LinkCellRenderer extends CellRenderer {
/**
* 종류: 링크
*/
type?: 'link';
/**
* 클릭 시 연결될 base url 주소
*
* @remarks
* `linkField` 필드나 셀의 값 앞에 덧붙여 최종적인 주소를 설정한다.
*
* `'#'`일 경우 클릭 시 {@link GridBase.onCellItemClicked | onCellItemClicked} 가 호출된다.
*
* @example
* ```js
* column.renderer = {
* "type": "link",
* "baseUrl": "#"
* }
* ```
*/
baseUrl?: string;
/**
* 링크의 target
*
* @remarks
* 링크의 target을 지정한다 지정하지 않으면 `_blank`가 지정된다.
*
* @defaultValue `undefined`
*/
target?: string;
/**
* 링크 될 주소가 지정되어있는 필드명
*
* @remarks
* 지정되지 않으면 렌더링 되는 셀의 값이 링크 될 주소로 지정된다.
*/
linkField?: string;
/**
* 스페이스바를 입력했을때 링크를 실행할 것인지의 여부
*
* @remarks
* true를 입력하면 셀에 포커스가 있고 편집상태가 아닐때 스페이스 바를 입력하면 링크가 실행된다.
* {@link GridBase.onCellItemClicked}가 있는 경우 해당 이벤트가 호출된후 결과값이 false이면 기본동작을 실행하지 않는다.
*
* @defaultValue `true`
*/
spaceKey?: boolean;
/**
* enter를 입력했을때 링크를 실행할 것인지의 여부
*
* @remarks
* true를 입력하면 셀에 포커스가 있고 편집상태가 아닐때 enter를 입력하면 링크가 실행된다.
* {@link GridBase.onCellItemClicked}가 있는 경우 해당 이벤트가 호출된후 결과값이 false이면 기본동작을 실행하지 않는다.
*
* @defaultValue `true`
*/
enterKey?: boolean;
/**
* 링크 될 주소를 지정하기 위한 콜백
*
* @remarks
* 지정되면 `linkField`, `baseUrl` 을 무시한다.
*
* @eventProperty
* @example
* ```js
* column.renderer = {
* "type": "link",
* "urlCallback": function (grid, cell) {
* return "http://realgrid.com";
* },
* }
* ```
*/
urlCallback?: GetLinkUrlCallback;
/**
* HTML Anchor Element의 title 텍스트 값으로 읽어올 필드의 필드명
*
* @example
* ```js
* column.renderer = {
* "type": "link",
* "linkField": "ProductID",
* "titleField": "CompanyName"
* }
* ```
*/
titleField?: string;
/**
* HTML Anchor Element의 title 텍스트를 설정하기 위한 콜백
*
* @remarks
* 설정할 HTML Anchor Element의 title 텍스트를 반환해야 한다.
*
* {@link GetCellTitleCallback} 의 형식을 따른다.
*
* @eventProperty
* @example
*
* ```js
* const f = function(grid, model) {
* return 'new product'
* }
*
* let column.renderer = {
* "type": "link",
* "urlCallback": function (grid, cell) {
* return "http://realgrid.com";
* },
* "titleCallback": f
* }
* ```
*/
titleCallback?: GetCellTitleCallback;
/**
* anchor element에 class를 추가한다.
*
* @remarks
* anchor element의 style을 변경하기 위한 class를 추가한다.
*
* {@link GetClassCallback}의 형식을 따른다.
*
* @eventProperty
*
* @example
*
* ```html
*
* ```
*
* ```js
* const f = function(grid, model) {
* var cls = "";
* var value = model.value || "";
* value.indexOf("new") && (cls += " new");
* value.indexOf("button") && (cls += " btn");
*
* return cls.trim();
* }
*
* column.renderer = {
* type: "link",
* "classCallback": f
* }
* ```
*/
classCallback?: GetClassCallback;
/**
* a tag에 text가 없는 경우 a tag를 화면에서 제거한다.
*
* @defaultValue `true`
*
*/
hideWhenEmpty?: boolean;
}
/**
* @public
* {@link DropDownCellEditor}의 목록을 만들때 사용하는 콜백
* 조건에 따라 변경되는 item을 가져올때 사용한다.
*
* @remarks
* {@link DataColumn.lookupDisplay}가 적용되기 위해서는 {@link DataColumn.labelField}를 이용해야 한다.
*
* 컬럼에 {@link DataColumn.lookupSourceId | lookupSource}가 연결된 상태에서 `undefined`가 return 되면 lookupSource에 있는 data가 표시된다.
*
* [매개 변수 목록]
*
* `grid` - gridView
*
* `index` - CellIndex
*/
export declare type ListCallback = (grid: GridBase, index: CellIndex) => ListResult | undefined | Promise
'+
* ' value = '+value+'>'+
* ' label = '+label+''+
* ' Country: '+item.name
* }
* }
* }
* ]
* ```
*/
export declare type ListTemplateCallback = (grid: GridBase, index: CellIndex, dom: HTMLDivElement, value: string, label: string, item: any) => void;
/**
* @public
*
* 고정된 값을 화면에 표시하는 컬럼
*
* @remarks
* `value`로 지정된 값이 화면에 표시된다.
*
* `type`속성에 `'literal'`을 설정하면 적용된다.
*
* {@link ValueColumn}을 상속한다.
*/
export declare interface LiteralColumn extends ValueColumn {
/**
* 컬럼의 type
*/
type: "literal";
/**
* 화면에 표시되는 Text
*/
value?: string;
}
/**
* @public
* LocalDataProvider 클래스. {@link DataProviderBase} 를 상속한다.
*
* @remarks
* [상위 클래스]
*
* {@link DataProviderBase}
*/
export declare class LocalDataProvider extends DataProviderBase {
/**
* @internal
*/
/**
* rowCount를 읽어오거나 설정한다. 설정하는 경우 {@link LocalDataProvider.setRowCount} 참조.
*/
get rowCount(): number;
set rowCount(value: number);
/**
* 데이터 행의 건수가 변경되었음을 알리는 콜백
*
* @remarks
* 행 추가 및 삭제 등으로 데이터 행의 개수가 변경됐을 때 호출된다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `newCount` - 변경 후 전체 데이터 행의 건수
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowCountChanged = function (provider, newCount) {
* console.log("DataProvider rowCount changed as: " + newCount);
* };
* ```
*/
onRowCountChanged?: (provider: LocalDataProvider, newCount: number) => void;
/**
* 데이터 행의 수정을 결정하는 콜백
*
* @remarks
* 데이터 행이 수정되기 직전에 호출하여 행의 수정 여부를 확인한다. 행의 수정이 완료된 후 {@link LocalDataProvider.onRowUpdated | onRowUpdated}가 발생한다.
*
* 이벤트에 함수가 바인딩되지 않은 경우 기본으로 `true`를 반환한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 변경된 데이터 행의 인덱스
*
* `oldValues` - 기존 데이터행의 값들
*
* `newValues` - 수정될 데이터행의 값들
* @defaultValue `null`
* [반환값] - `true`면 행의 수정을 완료하고 `false`면 행의 수정을 취소한다.
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowUpdating = function (provider, row, oldValues, newValues) {
* if(row % 2 === 0) {
* console.log("DataProvider row updated: " + row);
* return true;
* }
* return false;
* };
* ```
*/
onRowUpdating?: (provider: LocalDataProvider, row: number, oldValues: RowValues, newValues: RowValues) => boolean;
/**
* 데이터 행이 수정되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.onRowUpdating | onRowUpdating} 에서 `true`가 반환되었을 때 수정이 완료된 후에 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 변경된 데이터 행의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowUpdated = function (provider, row) {
* console.log("DataProvider row updated: " + row);
* };
* ```
*/
onRowUpdated?: (provider: LocalDataProvider, row: number) => void;
/**
* 다수의 데이터 행이 일괄 수정되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.updateRows | updateRows } 등의 함수에서 이벤트 일괄 반영되도록 했을 때 발생한다.
* @eventProperty
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 변경된 시작 데이터 행의 인덱스
*
* `count` - 변경된 행의 건수
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowsUpdated = function (provider, row, count) {
* console.log("DataProvider rows updated from " + row + 'to' + (count + row));
* };
* ```
*/
onRowsUpdated?: (provider: LocalDataProvider, row: number, count: number) => void;
/**
* 다수의 데이터 행이 변경되었음을 알리는 콜백
* @remarks
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `rows` - 변경된 데이터 행들의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowListUpdated = function (provider, rows) {
* console.log("DataProvider rows updated: " + rows.join(', '));
* };
* ```
*/
onRowListUpdated?: (provider: LocalDataProvider, rows: number[]) => void;
/**
* 데이터 행 추가를 결정하는 콜백
*
* @remarks
* 데이터 행이 추가되기 직전에 호출하여 행의 추가 여부를 확인한다. 행의 수정이 완료된 후 {@link LocalDataProvider.onRowInserted | onRowInserted }가 발생한다.
*
* 이벤트에 함수가 바인딩되지 않은 경우 기본으로 `true`를 반환한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 추가될 데이터 행의 인덱스
*
* `values` - 추가될 데이터 값, {@link DataValues} 형식
*
* @defaultValue `null`
* [반환값] - `true`이면 행의 추가를 완료하고 `false`이면 행의 추가를 취소한다.
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowInserting = function (provider, row, values) {
* if (row > 100) {
* return false;
* }
* return true;
* };
* ```
*/
onRowInserting?: (provider: LocalDataProvider, row: number, values: DataValues) => boolean;
/**
* 데이터 행이 추가되었을을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.onRowInserting | onRowInserting} 콜백에서 `true`가 반환되어 행이 추가된 후 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 추가된 데이터 행의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowInserted = function (provider, row) {
* console.log("DataProvider row inserted!");
* };
* ```
*/
onRowInserted?: (provider: LocalDataProvider, row: number) => void;
/**
* 다수의 데이터 행이 일괄 추가되었을 때 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.insertRows} 등의 함수에서 이벤트 일괄 반영되도록 했을 때 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 변경된 시작 데이터 행의 인덱스
*
* `count` - 변경된 행의 건수
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowsInserted = function (provider, row, count) {
* console.log("DataProvider " + count + " rows inserted!");
* };
* ```
*/
onRowsInserted?: (provider: LocalDataProvider, row: number, count: number) => void;
/**
* 데이터 행의 삭제를 결정하는 콜백
*
* @remarks
* 데이터 행이 삭제되기 직전에 호출하여 행의 삭제 여부를 확인한다. 행의 삭제가 완료된 후 {@link LocalDataProvider.onRowDeleted | onRowDeleted} 가 발생한다.
*
* 이벤트에 함수가 바인딩되지 않은 경우 기본으로 `true`를 반환한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 추가될 데이터 행의 인덱스
*
* @defaultValue `null`
* [반환값] - `true`이면 행의 삭제를 완료하고 `false`이면 행의 삭제를 취소한다.
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowDeleting = function (provider, row) {
* if (row < 100) {
* return false;
* }
* return true;
* };
* ```
*/
onRowDeleting?: (provider: LocalDataProvider, row: number) => boolean;
/**
* 데이터 행이 삭제되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.onRowDeleting | onRowDeleting} 콜백 함수에서 `true`가 반환되어 행이 추가된 후 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 삭제된 데이터 행의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowDeleted = function (provider, row) {
* console.log('dataProvider row deleted: ' + row);
* };
* ```
*/
onRowDeleted?: (provider: LocalDataProvider, row: number) => void;
/**
* 데이터 행이 삭제되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.onRowDeleting | onRowDeleting} 콜백 함수에서 `true`가 반환되어 행이 추가된 후 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 삭제된 데이터 행의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowsDeleted = function (provider, rows) {
* console.log('DataProvider rows deleted: ' + rows.join(', '));
* };
* ```
*/
onRowsDeleted?: (provider: LocalDataProvider, rows: number[]) => void;
/**
* 데이터 행의 이동을 결정하는 콜백
*
* @remarks
* 데이터 행이 이동 되기 직전에 호출하여 행의 이동 여부를 결정한다. 행의 이동이 완료된 후 {@link LocalDataProvider.onRowMoved | onRowMoved} 가 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 데이터 행의 원래의 인덱스
*
* `newRow` - 데이터 행의 이동후의 인덱스
*
* @defaultValue `null`
* [반환값] - `true`이면 행의 이동을 완료하고 `false`이면 행의 이동을 취소한다.
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowMoving = function (provider, row, newRow) {
* if (row < newRow) {
* return false;
* }
* return true;
* };
* ```
*/
onRowMoving?: (provider: LocalDataProvider, row: number, newRow: number) => boolean;
/**
* 데이터 행이 이동되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.onRowMoving | onRowMoving } 콜백 함수에서 `true`가 반환되어 행이 이동된 후 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 데이터 행의 원래의 인덱스
*
* `newRow` - 데이터 행의 이동후의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowMoved = function (provider, row, newRow) {
* console.log('DataProvider row moved from ' + row + ' to ' + newRow);
* };
* ```
*/
onRowMoved?: (provider: LocalDataProvider, row: number, newRow: number) => void;
/**
* 복수의 데이터 행의 이동을 결정하는 콜백
*
* @remarks
* 복수의 데이터 행이 이동 되기 직전에 호출하여 행의 이동 여부를 결정한다.행들의 이동이 완료된 후 {@link LocalDataProvider.onRowsMoved | onRowsMoved} 가 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 첫 데이터 행의 원래의 인덱스
*
* `count` - 이동할 데이터 행의 건수
*
* `newRow` - 첫 데이터 행의 이동 후의 인덱스
*
* @defaultValue `null`
* [반환값] - `true`이면 행들의 이동을 완료하고 `false`이면 행들의 이동을 취소한다.
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowsMoving = function (provider, row, count, newRow) {
* if (row < newRow || count > 20) {
* return false;
* }
* return true;
* };
* ```
*/
onRowsMoving?: (provider: LocalDataProvider, row: number, count: number, newRow: number) => boolean;
/**
* 복수의 데이터 행이 이동되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.onRowsMoving | onRowsMoving} 콜백 함수에서 `true`가 반환되어 행들이 이동된 후 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 첫 데이터 행의 원래의 인덱스
*
* `count` - 이동할 데이터 행의 건수
*
* `newRow` - 첫 데이터 행의 이동후의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowsMoved = function (provider, row, count, newRow) {
* console.log('DataProvider ' + count + ' rows moved!');
* };
* ```
*/
onRowsMoved?: (provider: LocalDataProvider, row: number, count: number, newRow: number) => void;
/**
* 마우스를 이용한 행의 이동을 결정하는 콜백
*
* @remarks
* 복수의 데이터 행이 이동 되기 직전에 호출하여 행의 이동 여부를 결정한다.행들의 이동이 완료된 후 {@link LocalDataProvider.onRowListMoved | onRowListMoved} 가 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `rows` - 이동되는 행 인덱스의 배열
*
* `newRow` - 첫 데이터 행의 이동 후의 인덱스
*
* @defaultValue `null`
* [반환값] - `true`이면 행들의 이동을 완료하고 `false`이면 행들의 이동을 취소한다.
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowListMoving = function (provider, rows, newRow) {
* return rows.length === 1)
* };
* ```
*/
onRowListMoving?: (provider: LocalDataProvider, rows: number[], newRow: number) => boolean;
/**
* 복수의 데이터 행이 이동되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.onRowListMoving | onRowListMoving} 콜백 함수에서 `true`가 반환되어 행들이 이동된 후 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `rows` - 이동된 행 인덱스의 배열
*
* `newRow` - 첫 데이터 행의 이동후의 인덱스
*
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowListMoved = function (provider, rows, newRow) {
* console.log('DataProvider ' + rows.length + ' rows moved!');
* };
* ```
*/
onRowListMoved?: (provider: LocalDataProvider, rows: number[], newRow: number) => void;
/**
* 데이터 셀의 값이 변경되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.setValue | setValue()} 를 이용하여 데이터를 변경할 때 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 값이 변경된 행의 인덱스
*
* `field` - 값이 변경된 필드의 인덱스
*
* @eventProperty
*
* @example
* ```js
* dataProvider.onValueChanged = function (provider, row, field) {
* console.log('DataProvider row Value changed at ' + row + ' on ' + field);
* };
* ```
*/
onValueChanged?: (provider: LocalDataProvider, row: number, field: number) => void;
/**
* 데이터 셋의 값이 변경되었었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.setValue | setValue()} 함수나 View에서의 입력으로 값이 바뀔 때 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* @eventProperty
* @example
* ```js
* dataProvider.onDataChanged = function (provider) {
* console.log('dataChanged!');
* };
* ```
*/
onDataChanged?: (provider: LocalDataProvider) => void;
/**
* 데이터 행의 상태가 변경되었음을 알리는 콜백
*
* @remarks
* 데이터행의 상태가 변경되는 경우 발생, 단 행 추가시에는 상태가 변경되었다 할 수 없으므로 예외로 한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `row` - 상태가 변경된 데이터 행의 인덱스
*
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowStateChanged = function (provider, row) {
* console.log('dataProvider row state changed: ' + row);
* };
* ```
*/
onRowStateChanged?: (provider: LocalDataProvider, row: number) => void;
/**
* 복수의 데이터 행의 상태가 일괄 변경되었음을 알리는 콜백
*
* @remarks
* 복수의 데이터행의 상태가 일괄 변경되는 경우 발생, 단 행 추가시에는 상태가 변경되었다 할 수 없으므로 예외로 한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `rows` - 상태가 변경된 데이터 행들의 인덱스 배열
*
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowStatesChanged = function (provider, rows) {
* console.log('dataProvider row state changed: ' + rows.join(','));
* };
* ```
*/
onRowStatesChanged?: (provider: LocalDataProvider, rows: number[]) => void;
/**
* 모든 행의 상태가 초기회 되었음을 알리는 콜백
*
* @remarks
* {@link DataProviderBase.clearRowStates} 를 통해 행의 상태가 모두 초기화 한 후에 발생
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
* @eventProperty
*
* @example
* ```js
* dataProvider.onRowStatesCleared = function (provider) {
* console.log('dataProvider row state cleared!');
* };
* ```
*/
onRowStatesCleared?: (provider: LocalDataProvider) => void;
/**
* 복수의 데이터 행의 상태가 복원되었음을 알리는 콜백
*
* @remarks
* {@link DataProviderBase.restoreUpdatedRows | restoreUpdatedRows() } 함수를 통해 수정된 행들이 복원 되었을 때 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `rows` - 복원된 데이터 행들의 인덱스 배열
*
* @eventProperty
*
* @example
* ```js
* dataProvider.onRestoreRows = function (provider, rows) {
* console.log('dataProvider row restored: ' + rows.join(', '));
* };
* ```
*/
onRestoreRows?: (provider: LocalDataProvider, rows: number[]) => void;
/**
* 데이터 셋의 데이터 건수를 반환한다.
*
* @example
* ```js
* let rowCount = ds.getRowCount();
* ```
*/
getRowCount(): number;
/**
* 데이터 셋의 데이터 건수를 설정하다.
*
* @remarks
* 데이터 셋의 데이터 건수를 강제로 설정한다. 기존의 건수가 새로운 건수보다 많을 경우 잘려서 버려지고 새로운 건수가 많을 경우 새로운 행이 추가된다.
*
* @param newCount - 새로운 데이터 건수
* @param fillFieldDefaults - 새로운 행이 추가될때 필드의 기본값을 사용하여 값을 넣을지의 여부, 기본값: `false`
* @param defaultValues - 새로운 행이 추가될때 각각의 필드에 해당하는 값들, 기본값: `null`, 필드순서대로 사용한다.
* @param rowState - 새로운 행의 상태, 기본값: {@link RowState.NONE}
*
* @example
* ```js
* ds.setRowCount(100);
* ```
*/
setRowCount(newCount: number, fillFieldDefaults?: boolean, defaultValues?: DataValues, rowState?: RowState): void;
/**
* 필터간의 연산조건을 설정한다.
*
* @remarks
* 필터들의 연산 조건을 AND 또는 OR로 설정한다
* {@link LocalDataProvider.setFilters | setFilters }에서 filterMode 지정하는것과 동일한 기능이다
*
* @param filterMode - 필터들의 연산 조건. `'and'`또는 `'or'`
*/
setFilterMode(filterMode?: string): void;
/**
* 데이터 셋에서 데이터를 필터링한다.
*
* @remarks
* DataProvider에 필터를 적용한다. 필터에 부합하지 않은 행은 DataProvider에 존재하지 않게 된다.
*
* @param filters - 필터 설정 값
* @param filterMode - 필터들의 연산 조건. `'and'`또는 `'or'` 다.
* @example
* ```js
* // nonArray
* dataProvider.setFilters({criteria: "value['field1']='가수'"});
*
* // string
* dataProvider.setFilters([
* "value['field1']='가수'",
* "value['field2']='여자'"
* ], "and");
*
* // object
* dataProvider.setFilters([
* {criteria: "value['field1']='가수'"},
* {criteria: "value['field2']='여자'"}
* ], "and");
* ```
*/
setFilters(filters: DataFilters, filterMode?: string): void;
/**
* JSON 데이터 원본에서 데이터를 가져와 데이터 셋을 생성한다.
*
* @param data - 데이터 원본, JSON 문자열 또는 오브젝트의 배열
* @param options - 데이터 추출및 채우는 방식 설정, {@link DataFillOptions} 또는 DataFillOptions 객체, `null`이면 기본값으로 동작
* @example
* ```js
* let options = {
* start: 1,
* count: 3
* }
*
* dataProvider.fillJsonData([
* {
* FieldA: 'ABC',
* FieldB: 10
* }, {
* FieldA: 'DEF',
* FieldB: 30
* }], options);
* ```
*/
fillJsonData(data: any, options?: DataFillOptions): void;
/**
* XML 데이터 원본에서 문자열을 파싱하여 데이터 셋을 생성한다.
*
* @param data - XML 문자열
* @param options - 데이터 추출및 채우는 방식 설정, {@link DataFillOptions} 객체 또는 DataFillOptions와 동일 구조의 object
*
* @example
* ```js
* let options = {
* start: 1,
* count: 3
* }
*
* dataProvider.fillXmlData(data, options);
* ```
*/
fillXmlData(data: any, options?: DataFillOptions): void;
/**
* CSV 데이터 원본에서 문자열을 파싱하여 데이터 셋을 생성한다.
*
* @param data - CSV 문자열
* @param options - 데이터 추출및 채우는 방식 설정, {@link DataFillOptions} 객체 또는 DataFillOptions와 동일 구조의 object
*
* @example
* ```js
* let options = {
* start: 1,
* count: 3
* }
*
* dataProvider.fillCsvData(data, options);
* ```
*/
fillCsvData(data: any, options?: DataFillOptions): void;
/**
* 데이터 원본에서 가져와 데이터 셋을 채운다.
*
* @param rows - 데이터 원본, 2차원 배열 또는 오브젝트의 배열
* @param start - 데이터 셋에 채울 데이터의 시작 행, 기본값: `0`
* @param count - 데이터 셋에 채울 데이터 건수, `-1`이면 데이터 원본의 건수만큼 채운다. 기본값: `-1`
* @example
* ```js
* dataProvider.setRows([
* {
* FieldA: 'ABC',
* FieldB: 10
* }, {
* FieldA: 'DEF',
* FieldB: 30
* }]);
* ```
*/
setRows(rows: DataValues[], start?: number, count?: number): void;
/**
* 데이터 원본에서 가져와 데이터 셋에 추가한다.
*
* @param rows - 데이터 원본, 2차원 배열 또는 오브젝트의 배열
* @param start - 데이터 셋에 채울 데이터의 시작 행, 기본값 `0`
* @param count - 데이터 셋에 채울 데이터 건수, `-1`이면 데이터 원본의 건수만큼 추가된다, 기본값: `-1`
* @param rowEvents - true면 행 단위로 추가 이벤트가 발생하고, false면 복수행 추가 이벤트가 한 번 발생한다. 기본값: `false`
* @example
* ```js
* dataProvider.addRows([
* {
* FieldA: 'GHI',
* FieldB: 15
* }, {
* FieldA: 'KLM',
* FieldB: 31
* }]);
* ```
*/
addRows(rows: DataValues[], start?: number, count?: number, rowEvents?: boolean): void;
/**
* 데이터 원본에서 가져와 데이터 셋의 특정 위치에 삽입한다.
*
* @param row - 삽입할 데이터 행의 인덱스
* @param rows - 데이터 원본, 2차원 배열 또는 Object의 배열
* @param start - 데이터 셋에 채울 데이터의 시작 행, 기본값: `0`
* @param count - 데이터 셋에 채울 데이터 건수, -1이면 데이터 원본의 건수만큼 삽입된다. 기본값: `-1`
* @param rowEvents - true면 행 단위로 추가 이벤트가 발생하고, false면 복수행 추가 이벤트가 한 번 발생한다. 기본값: `false`
* @example
* ```js
* dataProvider.insertRows(10, [
* {
* FieldA: 'OPQ',
* FieldB: 34
* }, {
* FieldA: 'RST',
* FieldB: 27
* }]);
* ```
*/
insertRows(row: number, rows: DataValues[], start?: number, count?: number, rowEvents?: boolean): void;
/**
* 데이터 원본에서 가져와 데이터 셋의 특정 위치에 변경한다.
*
* @param row - 변경할 데이터 행의 인덱스
* @param rows - 데이터 원본, 2차원 배열 또는 Object의 배열
* @param start - 데이터 셋에 채울 데이터의 시작 행, 기본값: `0`
* @param count - 데이터 셋에 채울 데이터 건수, `-1`이면 데이터 원본의 건수만큼 변경된다, 기본값: `-1`
* @param strict - textField의 값이 `null`, `undefined` `""`인경우 변경여부 `false`이면 동일한 값으로 판단하여 변경하지 않는다.
* @param rowEvents - `true`이면 행별로 {@link LocalDataProvider.onRowUpdated | onRowUpdated}를 호출한다. `false`이면 {@link LocalDataProvider.onRowsUpdated | onRowsUpdated}를 호출한다.
* @example
* ```js
* dataProvider.updateRows(10, [
* {
* FieldA: 'OPQ',
* FieldB: 34
* }, {
* FieldA: 'RST',
* FieldB: 27
* }]);
* ```
*/
updateRows(row: number, rows: DataValues[], start?: number, count?: number, strict?: boolean, rowEvents?: boolean): void;
/**
* 연속적이지 않은 행을 일괄 수정한다.
* @param rows - 데이터 원본 {1:{"field1":value, "field2":value2}, ...}
* @param strict - textField의 값이 `null`, `undefined` `""`인경우 변경여부 `false`이면 동일한 값으로 판단하여 변경하지 않는다.
* @param rowEvents - `true`이면 행별로 {@link LocalDataProvider.onRowUpdated | onRowUpdated}를 호출한다. `false`이면 {@link LocalDataProvider.onRowListUpdated | onRowListUpdated}를 호출한다.
*
* @example
* ```js
* var data = {
* 1:{"field1":value1, "field2":value2},
* 3:{"field1":value1, "field2":value2}
* }
* dataProvider.updateRowsByDataRow(data);
* ```
*/
updateRowsByDataRow(rows: {
[key: number]: DataValues;
}, strict?: boolean, rowEvents?: boolean): void;
/**
* 데이터 셋을 초기화한다
*
* @example
* ```js
* dataProvider.clearRows();
* ```
*/
clearRows(): void;
/**
* 데이터 셋의 특정 데이터 행의 값을 변경한다.
*
* @param row - 변경할 데이터 행의 인덱스
* @param values - 행의 변경할 데이터, 필드 인덱스 순서대로 배열에서 가져온다
* @param strict - 값이 `undefined` 이거나 명시되지 않은 필드는 기존의 값을 유지한다
*
* @example
* ```js
* dataProvider.updateRow(3, ['value1', 'value2', 'value3', 'value4'], true);
* ```
*/
updateRow(row: number, values: DataValues, strict?: boolean): void;
/**
* 특정 행들을 View에게 감출 때 사용한다.
* @remarks
* 숨겨진 상태에서 데이터 셋의 추가, 삭제가 발생하는 경우 인덱스가 변경되므로 주의를 요한다.
* @param dataRows - 감출 데이터 행의 인덱스 또는 인덱스 배열
*
* @example
* ```js
* // single
* dataProvider.hideRows(3);
*
* //multiple
* dataProvider.hideRows([3,2,1]);
* ```
*/
hideRows(dataRows: number[] | number): void;
/**
* 감춰진 데이터행을 다시 표시한다.
*
* @param dataRows - 다시 표시할 데이터 행의 인덱스 또는 인덱스 배열
*
* @example
* ```js
* // single
* dataProvider.showHiddenRows(3);
*
* //multiple
* dataProvider.showHiddenRows([3,2,1]);
* ```
*/
showHiddenRows(dataRows: number[] | number): void;
/**
* 감춰진 데이터행들의 인덱스을 반환한다.
*
* @example
* ```js
* let hiddens = dataProvider.getHiddenRows();
* ```
*/
getHiddenRows(): number[];
/**
* 특정 행이 감춰줘있는지의 여부를 반환한다.
*
* @param dataRow - 확인할 데이터 행의 인덱스
*
* @example
* ```js
* let isHidden = dataProvider.isHiddenRow(3);
* ```
*/
isHiddenRow(dataRow: number): boolean;
/**
* 모든 행의 감춰진 상태를 초기환한다.
*
* @example
* ```js
* dataProvider.resetHiddenRows();
* ```
*/
resetHiddenRows(): void;
/**
* 데이터 행을 추가한다
*
* @param values - 추가할 행의 값, 배열 또는 Object
* @returns 추가된 행의 dataRow 실패한경우 -1이 return된다.
*
* @example
* ```js
* dataProvider.addRow({
* FieldA: 'GHI',
* FieldB: 15
* });
* ```
*/
addRow(values: DataValues): number;
/**
* 특정 위치에 데이터 행을 삽입한다
*
* @param row - 삽입할 데이터 행의 인덱스
* @param values - 삽입할 행의 값, 배열 또는 오브젝트
*
* @example
* ```js
* dataProvider.insertRow(4, {
* FieldA: 'DNA',
* FieldB: 15
* });
* ```
*/
insertRow(row: number, values: DataValues): boolean;
/**
* 특정 위치의 데이터 행을 제거한다
*
* @param row - 제거할 데이터 행의 인덱스
*
* @example
* ```js
* dataProvider.removeRow(2);
* ```
*/
removeRow(row: number): void;
/**
* 특정 위치의 복수의 데이터 행들을 제거한다.
*
* @param rows - 제거할 데이터 행 인덱스의 배열
* @param rowEvents - 개별 이벤트 발생 여부, 기본값: `false`
*
* @example
* ```js
* dataProvider.removeRows([2,3,4]);
* ```
*/
removeRows(rows: number[], rowEvents?: boolean): void;
/**
* 특정 데이터 행을 이동한다
*
* @param rows - 이동할 데이터 행 인덱스
* @param newRow - 새로운 인덱스
*
* @example
* ```js
* dataProvider.moveRow(2, 5);
* ```
*/
moveRow(row: number, newRow: number): void;
/**
* 복수의 데이터 행들을 이동한다.
*
* @param row - 이동할 데이터 행들 중 첫 행의 인덱스
* @param count - 이동할 데이터 행의 건수
* @param newRow - 이동될 행의 인덱스
* @example
* ```js
* dataProvider.moveRows(2, 2, 5);
* ```
*/
moveRows(row: number, count: number, newRow: number): void;
/**
* 특정 데이터 행의 특정 필드의 값을 반환한다.
*
* @param row - 값을 가져올 데이터 행의 인덱스
* @param field - 값을 가져올 필드의 인덱스 또는 필드명
*
* @example
* ```js
* let val = dataProvider.getValue(2, 10);
* ```
*/
getValue(row: number, field: number | string): any;
/**
* 특정 데이터 행의 특정 필드의 값을 변경한다.
*
* @param row - 값을 변경할 데이터 행의 인덱스
* @param field - 값을 변경할 필드의 인덱스 또는 필드명
* @param newValue - 변경할 새로운 값
*
* @example
* ```js
* dataProvider.setValue(2, 5, 'newValue');
* ```
*/
setValue(row: number, field: number | string, newValue: any): void;
/**
* 데이터 셋의 특정 구간의 데이터를 2차원 배열로 반환한다.
*
* @param startRow - 시작 데이터 행의 인덱스 0이면 시작, 기본값: `0`
* @param endRow - 끝 데이터 행의 인덱스, `-1`이면 데이터 셋의 끝까지, 기본값: `-1`
*
* @example
* ```js
* let rows = dataProvider.getRows();
* ```
*/
getRows(startRow?: number, endRow?: number): RowValues[];
/**
* @public
* 지정한 데이터 행의 값을 Object 형태로 변환한다.
*
* @param row - 행 고유번호
* @param rowState - `true`이면 행의 상태값을 추가한다.
*
* @returns 행의 값을 json 형태로 반환한다.
*
* @example
* ```js
* let jsonRow = ds.getJsonRow(5);
* ```
*/
getJsonRow(row: number, rowState?: boolean): RowObject;
/**
* 데이터 셋의 특정 구간의 데이터를 Object 배열로 반환한다.
*
* @param startRow - 시작 데이터 행의 인덱스, 기본값: `0`
* @param endRow - 끝 데이터 행의 인덱스, -1이면 데이터 셋의 끝까지
* @param rowState - `true`이면 결과 값에 행의 상태값을 추가한다.
*
* @example
* ```js
* let rows = dataProvider.getJsonRows();
* ```
*/
getJsonRows(startRow?: number, endRow?: number, rowState?: boolean): object[];
/**
* 데이터 셋의 특정 데이터 행을 설정에 따라 Object로 반환한다.
*
* @param options - 데이터를 반환내는 방식 설정, {@link DataOutputOptions} 과 동일
* @param row - 데이터 행의 인덱스
*
* @example
* ```js
* let opt = {
* nullText: '빈 값'
* }
* let row = dataProvider.getOutputRow(opt, 4);
* ```
*/
getOutputRow(options: DataOutputOptions, row: number): object;
/**
* 데이터 셋의 특정 구간의 데이터를 설정에 따라 Object 배열로 반환한다.
*
* @param options - 데이터를 반환내는 방식 설정, {@link DataOutputOptions} 과 동일
* @param startRow - 시작 데이터 행의 인덱스, 기본값: `0`
* @param endRow - 끝 데이터 행의 인덱스, -1이면 데이터 셋의 끝까지, 기본값: `-1`
*
*
* @example
* ```js
* let opt = {
* nullText: '빈 값'
* }
* let rows = dataProvider.getOutputRows(opt, 4, 10);
* ```
*/
getOutputRows(options: DataOutputOptions, startRow?: number, endRow?: number): object[];
/**
* 데이터 셋의 특정 필드에 해당하는 특정 구간의 데이터를 반환한다.
*
* @param filed - 필드의 인덱스 또는 필드명
* @param startRow - 시작 행의 인덱스, 기본값: `0`
* @param endRow - 마지막 행의 인덱스, -1이면 데이터 셋의 끝까지, 기본값: `-1`
*/
getFieldValues(field: number | string, startRow?: number, endRow?: number): any[];
/**
* 검색 설정 방식에 따라 특정 값이 있는 행을 찾는다.
*
* @param options - 검색 방식, {@link SearchOptions} 모델로 지정한다.
* @returns 찾은 행의 인덱스
*
* @example
* ```js
* ds.searchDataRow({fields:['fieldName'], values: ['value']});
* ```
*/
searchDataRow(options: SearchOptions): number;
/**
* 검색 설정 방식에 따라 특정 값이 있는 셀을 찾는다.
*
* @param options - 검색 방식, {@link SearchCellOptions} 모델로 지정한다.
* @returns 찾은 셀의 정보, {@link SearchCellResult} 모델이다.
*
* @example
* ```js
* ds.searchData({fields:['fieldName'], value: 'value'});
* ```
*/
searchData(options: SearchCellOptions): SearchCellResult;
}
/**
* @public
* LocalTreeDataProvider 클래스. {@link DataProviderBase} 를 상속한다.
*
* @remarks
* [상위 클래스]
*
* {@link DataProviderBase}
*/
export declare class LocalTreeDataProvider extends DataProviderBase {
/**
* @internal
*/
/**
* 행의 갯수가 변경되었음을 알리는 콜백
*
* @remarks
* 행 추가 및 삭제 등으로 행의 개수가 변경됐을 때 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `newCount` - 변경된 행의 갯수
*
* @example
* ```js
* dataProvider.onRowCountChanged = function (provider, count) {
* console.log("DataProvider rowCount changed as: " + newCount);
* };
* ```
*/
onRowCountChanged?: (provider: LocalTreeDataProvider, newCount: number) => void;
/**
* 행이 추가됨을 결정하는 콜백
*
* @remarks
* TreeDataProvider에 데이터가 추가되기 직전에 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 데이터 행의 트리 id
*
* `index` - 부모 행의 자식들 중 삽입된 행의 위치(순서)
*
* `child` - 추가 된 행의 자식 데이터
*
* @defaultValue `null`
* [반환값] - 기본값: `true`, 명시적으로 `false`를 리턴하면 행이 삽입되지 않는다.
*
* @example
* ```js
* dataProvider.onRowAdding = function (provider, row, index, child) {
* if (row > 100) {
* return false;
* }
* return true;
* };
* ```
*/
onRowAdding?: (provider: LocalTreeDataProvider, row: number, index: number, child: any) => boolean;
/**
* 행이 추가되었음을 알리는 콜백
*
* @remarks
* TreeDataProvider에 데이터가 추가된 후 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 데이터 행의 트리 id
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowAdded = function (provider, row) {
* console.log("DataProvider row added at "+ row);
* };
* ```
*/
onRowAdded?: (provider: LocalTreeDataProvider, row: number) => void;
/**
* 행들이 추가되었음을 알리는 콜백
*
* @remarks
* TreeDataProvider에 데이터가 추가된 후 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `parent` - 부모의 id
*
* `rows` - 데이터 행들의 트리 id들
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowsAdded = function (provider, parent, rows) {
* console.log("DataProvider row added at " + parent + " as " + rows.join(", "));
* };
* ```
*/
onRowsAdded?: (provider: LocalTreeDataProvider, parent: number, rows: number[]) => void;
/**
* 행 삭제를 결정하는 콜백
*
* @remarks
* TreeDataProvider에 데이터가 삭제되기 전 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 데이터 행의 트리 id
*
* @defaultValue `null`
*
* [반환값] - - 기본값: `true`, 삭제하려면 `true`, 삭제를 취소하려면 `false` 를 반환한다.
*
* @example
* ```js
* dataProvider.onRowDeleting = function (provider, row) {
* if (row < 100) {
* return false;
* }
* return true;
* };
* ```
*/
onRowDeleting?: (provider: LocalTreeDataProvider, row: number) => boolean;
/**
* 행 삭제가 되었음을 알리는 콜백
*
* @remarks
* TreeDataProvider에 데이터가 삭제된 후 호출한다.
*
* softDeleting = true 일 경우 Row의 State가 Deleted로 변경된 것 만으로는 호출되지 않는다.
*
* 완전히 TreeDataProvider에서 삭제되었을 때 발생한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 데이터 행의 트리 id
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowDeleted = function (provider, row) {
* console.log('dataProvider row deleted ' + row);
* };
* ```
*/
onRowDeleted?: (provider: LocalTreeDataProvider, row: number) => void;
/**
* 행들이 삭제가 되었음을 알리는 콜백
*
* @remarks
* TreeDataProvider에 데이터 행들이 삭제된 후 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `rows` - 데이터 행들의 트리 id들
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowsDeleted = function (provider, rows) {
* console.log('DataProvider rows deleted: ' + rows.join(', '));
* };
* ```
*/
onRowsDeleted?: (provider: LocalTreeDataProvider, rows: number[]) => void;
/**
* 행 수정을 결정하는 콜백
*
* @remarks
* TreeDataProvider에 데이터가 수정되기 전에 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 데이터 행의 트리 id
*
* `oldValues` - 기존 데이터행의 값들
*
* `newValues` - 수정될 데이터행의 값들
*
* @defaultValue `null`
* [반환값] - 기본값: `true`, `false` 를 반환하면 수정이 취소된다.
*
* @example
* ```js
* dataProvider.onRowUpdating = function (provider, row, oldValues, newValues) {
* if(row % 2 === 0) {
* console.log("DataProvider row updated: " + row);
* return true;
* }
* return false;
* };
* ```
*/
onRowUpdating?: (provider: LocalTreeDataProvider, row: number, oldValues: RowValues, newValues: RowValues) => boolean;
/**
* 행 수정이 되었음을 알리는 콜백
*
* @remarks
* TreeDataProvider에 데이터가 수정되기 전에 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 데이터 행의 트리 id
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowUpdated = function (provider, row) {
* console.log("DataProvider row updated: " + row);
* };
* ```
*/
onRowUpdated?: (provider: LocalTreeDataProvider, row: number) => void;
/**
* 다수의 데이터 행 변경을 결정하는 콜백
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `rows` - 변경될 데이터 행들의 트리 id
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowsUpdating = function (provider, rows) {
* if (rows.length > 10) {
* return false;
* }
* return true;
* };
* ```
*/
onRowsUpdating?: (provider: LocalTreeDataProvider, rows: number[]) => boolean;
/**
* 다수의 데이터 행이 변경되었음을 알리는 콜백
*
* @remarks
* {@link LocalDataProvider.updateRows | updateRows } 등의 함수에서 이벤트 일괄 반영되도록 했을 때 발생한다.
*
* [매개변수 목록]
*
* `provider` - DataProvider 컨트롤
*
* `rows` - 변경된 데이터 행들의 트리 id들
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowsUpdated = function (provider, rows) {
* console.log("DataProvider rows updated: " + rows.join(', '));
* };
* ```
*/
onRowsUpdated?: (provider: LocalTreeDataProvider, rows: number[]) => void;
/**
* 데이터의 값이 변경 되었음을 알리는 콜백
*
* @remarks
* {@link LocalTreeDataProvider.setValue} 를 이용하여 데이터를 변경한후 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 값이 변경된 데이터 행의 트리 id.
*
* `field` - 필드의 인덱스.
*
* @defaultValue `null`
* @example
* ```js
* dataProvider.onValueChanged = function (provider, row, field) {
* console.log('DataProvider row Value changed at ' + row + ' on ' + field);
* };
* ```
*/
onValueChanged?: (provider: LocalTreeDataProvider, row: number, field: number) => void;
/**
* 데이터가 변경 되었음을 알리는 콜백
*
* @remarks
* key 입력이나 {@link LocalTreeDataProvider.setValue} 를 이용하여 데이터를 변경한후 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onDataChanged = function (provider) {
* console.log('dataChanged!');
* };
* ```
*/
onDataChanged?: (provider: LocalTreeDataProvider) => void;
/**
* 행 상태가 변경되었음을 알리는 콜백
*
* @remarks
* TreeDataProvider의 데이터행의 rowState가 변경된 뒤 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 변경된 데이터 행의 트리 id
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowStateChanged = function (provider, row) {
* console.log('dataProvider row state changed: ' + row);
* };
* ```
*/
onRowStateChanged?: (provider: LocalTreeDataProvider, row: number) => void;
/**
* 여러 행들의 상태가 변경되었음을 알리는 콜백
*
* @remarks
* TreeDataProvider에서 여러 건의 데이터행의 rowState가 변경된 뒤 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `rows` - 변경된 데이터 행들의 트리 id 들
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowStatesChanged = function (provider, rows) {
* console.log('dataProvider row state changed: ' + rows.join(','));
* };
* ```
*/
onRowStatesChanged?: (provider: LocalTreeDataProvider, rows: number[]) => void;
/**
* 행 들의 형제 간 이동을 결정하는 콜백
*
* @remarks
* {@link LocalTreeDataProvider.moveRowSibling} 함수를 사용하여 형제 간 위치를 바꾸려고 할때 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 이동하려는 데이터 행의 트리 id
*
* `offset` - 상하 위치 단계 값
*
* @defaultValue `null`
* [반환값] - 기본값: `true`, `false`를 반환하면 이동이 취소된다.
*
* @example
* ```js
* dataProvider.onRowSiblingMoving = function (provider, row, offset) {
* if (row % 2 === 0) {
* return true;
* }
* return false;
* };
* ```
*/
onRowSiblingMoving?: (provider: LocalTreeDataProvider, row: number, offset: number) => boolean;
/**
* 행 들의 형제 간 이동했음을 알리는 콜백
*
* @remarks
* {@link LocalTreeDataProvider.moveRowSibling} 함수를 사용하여 형제 간 위치가 바뀌었을 때 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 이동한 데이터 행의 트리 id
*
* `offset` - 상하 위치 단계 값
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowSiblingMoved = function (provider, row, offset) {
* console.log('sibling row moved on: ' + row);
* };
* ```
*/
onRowSiblingMoved?: (provider: LocalTreeDataProvider, row: number, offset: number) => void;
/**
* DragAndDrop을 이용한 형제 간 이동을 결정하는 콜백
*
* @remarks
* 마우스 dragAndDrop을 사용하여 형제 간 위치를 바꾸려고 할때 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `rows` - 이동하려는 데이터 행의 트리 id 배열
*
* `offset` - 상하 위치 단계 값
*
* @defaultValue `null`
* [반환값] - 기본값: `true`, `false`를 반환하면 이동이 취소된다.
*
* @example
* ```js
* dataProvider.onRowsSiblingMoving = function (provider, rows, offset) {
* if (rows.length > 1) {
* return false;
* }
* return true;
* };
* ```
*/
onRowsSiblingMoving?: (provider: LocalTreeDataProvider, rows: number[], offset: number) => boolean;
/**
* dragAndDrop을 이용해서 형제 간 이동했음을 알리는 콜백
*
* @remarks
* 마우스 dragAndDrop을 사용하여 형제 간 위치가 바뀌었을 때 호출한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `rows` - 이동한 데이터 행의 트리 id 배열
*
* `offset` - 상하 위치 단계 값
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowsSiblingMoved = function (provider, rows, offset) {
* console.log('sibling rows moved on: ' + rows);
* };
* ```
*/
onRowsSiblingMoved?: (provider: LocalTreeDataProvider, rows: number[], offset: number) => void;
/**
* 행의 부모를 바꾸는 것을 결정하는 콜백
*
* @remarks
* {@link LocalTreeDataProvider.changeRowParent} 함수를 사용하여 부모를 바꾸려고 할때 발생한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 이동하려는 데이터 행의 트리 id
*
* `parent` - 이동하려는 곳의 부모 아이템
*
* `index` - 이동하려는 부모의 위치 인덱스
*
* @defaultValue `null`
* [반환값] - `false`를 반환하면 이동이 취소된다.
*
* @example
* ```js
* dataProvider.onRowParentChanging = function (provider, row, parent, index) {
* if (row % 2 === 0) {
* return true;
* }
* return false;
* };
* ```
*/
onRowParentChanging?: (provider: LocalTreeDataProvider, row: number, parent: number, index: number) => boolean;
/**
* 행의 부모가 바뀐 것을 알리는 콜백
*
* @remarks
* {@link LocalTreeDataProvider.changeRowParent} 함수를 사용하여 부모가 바뀐 후에 발생한다.
*
* [매개변수 목록]
*
* `provider` - TreeDataProvider 컨트롤
*
* `row` - 이동한 데이터 행의 트리 id
*
* `parent` - 이동한 곳의 부모 아이템
*
* `index` - 이동한 부모의 위치 index
*
* @defaultValue `null`
*
* @example
* ```js
* dataProvider.onRowParentChanged = function (provider, row, parent, index) {
* console.log('parent row changed to ' + parent);
* };
* ```
*/
onRowParentChanged?: (provider: LocalTreeDataProvider, row: number, parent: number, index: number) => void;
/**
* 저장 된 데이터행의 갯수를 반환한다.
*
* @remarks
* 루트의 하위에 저장되어있는 모든 아이템의 갯수를 반환한다.
*
* @example
* ```js
* let rowCount = ds.getRowCount();
* ```
*/
getRowCount(): number;
/**
* 트리의 데이터를 새로운 데이터로 설정한다.
*
* @remarks
* 트리의 기존 데이터행들을 모두 삭제하고 매개변수로 전달되는 배열의 배열을 데이터 행들로 추가한다.
*
* @param rows - 설정할 데이터
* @param treeField - 필드 명
* @param needSortnig - 정렬 여부
* @param childrenField - 자식 행이 있는 지를 지시하는 필드
* @param iconField - 트리 노드에 표시할 아이콘 경로를 값으로 가지고 있는 필드 이름
*
* @example
* ```js
* dataProvider.setRows([{
* 'uno', 1, 'one', 'ichi', 'ee', 'I'
* }, {
* 'dos', 2, 'two', 'ni', 'er', 'II'
* }
* ], 'number', false, '', 'icon');
* ```
*/
setRows(rows: DataValues[], treeField: string, needSorting?: boolean, childrenField?: string, iconField?: string): void;
/**
* 트리의 데이터를 새로운 CSV 데이터로 설정한다.
*
* @remarks
* 트리의 기존 데이터행들을 모두 삭제하고 매개변수로 전달되는 CSV를 데이터 행들로 추가한다.
*
* @param rows - 설정할 데이터
* @param treeField - 필드 명
* @param needSortnig - 정렬 여부
* @param childrenField - 자식 행이 있는 지를 지시하는 필드
* @param iconField - 트리 노드에 표시할 아이콘 경로를 값으로 가지고 있는 필드 이름
*
* @example
* ```js
* let rows = `Username; Identifier;First name;Last name
* booker12;9012;Rachel;Booker
* grey07;2070;Laura;Grey
* johnson81;4081;Craig;Johnson
* jenkins46;9346;Mary;Jenkins
* smith79;5079;Jamie;Smith
* `
* dataProvider.setCsvRows(rows, 'number', false, '', 'icon');
* ```
*/
setCsvRows(rows: string, treeField: string, needSorting?: boolean, childrenField?: string, iconField?: string): void;
/**
* 트리의 데이터를 새로운 XML 데이터로 설정한다.
*
* @remarks
* 트리의 기존 데이터행들을 모두 삭제하고 매개변수로 전달되는 XML을 데이터 행들로 추가한다.
* rowElement에 "row"를 입력하면 루트의 row element가 사용될 것이고,
* rowElement에 "row[0].row"를 입력하면 루트의 첫번째 행이 사용될 것이다.
* "row.row"는 "row[0].row"와 같다.
*
* @param xml - 설정할 데이터
* @param rowElement - XML 중 트리의 데이터 행들로 사용될 element의 이름
* @param childrenField - 자식 행이 있는 지를 지시하는 필드, 자식의 필드 명
* @param iconField - 트리 노드에 표시할 아이콘 경로를 값으로 가지고 있는 필드 이름
*
* @example
* ```js
* dataProvider.setXmlRows(rows, 'number', false, '', 'icon');
* ```
*/
setXmlRows(xml: any, rowElement: string, childrenField?: string, iconField?: string): void;
/**
* 트리의 데이터를 새로운 JSON 데이터로 설정한다.
*
* @remarks
* 트리의 기존 데이터행들을 모두 삭제하고 매개변수로 전달되는 JSON 객체를 데이터 행들로 추가한다.
*
* @param json - 설정할 데이터. Json 배열이거나 Json 배열을 속성으로 갖는 object. Json 배열이 아닌 경우 rowsProp에 지정된 속성을 배열로 지정해야 한다.
* @param rowsProp - Json 중 트리의 데이터 행들로 사용될 배열을 값으로 하는 속성명
* @param childrenProp - 자식 행이 있는 지를 지시하는 속성 이름. 해당 속성의 값이 자식의 필드 이름과 같아야한다.
* @param iconProp - 트리 노드에 표시할 아이콘 경로를 값으로 가지고 있는 속성명
*
* @example
* ```js
* dataProvider.setObjectRows(rows, 'rowsProp', 'childField', 'iconField');
* ```
*/
setObjectRows(json: any, rowsProp: string, childrenProp?: string, iconProp?: string): void;
/**
* 트리의 데이터를 새로운 JSON 데이터로 설정한다.
*
* @remarks
* 트리의 기존 데이터행들을 모두 삭제하고 매개변수로 전달되는 JSON 객체를 데이터 행들로 추가한다.
* {@link LocalTreeDataProvider.setObjectRows}와 다른점은 childrenProp와 iconProp가 field에 등록되어있지 않아도 된다.
*
* @param json - 설정할 데이터. Json 배열이거나 Json 배열을 속성으로 갖는 object. Json 배열이 아닌 경우 rowsProp에 지정된 속성을 배열로 지정해야 한다.
* @param rowsProp - Json 중 트리의 데이터 행들로 사용될 배열의 속성명
* @param childRowsProp - 1 레벨의 배열명과 하위 레벨의 배열명이 다른경우 하위 레벨의 배열 속성명
* @param childrenProp - 자식 행이 있는 지를 지시하는 속성명.
* @param iconProp - 트리 노드에 표시할 아이콘 경로를 값으로 가지고 있는 속성명
*
* @example
* ```js
* dataProvider.setNestedRows(rows, 'rowsProp', 'childRowsProp', 'childrenProp", 'iconProp');
* ```
*/
setNestedRows(json: any, rowsProp: string, childRowsProp: string, childrenProp?: string, iconProp?: string): void;
/**
* 지정한 설정에 따라 Json 데이터를 로드하여 TreeDataProvider 로컬 저장소에 저장한다.
*
* @param data - json 형태의 데이터
* @param options - {@link DataFillOptions} 와 같은 모델의 설정 정보
*
* @example
* ```js
* let options = {
* start: 1,
* count: 3
* }
*
* dataProvider.fillJsonData([
* {
* FieldA: 'ABC',
* FieldB: 10
* }, {
* FieldA: 'DEF',
* FieldB: 30
* }], options);
* ```
*/
fillJsonData(data: any, options: DataFillOptions): void;
/**
* 지정한 설정에 따라 xml 데이터를 로드하여 TreeDataProvider 로컬 저장소에 저장한다.
*
* @param data - xml 형태의 데이터
* @param options - {@link DataFillOptions} 와 같은 모델의 설정 정보
*
* @example
* ```js
* let options = {
* start: 1,
* count: 3
* }
*
* dataProvider.fillXmlData(data, options);
* ```
*/
fillXmlData(data: any, options: DataFillOptions): void;
/**
* 지정한 설정에 따라 csv 데이터를 로드하여 TreeDataProvider 로컬 저장소에 저장한다.
*
* @param data - csv 형태의 데이터
* @param options - {@link DataFillOptions} 와 같은 모델의 설정 정보
*
* @example
* ```js
* let options = {
* start: 1,
* count: 3
* }
*
* dataProvider.fillCsvData(data, options);
* ```
*/
fillCsvData(data: any, options: DataFillOptions): void;
/**
* 트리 행에 표시된 아이콘 인덱스를 반환한다.
*
* @param row - 데이터 행의 트리 id
*
* @example
* ```js
* let iconIndex = treeProvider.getIconIndex(4);
* ```
*/
getIconIndex(row: number): number;
/**
* 지정한 행의 아이콘을 변경한다.
*
* @param row - 아이콘을 변경할 행의 트리 id
* @param iconIndex - 새로 변경할 아이콘 인덱스
*
* @example
* ```js
* treeProvider.setIconIndex(42, 4);
* ```
*/
setIconIndex(row: number, iconIndex: number): void;
/**
* 지정한 행의 부모의 row id를 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id
* @returns 행 또는 부모 행이 존재하지 않을 경우 -1을 반환한다
*
* @example
* ```js
* let p = treeProvider.getParent(4);
* ```
*/
getParent(row: number): number;
/**
* 지정한 행의 level을 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id
*
* @example
* ```js
* let level = treeProvider.getLevel(4);
* ```
*/
getLevel(row: number): number;
/**
* 지정한 행의 자식 행들의 개수를 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id. -1일 경우 루트 행의 자식 행들의 개수를 반환한다.
* @returns 지정한 행 또는 자식 행이 존재하지 않을 경우 0을 반환한다
* @example
* ```js
* let childCount = treeProvider.getChildCount(4);
* ```
*/
getChildCount(row: number): number;
/**
* 지정한 행의 모든 자식 행들의 고유 번호를 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id, -1일 경우 루트 행의 자식 행들의 고유 번호를 반환한다.
* @returns 지정한 행이 존재하지 않을 경우 null을 반환한다.
*
* @example
* ```js
* let children = treeProvider.getChildren(4);
* ```
*/
getChildren(row: number): number[];
/**
* 지정한 행의 자손 행들의 개수를 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id, -1일 경우 루트 행의 자손 행들의 개수를 반환한다.
*
* @example
* ```js
* let descenCount = treeProvider.getDescendantCount(4);
* ```
*/
getDescendantCount(row: number): number;
/**
* 지정한 행의 자손 행들의 id를 반환한다.
*
* @param data - 지정한 데이터 행의 트리 id, -1일 경우 루트 행의 자손 행들의 row id를 반환한다.
* @param maxLevel - 반환할 수 있는 최대 레벨 깊이. 설정 된 값 이하의 레벨을 가진 행들만 반환한다.
* @example
* ```js
* let descendants = treeProvider.getDescendants(4, 2);
* ```
*/
getDescendants(row: number, maxLevel?: number): number[];
/**
* 지정한 행의 조상 행들의 id를 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id
* @returns 지정한 행 또는 행의 조상 행들이 존재하지 않을 경우 `null`을 반환한다.
* @example
* ```js
* let ances = treeProvider.getAncestors(4);
* ```
*/
getAncestors(row: number): number[];
/**
* 지정한 데이터 행을 JSON 객체로 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id
* @param rowState - `true`이면 행의 상태값을 추가한다.
* @param recursive - `true`이면 자식노드를 포함한다.
* @param childRowsProp - 자식 속성의 속성명을 지정한다. 기본값: 'rows'
* @param iconProp - 아이콘 필드의 속성명을 지정한다. 기본값: 'iconIndex'
* @param level - 자식노드를 포함하는 경우 포함될 parentNode의 level을 `0`으로 계산한 level을 지정한다. 기본값: '-1'
*
* @returns 지정한 행이 존재하지 않을 경우 `null`을 반환한다.
*
* @example
* ```js
* let jsonRow = treeProvider.getJsonRow(4);
* ```
*/
getJsonRow(row: number, rowState?: boolean, recursive?: boolean, childRowsProp?: string, iconProp?: string, level?: number): any;
/**
* 지정한 데이터 행과 자손들을 JSON 객체로 반환한다.
*
* @param row - 지정한 데이터 행의 트리 id, 지정하지 않거나 rowId를 null로 지정하면 루트 행의 데이터를 가져옵니다.
* @param recursive - 자손을 포함할 것인지 여부. 기본값: false
* @param childRowsProp - 자식 속성의 속성명을 지정한다. 기본값: 'rows'
* @param iconProp - 아이콘 필드의 속성명을 지정한다. 기본값: 'iconIndex'
* @param rowState - `true`이면 행의 상태값을 추가한다.
*
* @returns 지정한 행이 존재하지 않을 경우 `null`을 반환한다.
* @example
* ```js
* let jsonRow = treeProvider.getJsonRows(4, true);
* ```
*/
getJsonRows(row: number, recursive?: boolean, childRowsProp?: string, iconProp?: string, rowState?: boolean): object[];
/**
* 지정한 데이터 행을 형식을 적용하여 JSON 객체로 가져온다.
*
* @param options - {@link DataOutputOptions} 와 같은 모델의 설정 정보
* @param row - 지정한 데이터 행의 트리 id. 지정하지 않을경우 루트 행의 결과를 반환한다.
* @param iconProp - 아이콘 필드의 속성명을 지정한다. 기본값: 'iconIndex'
* @returns 지정한 데이터 행이 존재하지 않으면 `null`을 반환한다.
* @example
* ```js
* let opt = {
* nullText: '빈 값'
* }
* let row = dataProvider.getOutputRow(opt, 4);
* ```
*/
getOutputRow(options: DataOutputOptions, row: number, iconProp?: string): object;
/**
* 지정한 데이터 행과 자손들을 형식을 적용하여 JSON 객체로 가져온다.
*
* @param options - {@link DataOutputOptions} 와 같은 모델의 설정 정보
* @param row - 지정한 데이터 행의 트리 id. 지정하지 않을경우 루트 행의 결과를 반환한다.
* @param recursive - 자손을 포함할 것인지 여부. 기본값: `false`
* @param childRowsProp - 자식 속성의 속성명을 지정한다. 기본값: 'rows'
* @param iconProp - 아이콘 필드의 속성명을 지정한다. 기본값: 'iconIndex'
* @returns 지정한 데이터 행이 존재하지 않으면 `null`을 반환한다.
*
* @example
* ```js
* let opt = {
* nullText: '빈 값'
* }
* let row = dataProvider.getOutputRows(opt, 4);
* ```
*/
getOutputRows(options: DataOutputOptions, row: number, recursive?: boolean, childRowsProp?: string, iconProp?: string): object[];
/**
* 지정한 트리 행의 자식 행을 추가한다.
*
* @param row - 지정한 데이터 행의 트리 id. 지정하지 않을경우 루트 행을 지정한다.
* @param values - 추가할 행의 필드 값 배열 또는 Object
* @param iconIndex - 트리 행에 표시할 아이콘 인덱스. 기본값: -1
* @param hasChildren - 자식의 있는지 표시 여부. 기본값: `false`. true면 자식이 있는 것으로 표시
* @returns 성공적으로 추가하면 추가된 행 고유번호를, 실패하면 -1을 반환한다.
* @example
* ```js
* treeProvider.addChildRow(4, ['value1', 'value2', 'value3', 'value4'], -1, true);
* ```
*/
addChildRow(row: number, values: DataValues, iconIndex?: number, hasChildren?: boolean): number;
/**
* 지정한 트리 행의 자식행들 중 원하는 위치에 자식행을 추가한다.
*
* @param row - 지정한 데이터 행의 트리 id. 지정하지 않을경우 루트 행을 지정한다.
* @param index - 지정한 부모 행의 자식들 중 삽입하려는 행이 들어갈 위치
* @param values - 필드값의 배열이나 필드들을 속성으로 하는 json 객체
* @param iconIndex - 트리 행에 표시할 아이콘 인덱스. 기본값: -1
* @param hasChildren - 자식의 있는지 표시 여부. 기본값: `false`. `true`면 자식이 있는 것으로 표시
* @returns 성공적으로 추가하면 추가된 행 고유번호를, 실패하면 -1을 반환한다.
* @example
* ```js
* treeProvider.insertChildRow(4, 3, ['value1', 'value2', 'value3', 'value4'], -1, true);
* ```
*/
insertChildRow(row: number, index: number, values: DataValues, iconIndex?: number, hasChildren?: boolean): number;
/**
* 지정한 트리 행에 자식노드를 원하는 위치에 추가한다.
*
* @remarks
* 트리형태의 자료를 추가할때 사용한다.
*
* @param row - 지정한 데이터 행의 트리 id. 지정하지 않을경우 루트 행을 지정한다.
* @param index - 지정한 부모 행의 자식들 중 삽입하려는 행이 들어갈 위치
* @param data - json형태의 data
* @param childrenProp - 하위 노드가 있는 경우 속성명
* @param iconField - 트리 행에 표시할 아이콘 인덱스를 가지고 있는 필드
* @param noState - 행의 상태값을 추가여부 기본값: false
* @returns 성공적으로 추가하면 추가된 행 고유번호를, 실패하면 -1을 반환한다.
*/
insertChildNode(row: number, index: number, data: RowObject, childrenProp?: string, iconField?: string, noState?: boolean): any;
/**
* 지정한 데이터행의 필드 값들을 수정한다.
*
* @param row - 지정한 데이터 행의 트리 id
* @param values - 변경 값. 필드값의 배열이거나, array또는 json객체다.
* @param strict - 값이 undefined거나 명시되지 않은 필드는 기존 값을 유지한다.
* @returns 지정한 데이터 행이 존재할 경우 성공여부를, 하지 않을 경우 `false`를 반환한다.
*
* @example
* ```js
* treeProvider.updateRow(4, ['value1', 'value2', 'value3', 'value4'], true);
* ```
*/
updateRow(row: number, values: DataValues, strict?: boolean): boolean;
/**
* 지정한 데이터행들의 필드 값들을 수정한다.
*
* @param rows - 지정한 데이터 행의 트리 id 배열
* @param values - 변경 값. 필드값의 배열이거나, array또는 json객체다.
* @param strict - true이면 값이 undefined거나 명시되지 않은 필드는 기존 값을 유지한다.
*
* @example
* ```js
* treeProvider.updateRows([4,3], [{field1: 'value1', field2: 'value2', field2: 'value3', field4: 'value4'}, {field1: 'val1'}], true);
* ```
*/
updateRows(rows: number[], values: DataValues[], strict: boolean): void;
/**
* 지정한 데이터행을 삭제한다.
*
* @remarks
* 지정한 데이터행이 조상행인 경우 모든 자손행들도 같이 삭제된다.
* DataProvider의 softDeleting이 `true`인 경우 실제로 삭제되지않고 rowState만 변경된다.
*
* @param row - 삭제할 데이터 행의 트리 id
* @returns - 지정한 행 또는 행의 부모가 존재할 경우 성공여부를, 하지 않을경우 `false`를 반환한다.
*
* @example
* ```js
* treeProvider.removeRow(4);
* ```
*/
removeRow(row: number, recursive?: boolean): boolean;
/**
* 지정한 데이터 행들을 삭제한다.
*
* @remarks
* 지정한 데이터행이 조상행인 경우 모든 자손행들도 같이 삭제된다.
* DataProvider의 softDeleting이 `true`인 경우 실제로 삭제되지않고 rowState만 변경된다.
*
* @param rows - 삭제할 데이터 행들의 트리 id들. 지정하지 않거나 빈 배열을 입력할 경우, false를 반환한다.
* @returns - 삭제의 성공여부를 반환한다.
*
* @example
* ```js
* treeProvider.removeRows([1,3,4]);
* ```
*/
removeRows(rows: number[], recursive: boolean): boolean;
/**
* DataProvider의 모든 행을 삭제한다.
*
*
* @example
* ```js
* treeProvider.clearRows();
* ```
*/
clearRows(): void;
/**
* 지정한 행 또는 행들을 화면에서 감춘다.
*
* @remarks
* 숨겨진 상태에서 remove, insert가 발생하는 경우 dataRow가 변경될 수 있으므로 사용시 주의한다.
*
* @param dataRows - 숨기고 싶은 행 번호 또는 번호들
*
* @example
* ```js
* // single
* treeProvider.hideRows(4);
*
* // array
* treeProvider.hideRows([3,4]);
* ```
*/
hideRows(dataRows: number[] | number): void;
/**
* 화면에서 감춘 행또는 행들을 보여준다.
*
* @remarks
* filterMode, sortMode:"explicit"인 경우 `showHiddenRows()`를 사용하면 필터나 정렬이 재적용된다.
* 접힌(collapse) 상태로 표시된다.
*
* @param dataRows - 보이고 싶은 행 번호 또는 번호들
*
* @example
* ```js
* // single
* treeProvider.showHiddenRows(4);
*
* // array
* treeProvider.showHiddenRows([3,4]);
* ```
*/
showHiddenRows(dataRows: number[] | number): void;
/**
* 숨겨진 행들의 번호를 반환한다.
* @example
* ```js
* let rows = treeProvider.getHiddenRows();
* ```
*/
getHiddenRows(): number[];
/**
* 지정된 행이 숨겨진 행인지의 여부를 반환한다.
*
* @param dataRow - 지정한 데이터 행의 고유번호
*
* @example
* ```js
* let isHidden = treeProvider.isHiddenRow(4);
* ```
*/
isHiddenRow(dataRow: number): boolean;
/**
* 숨겨진 모든 행을 다시 표시한다.
*
* @example
* ```js
* treeProvider.resetHiddenRows();
* ```
*/
resetHiddenRows(): void;
/**
* 지정한 데이터 셀의 값을 반환한다.
*
* @param row - 데이터 행의 트리 id
* @param field - 필드명 또는 인덱스
* @returns 해당 데이터 행이 존재하지 않을 경우 `null`을 반환한다.
* @example
* ```js
* let val = dataProvider.getValue(2, 10);
* ```
*/
getValue(row: number, field: string | number): any;
/**
* 지정한 데이터 셀의 값을 변경한다.
*
* @param row - 데이터 행의 트리 id
* @param field - 필드명 또는 인덱스
* @returns 해당 데이터 행이 존재하지 않을 경우 `null`을 반환한다.
*
* @example
* ```js
* dataProvider.setValue(2, 5, 'newValue');
* ```
*/
setValue(row: number, field: string | number, value: any): void;
/**
* 같은 부모의 형제 사이에서 특정 데이터행의 위치를 지정한 단계만큼 이동한다.
*
* @param row - 데이터 행의 트리 id
* @param offset - 지정 단계 값
* @returns 해당 데이터 행이 존재하지 않을 경우 `false`를 반환한다
*
* @example
* ```js
* dataProvider.moveRowSibling(4, 1);
* ```
*/
moveRowSibling(row: number, offset: number): boolean;
/**
* 특정 데이터행의 위치를 지정한 행의 하위로 이동한다.
*
* @param row - 데이터 행의 트리 id
* @param parent - 지정한 부모 행의 id. 이 행의 하위로 이동한다.
* @param index - 형제들 사이에서의 위치
* @returns 해당 데이터 행 또는 그 부모행이 존재하지 않을 경우 또는 동일한 위치로 이동하려고 했을때 `false`를 반환한다.
*
* @example
* ```js
* dataProvider.changeRowParent(4, 1, 2);
* ```
*/
changeRowParent(row: number, parent: number, index: number): boolean;
/**
* 검색 설정 방식에 따라 특정 값이 있는 행을 찾는다.
*
* @param options - 검색 방식, {@link SearchOptions} 모델로 지정한다.
* @returns 찾은 행의 인덱스
*
* @example
* ```js
* ds.searchDataRow({fields:['fieldName'], values: ['value'], parentId: 3});
* ```
*
* @example
* ```js
* ds.searchDataRow({fields:['fieldName'], values: ['value']});
* ```
*/
searchDataRow(options: SearchOptions): number;
/**
* 검색 설정 방식에 따라 특정 값이 있는 셀을 찾는다.
*
* @param options - 검색 방식, {@link SearchCellOptions} 모델로 지정한다.
* @returns 찾은 셀의 정보, {@link SearchCellResult} 모델이다.
*
* @example
* ```js
* ds.searchData({fields:['fieldName'], value: 'value', parentId: 3});
* ```
*/
searchData(options: SearchCellOptions): SearchCellResult;
}
/**
* {@link LookupSource} 를 채우기 위한 모델 정보
*
* @remarks
* {@link GridBase.fillLookupData | fillLookupData()} 시 매개변수로 사용된다.
*
* @example
* ```js
* // rows 속성을 이용할 경우
* gridView.fillLookupData("empLookup", {
* rows: [
* ["TOMSP", "5", "TOMSP_5X"],
* ["TOMSP", "6", "TOMSP_6X"]
* ]});
*
* // key-value 속성을 이용할 경우
* gridView.fillLookupData("empLookup", {
* keys: [
* ["TOMSP", "5", "TOMSP_5X"],
* ["TOMSP", "6", "TOMSP_6X"]
* ],
* values: [
* ["TOMSP_5X"],
* ["TOMSP_6X"]
* ]});
* ```
*/
export declare type LookupData = LookupDataRows | LookupDataKeyValues;
/**
* {@link LookupData} 의 한 종류
*
* @example
* ```
* {
* keys: [
* ["TOMSP", "5"],
* ["TOMSP", "6"]
* ],
* values: [
* ["TOMSP_5X"],
* ["TOMSP_6X"]
* ]
* }
* ```
*/
export declare interface LookupDataKeyValues {
/**
* 키들
*/
keys: string[] | string[][];
/**
* 값
*/
values: string[];
/**
* dropdownEditer templateCallback의 item으로 전달되는 값
*/
listResult?: ListResult;
}
/**
* {@link LookupData} 의 한 종류
*
* @example
* ```js
* // key1, key2, value
* rows: [
* ["TOMSP", "5", "TOMSP_5X"],
* ["TOMSP", "6", "TOMSP_6X"]
* ]
* ```
*/
export declare interface LookupDataRows {
/**
* 키들과 값들의 배열
*/
rows: string[][];
}
/**
* 컬럼에 연결된 데이터 필드의 실제 값 대신 그 값과 연관된 다른 값을 셀에 표시하기 위한 설정 정보
*
* @remarks
* {@link GridBase.setLookups | setLookups}, {@link GridBase.addLookupSource | addLookupSource} 에서 사용된다.
*
* @example
* ```js
* dataProvider.setFields([
* { fieldName:"field1"},
* { fieldName:"field2"},
* { fieldName:"text1"},
* { fieldName:"text2"},
* ....
* ]);
* gridView.setColumns([
* { fieldName:"field1", name:"field1", lookupDisplay:true, lookupSourceId:"field1Data", lookupKeyFields:["field1"], editor:{type:"dropDown"}},
* { fieldName:"field2", name:"field2", lookupDisplay:true, lookupSourceId:"field2Data", lookupKeyFields:["field1","field2"], editor:{type:"dropDown"}},
* { fieldName:"text1", name:"text1"},
* { fieldName:"text2", name:"text2"}
* ....
* ]);
* // field1의 셀을 수정하였을때 field2의 dropDown Editor의 목록이 변경되도록 컬럼 구성
* ....
* gridView.setLookups([
* { id:"field1Data",
* levels:1,
* keys:["data1","data2","data3"],
* values:["데이터1","데이터2","데이터3",],
* },
* { id:"field2Data",
* levels:2,
* keys: [
* ["data1","data1_code1"],
* ["data1","data1_code2"],
* ["data1","data1_code3"],
* ["data1","data1_code4"],
* ["data2","data2_code1"],
* ["data2","data2_code2"],
* ["data3","data3_code3"],
* ["data3","data3_code4"]
* ],
* values:[
* ["데이터1_코드1"],
* ["데이터1_코드2"],
* ["데이터1_코드3"],
* ["데이터1_코드4"],
* ["데이터2_코드1"],
* ["데이터2_코드2"],
* ["데이터3_코드1"],
* ["데이터3_코드2"]
* ],
* }
* ]);
* // field1에서 data1을 선택하면 field2의 dropDown Editor에는 data1의 하위코드들만 보여진다.
* ```
*/
export declare interface LookupSource {
/**
* 고유명 (id)
*/
id: string;
/**
* lookup tree 에서의 수준
*
* @remarks
* `1` 이상이어야 한다.
*/
levels?: number;
/**
* @deprecated
* 정렬 여부
*
* @remarks
* 2.8.5 버전에서 제거하고 입력된 순서대로 나오도록 변경
*
* @defaultValue `false`
*/
ordered?: boolean;
/**
* 키들
*
* @remarks
* `level` 이 1보다 큰 경우, 순차적으로 해당 레벨과 대응되는 key 값들을 입력해야한다.
*
* @example
* ```js
* // level 1 인 경우
* ['동물', '식물', '균류']
*
* // level 2 인 경우
* [['동물', '인간'], ['동물', '쥐'], ['식물', '피튜니아'], ['식물', '파리지옥'], ['균류', '푸른곰팡이'], ['균류', '송이버섯']]
* ```
*/
keys?: string[] | string[][];
/**
* 값
*/
values?: string[];
}
/**
* {@link ExportMemo | 엑셀 노트 내보내기}에서 셀 별로 메모 출력 시 수행될 콜백을 지정하기 위한 형식
*
* @remarks
* [매개변수 목록]
*
* `grid` - export를 진행중인 grid
*
* `itemIndex` - 인덱스
*
* `dataRow` - 데이터 행
*
* `column` - 컬럼명
*
* `cellMemo` - 셀에 대한 메모 정보 모델
*
* [반환값] - {@link CellMemo | CellMemo} | string | undefined
*
* @example
* ```js
* gridView.exportGrid({
* type:"excel",
* target:"local",
* exportMemo : {
* validation: true,
* callback: (grid, index, dataRow, column, cellMemo) => {
* if (column == "LiteralCol") {
* cellMemo.author = '리터럴 컬럼 작성자';
* cellMemo.message = '리터럴 컬럼 영역입니다.';
* return cellMemo;
* }
* if (column === 'SaveCost') {
* return "Message";
* }
*
* return false;
* }
* }
* });
* ```
*/
export declare type MemoCallback = (grid: GridBase, itemIndex: number, dataRow: number, column: string, cellMemo: CellMemo) => CellMemo | string | undefined;
/**
* 메뉴 항목 관련 설정 정보 모델
*
* @deprecated
* PopupMenuItem으로 변경
*
* @remarks
* {@link PopupMenuItem} 형식을 이용하여 생성한 객체를 {@link GridBase.onMenuItemClicked} 와 {@link GridBase.onContextMenuItemClicked} 으로 콜백을 지정할 때 매개변수로 사용된다.
*
* 또는 {@link GridBase.addPopupMenu} 사용 시 {@link PopupMenuItem.callback | callback} 의 매개변수 중 `menuItem`의 형식이다.
*
* @example
* ```js
* gridView.addPopupMenu("menu1", [
* {
* label: "alpha",
* callback: function(grid, menuItem, index) {
* console.log("aa")
* console.log(menuItem); // 해당 형식의 객체
* console.log(clickData);
* }
* },
* {label: "beta"},
* {label: "gamma"}
* ]);
* ```
*/
export declare interface MenuItem {
/**
* 메뉴 항목 형태
*/
type: MenuItemType;
/**
* 표시 여부
*/
visible: boolean;
/**
* 클릭 가능 여부
*/
enabled: boolean;
/**
* 메뉴에 표시될 명칭
*/
label: string;
/**
* 메뉴의 그룹, type이 "radio"일때 동일 그룹내에서 하나만 선택
*/
group: string;
/**
* type이 "check"나 "radio"일때 체크 여부
*/
checked: boolean;
/**
* 태그
*/
tag: any;
/**
* 클릭 했을 때 호출되는 콜백
* @eventProperty
*/
callback: MenuItemClick;
/**
* 부모: MenuItem 객체
*/
parent: PopupMenu;
}
/**
* 메뉴 아이템을 클릭 시 호출되는 콜백
*
* @remarks
* {@link GridBase.onMenuItemClicked} 와 {@link GridBase.onContextMenuItemClicked}, {@link PopupMenuItem | PopupMenuItem.callback} 에서 사용된다.
*
* [매개변수 목록]
*
* grid - GridBase 컨트롤
*
* menuItem - MenuItem 객체
*
* clickData - 클릭된 아이템의 정보
*
* @example
* ```js
* grid.addPopupMenu("menu1", [
* {
* label: "alpha",
* callback: function(grid, menuItem, clickData) {
* console.log("aa")
* console.log(menuItem);
* console.log(clickData);
* }
* },
* {label: "beta"},
* {label: "gamma"}
* ]);
* ```
*/
export declare type MenuItemClick = (grid: GridBase, menuItem: PopupMenuItem, clickData: ClickData) => void;
/**
* @public
*
* PopupMenu 등에 표시되는 메뉴 항목의 유형
*
* @remarks
* {@link PopupMenuItem."type"} 과 {@link MenuItem."type"} 에서 사용된다.
*
* @example
* ```js
* let menu = [{
* label: "menu3 입니다",
* type: "check",
* checked: true,
* }]
* ```
*/
export declare enum MenuItemType {
/**
* 일반 텍스트
*/
NORMAL = "normal",
/**
* 체크박스와 텍스트
*/
CHECK = "check",
/**
* 라디오 버튼과 텍스트
*/
RADIO = "radio",
/**
* 메뉴 항목 간 구분
*/
SEPARATOR = "separator"
}
/**
* {@link DataColumn.mergeCallback}에서 사용되는 콜백형식
*
* @remarks
* 표시되는 값은 {@link DataColumn.displayCallback}을 이용해서 변경한다
* `data`가 변경되는 경우에는 그리드가 다시 merge정보를 생성하지만 외부값에 따라 merge정보를 갱신해야 하는 경우 {@link GridView.populateMerges}를 이용해서 갱신한다.
*
* [매개변수 목록]
*
* `grid` - GridView
*
* `column` - DataColumn
*
* `itemIndex` - itemIndex
*
* `value` - value
*
* [반환값] - 이전셀과 동일한지 판단하기 위한 값
*
* @example
* ```js
* const column = gridView.columnByName("column");
* column.mergeCallback = (grid, column, itemIndex, value) => {
* if (!grid.isCheckedItem(itemIndex)) {
* return value;
* }
* }
* column.breakMergeOnEmpty = true;
* grid.onItemChecked = (grid, itemIndex, checked) => {
* grid.populateMerges();
* }
*
* ```
*
*/
declare type MergeCallback = (grid: GridBase, column: DataColumn, itemIndex: number, value: any) => any;
/**
* 모바일 관련 설정 모델
*
* @remarks
* {@link GridBase | 그리드} 에서 옵션으로 설정할 때는 필요한 정보만 넣으면 된다.
*
* @example
*
* ```js
* grid.setMobileOptions({longTapDuration: 300});
* ```
*/
export declare interface MobileOptions {
/**
* 롱 탭으로 인식하기 위한 최소 시간
*
* @defaultValue `500`
*/
longTapDuration?: number;
/**
* 더블 탭이 발생하기 위한 탭 간 최대 시간
*
* @defaultValue `500`
*/
doubleTapInterval?: number;
/**
* touch move를 했을때 dragging또는 swipe로 인지하도록 하는 범위
*
* @defaultValue `10`
*/
tapThreshold?: number;
/**
* 편집 커맨더를 보여줄지에 대한 여부
*
* @defaultValue `false`
*/
showEditCommander?: boolean;
/**
* 모바일에서 툴팁을 보여줄 건지에 대한 여부
*
* @remarks
* 다른 툴팁 설정들이 `true`여야 한다.
*
* @defaultValue `false`
*/
showTooltip?: boolean;
/**
*
* @deprecated
* {@link EditOptions.scrollOnEditing}으로 이동.
*
* 모바일에서 편집 중 일때 스크롤 시 처리
*
*/
scrollOnEditing?: ScrollOnEditing;
/**
* `false`이면 그리드 내부에서 스크롤이 발생했을때 외부로 전달하지 않는다.
*
* @remarks
* 일부 모바일 기기의 경우 그리드 스크롤대신 body 영역이 스크롤되는것을 방지하기 위해 사용한다.
*
* @defaultValue `true`
*/
scrollPropagate?: boolean;
/**
* `true`이면 Selection시 크기를 변경할수 있는 handle이 보여진다.
*
* @defaultValue `false`
*/
showSelectionHandle?: boolean;
}
/**
* @public
* 드롭 다운 목록에서 여러 항목들을 선택할 수 있는 편집기
*
* @remarks
* 셀에 저장되는 값의 각 value 를 구분하기 위한 구분자 지정은 편집기의 속성이 아닌 {@link ValueColumn.valueSeparator | column.valueSeparator} 에서 지정하며 기본값은 ',' 이다.
*
* {@link DropDownCellEditor} 를 상속한다.
*
* [상위 클래스]
*
* {@link CellEditor} - {@link TextCellEditor} - {@link DropDownCellEditor}
*
* @example
*
* ```js
* // string type
* column.editor = "checklist"
*
* // object type
* column.editor = {
* type: "checklist",
* values: ["VINET", "TOMSP", "VICTE"],
* labels: ['label1', 'label2', 'label3'],
* displayLabels: "valueLabel",
* textReadOnly: true,
* showButtons: true
* }
* ```
*/
export declare interface MultiCheckCellEditor extends Omit"+
* "${field1}"+
* "${field2}";
* column.header.templateCallback = f;
* ```
*/
export declare type RealizeHeaderCallback = (grid: GridBase, header: ColumnHeader | CellLayoutGroupHeader, field: string) => string;
/**
* @public
* {@link ColumnSummary.templateCallback}에서 사용되는 콜백 형식
*
* @remarks
* {@link ColumnFooter}, {@link HeaderSummary}, {@link GridColumn.groupFooter | GroupFooter}의 template에 입력한 field중 {@link ColumnObject.values | values}에 지정되지 않은 값을 가져올때 사용한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `column` - footer의 column
*
* `summaryIndex` - footer의 순번
*
* `summary` - `footer`객체 또는 `groupFooter`인 경우 {@link GroupItem}
*
* `field` - 필드명
*
* [반환값] - string
*
* @example
* ```js
* const f = function (grid, column, summaryIndex, summary, field) {
* if (field == "field1") {
* return "1234";
* } else if (field === "field2") {
* return "ABCD";
* } else {
* return "field Fail";
* }
* }
*
* column.footer.template =
* ""+
* "${field1}"+
* "${field2}";
* column.footer.templateCallback = f;
* ```
*/
export declare type RealizeSummaryCallback = (grid: GridBase, column: GridColumn, summaryIndex: number, summary: ColumnSummary | GroupItem, field: string) => string;
/**
* {@link TemplateCellRenderer.valueCallback} 에 사용되는 콜백 형식
*
* @remarks
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `model` - 그리드의 셀
*
* `field` - 필드명
*
* [반환값] - string type 의 template 형식
*
* @example
* ```js
* const f = function (grid, model, field) {
* if (field == "xxx") {
* return "1234";
* }
* }
*
* column.renderer = {
* type: "html",
* template: ""+
* "${value}-${value:unitprice}-"+
* "${xxx}"+
* "${value:Country}",
* valueCallback: f
* }
* ```
*/
export declare type RealizeValueCallback = (grid: GridBase, model: GridCell, field: string) => string;
/**
* 사각형의 좌표 정보
*
* @remarks
* {@link GridBase.getCellBounds}에서 셀의 위치정보를 반환하는 형식이다.
*/
export declare interface Rectangle {
/**
* left
*/
x: number;
/**
* top
*/
y: number;
/**
* 너비
*/
width: number;
/**
* 높이
*/
height: number;
}
/**
* @public
*
* 그리드를 다시 그릴 때 필요한 상수
*
* @remarks
* {@link DisplayOptions.refreshMode} 에서 사용한다.
*
* @example
* ```js
* grid.displayOptions.refreshMode = 'visibleOnly';
* ```
*/
export declare enum RefreshMode {
/**
* 모든 컬럼들을 다시 그리기
*/
ALL = "all",
/**
* 보이는 컬럼들만 다시 그리기
*/
VISIBLE_ONLY = "visibleOnly",
/**
* 세로스크롤시에는 보이는 컬럼만 다시 그리고 가로스크롤시에는 전체 컬럼을 다시 그린다.
* @remarks
* 가로스크롤이 연속되는 경우에는 다시 그리지 않고 위치만 이동한다.
*/
RECYCLE = "recycle"
}
/**
* @public
*
* 사용자 지정 렌더러의 편집 완료 결과 모델
*
* @remarks
* {@link CustomCellRenderer.editClick} 에서 반환되어야 한다.
*/
export declare interface RendererEditResult {
/**
* 커밋 여부
*
* @defaultValue `true`
*/
commit: boolean;
/**
* 수정된 값
*/
value: any;
}
/**
* 복원 모드 종류
*/
export declare enum RestoreMode {
/**
* 복원 모드를 설정하지 않는다.
*/
NONE = "none",
/**
* 명시적으로 {@link DataProviderBase.restoreUpdatedRows | restoreUpdatedRows()}를 사용했을 경우에만 RowState 와 값이 변경된다.
*/
EXPLICIT = "explicit",
/**
* 원래 값으로 다시 수정만 하면 RowState 도 다시 원상태로 돌아온다.
*/
AUTO = "auto"
}
/**
* @public
* RowBar영역의 셀 스타일을 지정하기 위한 콜백
*
* @remarks
* {@link CheckBar.cellStyleCallback}에서 사용되는 형식이다.
*
* [매개변수 목록]
* `grid` - GridBase 컨트롤
*
* `type` - {@link GridCellType} 중 `check`, `indicator`, `state` 중 하나
*
* `index` - 셀의 itemIndex
*
* @example
* ```js
* var f = function(grid, type, index) {
* if (grid.getValue(index, "field") === "TEST") {
* return 'style-test';
* }
* }
* ```
*/
export declare type RowBarCellStyleCallback = (grid: GridBase, type: GridCellType, index: number) => string;
/**
* row block 마스크를 설정하기 위한 콜백
*
* @remarks
*
* {@link DisplayOptions.rowBlockCallback} 에서 사용된다.
* {@link DisplayOptions.rowBlockType} 이 {@link RowMaskType.NONE} 이면 반영되지 않는다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `itemIndex` - 선택 된 행의 인덱스
*
* [반환값] - Row Block Mask 를 적용시킬 행의 범위, `start`: 시작 행, `end`: 끝 행
*
* @example
* ```js
* const f = function(grid, itemIndex) {
* let billNo;
* let ds = grid.getDataSource();
* let fld = ds.getFieldIndex("text1");
* let dataRow = grid.getDataRow(itemIndex);
* if (dataRow >= 0) {
* billNo = ds.getValue(dataRow, fld);
* } else {
* billNo = null;
* }
*
* let top = Math.min(grid.getTopItem(), itemIndex);
* let full = top + grid.fullItemCount();
* let startNo = top + full;
* let endNo = -1;
* let check1 = false;
*
* for (let i = top; i <= full; i++) {
* dataRow = grid.getDataRow(i);
* if (dataRow < 0) {
* continue;
* }
*
* let cBillNo = ds.getValue(dataRow, fld);
*
* if (cBillNo === billNo) {
* startNo = Math.min(startNo, i), endNo = Math.max(endNo, i);
* check1 = true;
* } else {
* if (check1) {
* break;
* }
* }
* };
*
* if (startNo <= endNo && endNo > 0) {
* console.log(startNo)
* console.log(endNo);
* return { start: startNo, end: endNo };
* }
* }
* ```
*/
export declare type RowBlockCallback = (grid: GridBase, itemIndex: number) => {
start: number;
end: number;
};
/**
* 행 그룹핑과 관련된 영역들의 표시 방법 등에 대한 설정 모델
*
* @remarks
* {@link GridView.setRowGroup} 사용시 필요한 정보만 입력하면 된다.
*
* @example
*
* ```js
* gridView.setRowGroup({levelIndent: false});
* ```
*/
export declare interface RowGroup {
/**
* 그룹핑 된 컬럼의 머지 표현 여부
*
* @defaultValue `false`
*/
mergeMode?: boolean;
/**
* mergeMode가 `true`일때 Grouping에서 해제된 컬럼이 원래의 위치로 이동되도록 한다.
*
* @remarks
* grouping후 컬럼을 이동시키거나 또는 visible을 변경한 경우에는 정상적인 위치로 찾아가지 못한다.
*/
resetOriginVindex?: boolean;
/**
* 자동 정렬 여부
*
* @remarks
* `false`로 설정하면 행 그룹 시 자동으로 정렬되지 않고 그리드에 표시된 데이터의 순서대로 행 그룹핑 된다.
*/
sorting?: boolean;
/**
* 행 그룹이 펼쳐진 상태일 때, 그룹 헤더, 푸터의 표시 여부
*
* @defaultValue {@link RowGroupAdornments.BOTH}
*/
expandedAdornments?: RowGroupAdornments;
/**
* 행 그룹이 접힌 상태일 때, 그룹 헤더, 푸터의 표시 여부
*
* @defaultValue {@link RowGroupAdornments.HEADER}
*/
collapsedAdornments?: RowGroupAdornments;
/**
* 특정 그룹 푸터의 표시 여부를 지정하기 위한 콜백
*
* @remarks
* {@link RowGroup.mergeMode } 가 `true` 인 경우 일부 그룹 푸터의 표시여부를 지정할 수 있다.
* 표시하길 원하는 경우 `true` 값을 반환한다.
*
* @eventProperty
*/
createFooterCallback?: CreateFooterCallback;
/**
* 그룹 레벨 간 들여쓰기 여백
*
* @defaultValue `20`
*/
levelIndent?: number;
/**
* 그룹 expander영역 표시여부
*
* @defaultValue `true`
*/
indentVisible?: boolean;
/**
* 그룹 expander를 몇 레벨까지 보여질지 여부
*
* @remarks
* {@link RowGroup.expandedAdornments}, {@link RowGroup.collapsedAdornments}가 {@link RowGroupAdornments.FOOTER} 또는 {@link RowGroupAdornments.SUMMARY} 인 경우만 적용된다.
* `0` 전체 레벨이 보여진다.
* 양수이거나 음수인경우 설정된 레벨까지 보여진다.
* 그룹이 3레벨인경우 `1`로 설정하면 1레벨만 보여지고 `-1`로 설정하면 3레벨만 보여진다.
*
* @defaultValue `0`
*/
indentVisibleLevel?: number;
/**
* expander 표시 여부
* @defaultValue {@link ExpanderVisibility.DEFAULT}
* @deprecated
* expanderVisibility로 대체.
*/
mergeExpanderVisibility?: ExpanderVisibility;
/**
* expander 표시 여부
* @defaultValue {@link ExpanderVisibility.DEFAULT}
*/
expanderVisibility?: ExpanderVisibility;
/**
* expander 표시여부를 결정하는 콜백
*
* @eventProperty
*/
expanderVisibleCallback?: ExpanderVisibleCallback;
/**
* 헤더에 표시할 문자열 서식
* @defaultValue `'${groupField}: ${groupValue} - ${rowCount} rows'`
*/
headerStatement?: string;
/**
* 헤더에 표시할 문자열을 return하는 콜백
* @remarks
* {@link RowGroup.headerStatement}가 있는 경우 무시된다.
*
* @eventProperty
*/
headerCallback?: HeaderCallback;
/**
* 컬럼의 값이 아닌 다른 값으로 그룹을 만들때 사용하는 콜백
* {@link RowGroup.mergeMode}에서는 사용할수 없다.
*
* @remarks
* 컬럼의 일부 값 또는 다른 컬럼과 조합해서 그룹을 만드는 경우 사용한다.
* 데이터를 정렬한후 콜백이 호출되기 때문에 별도의 정렬이 필요하다면 {@link DataProviderBase.setDataComparer | 사용자 정의 정렬 함수}를 이용해서 정렬을 한다.
*
* @eventProperty
*/
valueForGroupCallback?: ValueForGroupCallback;
/**
* 로우그룹 푸터의 갯수와 style등을 지정한다.
*
*/
footers?: RowGroupFooterCollection;
/**
* @deprecated
* 로우그룹 푸터의 갯수와 style등을 지정한다.
* @param footers - {@link RowGroupFooter} 또는 배열
*/
setFooters?(footers: RowGroupFooter | RowGroupFooter[]): void;
/**
* 그룹 컬럼의 데이터 표시여부
*
* @remarks
* `true`이면 그룹의 첫번째 데이터만 표시된다.
* {@link RowGroup.mergeMode} 가 `true`일때 적용되지 않는다.
*
* @defaultValue `false`
*/
blankGroupData?: boolean;
}
/**
* @public
*
* 행 그룹 상태일 때 헤더나 푸터의 표시 방법
*
* @remarks
* {@link RowGroup.collapsedAdornments}, {@link RowGroup.expandedAdornments} 에서 사용된다.
*
* @example
*
* ```js
* grid.setRowGroup({expandedAdornments: "none"});
* ```
*/
export declare enum RowGroupAdornments {
/**
* 표시 안 함, expandedAdornments 상태에서만 적용 가능하다.
*/
NONE = "none",
/**
* 행 그룹 상태일 때 헤더 표시
*/
HEADER = "header",
/**
* 행 그룹 상태일 때 푸터 표시
*/
FOOTER = "footer",
/**
* 행 그룹 상태일 때 summary의 내용을 헤더 위치에 표시
*/
SUMMARY = "summary",
/**
* 행 그룹 상태일 때 헤더와 푸터 둘 다 표시
*/
BOTH = "both"
}
/**
* 그리드 그룹푸터 모델
*/
export declare interface RowGroupFooter {
/**
* 그룹 푸터 행에 적용되는 스타일 클래스명
*/
styleName?: string;
/**
* excel로 export할때 적용될 스타일 명
*/
exportStyleName?: string;
/**
* 스타일을 지정하기 위한 콜백
*
* @remarks
* {@link GroupFooterStyleCallback} 참조
*
* @eventProperty
*/
styleCallback?: GroupFooterStyleCallback;
/**
* 그룹 푸터의 컬럼별로 적용되는 스타일을 지정하기 위한 콜백
*
* @remarks
* {@link CellStyleCallback} 참조
*
* @eventProperty
*/
cellStyleCallback?: CellStyleCallback;
}
/**
* @public
*
* 그리드 그룹 푸터 영역에 관한 콜렉션 모델
*
* @remarks
*
* 그리드의 그룹 푸터를 생성하고 관리한다.
*
* @example
* ```js
* gridView.rowGroup.setFooters([
* {
* styleName: 'group-footer-1'
* }, {
* styleName: 'group-footer-2'
* }
* ])
* ```
*/
export declare interface RowGroupFooterCollection {
/**
* 표시되는 푸터의 갯수
*/
count?: number;
/**
* 그룹 푸터의 아이템들
*/
items?: RowGroupFooter[];
/**
* 지정된 index의 그룹 푸터를 가져온다.
*
* @param index - 푸터의 index
*/
get?(index: number): RowGroupFooter;
}
/**
*
* 행의 높이를 반환하는 콜백형식
*
* @remarks
* number 또는 number[]형태로 행의 높이를 지정한다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `type` - row의 {@link ItemType | type}
*
* `itemIndex` - row의 itemIndex
*
* [반환값] - 행의 높이, 여러줄로 이루어진 행의 경우 배열로 반환하면 각각 지정된다.
*/
export declare type RowHeightCallback = (grid: GridBase, type: ItemType, itemIndex: number) => number | number[];
/**
* 그리드의 인디케이터에 관한 설정 모델
*
* @remarks
* 인디케이터는 행 index를 표시하거나, focus 된 행의 위치 등을 표시한다.
*
* {@link GridBase.setRowIndicator} 사용시 필요한 정보만 입력하면 된다.
*
* @example
*
* ```js
* gridView.setRowIndicator({zeroBase: true});
* ```
*/
export declare interface RowIndicator {
/**
* 인디케이터 셀들에 표시할 내용
*
* @defaultValue {@link IndicatorValue.INDEX}
*/
displayValue?: IndicatorValue;
/**
* 인디케이터 숫자가 0부터 시작할 것인지의 여부
*
* @defaultValue `false`
*/
zeroBase?: boolean;
/**
* 인디케이터에 표시될 숫자와 아이템 인덱스(행 순서)와의 간격
*
* @remarks
* 인디케이터 숫자 = 아이템 인덱스 + indexOffset
*
* @defaultValue `0`
*/
indexOffset?: number;
/**
* 인디케이터에 표시될 숫자와 데이터 행 고유번호와의 간격을 지정
*
* @remarks
* 인디케이터 숫자 = 데이터 행 번호 + rowOffset
*
* @defaultValue `0`
*/
rowOffset?: number;
/**
* 최소 너비
*
* @defaultValue `32`
*/
minWidth?: number;
/**
* 최대 너비
*
* @defaultValue `0`
*/
maxWidth?: number;
/**
* 너비
*
* @remarks
* `0`인경우 표시되는 내용에 따라 너비가 변경된다.
*
* @defaultValue `0`
*
*/
width?: number;
/**
* 실제 표시되는 너비
*
* @remarks
* `width`가 0일때 rowIndicator의 너비
*/
displayWidth?: number;
/**
* 마우스로 클릭 혹은 드래그 시 선택 영역 지정 가능 여부
*
* @remarks
* {@link DisplayOptions.selectionMode} 가 {@link SelectionMode.NONE} 이 아니고, {@link DisplayOptions.selectionStyle} 이 {@link SelectionStyle | single selection style} 이 아니어야 선택 영역 지정이 가능하다.
*
* @defaultValue `true`
*/
selectable?: boolean;
/**
* @deprecated
* 인디케이터에 표시되는 상태의 형태
*
* @defaultValue {@link StateMark.IMAGE}
*/
mark?: StateMark;
/**
* focus 된 행에 해당하는 셀의 스타일 적용여부 여부
*
* @remarks
* `true`면 focus 된 행에 해당하는 셀을 `'rg-rowindicator-focus'` 스타일로 표시한다.
*
* @defaultValue `true`
*/
showFocus?: boolean;
/**
* 데이터 선택 영역에 맞춰 관련된 셀들의 스타일 적용 여부
*
* @remarks
* `true`면 데이터 선택 영역에 맞춰 관련된 셀들을 `'rg-rowindicator-select'` 스타일로 표시한다.
*
* @defaultValue `true`
*/
showSelection?: boolean;
/**
* 체크바, 상태바, 인디케이터 중에서 보여지는 순서 (인덱스)
*
* @remarks
* 숫자가 작을 수록 왼쪽에 배치된다.
*/
displayOrder?: number;
/**
* head 영역에 표시할 텍스트
*
* @defaultValue `null`
*/
headText?: string;
/**
* foot 영역에 표시할 텍스트
*
* @defaultValue `null`
*/
footText?: string;
/**
* summary 영역에 표시할 텍스트
*
* @defaultValue `null`
*/
sumText?: string;
/**
* 팝업 메뉴
*/
popupMenu?: PopupMenuItem[] | string;
/**
* 표시 여부
*/
visible?: boolean;
/**
* 셀의 스타일을 지정하기 위한 콜백
*/
cellStyleCallback?: RowBarCellStyleCallback;
/**
* 선택된 행의 인디케이트 셀에서 행 이동 여부
*
* @defaultValue `false`
*/
draggableSelectedRows?: boolean;
}
/**
* @public
*
* 선택 된 행의 표시 형태 (행의 마스크 종류)
*
* @remarks
* {@link DisplayOptions.rowBlockType | rowBlockType}, {@link DisplayOptions.rowHoverType | rowHoverType}, {@link DisplayOptions.rowFocusType | rowFocusType} 등에서 사용된다.
*
* @example
*
* ```js
* grid.displayOptions.rowBlockCallback = f;
* grid.displayOptions.rowBlockType = 'row';
* ```
*/
export declare enum RowMaskType {
/**
* 없음
*/
NONE = "none",
/**
* 인디케이터, 상태바, 체크바, 컬럼을 포함한 영역
*/
ROW = "row",
/**
* 컬럼 영역
*/
DATA = "data",
/**
* 인디케이터, 상태바, 체크바, 컬럼을 포함한 영역 + 빈 영역
*/
FILL = "fill",
/**
* 하나의 셀
*/
CELL = "cell"
}
/**
* 행 오브젝트
*
* @remarks
* {@link DataValues} 의 형식 중 하나
*/
export declare type RowObject = {
[key: string]: any;
};
/**
* 행의 상태
*/
export declare enum RowState {
/**
* 아무것도 아님
*/
NONE = "none",
/**
* 생성됨
*/
CREATED = "created",
/**
* 업데이트됨
*/
UPDATED = "updated",
/**
* 삭제됨
*/
DELETED = "deleted",
/**
* 생성 후 삭제됨
*/
CREATE_AND_DELETED = "createAndDeleted"
}
/**
* 행 상태의 따른 행들의 목록
*
* @remarks
* {@link DataProviderBase.getAllStateRows} 로 해당 모델을 반환할 수 있다.
*/
export declare interface RowStateList {
/**
* 생성된 행의 index 들
*/
created?: number[];
/**
* 생성되었다 삭제된 행의 index 들
*/
createAndDeleted?: number[];
/**
* 삭제된 행의 index 들
*/
deleted?: number[];
/**
* 갱신 된 행의 index 들
*/
updated?: number[];
}
/**
* 행 스타일 변경을 위한 콜백
*
* @remarks
* 스타일 클래스 명을 반환해야한다.
*
* {@link GridBase.setRowStyleCallback} 에서 쓰인다.
*
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `item` - 행 아이템
*
* `fixed` - 고정행 여부
*
* [반환값] - 스타일 클래스 명 또는 {@link RowStyleObject} 객체
*
* @example
* ```js
* const f = function(grid, item, fixed) {
* if (fixed) {
* return 'custom-fixed-row';
* }
* else if (item.isDataRow) {
* var val =
* return 'custom-data-row';
* }
* }
* gridView.setRowStyleCallback(f)
* ```
*/
export declare type RowStyleCallback = (grid: GridBase, item: GridItem, fixed: boolean) => string | RowStyleObject | undefined;
/**
* {@link RowStyleCallback} 으로 행의 스타일을 변경시 반환되는 스타일 모델
*
* @remarks
* {@link GridBase.setRowStyleCallback}에서 사용된다.
*
* @example
* ```js
* cosnt f = function(grid, item fixed) {
* if (dataProvider.getValue(item.dataRow, "fieldName") === "value") {
* return {
* editable: false,
* styleName: "userStyleName"
* }
* }
* }
* gridView.setRowStyleCallback(f);
* ```
*/
export declare interface RowStyleObject {
/**
* 행전체의 editable 여부
*
* @remarks
* 지정하지않으면 다음 순위의 editable이 적용된다.
*/
editable?: boolean;
/**
* 행전체의 readOnly여부
* @remarks
* 지정하지않으면 다음 순위의 editable이 적용된다.
*/
readOnly?: boolean;
/**
* 행의 className
* @remarks
* 지정하지 않으면 그리드의 기본 스타일명이 사용된다.
*/
styleName?: string;
/**
* excel로 export할때 적용되는 스타일 명
*/
exportStyleName?: string;
/**
* 행의 tr element에 적용되는 inline style
*
* @remarks
* tr의 style에 직접 적용되는 속성들을 지정한다.
*
* @example
* ```js
* const f = function(grid, item, fixed) {
* var ret = { style: {background:undefined, color: undefined}}
* if (dataProvider.getValue(item.dataRow, "fieldName") === "A") {
* ret.style.background = "red";
* } else if (dataProvider.getValue(item.dataRow, "fieldName") === "B") {
* ret.style.color = "red";
* } else if (dataProvider.getValue(item.dataRow, "fieldName") === "C") {
* ret.style.background = "lightblue"
* ret.style.color = "red";
* };
* return ret;
* }
* ```
*/
style?: Partial${value}-${value:unitprice}-${xxx}",
* valueCallback: function (grid, model, field) {
* if (field == "xxx") {
* return "1234";
* }
* }
* ```
*/
export declare interface TemplateCellRenderer extends CellRenderer {
/**
* 종류: html 템플릿
*/
type?: 'html';
/**
* 입력되는 html 템플릿 형태의 문자열
*
* @remarks
* `callback`이 지정되지 않으면 사용한다.
*/
template?: string;
/**
* template에 `${xxx}` 형태로 감싸진 값을 실제 값으로 치환하기 위한 콜백
*
* @remarks
* 셀의 값에 따라 template를 변경하는 경우 `${xxx}`형태로 template에 지정하면 rendering시 valueCallback을 호출하고 return된 문자열로 `${xxx}`을 대체한다.
*
* @eventProperty
* @example
* ```js
* column.renderer = {
* type:"html",
* template: "${value}-${value:unitprice}-${xxx}",
* valueCallback: function (grid, model, field) {
* if (field == "xxx") {
* return "1234";
* }
* }
* }
* ```
*/
valueCallback?: RealizeValueCallback;
/**
* 렌더링 시 표시할 html을 만들기 위한 콜백
*
* @remarks
* 화면에 표시되어야 할 내용이 값에 따라 변경되는 경우 표시되는 html을 만들기 위해 사용한다.
*
*
* @eventProperty
* @example
* ```js
* column.renderer = {
* type:"html",
* callback: function (grid, model, width, height) {
* const value = model.value;
* if (value === 'xxx') {
* return "" + "" + model.value + "
";
* } else {
* return "" + model.value + "
"
* }
*
* }
* }
* ```
*/
callback?: GetTemplateCallback;
/**
* renderer에 input element가 있을때 focus를 가질수 있는지 여부
*
* @remarks
* `true`로 지정하면 input element가 focus를 가질수 있다.
* `false`이면 input element를 클릭해도 그리드가 focus를 가져간다.
* 그리드의 editor가 아닌 사용자의 input이 focus를 가지는 경우 키보드를 이용한 이동/Tab/편집은 사용자가 관리해야 한다.
*/
inputFocusable?: boolean;
/**
* element의 event를 지정한다.
*
* @remarks
*
* @example
*
* ```js
* const htmlRenderer = {
* type: "html",
* template: ``,
* templateEvents: {
* selector: 'input[type="button"]',
* event: {
* onclick: function(e) {console.log(e)}
* }
* }
* }
* ```
*/
templateEvents?: TemplateEvent | TemplateEvent[];
}
/**
* {@link TemplateCellRenderer} 또는 {@link ColumnObject.template}에서 생성되는 요소에 이벤트를 추가할때 사용되는 형식
*
* @remarks
* 주어진 선택자를 사용해서 요소를 선택한후 이벤트를 추가한다.
*
* @example
* ```js
* column.renderer = {
* type: "html",
* template: ``,
* templateEvents: {
* selector: 'input[type="button"]',
* event: {
* onclick: function(e) {console.log(e)}
* }
* }
* }
* ```
*/
export declare interface TemplateEvent {
/**
* 요소의 선택자
*
* @remarks
* renderer의 하위 요소를 선택한다.
* querySelect에 사용되는 선택자와 동일하게 사용한다.
*/
selector: string;
/**
* 이벤트명과 실행될 method
*/
event?: Partial${value}-${value:unitprice}-${xxx}",
* valueCallback: function (grid, model, field) {
* if (field == "xxx") {
* return "1234";
* }
* }
* }
* ```
*/
valueCallback?: RealizeValueCallback;
/**
* 렌더링 시 표시할 html을 만들기 위한 콜백
*
* @remarks
* 화면에 표시되어야 할 내용이 값에 따라 변경되는 경우 표시되는 html을 만들기 위해 사용한다.
*
*
* @eventProperty
* @example
* ```js
* treeView.treeOptions.templateOptions = {
* callback: function (grid, model, width, height) {
* const value = model.value;
* if (value === 'xxx') {
* return "" + "" + model.value + "
";
* } else {
* return "" + model.value + "
"
* }
* }
* }
* ```
*/
callback?: GetTemplateCallback;
/**
* element의 event를 지정한다.
*
* @remarks
*
* @example
*
* ```js
* treeView.treeOptions.templateOptions = {
* template: ``,
* templateEvents: {
* selector: 'input[type="button"]',
* event: {
* onclick: function(e) {console.log(e)}
* }
* }
* }
* ```
*/
templateEvents?: TreeTemplateEvent | TreeTemplateEvent[];
}
/**
* @public
* TreeView 클래스, {@link GridBase} 의 자식 클래스이다.
*
* @remarks
* [상위 클래스]
*
* {@link GridBase}
*/
export declare class TreeView extends GridBase {
/**
* TreeView 만이 고유로 가지는 설정 모델
*
* @remarks
* {@link TreeOptions} 객체를 반환한다.
* TreeOptions 의 속성을 가져오거나 설정할 수 있다.
*
* @example
* ```js
* treeView.treeOptions.iconWidth = 20;
* ```
*/
get treeOptions(): TreeOptions;
/**
* @public
*
* 트리에 연결되어 있는 DataProvider를 반환한다.
* @example
* ```js
* let ds = treeView.getDataSource();
* ```
*/
getDataSource(): LocalTreeDataProvider;
/**
* TreeView의 아이템 노드 펼치기를 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `tree` - TreeView 컨트롤
*
* `itemIndex` - 펼쳐지려는 행의 인덱스
*
* `rowId` - 펼쳐지려는 행의 고유번호
*
*
* [반환값] - `false`를 반환하면 펼쳐지지 않는다.
* @defaultValue `null`
* @eventProperty
*
* @example
* ```js
* treeView.onTreeItemExpanding = function (tree, itemIndex, rowId) {
* return false;
* };
* ```
*/
onTreeItemExpanding?: (tree: TreeView, itemIndex: number, rowId: number) => boolean;
/**
* TreeView의 아이템 노드가 펼쳐졌음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `tree` - TreeView 컨트롤
*
* `itemIndex` - 펼쳐진 행의 인덱스
*
* `rowId` - 펼쳐진 행의 고유번호
* @eventProperty
*
* @example
* ```js
* treeView.onTreeItemExpanded = function (tree, itemIndex, rowId) {
* console.log('Expanded at: ' + itemIndex);
* };
* ```
*/
onTreeItemExpanded?: (tree: TreeView, itemIndex: number, rowId: number) => void;
/**
* TreeView의 아이템 노드 접힘을 결정하는 콜백
*
* @remarks
* [매개변수 목록]
*
* `tree` - TreeView 컨트롤
*
* `itemIndex` - 접으려는 행의 인덱스
*
* `rowId` - 접으려는 행의 고유번호
*
* @eventProperty
*
* [반환값] - `false`를 반환하면 펼쳐지지 않는다.
* @defaultValue `null`
*
* @example
* ```js
* treeView.onTreeItemCollapsing = function (tree, itemIndex, rowId) {
* return false;
* };
* ```
*/
onTreeItemCollapsing?: (tree: TreeView, itemIndex: number, rowId: number) => void;
/**
* TreeView의 아이템 노드가 졉혔음을 알리는 콜백
*
* @remarks
* [매개변수 목록]
*
* `tree` - TreeView 컨트롤
*
* `itemIndex` - 접힌 아이템 행의 인덱스
*
* `rowId` - 접힌 행의 고유번호
*
* @eventProperty
*
* @example
* ```js
* treeView.onTreeItemCollapsed = function (tree, itemIndex, rowId) {
* console.log('Collapsed at: ' + itemIndex);
* };
* ```
*/
onTreeItemCollapsed?: (tree: TreeView, itemIndex: number, rowId: number) => void;
/**
* TreeView의 값이 변경되었음을 알리는 콜백
*
* @remarks
* 값이 변경된 후 {@link GridBase.commit | commit()} 시 발생한다.
*
* [매개변수 목록]
*
* `tree` - TreeView 컨트롤
*
* `itemIndex` - 값이 변경된 행의 인덱스
*
* `rowId` - 값이 변경된 행의 고유번호
*
*
* @eventProperty
* @example
* ```js
* treeView.onTreeItemChanged = function (tree, itemIndex, rowId) {
* console.log("TreeItem item changed:: " + itemIndex);
* };
* ```
*/
onTreeItemChanged?: (tree: TreeView, itemIndex: number, rowId: number) => void;
/**
* 트리 그리드 선택 표시 등, 관련된 설정 정보들을 가져온다.
*
* @returns - {@link TreeOptions} 설정 모델과 동일한 내용의 객체.
*
* @example
* ```js
* let treeOpts = tree.getTreeOptions();
* treeOpts.lineVisible = false;
* tree.setTreeOptions(treeOpts);
* ```
*/
getTreeOptions(): TreeOptions;
/**
* 트리뷰 표시 및 동작과 관련된 설정을 한다.
*
* @remarks
* {@link TreeOptions} 에서 원하는 속성만 지정하여 사용한다.
*
* @param options - {@link TreeOptions} 설정 모델과 동일한 내용의 객체. 변경하고자 하는 속성만 변경하면 된다.
*
* @example
*
* ```js
* tree.setTreeOptions({lineVisible: false});
* ```
*/
setTreeOptions(options: TreeOptions): void;
/**
* 부모 행의 인덱스를 반환한다.
*
* @param itemIndex - 자식 행의 인덱스
*
* @example
*
* ```js
* let pIndex = tree.getParent(3);
* ```
*/
getParent(itemIndex: number): number;
/**
* 자식 행들의 인덱스들을 반환한다.
*
* @param itemIndex - 부모 행의 인덱스
*
* @example
*
* ```js
* let cIndexes = tree.getChildren(3);
* ```
*
*/
getChildren(itemIndex: number): number[];
/**
* 자손 행들의 인덱스들을 반환한다.
*
* @param itemIndex - 조상 행의 인덱스
*
* @example
*
* ```js
* let dIndexes = gridView.getDescendants(3);
* ```
*
*/
getDescendants(itemIndex: number): number[];
/**
* 조상 행들의 인덱스들을 반환한다.
*
* @param itemIndex - 해당 행의 인덱스
* @param includeRoot - 기본값: `true`, `true`: 숨겨진 최상위 루트행의 인덱스를 포함하여 결과 값으로 반환한다.
*
* @example
*
* ```js
* let aIndexes = tree.getAncestors(3);
* ```
*/
getAncestors(itemIndex: number, includeRoot?: boolean): number[];
/**
* 행을 펼친다.
*
* @remarks
* recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.
*
* @param itemIndex - 펼치려는 행의 인덱스
* @param recursive - 기본값: `false`, 그룹에 포함된 자손 그룹의 펼침여부
* @param force - 기본값: `false`, 이미 expanded 상태라도 recursive가 `true`일 때 자손들의 펼침여부
* @param level - 기본값: `0`, `0`일 때 recursive가 `true`면 모든 자손 펼침
*
* @example
*
* ```js
* tree.expand(3);
* ```
*/
expand(itemIndex: number, recursive?: boolean, force?: boolean, level?: number): void;
/**
* 아이템(행)을 펼친다.
*
* @remarks
* recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.
*
* @param model - 펼치려는 아이템의 모델
* @param recursive - 기본값: `false`, 그룹에 포함된 자손 그룹의 펼침여부
* @param force - 기본값: `false`, 이미 expanded 상태라도 recursive가 `true`일 때 자손들의 펼침여부
* @param level - 기본값: `0`, `0`일 때 recursive가 `true`면 모든 자손 펼침
*
* @example
*
* ```js
* let model = tree.getModel(4);
* tree.expandModel(model);
* ```
*/
expandModel(model: GridItem, recursive?: boolean, force?: boolean, level?: number): void;
/**
* 행을 접는다.
*
* @param itemIndex - 접으려는 행의 인덱스
* @param recursive - 기본값: `false`, 그룹에 포함된 자손 그룹의 접힘여부
*
* @example
*
* ```js
* tree.collapse(3);
* ```
*/
collapse(itemIndex: number, recursive?: boolean): void;
/**
* 아이템(행)을 접는다.
*
* @param model - 접으려는 아이템 모델
* @param recursive - 기본값: `false`, 그룹에 포함된 자손 그룹의 접힘여부
*
* @example
*
* ```js
* let model = tree.getModel(4);
* tree.collapseModel(model);
* ```
*/
collapseModel(model: GridItem, recursive: boolean): void;
/**
* 모든 행을 펼친다.
*
* @remarks
* level을 지정하면 해당 level까지 펼친다.
*
* @param level - 기본값: `0`, `0`일 때 recursive가 `true`면 모든 자손 펼침
* @param renewHasChildren - 기본값: `true` `false`이면 자식행 여부를 갱신하지 않는다
* @example
*
* ```js
* tree.expandAll();
* ```
*/
expandAll(level?: number, renewHasChildren?: boolean): void;
/**
* 모든 행을 접는다.
*
* @example
*
* ```js
* tree.collapseAll();
* ```
*/
collapseAll(): void;
/**
* Check된 아이템들의 index 목록을 배열로 반환한다.
*
* @example
* ```js
* let checkedItems = treeView.getCheckedItems();
* ```
*/
getCheckedItems(): number[];
/**
* Check된 데이터 행들의 index 목록을 반환한다.
*
* @param visibleOnly - 기본값: `false`, `true`로 입력하면 collapse되거나 페이징시 보이지 않는 행들은 제외한다.
* @returns 체크 된 트리 데이텅 행들의 고유번호의 배열
*
* @example
* ```js
* let checkedRows = treeView.getCheckedRows(true);
* ```
*/
getCheckedRows(visibleOnly: boolean): number[];
/**
* 입력된 행의 자식 행들을 체크하거나 해제한다.
*
* @param itemIndex - 부모행의 ItemModel index
* @param checked - `true`: 체크, `false`: 해제
* @param recursive - 기본값: `false`, 그룹에 포함된 자손 그룹의 펼침여부
* @param visibleOnly - `true`면 collapse되거나 페이징시 보이지 않는 행들은 제외한다.
* @param checkableOnly - `true`면 체크 가능한 상태인 것들만 체크 한다.
* @param checkEvent - 기본값: `true`, {@link GridBase.onItemChecked | onItemChecked()} 의 발생 여부
*
* @example
* ```js
* treeView.checkChildren(4, true, true, true, true);
* ```
*/
checkChildren(itemIndex: number, checked: boolean, recursive: boolean, visibleOnly: boolean, checkableOnly: boolean, checkEvent?: boolean): void;
}
/**
* @public
*
* 변경된 셀 정보
*
* @remarks
* {@link UpdatedRow} 에서 사용된다.
*/
export declare interface UpdatedCell {
/**
* 필드명
*/
fieldName: string;
/**
* 변경 전 값
*/
oldValue: any;
/**
* 변경 후 값
*/
newValue: any;
}
/**
* @public
*
* 변경된 행 정보
*
* @remarks
* {@link DataProviderBase.getUpdatedCells | getUpdatedCells()} 에서 사용된다.
*/
export declare interface UpdatedRow {
/**
* 행의 고유번호
*/
__rowId: number;
/**
* 변경된 셀 정보들
*/
updatedCells: UpdatedCell[];
}
/**
* 이미지의 경로와 위치를 지정한다.
* @remarks
* width, height가 지정되면 이미지의 원래 크기가 아닌 입력된 값을 이용해서 크기를 변경한다.
*/
declare interface UserCellImage {
/**
* 이미지의 url을 입력한다.
*/
url: string;
/**
* 이미지의 위치를 지정한다.
* @defaultValue IconLocation.CENTER
*/
location?: IconLocation;
/**
* 이미지의 너비를 지정한다.
* 지정하지 않으면 이미지의 원래너비를 사용한다.
*/
width?: number;
/**
* 이미지의 높이를 지정한다.
* 지정하지 않으면 이미지의 원래높이를 사용한다.
*/
height?: number;
}
/**
* @public
* 사용자가 출력 셀을 추가할때 사용되는 콜백 {@link GridExportOptions.userCells}이 있는 경우 수행되지 않는다.
*
* @remarks
* [매개변수 목록]
* `grid` - 현재 export를 진행중인 grid
*
* `rowCount` - sheet의 행수
*
* `colCount` - sheet의 컬럼수
*
* `name` - sheet의 name
*
* [반환값] - {@link UserExportCell}의 배열
*
* @example
* ```js
* var callback = function(grid, rowCount, colCount, sheetName) {
* return [{row:3, col: colCount -3, mergeCol: 3, text:"열의 마지막에 표시", styles:{textAlign:"right"}}]
* }
* gridView.exportGrid({"type":"excel", "target":"local", "yOffset":4, userCellsCallback: callback});
* ```
*/
export declare type UserCellsCallback = (grid: GridBase, rowCount: number, columnCount: number, sheetName: string) => UserExportCell[];
/**
* @public
* 엑셀로 export할때 그리드가 출력하는 내용외에 추가적으로 출력할 내용을 지정한다.
*
* @remarks
* 그리드가 출력하는 영역을 덮어쓰는 경우 엑셀파일에 오류가 발생할수 있기 때문에 주의해야 한다.
* row, col, value는 반드시 지정해야 한다.
* @example
* ```js
* var userCells = [
* {row: 0, col: 0, value: "사용자 입력문자열"},
* {row: 1, col: 0, styleName: "userCellRed", value: "스타일을 적용"},
* {row: 2, col: 0, mergeRow: 1, mergeCol: 3, styleName: "userCellRed", value: "merge를 하고 스타일을 적용."},
* {row: 3, col: 0, value: "inline-style", styles: {background:"red", fontSize:"20px"}},
* {row: 4, col: 0, value: 12345, format: "#,##0.0_ ", styles: {textAlign:"right"}},
* {row: 4, col: 2, value: new Date(2022, 4, 16), format: "[$-F800]dddd, mmmm dd, yyyy", styles: {textAlign:"center"}},
* ]
* gridView.exportGrid({"type": "excel", "target": "local", "yOffset": 5, "userCells": userCells});
* ```
*/
export declare interface UserExportCell {
/**
* 출력될 행번호 `0`부터 계산된다.
*/
row: number;
/**
* 출력될 컬럼번호 `0`부터 계산된다.
*/
col: number;
/**
* 출력될 내용
*
* @remarks
* string, numbar, Date, boolean 형태의 값을 입력한다.
*/
value: any;
/**
* 셀에 적용될 className
*/
styleName?: string;
/**
* 셀에 적용될 format을 입력한다.
*/
format?: string;
/**
* 셀에 적용될 스타일
*
* @example
* ```js
* var styles = {
* textAlign: "center",
* background: "green",
* color: "red"
* }
*
* var styles2 = "text-align:center;background:green;color:red"
* ```
*
*/
styles?: ConfigObject | string;
/**
* merge할 경우 row갯수
*/
mergeRow?: number;
/**
* merge할 경우 컬럼갯수
*/
mergeCol?: number;
/**
* 행의 높이를 지정한다.
*
* @remarks
* 이미 출력된 행에 추가되는 경우 출력행의 높이를 유지한다.
*
* @defaultValue `-1` 엑셀이 높이를 결정.
*/
height?: number;
/**
* mergeRow가 있는 경우 각행의 높이를 지정한다.
*
* @remarks
* 지정하지 않으면 height가 적용된다.
*/
heights?: number[];
/**
* 컬럼의 너비를 지정한다.
*
* @remarks
* 이미 있는 컬럼인 경우 기존너비가 유지된다.
*
* @defaultValue `undefined`
*/
width?: number;
/**
* mergeCol이 있는 경우 각 컬럼의 너비를 지정한다.
*
* @remarks
* 지정하지 않으면 width가 적용된다.
*/
widths?: number[];
/**
* @remarks
*
* 잠금
*/
cellProtectProps?: CellProtectProperties;
/**
* 셀에 이미지를 추가한다. 이미지는 셀(병합된경우 포함)보다 크게 표시될수 없다.
*
* @remarks
* string으로 입력하면 이미지를 가운데 정렬해서 출력한다.
*
*/
image?: UserCellImage | string;
/**
* 셀에 메모를 출력한다.
*
* @remarks
* string으로 입력하여 message를 설정할 수 있다.
*/
cellMemo?: CellMemo | string;
}
/**
* autoFilter와 사용자 필터를 동시에 보여줄때 사용자 필터의 위치
*
*/
export declare enum UserFilterPosition {
/**
* 사용자 필터를 autoFiler 상단에 위치시킨다.
*/
FIRST = "first",
/**
* 사용자 필터를 autoFiler 하단에 위치시킨다.
*/
LAST = "last",
/**
* 사용자 필터를 표시하지 않는다.
*/
NONE = "none"
}
/**
* @public
* footer의 사용자 지정 span
*
* @remarks
* footer, headerSummary, groupFooter의 셀을 사용자가 span시키기 위한 rowspan, colspan을 지정한다.
* footerCount가 지정되면 rowspan은 무시된다.
*/
declare interface UserSpan {
/**
* rowspan
*/
rowspan?: number;
/**
* colspan
*/
colspan?: number;
/**
* footerCount
*/
footerCount?: number;
}
/**
* @public
*
* 검증 결과 관련 설정 정보 모델
*
* @remarks
* {@link GridBase.onValidateColumn}, {@link GridBase.onValidateRow}, {@link GridBase.onValidationFail} 에서 사용된다.
*/
export declare interface ValidationError {
/**
* 데이터 검증 결과 수준
*/
level: ValidationLevel;
/**
* 표시할 메세지 내용
*/
message: string;
}
/**
* @public
*
* 데이터 검증 결과 수준
*
* @remarks
* {@link GridBase.setValidations} 등에서 쓰인다.
*
* @example
* ```js
* gridView.setValidations({
* message: 'Too expensive!',
* criteria: "values['UnitPrice'] > 100",
* level: 'error'
* })
* ```
*/
export declare enum ValidationLevel {
/**
* 오류
*/
ERROR = "error",
/**
* 경고
*/
WARNING = "warning",
/**
* 정보
*/
INFO = "info",
/**
* 없음
*/
IGNORE = "ignore"
}
/**
* @public
*
* 검증 방법
*
* @remarks
* {@link GridBase.setValidations} 등에서 쓰인다.
*
* @example
* ```js
* gridView.setValidations({
* message: 'Too expensive!',
* criteria: "values['UnitPrice'] > 100",
* mode: 'always'
* })
* ```
*/
export declare enum ValidationMode {
/**
* 항상(삽입, 수정) 커밋될 때마다
*/
ALWAYS = "always",
/**
* 수정한 행이 커밋될 때
*/
UPDATE = "update",
/**
* 추가한 행이 커밋될 때
*/
INSERT = "insert"
}
/**
* DataCell의 상위 클래스이다.
*/
export declare interface ValueCell {
/**
* Validation 정보
*/
error?: any;
/**
* Validation Level
*/
errorLevel?: ValidationLevel;
}
/**
* @public
* {@link GridColumn} 을 상속한 컬럼 정보 모델
*
* @remarks
* 추가로 서식 정보 등이 들어가 있다.
*
* [하위 클래스]
*
* {@link DataColumn}
*
* {@link SeriesColumn}
*/
export declare interface ValueColumn extends GridColumn {
/**
* 컬럼에 지정되어 있는 숫자 형식의 값일 때 표시되는 서식
*
* 천단위기호,소수점을 변경하는 경우 `;`로 구분해서 지정.
*
* @remarks
* 예) `'#,##0.###'`
* `undefined`이면 {@link GridBase.formatOptions}에 지정된 numberFormat이 적용.
*
* 형식 - 포맷;소수점기호;천단위기호;반올림구분
*
* 반올림구분 - 지정된 소수점 이하 자리를 처리하는 방법
* `c` - 올림
* `f` - 버림
* `a` - 절대값으로 표시
* @example
* ```js
* // 천단위마다 `,`를 표시 하고 소수점이하 자리는 반올림
* gridView.columnByName("number").numberFormat = "#,##0";
*
* // 천단위 기호와 소수점을 변경하는 경우
* gridView.columnByName("number").numberFormat = "#,##0.00;,;."
*
* // 소수점 2자리까지만 표시하고 3번째는 버림
* gridView.columnByName("number").numberFormat = "#,##0.00;;;f"
* ```
*
* @defaultValue `undefined`
*/
numberFormat?: string | null;
/**
* -0.00 처럼 표시되는것을 0.00 으로 표시 여부
*
* @defaultValue `true`
*/
displayMinusZero?: boolean;
/**
* 컬럼에 지정되어 있는 날짜 형식의 값일 때 표시되는 서식
* `undefined`이면 {@link GridBase.formatOptions}에 지정된 numberFormat이 적용된다.
*
* @remarks
* 예) `'yy-M-dd'`
*
* @defaultValue `undefined`
*/
datetimeFormat?: string;
/**
* 컬럼에 지정되어 있는 Boolean 형식의 값일 때 표시되는 서식
*
* @remarks
* 콜론(:) 또는 세미콜론(;)으로 구분하여 왼쪽은 `false`일 때, 오른쪽은 `true`일 때
*
* 예) `'Nub: Yub'`
*/
booleanFormat?: string;
/**
* 텍스트 형식의 값일 때 표시되는 서식
*
* @remarks
* 세미콜론(;)으로 구분하여 왼쪽에는 String.prototype.replace의 첫 번째 매개변수, 오른쪽에는 두 번째 매개변수와 같은 타입으로 지정
* 예) `'([A-Za-z]*); Mr\. \$1'`
*
*/
textFormat?: string;
/**
* 앞에 추가 될 텍스트
*
* @remarks
* 데이터를 표시할 때 지정한 앞에 추가 될 텍스트를 값의 앞에 붙여 표시한다.
*/
prefix?: string;
/**
* 뒤에 추가 될 텍스트
*
* @remarks
* 데이터를 표시할 때 지정한 뒤에 추가 될 텍스트를 값의 뒤에 붙여 표시한다.
*/
suffix?: string;
/**
* 클립 보드에 복사 시 빈 값을 넘겨줄지의 여부
*
* SeriesColumn의 경우 기본값이 true이다.
*
* @defaultValue `false`
*/
blankWhenCopy?: boolean;
/**
* Export 시 빈 값을 넘겨줄지의 여부
*
* @defaultValue `false`
*/
blankWhenExport?: boolean;
/**
* 편집기에 입력되는 값의 대소문자 변환 형태
*
* @defaultValue {@link TextInputCase.NORMAL}
*/
textInputCase?: TextInputCase;
/**
* 스타일 클래스 명
*/
styleName?: string;
/**
* excel로 export될때 사용될 스타일 명
*/
exportStyleName?: string;
/**
* 스타일을 지정하기 위한 콜백
*
* @eventProperty
* @example
* ```js
* const f = function (grid, cell) {
* return {
* styleName: 'custom-cell'
* editor: 'text'
* }
* }
* column.styleCallback = f;
* ```
*/
styleCallback?: CellStyleCallback;
/**
* 렌더러
*
* @remarks
* {@link CellRenderer} 참조
*/
renderer?: TextCellRenderer | BarCellRenderer | ImageCellRenderer | IconCellRenderer | CheckCellRenderer | MultiCheckCellRenderer | ButtonCellRenderer | ShapeCellRenderer | LinkCellRenderer | SignalBarCellRenderer | Code39CellRenderer | Code128CellRenderer | SeriesTextCellRenderer | SparkLineRenderer | SparkColumnRenderer | SparkWinLossRenderer | ActualTargetTextRenderer | ActualTargetBulletRenderer | TemplateCellRenderer | ConfigObject | string;
/**
* 편집기
*
* @remarks
* {@link CellEditor} 참조
*/
editor?: LineCellEditor | PasswordCellEditor | NumberCellEditor | MultiLineCellEditor | DropDownCellEditor | MultiCheckCellEditor | SearchCellEditor | DateCellEditor | BTDateCellEditor | ConfigObject | string;
/**
* 데이터 셀 우측에 표시할 버튼
*
* @defaultValue {@link CellButton.NONE}
*
* @example
* ```js
* column.button = 'popup';
* ```
*/
button?: string;
/**
* 컬럼 버튼의 표시 방법
*
* @defaultValue {@link ButtonVisibility.DEFAULT}
*/
buttonVisibility?: ButtonVisibility;
/**
* 컬럼 버튼 표시 콜백
*
* @eventProperty
* @example
* ```js
* column.buttonVisibleCallback = function(grid, index, focused, mouseEntered) {
* return (grid.getValue(index.itemIndex, index.fieldName) === "AAA" && (focused || mouseEntered))
* }
* ```
* @remarks
* column.button이 설정되어있을때 특정조건에 해당하는 경우에만 button이 표시되도록 할때 사용한다.
*/
buttonVisibleCallback?: ButtonVisibleCallback;
/**
* 셀 편집기 버튼의 표시 방법
*
* @remarks
* 현재 버튼이 표시되는 셀 편집기는 DropDownCellEditor, DateCellEditor, SearchCellEditor가 있다.
*
* @defaultValue {@link ButtonVisibility.DEFAULT }
*/
editButtonVisibility?: ButtonVisibility;
/**
* 팝업메뉴
*
* @remarks
* 메뉴가 지정되면 데이터 셀 위로 마우스가 진입하거나 focus를 가질 때 메뉴 버튼이 활성화된다.
* {@link MenuItem} 모델의 배열 형태다.
*/
popupMenu?: ConfigObject[];
/**
* 팝업메뉴 이름
*
* @remarks
* {@link GridBase.addPopupMenu}로 등록한 메뉴를 컬럼의 팝업메뉴로 사용한다.
*/
popupMenuName?: string;
/**
*
* edgeMark 표시여부
*
* @remarks
* 셀에 강조 표시를 할때 사용한다.
*/
edgeMark?: EdgeMark;
/**
* 값을 구분하기 위한 구분자
*
* @remarks
*
* data가 "value,value" 형태로 되어 있는 것을 "label,label" 형태로 보여줄 때 value를 구분하기 위한 구분자
* 또는 fields의 값들을 구분할 때 사용하는 구분자
*
* @defaultValue `,`
*/
valueSeparator?: string;
}
/**
* @public
*
* 동일한 값이 아니지만 하나의 그룹으로 묶을때 기준이 되는 값을 개발자가 지정할때 사용한다.
* field의 dataType과 동일한 dataType으로 return 해야한다.
*
* @remarks
* {@link RowGroup.valueForGroupCallback}에서 사용되는 형식이다.
* [매개변수 목록]
*
* `grid` - GridBase 컨트롤
*
* `dataRow` - dataRow
*
* `fieldName` - fieldName
*
* `value` - value
*
* @example
* ```js
* valueForGroupCallback = function(grid, dataRow, fieldName, value) {
* if (value && fieldName === 'date1') {// 특정 field에만 적용.
* // Date형식의 data를 년도와 월을 이용해서 그룹으로 묶는다.
* return new Date(value.getFullYear(), value.getMonth());
* };
* // 변경되지 않았다면 원래의 값을 reutrn해야 한다.
* return value;
* }
* ```
*/
export declare type ValueForGroupCallback = (grid: GridView, dataRow: number, fieldName: string, value: any) => any;
/**
* @public
*
* 데이터 필드의 데이터 자료형
*
* @remarks
* {@link DataField.dataType} 에서 사용될 때는 `TEXT`, `NUMBER`, `DATETIME`, `BOOLEAN`, `OBJECT` 으로 사용되며, 적용한 자료형을 제한하고 싶을 때에는 {@link DataField.subType} 에 다음과 같이 부여 가능하다.
*
* {@link DataField.dataType | dataType} 이 `TEXT`: `CHAR`
*
* {@link DataField.dataType | dataType} 이 `NUMBER`: `INT`, `UNUM`, `UINT`
*
* {@link DataField.dataType | dataType} 이 `DATETIME`: `DATE`
*
* @example
* ```js
* let fields = [{
* ...
* dataType: "text",
* subType: "char",
* ...
* }]
*
* ds.setFields(fields);
* ```
*/
export declare enum ValueType {
/**
* 텍스트
*/
TEXT = "text",
/**
* 숫자
*/
NUMBER = "number",
/**
* Boolean
*/
BOOLEAN = "boolean",
/**
* 날짜
*/
DATETIME = "datetime",
/**
* 오브젝트
*/
OBJECT = "object",
/**
* 문자
*
* @remarks
* 0보다 큰 `length` 속성과 더불어 길이가 제한된 문자열로 저장된다. `length`를 0 이하로 지정하면 `text` 기본 자료형과 동일하다.
*/
CHAR = "char",
/**
* 0 이상의 숫자
*/
UNUM = "unum",
/**
* 정수형
*
* @remarks
* `i = v >= 0 ? Math.floor(v) : Math.ceil(v);` 와 같은 방식으로 저장 즉, 1.1이면 1로, -1.1이면 -1로 저장된다.
*/
INT = "int",
/**
* 0 이상의 정수형 값
* @remarks
* i = `Math.floor(v);` 와 같은 방식으로 저장된다.
*/
UINT = "uint",
/**
* 시간 부분이 제거된 날짜
*/
DATE = "date"
}
/**
* direction이 `vertical`인 ColumnGruop의 하위 컬럼에서 위화살표 또는 아래화살표를 입력했을때 focus이동 방식.
*/
export declare enum VerticalMoveStep {
/**
* row단위로 이동한다.
*/
ROW = "row",
/**
* 셀단위로 이동한다.
*/
CELL = "cell"
}
/**
* {@link GridView} 의 전체 설정 정보들
*
* @remarks
* {@link GridOptions} 를 상속한다.
*
* [상위 클래스]
*
* {@link GridOptions}
*
* @example
* ```js
* let options = {
* summaryMode: 'aggregate',
* display: {
* columnResizable : false
* },
* grouping: {
* enabled: false
* }
* };
* gridView.setOptions(options);
* ```
*/
export declare interface ViewOptions extends GridOptions {
filterOr?: boolean;
groupSummaryMode?: SummaryMode;
filterMode?: FilterMode;
grouping?: GroupingOptions;
groupPanel?: GroupPanel;
rowGroup?: RowGroup;
}
/**
* Shadow Dom 에 관한 설정 모델
*
* @remarks
* 웹 접근성 지원을 위해 그리드 구성 요소의 각 명칭을 지정한다.
*/
export declare interface WaiOptions {
/**
* 그리드 제목
*
* @remarks
* table tag의 caption으로 표시된다.
*/
title?: string;
/**
* table의 설명
*
* @remarks
* table tag의 caption으로 표시된다.
* title이 있으면 title다음에 표시되고 문자열에 `${columns}`가 있으면 해당위치에 column 제목을 표시한다.
*/
description?: string;
}
/**
* DataSource (DataProvider)
*/
export declare type DataSource = any;
// /**
// * GridCell
// */
// export declare type GridCell = any;
/**
* BodyTabelCell
*/
export declare type BodyTableCell = any;
/**
* DataCellRenderer
*/
declare class DataCellRenderer {}