_ Base Handle Prop Update
Class full path: HandlePropertiesService._BaseHandlePropUpdate
Bases: ABC
base class for the handle property update
Attributes
update_palette: bool
property
get the update palette state
Returns:
| Type | Description |
|---|---|
bool
|
update palette state |
Functions
__call__()
abstractmethod
execute the value update
__init__(build_ele, handle_prop, input_pnt, param_data)
initialize
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
build_ele
|
BuildingElement
|
building element with the parameter properties |
required |
handle_prop
|
HandleProperties
|
handle property |
required |
input_pnt
|
Point3D
|
input point |
required |
param_data
|
HandleParameterData
|
parameter data |
required |
get_property_data()
get the property data
Returns:
| Type | Description |
|---|---|
Tuple[Optional[ParameterProperty], str, str]
|
parameter property, item_name with index, parameter name |
get_z_min_max()
get the min and max parameter of the z coordinate
Returns:
| Type | Description |
|---|---|
Tuple[Optional[ParameterProperty], Optional[ParameterProperty]]
|
min/max parameter of the z coordinate |
update_property_value(value)
update the property value
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Any
|
new value |
required |