-
Notifications
You must be signed in to change notification settings - Fork 208
/
NodeArtifactsRule.ts
33 lines (29 loc) · 1.32 KB
/
NodeArtifactsRule.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
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module PresentationRules
*/
import { RuleBase } from "../Rule";
/**
* Node artifacts rules are used to create and assign artifacts to specific nodes. The artifacts can be
* accessed when evaluating parent node's `hideExpression` to decide whether it should be hidden or not.
*
* @see [Node artifacts rule reference documentation page]($docs/presentation/hierarchies/NodeArtifactsRule.md)
* @public
*/
export interface NodeArtifactsRule extends RuleBase {
/** Used for serializing to JSON. */
ruleType: "NodeArtifacts";
/**
* Specifies an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) that
* allows applying node artifacts based on evaluation result, e.g. by some property of the parent node.
*/
condition?: string;
/**
* A map of [ECExpressions]($docs/presentation/hierarchies/ECExpressions.md#specification) whose evaluation results
* are used as artifact values.
*/
items: { [key: string]: string };
}