user: Provide the full official documentation entry for Bpy.Types.Uilayout, preserving all code examples.

assistant: ifier of the boolean property that determines whether the panel is open or closed Returns : layout_header , Sub-layout to put items in, UILayout layout_body , Sub-layout to put items in. Will be none if the panel is collapsed., UILayout Return type : ( UILayout , UILayout ) column_flow ( * , columns = 0 , align = False ) ¶ column_flow Parameters : columns ( int in [ 0 , inf ] , ( optional ) ) – Number of columns, 0 is automatic align ( boolean , ( optional ) ) – Align buttons to each other Returns : Sub-layout to put items in Return type : UILayout grid_flow ( * , row_major = False , columns = 0 , even_columns = False , even_rows = False , align = False ) ¶ grid_flow Parameters : row_major ( boolean , ( optional ) ) – Fill row by row, instead of column by column columns ( int in [ -inf , inf ] , ( optional ) ) – Number of columns, positive are absolute fixed numbers, 0 is automatic, negative are automatic multiple numbers along major axis (e.g. -2 will only produce 2, 4, 6 etc. columns for row major layout, and 2, 4, 6 etc. rows for column major layout). even_columns ( boolean , ( optional ) ) – All columns will have the same width even_rows ( boolean , ( optional ) ) – All rows will have the same height align ( boolean , ( optional ) ) – Align buttons to each other Returns : Sub-layout to put items in Return type : UILayout box ( ) ¶ Sublayout (items placed in this sublayout are placed under each other in a column and are surrounded by a box) Returns : Sub-layout to put items in Return type : UILayout split ( * , factor = 0.0 , align = False ) ¶ split Parameters : factor ( float in [ 0 , 1 ] , ( optional ) ) – Percentage, Percentage of width to split at (leave unset for automatic calculation) align ( boolean , ( optional ) ) – Align buttons to each other Returns : Sub-layout to put items in Return type : UILayout menu_pie ( ) ¶ Sublayout. Items placed in this sublayout are placed in a radial fashion around the menu center). Returns : Sub-layout to put items in Return type : UILayout classmethod icon ( data ) ¶ Return the custom icon for this data, use it e.g. to get materials or texture icons. Parameters : data ( AnyType , (never None)) – Data from which to take the icon Returns : Icon identifier Return type : int in [0, inf] classmethod enum_item_name ( data , property , identifier ) ¶ Return the UI name for this enum item Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data identifier ( string , ( never None ) ) – Identifier of the enum item Returns : UI name of the enum item Return type : string, (never None) classmethod enum_item_description ( data , property , identifier ) ¶ Return the UI description for this enum item Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data identifier ( string , ( never None ) ) – Identifier of the enum item Returns : UI description of the enum item Return type : string, (never None) classmethod enum_item_icon ( data , property , identifier ) ¶ Return the icon for this enum item Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data identifier ( string , ( never None ) ) – Identifier of the enum item Returns : Icon identifier Return type : int in [0, inf] prop ( data , property , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , placeholder = '' , expand = False , slider = False , toggle = -1 , icon_only = False , event = False , full_event = False , emboss = True , index = -1 , icon_value = 0 , invert_checkbox = False ) ¶ Item. Exposes an RNA item and places it into the layout. Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item placeholder ( string , ( optional ) ) – Hint describing the expected value when empty expand ( boolean , ( optional ) ) – Expand button to show more detail slider ( boolean , ( optional ) ) – Use slider widget for numeric values toggle ( int in [ -1 , 1 ] , ( optional ) ) – Use toggle widget for boolean values, or a checkbox when disabled (the default is -1 which uses toggle only when an icon is displayed) icon_only ( boolean , ( optional ) ) – Draw only icons in buttons, no text event ( boolean , ( optional ) ) – Use button to input key events full_event ( boolean , ( optional ) ) – Use button to input full events including modifiers emboss ( boolean , ( optional ) ) – Draw the button itself, not just the icon/text. When false, corresponds to the ‘NONE_OR_STATUS’ layout emboss type. index ( int in [ -2 , inf ] , ( optional ) ) – The index of this button, when set a single member of an array can be accessed, when set to -1 all array members are used icon_value ( int in [ 0 , inf ] , ( optional ) ) – Icon Value, Override automatic icon of the item invert_checkbox ( boolean , ( optional ) ) – Draw checkbox value inverted props_enum ( data , property ) ¶ props_enum Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data prop_menu_enum ( data , property , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' ) ¶ prop_menu_enum Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item prop_with_popover ( data , property , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , icon_only = False , panel ) ¶ prop_with_popover Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item icon_only ( boolean , ( optional ) ) – Draw only icons in tabs, no text panel ( string , ( never None ) ) – Identifier of the panel prop_with_menu ( data , property , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , icon_only = False , menu ) ¶ prop_with_menu Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item icon_only ( boolean , ( optional ) ) – Draw only icons in tabs, no text menu ( string , ( never None ) ) – Identifier of the menu prop_tabs_enum ( data , property , * , data_highlight = None , property_highlight = '' , icon_only = False ) ¶ prop_tabs_enum Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data data_highlight ( AnyType , (optional, never None)) – Data from which to take highlight property property_highlight ( string , ( optional , never None ) ) – Identifier of highlight property in data icon_only ( boolean , ( optional ) ) – Draw only icons in tabs, no text prop_enum ( data , property , value , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' ) ¶ prop_enum Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data value ( string , ( never None ) ) – Enum property value text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item prop_search ( data , property , search_data , search_property , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , results_are_suggestions = False , item_search_property = '' ) ¶ prop_search Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data search_data ( AnyType , (never None)) – Data from which to take collection to search in search_property ( string , ( never None ) ) – Identifier of search collection property text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item results_are_suggestions ( boolean , ( optional ) ) – Accept inputs that do not match any item item_search_property ( string , ( optional , never None ) ) – Identifier of the string property in each collection’s items to use for searching (defaults to the items’ type ‘name property’) prop_decorator ( data , property , * , index = -1 ) ¶ prop_decorator Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data index ( int in [ -2 , inf ] , ( optional ) ) – The index of this button, when set a single member of an array can be accessed, when set to -1 all array members are used operator ( operator , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , emboss = True , depress = False , icon_value = 0 , search_weight = 0.0 ) ¶ Item. Places a button into the layout to call an Operator. Parameters : operator ( string , ( never None ) ) – Identifier of the operator text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item emboss ( boolean , ( optional ) ) – Draw the button itself, not just the icon/text depress ( boolean , ( optional ) ) – Draw pressed in icon_value ( int in [ 0 , inf ] , ( optional ) ) – Icon Value, Override automatic icon of the item search_weight ( float in [ -inf , inf ] , ( optional ) ) – Search Weight, Influences the sorting when using menu-seach Returns : Operator properties to fill in Return type : OperatorProperties operator_menu_hold ( operator , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , emboss = True , depress = False , icon_value = 0 , menu ) ¶ Item. Places a button into the layout to call an Operator. Parameters : operator ( string , ( never None ) ) – Identifier of the operator text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item emboss ( boolean , ( optional ) ) – Draw the button itself, not just the icon/text depress ( boolean , ( optional ) ) – Draw pressed in icon_value ( int in [ 0 , inf ] , ( optional ) ) – Icon Value, Override automatic icon of the item menu ( string , ( never None ) ) – Identifier of the menu Returns : Operator properties to fill in Return type : OperatorProperties operator_enum ( operator , property , * , icon_only = False ) ¶ operator_enum Parameters : operator ( string , ( never None ) ) – Identifier of the operator property ( string , ( never None ) ) – Identifier of property in operator icon_only ( boolean , ( optional ) ) – Draw only icons in buttons, no text operator_menu_enum ( operator , property , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' ) ¶ operator_menu_enum Parameters : operator ( string , ( never None ) ) – Identifier of the operator property ( string , ( never None ) ) – Identifier of property in operator text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item Returns : Operator properties to fill in Return type : OperatorProperties label ( * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , icon_value = 0 ) ¶ Item. Displays text and/or icon in the layout. Parameters : text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item icon_value ( int in [ 0 , inf ] , ( optional ) ) – Icon Value, Override automatic icon of the item menu ( menu , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , icon_value = 0 ) ¶ menu Parameters : menu ( string , ( never None ) ) – Identifier of the menu text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item icon_value ( int in [ 0 , inf ] , ( optional ) ) – Icon Value, Override automatic icon of the item menu_contents ( menu ) ¶ menu_contents Parameters : menu ( string , ( never None ) ) – Identifier of the menu popover ( panel , * , text = '' , text_ctxt = '' , translate = True , icon = 'NONE' , icon_value = 0 ) ¶ popover Parameters : panel ( string , ( never None ) ) – Identifier of the panel text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled icon (enum in Icon Items , (optional)) – Icon, Override automatic icon of the item icon_value ( int in [ 0 , inf ] , ( optional ) ) – Icon Value, Override automatic icon of the item popover_group ( space_type , region_type , context , category ) ¶ popover_group Parameters : space_type (enum in Space Type Items ) – Space Type region_type (enum in Region Type Items ) – Region Type context ( string , ( never None ) ) – panel type context category ( string , ( never None ) ) – panel type category separator ( * , factor = 1.0 , type = 'AUTO' ) ¶ Item. Inserts empty space into the layout between items. Parameters : factor ( float in [ 0 , inf ] , ( optional ) ) – Percentage, Percentage of width to space (leave unset for default space) type (enum in [ 'AUTO' , 'SPACE' , 'LINE' ], (optional)) – Type, The type of the separator AUTO Auto – Best guess at what type of separator is needed.. SPACE Empty space – Horizontal or Vertical empty space, depending on layout direction.. LINE Line – Horizontal or Vertical line, depending on layout direction.. separator_spacer ( ) ¶ Item. Inserts horizontal spacing empty space into the layout between items. progress ( * , text = '' , text_ctxt = '' , translate = True , factor = 0.0 , type = 'BAR' ) ¶ Progress indicator Parameters : text ( string , ( optional ) ) – Override automatic text of the item text_ctxt ( string , ( optional ) ) – Override automatic translation context of the given text translate ( boolean , ( optional ) ) – Translate the given text, when UI translation is enabled factor ( float in [ 0 , 1 ] , ( optional ) ) – Factor, Amount of progress from 0.0f to 1.0f type (enum in [ 'BAR' , 'RING' ], (optional)) – Type, The type of progress indicator context_pointer_set ( name , data ) ¶ context_pointer_set Parameters : name ( string , ( never None ) ) – Name, Name of entry in the context data ( AnyType ) – Pointer to put in context context_string_set ( name , value ) ¶ context_string_set Parameters : name ( string , ( never None ) ) – Name, Name of entry in the context value ( string , ( never None ) ) – Value, String to put in context template_header ( ) ¶ Inserts common Space header UI (editor type selector) template_ID ( data , property , * , new = '' , open = '' , unlink = '' , filter = 'ALL' , live_icon = False , text = '' , text_ctxt = '' , translate = True ) ¶ template_ID Parameters : data ( AnyType , (never None)) – Data from which to take property property ( string , ( never None ) ) – Identifier of property in data new ( string , ( optional , never None ) ) – Operator identifier to create a new ID block open ( string , ( opti