-
Notifications
You must be signed in to change notification settings - Fork 208
/
CheckBoxRule.ts
55 lines (48 loc) · 1.85 KB
/
CheckBoxRule.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
/*---------------------------------------------------------------------------------------------
* 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";
/**
* CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.
*
* @see [CheckBox rule reference documentation page]($docs/presentation/customization/CheckBoxRule.md)
* @public
* @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
*/
export interface CheckBoxRule extends RuleBase {
/** Used for serializing to JSON. */
ruleType: "CheckBox";
/**
* Defines a condition for the rule, which needs to be met in order to execute it. Condition
* is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
* a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
*/
condition?: string;
/**
* Name of boolean type ECProperty which is bound with the check box state. When set, property
* value gets bound to checkbox state.
*
* @minLength 1
*/
propertyName?: string;
/**
* Should property value be inversed for the check box state.
*
* **Note:** Only makes sense when bound to an ECProperty.
*/
useInversedPropertyValue?: boolean;
/**
* Default value to use for the check box state
*
* **Note:** Only makes sense when *not* bound to an ECProperty.
*/
defaultValue?: boolean;
/**
* Indicates whether check box is enabled or disabled.
*/
isEnabled?: string | boolean;
}