Handbook · Reference · Blockly · Layouts

Blockly: Layouts

Where in the UI. Scripts tab toolbox.

Resolve layouts/elements, enable layouts, enum option helpers.

Block idRead asPurpose
containd_resolve_layout_indexresolve layout indexomit index to use live layoutInUse; returns stable layout id
containd_resolve_layout_idresolve layout idinverse of layout id for index; returns -1 when not found
containd_get_item_element_idget item element idcurrent item templateElementId
containd_item_has_elementitem has elementtrue when the bound item uses this element id
containd_list_template_element_idslist template element idselement ids on the item template (definition order)
containd_list_element_layout_idslist element layout idscyclable layout ids; omit element id to use the current element
containd_get_element_display_nameget element display nameomit element id to use the current element; app locale
containd_get_layout_display_nameget layout display nameomit layout id to use the live layout; app locale
containd_is_layout_enabledis layout enabledtrue when allowLayoutEnableDisable is off or the mask bit is 1; reserved variable _layoutEnabled
containd_is_layout_enabled_by_idis layout enabled by idcallHost(isLayoutEnabled) by layout id
containd_set_layout_enabledset layout enabledrequires element allowLayoutEnableDisable; refuses last enabled; remounts if current disabled
containd_set_layout_enabled_by_idset layout enabled by idcallHost(setLayoutEnabled) by layout id
containd_resolve_layout_index_on_itemresolve layout index on itemcallHost(resolveLayoutIndex) with itemId — requires read.relatives when not bound item
containd_resolve_layout_id_on_itemresolve layout id on itemcallHost(resolveLayoutId) with itemId — requires read.relatives when not bound item
containd_get_item_element_id_on_itemget item element id on itemcallHost(getItemElementId) with itemId — requires read.relatives when not bound item
containd_item_has_element_on_itemitem has element on itemcallHost(itemHasElement) with itemId — requires read.relatives when not bound item
containd_list_template_element_ids_on_itemlist template element ids on itemcallHost(listTemplateElementIds) with itemId — requires read.relatives when not bound item
containd_list_element_layout_ids_on_itemlist element layout ids on itemcallHost(listElementLayoutIds) with itemId — omit element id for current element
containd_get_element_display_name_on_itemget element display name on itemcallHost(getElementDisplayName) with itemId
containd_get_layout_display_name_on_itemget layout display name on itemcallHost(getLayoutDisplayName) with itemId
containd_is_layout_enabled_on_itemis layout enabled on itemcallHost(isLayoutEnabled) with itemId — requires read.relatives when not bound item
containd_is_layout_enabled_by_id_on_itemis layout enabled by id on itemcallHost(isLayoutEnabled) by id with itemId
containd_set_layout_enabled_on_itemset layout enabled on itemcallHost(setLayoutEnabled) with itemId — requires write.relatives when not bound item
containd_set_layout_enabled_by_id_on_itemset layout enabled by id on itemcallHost(setLayoutEnabled) by id with itemId
containd_enum_option_idenum option idStable enum option id string for the selected category enum property
containd_list_enum_optionslist enum optionscallHost(listEnumOptions) → array of { id, displayName, color?, icon? }.
containd_list_enum_option_idslist enum option idscallHost(listEnumOptions) → string[] of option ids in definition order.
containd_enum_value_to_indexenum value to indexcallHost(listEnumOptions) then map option id → 0-based index (−1 if not found).
containd_enum_index_to_valueenum index to valuecallHost(listEnumOptions) then map 0-based index → option id (empty if out of range).
containd_enum_option_fieldenum option fieldRead one field from a listEnumOptions option object.