new PropertyContext(properties, getValue, setValue)
Creates a new property context object. Warning: Property context objects are created in models internally. They are intended only to make publicly available the context for custom property functions.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
properties |
Array.<bo.shared.PropertyInfo> | An array of property definitions. |
|
getValue |
internal~getValue |
<optional> |
A function that returns the current value of a property. |
setValue |
internal~setValue |
<optional> |
A function that changes the current value of a property. |
Throws:
-
Argument error: The properties must be an array of PropertyInfo objects, or a single PropertyInfo object or null.
-
Argument error: The getValue argument must be a function.
-
Argument error: The setValue argument must be a function.
Members
-
<readonly> primaryProperty :bo.shared.PropertyInfo
-
The primary property of the custom function.
Type:
-
<readonly> properties :Array.<bo.shared.PropertyInfo>
-
Array of property definitions that may used by the custom function.
Type:
- Array.<bo.shared.PropertyInfo>
Methods
-
getValue(propertyName) → {*}
-
Gets the current value of a model property.
Parameters:
Name Type Description propertyNamestring The name of the property.
Throws:
-
Argument error: The name must be a non-empty string.
-
Argument error: The model has no property with the given name.
-
Model error: The property cannot be read.
Returns:
The value of the model property.
- Type
- *
-
-
setValue(propertyName, value)
-
Sets the current value of a model property.
Parameters:
Name Type Description propertyNamestring The name of the property.
value* The new value of the property.
Throws:
-
Argument error: The name must be a non-empty string.
-
Argument error: The model has no property with the given name.
-
Model error: The property cannot be written.
-
-
with(property) → {bo.shared.PropertyContext}
-
Sets the primary property of the custom function.
Parameters:
Name Type Description propertybo.shared.PropertyInfo The primary property of the custom function.
Returns:
The property context object itself.