TreeView
TreeView 클래스, GridBase 의 자식 클래스이다.
Signature:
export declare class TreeView extends GridBase Extends: GridBase
Remarks
[상위 클래스]
Events
| Property | Type | Description |
|---|---|---|
| onTreeItemChanged | (tree: TreeView, itemIndex: number, rowId: number) => void | TreeView의 값이 변경되었음을 알리는 콜백 |
| onTreeItemCollapsed | (tree: TreeView, itemIndex: number, rowId: number) => void | TreeView의 아이템 노드가 졉혔음을 알리는 콜백 |
| onTreeItemCollapsing | (tree: TreeView, itemIndex: number, rowId: number) => void | TreeView의 아이템 노드 접힘을 결정하는 콜백 |
| onTreeItemExpanded | (tree: TreeView, itemIndex: number, rowId: number) => void | TreeView의 아이템 노드가 펼쳐졌음을 알리는 콜백 |
| onTreeItemExpanding | (tree: TreeView, itemIndex: number, rowId: number) => boolean | TreeView의 아이템 노드 펼치기를 결정하는 콜백 |
Properties
| Property | Type | Description |
|---|---|---|
| treeOptions | TreeOptions | TreeView 만이 고유로 가지는 설정 모델 |
Methods
| Method | Type | Description |
|---|---|---|
| checkChildren(itemIndex, checked, recursive, visibleOnly, checkableOnly, checkEvent) | checkChildren(itemIndex: number, checked: boolean, recursive: boolean, visibleOnly: boolean, checkableOnly: boolean, checkEvent?: boolean): void; | 입력된 행의 자식 행들을 체크하거나 해제한다. |
| collapse(itemIndex, recursive) | collapse(itemIndex: number, recursive?: boolean): void; | 행을 접는다. |
| collapseAll() | collapseAll(): void; | 모든 행을 접는다. |
| collapseModel(model, recursive) | collapseModel(model: GridItem, recursive: boolean): void; | 아이템(행)을 접는다. |
| expand(itemIndex, recursive, force, level) | expand(itemIndex: number, recursive?: boolean, force?: boolean, level?: number): void; | 행을 펼친다. |
| expandAll(level, renewHasChildren) | expandAll(level?: number, renewHasChildren?: boolean): void; | 모든 행을 펼친다. |
| expandModel(model, recursive, force, level) | expandModel(model: GridItem, recursive?: boolean, force?: boolean, level?: number): void; | 아이템(행)을 펼친다. |
| getAncestors(itemIndex, includeRoot) | getAncestors(itemIndex: number, includeRoot?: boolean): number[]; | 조상 행들의 인덱스들을 반환한다. |
| getCheckedItems() | getCheckedItems(): number[]; | Check된 아이템들의 index 목록을 배열로 반환한다. |
| getCheckedRows(visibleOnly) | getCheckedRows(visibleOnly: boolean): number[]; | Check된 데이터 행들의 index 목록을 반환한다. |
| getChildren(itemIndex) | getChildren(itemIndex: number): number[]; | 자식 행들의 인덱스들을 반환한다. |
| getDataSource() | getDataSource(): LocalTreeDataProvider; | 트리에 연결되어 있는 DataProvider를 반환한다. |
| getDescendants(itemIndex) | getDescendants(itemIndex: number): number[]; | 자손 행들의 인덱스들을 반환한다. |
| getParent(itemIndex) | getParent(itemIndex: number): number; | 부모 행의 인덱스를 반환한다. |
| getTreeOptions() | getTreeOptions(): TreeOptions; | 트리 그리드 선택 표시 등, 관련된 설정 정보들을 가져온다. |
| setOptions(options) | setOptions(options: TreeViewOptions): void; | |
| setTreeOptions(options) | setTreeOptions(options: TreeOptions): void; | 트리뷰 표시 및 동작과 관련된 설정을 한다. |
Events Desc
onTreeItemChanged
TreeView의 값이 변경되었음을 알리는 콜백
Type - (tree: TreeView, itemIndex: number, rowId: number) => void
Remarks:
값이 변경된 후 commit() 시 발생한다.
[매개변수 목록]
tree - TreeView 컨트롤
itemIndex - 값이 변경된 행의 인덱스
rowId - 값이 변경된 행의 고유번호
Example:
treeView.onTreeItemChanged = function (tree, itemIndex, rowId) {
console.log("TreeItem item changed:: " + itemIndex);
};onTreeItemCollapsed
TreeView의 아이템 노드가 졉혔음을 알리는 콜백
Type - (tree: TreeView, itemIndex: number, rowId: number) => void
Remarks:
[매개변수 목록]
tree - TreeView 컨트롤
itemIndex - 접힌 아이템 행의 인덱스
rowId - 접힌 행의 고유번호
Example:
treeView.onTreeItemCollapsed = function (tree, itemIndex, rowId) {
console.log('Collapsed at: ' + itemIndex);
};onTreeItemCollapsing
TreeView의 아이템 노드 접힘을 결정하는 콜백
Type - (tree: TreeView, itemIndex: number, rowId: number) => void
Remarks:
[매개변수 목록]
tree - TreeView 컨트롤
itemIndex - 접으려는 행의 인덱스
rowId - 접으려는 행의 고유번호
[반환값] - false를 반환하면 펼쳐지지 않는다.
Example:
treeView.onTreeItemCollapsing = function (tree, itemIndex, rowId) {
return false;
};onTreeItemExpanded
TreeView의 아이템 노드가 펼쳐졌음을 알리는 콜백
Type - (tree: TreeView, itemIndex: number, rowId: number) => void
Remarks:
[매개변수 목록]
tree - TreeView 컨트롤
itemIndex - 펼쳐진 행의 인덱스
rowId - 펼쳐진 행의 고유번호
Example:
treeView.onTreeItemExpanded = function (tree, itemIndex, rowId) {
console.log('Expanded at: ' + itemIndex);
};onTreeItemExpanding
TreeView의 아이템 노드 펼치기를 결정하는 콜백
Type - (tree: TreeView, itemIndex: number, rowId: number) => boolean
Remarks:
[매개변수 목록]
tree - TreeView 컨트롤
itemIndex - 펼쳐지려는 행의 인덱스
rowId - 펼쳐지려는 행의 고유번호
[반환값] - false를 반환하면 펼쳐지지 않는다.
Example:
treeView.onTreeItemExpanding = function (tree, itemIndex, rowId) {
return false;
};Properties Desc
treeOptions
TreeView 만이 고유로 가지는 설정 모델
Type - TreeOptions
Remarks:
TreeOptions 객체를 반환한다. TreeOptions 의 속성을 가져오거나 설정할 수 있다.
Example:
treeView.treeOptions.iconWidth = 20;Methods Desc
checkChildren
입력된 행의 자식 행들을 체크하거나 해제한다.
[매개변수 목록]
itemIndex - number
부모행의 ItemModel index
checked - boolean
true: 체크, false: 해제
recursive - boolean
기본값: false, 그룹에 포함된 자손 그룹의 펼침여부
visibleOnly - boolean
true면 collapse되거나 페이징시 보이지 않는 행들은 제외한다.
checkableOnly - boolean
true면 체크 가능한 상태인 것들만 체크 한다.
checkEvent - boolean
기본값: true, onItemChecked() 의 발생 여부
[반환값] - void
Example:
treeView.checkChildren(4, true, true, true, true);collapse
행을 접는다.
[매개변수 목록]
itemIndex - number
접으려는 행의 인덱스
recursive - boolean
기본값: false, 그룹에 포함된 자손 그룹의 접힘여부
[반환값] - void
Example:
tree.collapse(3);collapseAll
모든 행을 접는다.
Example:
tree.collapseAll();collapseModel
아이템(행)을 접는다.
[매개변수 목록]
model - GridItem
접으려는 아이템 모델
recursive - boolean
기본값: false, 그룹에 포함된 자손 그룹의 접힘여부
[반환값] - void
Example:
let model = tree.getModel(4);
tree.collapseModel(model);expand
행을 펼친다.
[매개변수 목록]
itemIndex - number
펼치려는 행의 인덱스
recursive - boolean
기본값: false, 그룹에 포함된 자손 그룹의 펼침여부
force - boolean
기본값: false, 이미 expanded 상태라도 recursive가 true일 때 자손들의 펼침여부
level - number
기본값: 0, 0일 때 recursive가 true면 모든 자손 펼침
[반환값] - void
Remarks:
recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.
Example:
tree.expand(3);expandAll
모든 행을 펼친다.
[매개변수 목록]
level - number
기본값: 0, 0일 때 recursive가 true면 모든 자손 펼침
renewHasChildren - boolean
기본값: true false이면 자식행 여부를 갱신하지 않는다
[반환값] - void
Remarks:
level을 지정하면 해당 level까지 펼친다.
Example:
tree.expandAll();expandModel
아이템(행)을 펼친다.
[매개변수 목록]
model - GridItem
펼치려는 아이템의 모델
recursive - boolean
기본값: false, 그룹에 포함된 자손 그룹의 펼침여부
force - boolean
기본값: false, 이미 expanded 상태라도 recursive가 true일 때 자손들의 펼침여부
level - number
기본값: 0, 0일 때 recursive가 true면 모든 자손 펼침
[반환값] - void
Remarks:
recursive가 true일 때 level을 지정하면 해당 level까지 펼친다.
Example:
let model = tree.getModel(4);
tree.expandModel(model);getAncestors
조상 행들의 인덱스들을 반환한다.
[매개변수 목록]
itemIndex - number
해당 행의 인덱스
includeRoot - boolean
기본값: true, true: 숨겨진 최상위 루트행의 인덱스를 포함하여 결과 값으로 반환한다.
[반환값] - number[]
Example:
let aIndexes = tree.getAncestors(3);getCheckedItems
Check된 아이템들의 index 목록을 배열로 반환한다.
Example:
let checkedItems = treeView.getCheckedItems();getCheckedRows
Check된 데이터 행들의 index 목록을 반환한다.
[매개변수 목록]
visibleOnly - boolean
기본값: false, true로 입력하면 collapse되거나 페이징시 보이지 않는 행들은 제외한다.
[반환값] - number[]
Example:
let checkedRows = treeView.getCheckedRows(true);getChildren
자식 행들의 인덱스들을 반환한다.
[매개변수 목록]
itemIndex - number
부모 행의 인덱스
[반환값] - number[]
Example:
let cIndexes = tree.getChildren(3);getDataSource
트리에 연결되어 있는 DataProvider를 반환한다.
Example:
let ds = treeView.getDataSource();getDescendants
자손 행들의 인덱스들을 반환한다.
[매개변수 목록]
itemIndex - number
조상 행의 인덱스
[반환값] - number[]
Example:
let dIndexes = gridView.getDescendants(3);getParent
부모 행의 인덱스를 반환한다.
[매개변수 목록]
itemIndex - number
자식 행의 인덱스
[반환값] - number
Example:
let pIndex = tree.getParent(3);getTreeOptions
트리 그리드 선택 표시 등, 관련된 설정 정보들을 가져온다.
Example:
let treeOpts = tree.getTreeOptions();
treeOpts.lineVisible = false;
tree.setTreeOptions(treeOpts);setOptions
setTreeOptions
트리뷰 표시 및 동작과 관련된 설정을 한다.
[매개변수 목록]
options - TreeOptions
TreeOptions 설정 모델과 동일한 내용의 객체. 변경하고자 하는 속성만 변경하면 된다.
[반환값] - void
Remarks:
TreeOptions 에서 원하는 속성만 지정하여 사용한다.
Example:
tree.setTreeOptions({lineVisible: false});