Handbook · Reference · Blockly · Data
Blockly: Data
Where in the UI. Scripts tab toolbox.
Read/write item fields, categories, variables, local state, style patches.
| Block id | Read as | Purpose |
|---|---|---|
containd_read_item_field | read item field | callHost(getItemData) itemField |
containd_read_item_metric | read item metric | lazy-derived count or flag (imageCount, childCount, etc.) |
containd_read_category_property | read category property | callHost(getItemData) categoryProperty |
containd_read_item_field_on_item | read item field on item | callHost(getItemData) with itemId — accepts numeric id or ItemRef; requires read.relatives when not bound item |
containd_read_item_metric_on_item | read item metric on item | callHost(getItemMetric) with itemId — requires read.relatives when not bound item |
containd_read_category_property_on_item | read category property on item | callHost(getItemData) with itemId — accepts numeric id or ItemRef; requires read.relatives when not bound item |
containd_item_has_category | item has category | True when categories[] on the bound item includes the category id |
containd_item_has_category_on_item | item has category on item | True when categories[] on the given item includes the category id — item socket accepts numeric id or ItemRef (e.g. parent_ref) |
containd_category_property_has_value | category property has value | True when the bound item resolves a value (stored or static default) for the property |
containd_category_property_has_value_on_item | category property has value on item | True when the given item resolves a value for the property — item socket accepts numeric id or ItemRef |
containd_list_item_properties_by_type | list item properties by type | callHost(listItemPropertiesByType) on the bound item (DEC-076). |
containd_list_item_properties_by_type_on_item | list item properties by type on item | callHost(listItemPropertiesByType) for another item (needs read.relatives). |
containd_write_item_field | write item field | callHost(setItemData) |
containd_write_category_property | write category property | callHost(setItemData) |
containd_write_item_field_on_item | write item field on item | callHost(setItemData) with itemId — accepts numeric id or ItemRef; requires write.relatives when not bound item |
containd_write_category_property_on_item | write category property on item | callHost(setItemData) with itemId — requires write.relatives when not bound item |
containd_read_item_variable | read item variable | KEY is any string expression |
containd_read_item_variable_on_item | read item variable on item | callHost(getItemVariable) with itemId |
containd_item_variable_exists | item variable exists | True when the key is stored on the active item (getItemVariable type is set). |
containd_item_variable_exists_on_item | item variable exists on item | True when the key is stored on the given item. |
containd_write_item_variable | write item variable | types include itemRef and list (Blockly lists round-trip as JSON arrays) |
containd_write_item_variable_on_item | write item variable on item | callHost(setItemVariable) with itemId — accepts numeric id or ItemRef; type list stores a Blockly list |
containd_delete_item_variable | delete item variable | removes key from itemVariablesJson |
containd_delete_item_variable_on_item | delete item variable on item | callHost(deleteItemVariable) with itemId |
containd_read_local_state | read local state | ephemeral session bag (DEC-061) |
containd_local_state_exists | local state exists | True when the key is present in the ephemeral session bag (getLocalState.found). |
containd_write_local_state | write local state | not persisted to the item |
containd_delete_local_state | delete local state | callHost(deleteLocalState) |
containd_title_style_patch | title style patch | Partial defaultTitleStyle patch — unchanged fields are not written |
containd_apply_title_style_patch | apply title style patch | Merge patch into defaultTitleStyle on bound item (callHost getItemData/setItemData) |
containd_apply_title_style_patch_on_item | apply title style patch on item | Merge patch into defaultTitleStyle on target item — requires write.relatives when not bound |
containd_read_title_style_property | read title style property | Resolved defaultTitleStyle property on bound item (defaults applied) |
containd_read_title_style_property_on_item | read title style property on item | Resolved defaultTitleStyle property on target item |
containd_write_title_style_property | write title style property | Write one defaultTitleStyle property on bound item — type depends on the selected field |
containd_write_title_style_property_on_item | write title style property on item | Write one defaultTitleStyle property on target item — type depends on the selected field |
containd_svg_shape_settings_patch | svg shape settings patch | Partial svgShapeSettings patch — unchanged fields are not written |
containd_apply_svg_shape_settings_patch | apply svg shape settings patch | Merge patch into svgShapeSettings on bound item (callHost getItemData/setItemData) |
containd_apply_svg_shape_settings_patch_on_item | apply svg shape settings patch on item | Merge patch into svgShapeSettings on target item — requires write.relatives when not bound |
containd_read_svg_shape_settings_property | read svg shape settings property | Resolved svgShapeSettings property on bound item |
containd_read_svg_shape_settings_property_on_item | read svg shape settings property on item | Resolved svgShapeSettings property on target item |
containd_write_svg_shape_settings_property | write svg shape settings property | Write one svgShapeSettings property on bound item — boolean |
containd_write_svg_shape_settings_property_on_item | write svg shape settings property on item | Write one svgShapeSettings property on target item — boolean |
containd_web_share_policies_patch | web share policies patch | Partial webSharePolicies patch — unchanged fields are not written (public-share policies; openOnTap / openLinksInNewTab are web-only at runtime) |
containd_apply_web_share_policies_patch | apply web share policies patch | Merge patch into webSharePolicies on bound item (callHost getItemData/setItemData) |
containd_apply_web_share_policies_patch_on_item | apply web share policies patch on item | Merge patch into webSharePolicies on target item — requires write.relatives when not bound |
containd_read_web_share_policies_property | read web share policies property | Resolved webSharePolicies property on bound item (defaults applied) |
containd_read_web_share_policies_property_on_item | read web share policies property on item | Resolved webSharePolicies property on target item |
containd_write_web_share_policies_property | write web share policies property | Write one webSharePolicies property on bound item — boolean (public-share web only) |
containd_write_web_share_policies_property_on_item | write web share policies property on item | Write one webSharePolicies property on target item — boolean (public-share web only) |