ControlPropertiesUtil
Implementation of the control properties service
ControlPropertiesUtil
Canonical path: ControlPropertiesUtil.ControlPropertiesUtil
Implementation of the control properties utilities
__init__
__init__(
control_props_list: list[BuildingElementControlProperties],
build_ele_list: list[BuildingElement],
)
initialize
Parameters:
-
control_props_list
(list[BuildingElementControlProperties]
) –list with the control properties
-
build_ele_list
(list[BuildingElement]
) –list with the building elements
set_background_color
set the background color control property
Parameters:
-
value_name
(str
) –value name of the control
-
background_color
(str
) –background color in the format "(red, green, blue)" with "(-1, -1, -1)" as default
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".
set_enable_condition
set the enable condition control property
Parameters:
-
value_name
(value name of the control
-
enable_condition
(str
) –enable condition control property
-
element_id
(''
) –element ID of the building element. Defaults to "".
set_enable_function
set_enable_function(
value_name: str,
enable_function: Callable[..., bool] | None,
element_id: str = "",
)
set the enable function control property
Parameters:
-
value_name
(str
) –value name of the control
-
enable_function
(Callable[..., bool] | None
) –enable function control property
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".
set_global_attributes
set the global attributes
Parameters:
-
global_attributes
(dict[str, Any]
) –global attributes
set_max_value
set the max value control property
Parameters:
-
value_name
–value name of the control
-
max_value
(maximal value
-
element_id
–element ID of the building element. Defaults to "".
set_min_value
set the min value control property
Parameters:
-
value_name
–value name of the control
-
min_value
(minimal value
-
element_id
–element ID of the building element. Defaults to "".
set_text
set the text control property
Parameters:
-
value_name
(str
) –value name of the control
-
text
(str
) –text control property
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".
set_value_list
set the value list control property
Parameters:
-
value_name
(str
) –value name of the control
-
value_list
(str
) –value list control property
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".
set_value_list_2
set the value list 2 control property
Parameters:
-
value_name
(str
) –value name of the control
-
value_list_2
(str
) –value list 2 control property
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".
set_value_text_list
set the value list 2 control property
Parameters:
-
value_name
(str
) –value name of the control
-
value_text_list
(str
) –value text list
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".
set_visible_condition
set the visible condition control property
Parameters:
-
value_name
(str
) –value name of the control
-
visible_condition
(str
) –visible condition control property
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".
set_visible_function
set_visible_function(
value_name: str,
visible_function: Callable[..., bool] | None,
element_id: str = "",
)
set the visible function control property
Parameters:
-
value_name
(str
) –value name of the control
-
visible_function
(Callable[..., bool] | None
) –visible function control property
-
element_id
(str
, default:''
) –element ID of the building element. Defaults to "".