/
Node.ts
227 lines (212 loc) · 7.84 KB
/
Node.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module Hierarchies
*/
import { LabelDefinition, LabelDefinitionJSON } from "../LabelDefinition";
import { NodeKey, NodeKeyJSON } from "./Key";
/**
* Data structure that describes a tree node.
* @public
*/
export interface Node {
/** A key that uniquely identifies a node. */
key: NodeKey;
/** Definition of node display label */
label: LabelDefinition;
/** Extensive description */
description?: string;
/**
* Image ID
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
imageId?: string;
/**
* Foreground color
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
foreColor?: string;
/**
* Background color
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
backColor?: string;
/**
* Font style
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
fontStyle?: string;
/** Does this node have child nodes */
hasChildren?: boolean;
/** Is this node selectable */
isSelectionDisabled?: boolean;
/** Is this node editable */
isEditable?: boolean;
/** Is this node expanded */
isExpanded?: boolean;
/**
* Is checkbox visible for this node
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
isCheckboxVisible?: boolean;
/**
* Is this node's checkbox checked
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
isChecked?: boolean;
/**
* Is this node's checkbox enabled
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
isCheckboxEnabled?: boolean;
/**
* Identifies whether the hierarchy level below this node supports filtering. If not, requesting either a hierarchy level descriptor or
* a hierarchy level with [[HierarchyRequestOptions.instanceFilter]] will throw an error with [[PresentationStatus.InvalidArgument]] status.
* @beta
*/
supportsFiltering?: boolean;
/** Extended data injected into this node */
extendedData?: {
[key: string]: any;
};
}
/**
* Serialized [[Node]] JSON representation.
* @public
* @deprecated in 3.x. Use [[Node]].
*/
export interface NodeJSON {
// eslint-disable-next-line deprecation/deprecation
key: NodeKeyJSON;
// TODO: rename to `label`
// eslint-disable-next-line deprecation/deprecation
labelDefinition: LabelDefinitionJSON;
description?: string;
/** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
imageId?: string;
/** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
foreColor?: string;
/** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
backColor?: string;
/** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
fontStyle?: string;
hasChildren?: boolean;
isSelectionDisabled?: boolean;
isEditable?: boolean;
isExpanded?: boolean;
/** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
isCheckboxVisible?: boolean;
/** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
isChecked?: boolean;
/** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */
isCheckboxEnabled?: boolean;
/** @beta */
supportsFiltering?: boolean;
extendedData?: {
[key: string]: any;
};
}
/**
* Partial node definition.
* @public
*/
export type PartialNode = AllOrNone<Partial<Node>, "key" | "label">;
/**
* Serialized [[PartialNode]] JSON representation.
* @public
* @deprecated in 3.x. Use [[PartialNode]].
*/
// eslint-disable-next-line deprecation/deprecation
export type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, "key" | "labelDefinition">;
type AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);
/** @public */
export namespace Node {
/**
* Serialize given [[Node]] to JSON
* @deprecated in 3.x. Use [[Node]].
*/
// eslint-disable-next-line deprecation/deprecation
export function toJSON(node: Node): NodeJSON {
const { label, ...baseNode } = node;
return {
...baseNode,
labelDefinition: label,
};
}
/** @internal */
// eslint-disable-next-line deprecation/deprecation
export function toPartialJSON(node: PartialNode): PartialNodeJSON {
if (node.key === undefined) {
return node;
}
const { label, ...baseNode } = node;
return {
...baseNode,
labelDefinition: label,
};
}
/**
* Deserialize [[Node]] from JSON
* @deprecated in 3.x. Use [[Node]].
*/
// eslint-disable-next-line deprecation/deprecation
export function fromJSON(json: NodeJSON | string): Node {
if (typeof json === "string") {
return JSON.parse(json, reviver);
}
const { labelDefinition, ...baseJson } = json;
return {
...baseJson,
// eslint-disable-next-line deprecation/deprecation
key: NodeKey.fromJSON(json.key),
label: labelDefinition,
};
}
/** @internal */
// eslint-disable-next-line deprecation/deprecation
export function fromPartialJSON(json: PartialNodeJSON): PartialNode {
if (json.key === undefined) {
return json;
}
const { key, labelDefinition, ...baseJson } = json;
return {
...baseJson,
// eslint-disable-next-line deprecation/deprecation
key: NodeKey.fromJSON(key),
label: labelDefinition,
};
}
/**
* Reviver function that can be used as a second argument for
* `JSON.parse` method when parsing [[Node]] objects.
* @internal
*/
export function reviver(key: string, value: any): any {
// eslint-disable-next-line deprecation/deprecation
return key === "" ? fromJSON(value) : value;
}
/**
* Deserialize nodes list from JSON
* @param json JSON or JSON serialized to string to deserialize from
* @returns Deserialized nodes list
* @internal
*/
// eslint-disable-next-line deprecation/deprecation
export function listFromJSON(json: NodeJSON[] | string): Node[] {
if (typeof json === "string") {
return JSON.parse(json, listReviver);
}
// eslint-disable-next-line deprecation/deprecation
return json.map((m) => fromJSON(m));
}
/**
* Reviver function that can be used as a second argument for
* `JSON.parse` method when parsing [[Node]][] objects.
* @internal
*/
export function listReviver(key: string, value: any): any {
return key === "" ? listFromJSON(value) : value;
}
}