Building Element Composite
Class full path: BuildingElementComposite.BuildingElementComposite
Bases: BuildingElementCompositeData
Implementation of class BuildingElementComposite
Functions
get_build_ele_index(build_ele_id)
get the index of the building element by the ID
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
build_ele_id
|
str
|
id fo find |
required |
Returns:
| Type | Description |
|---|---|
int
|
index of the ID |
get_composite_build_ele_list(sub_ele_index, build_ele_list)
Get a tuple with the - list with the sub building elements - list with the indices of the sub building elements
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sub_ele_index
|
int
|
Index of the sub element |
required |
build_ele_list
|
List[BuildingElement]
|
List with the building elements |
required |
Returns:
| Type | Description |
|---|---|
Tuple[List[BuildingElement], List[int]]
|
tuple with the lists |
get_element_palette_data(element_id)
Set the palette data for the element (control index, page text, expander text)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
element_id
|
str
|
element ID |
required |
Returns:
| Type | Description |
|---|---|
PaletteData
|
palette data |
get_script(sub_ele_index)
Get the script of the sub element
Return: script
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sub_ele_index
|
int
|
Index of the sub element |
required |
Returns:
| Type | Description |
|---|---|
object
|
script name |
get_sub_element_name(sub_ele_index)
Get the name of the sub element
Return: name
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sub_ele_index
|
int
|
Index of the sub element |
required |
Returns:
| Type | Description |
|---|---|
str
|
sub element name |
is_element_visible(ele_index, build_ele_list)
Check for a visible element
Return: the element is visible: True/False
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ele_index
|
int
|
element index |
required |
build_ele_list
|
List[BuildingElement]
|
Building element list |
required |
Returns:
| Type | Description |
|---|---|
bool
|
element visible state |
set_connection_persistence(build_ele_list)
Set the persistence for the connected parameter
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
build_ele_list
|
List[BuildingElement]
|
building element list |
required |
set_element_visible(ele_index, value)
Set the visible state for the element
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ele_index
|
int
|
element index |
required |
value
|
str
|
value |
required |