Outliner Operators

bpy.ops.outliner.action_set(action='')

Change the active action used

Parameters

action (enum in [], (optional)) – Action

bpy.ops.outliner.animdata_operation(type='CLEAR_ANIMDATA')

Undocumented, consider contributing.

Parameters

type (enum in ['CLEAR_ANIMDATA', 'SET_ACT', 'CLEAR_ACT', 'REFRESH_DRIVERS', 'CLEAR_DRIVERS'], (optional)) –

Animation Operation

  • CLEAR_ANIMDATA Clear Animation Data, Remove this animation data container.

  • SET_ACT Set Action.

  • CLEAR_ACT Unlink Action.

  • REFRESH_DRIVERS Refresh Drivers.

  • CLEAR_DRIVERS Clear Drivers.

bpy.ops.outliner.collection_color_tag_set(color='NONE')

Set a color tag for the selected collections

Parameters

color (enum in ['NONE', 'COLOR_01', 'COLOR_02', 'COLOR_03', 'COLOR_04', 'COLOR_05', 'COLOR_06', 'COLOR_07', 'COLOR_08'], (optional)) –

Color Tag

  • NONE None, Assign no color tag to the collection.

  • COLOR_01 Color 01.

  • COLOR_02 Color 02.

  • COLOR_03 Color 03.

  • COLOR_04 Color 04.

  • COLOR_05 Color 05.

  • COLOR_06 Color 06.

  • COLOR_07 Color 07.

  • COLOR_08 Color 08.

bpy.ops.outliner.collection_disable()

Disable viewport drawing in the view layers

bpy.ops.outliner.collection_disable_render()

Do not render this collection

bpy.ops.outliner.collection_drop()

Drag to move to collection in Outliner

bpy.ops.outliner.collection_duplicate()

Recursively duplicate the collection, all its children, objects and object data

bpy.ops.outliner.collection_duplicate_linked()

Recursively duplicate the collection, all its children and objects, with linked object data

bpy.ops.outliner.collection_enable()

Enable viewport drawing in the view layers

bpy.ops.outliner.collection_enable_render()

Render the collection

bpy.ops.outliner.collection_exclude_clear()

Include collection in the active view layer

bpy.ops.outliner.collection_exclude_set()

Exclude collection from the active view layer

bpy.ops.outliner.collection_hide()

Hide the collection in this view layer

bpy.ops.outliner.collection_hide_inside()

Hide all the objects and collections inside the collection

bpy.ops.outliner.collection_hierarchy_delete()

Delete selected collection hierarchies

bpy.ops.outliner.collection_holdout_clear()

Clear masking of collection in the active view layer

bpy.ops.outliner.collection_holdout_set()

Mask collection in the active view layer

bpy.ops.outliner.collection_indirect_only_clear()

Clear collection contributing only indirectly in the view layer

bpy.ops.outliner.collection_indirect_only_set()

Set collection to only contribute indirectly (through shadows and reflections) in the view layer

bpy.ops.outliner.collection_instance()

Instance selected collections to active scene

bpy.ops.outliner.collection_isolate(extend=False)

Hide all but this collection and its parents

Parameters

extend (boolean, (optional)) – Extend, Extend current visible collections

Link selected collections to active scene

bpy.ops.outliner.collection_new(nested=True)

Add a new collection inside selected collection

Parameters

nested (boolean, (optional)) – Nested, Add as child of selected collection

bpy.ops.outliner.collection_objects_deselect()

Deselect objects in collection

bpy.ops.outliner.collection_objects_select()

Select objects in collection

bpy.ops.outliner.collection_show()

Show the collection in this view layer

bpy.ops.outliner.collection_show_inside()

Show all the objects and collections inside the collection

bpy.ops.outliner.constraint_operation(type='ENABLE')

Undocumented, consider contributing.

Parameters

type (enum in ['ENABLE', 'DISABLE', 'DELETE'], (optional)) – Constraint Operation

bpy.ops.outliner.data_operation(type='SELECT')

Undocumented, consider contributing.

Parameters

type (enum in ['SELECT', 'DESELECT', 'HIDE', 'UNHIDE', 'SELECT_LINKED'], (optional)) – Data Operation

bpy.ops.outliner.datastack_drop()

Copy or reorder modifiers, constraints, and effects

bpy.ops.outliner.delete(hierarchy=False)

Delete selected objects and collections

Parameters

hierarchy (boolean, (optional)) – Hierarchy, Delete child objects and collections

bpy.ops.outliner.drivers_add_selected()

Add drivers to selected items

bpy.ops.outliner.drivers_delete_selected()

Delete drivers assigned to selected items

bpy.ops.outliner.expanded_toggle()

Expand/Collapse all items

bpy.ops.outliner.hide()

Hide selected objects and collections

bpy.ops.outliner.highlight_update()

Update the item highlight based on the current mouse position

bpy.ops.outliner.id_copy()

Selected data-blocks are copied to the clipboard

bpy.ops.outliner.id_delete()

Delete the ID under cursor

bpy.ops.outliner.id_operation(type='UNLINK')

Undocumented, consider contributing.

Parameters

type (enum in ['UNLINK', 'MARK_ASSET', 'CLEAR_ASSET', 'LOCAL', 'SINGLE', 'DELETE', 'REMAP', 'OVERRIDE_LIBRARY_CREATE', 'OVERRIDE_LIBRARY_CREATE_HIERARCHY', 'OVERRIDE_LIBRARY_PROXY_CONVERT', 'OVERRIDE_LIBRARY_RESET', 'OVERRIDE_LIBRARY_RESET_HIERARCHY', 'OVERRIDE_LIBRARY_RESYNC_HIERARCHY', 'OVERRIDE_LIBRARY_DELETE_HIERARCHY', 'COPY', 'PASTE', 'ADD_FAKE', 'CLEAR_FAKE', 'RENAME', 'SELECT_LINKED'], (optional)) –

ID Data Operation

  • UNLINK Unlink.

  • MARK_ASSET Mark Asset.

  • CLEAR_ASSET Clear Asset.

  • LOCAL Make Local.

  • SINGLE Make Single User.

  • DELETE Delete.

  • REMAP Remap Users, Make all users of selected data-blocks to use instead current (clicked) one.

  • OVERRIDE_LIBRARY_CREATE Add Library Override, Add a local override of this linked data-block.

  • OVERRIDE_LIBRARY_CREATE_HIERARCHY Add Library Override Hierarchy, Add a local override of this linked data-block, and its hierarchy of dependencies.

  • OVERRIDE_LIBRARY_PROXY_CONVERT Convert Proxy to Override, Convert a Proxy object to a full library override, including all its dependencies.

  • OVERRIDE_LIBRARY_RESET Reset Library Override, Reset this local override to its linked values.

  • OVERRIDE_LIBRARY_RESET_HIERARCHY Reset Library Override Hierarchy, Reset this local override to its linked values, as well as its hierarchy of dependencies.

  • OVERRIDE_LIBRARY_RESYNC_HIERARCHY Resync Library Override Hierarchy, Rebuild this local override from its linked reference, as well as its hierarchy of dependencies.

  • OVERRIDE_LIBRARY_DELETE_HIERARCHY Delete Library Override Hierarchy, Delete this local override (including its hierarchy of override dependencies) and relink its usages to the linked data-blocks.

  • COPY Copy.

  • PASTE Paste.

  • ADD_FAKE Add Fake User, Ensure data-block gets saved even if it isn’t in use (e.g. for motion and material libraries).

  • CLEAR_FAKE Clear Fake User.

  • RENAME Rename.

  • SELECT_LINKED Select Linked.

bpy.ops.outliner.id_paste()

Data-blocks from the clipboard are pasted

bpy.ops.outliner.id_remap(id_type='OBJECT', old_id='', new_id='')

Undocumented, consider contributing.

Parameters

  • id_type (enum in ['ACTION', 'ARMATURE', 'BRUSH', 'CAMERA', 'CACHEFILE', 'CURVE', 'FONT', 'GREASEPENCIL', 'COLLECTION', 'IMAGE', 'KEY', 'LIGHT', 'LIBRARY', 'LINESTYLE', 'LATTICE', 'MASK', 'MATERIAL', 'META', 'MESH', 'MOVIECLIP', 'NODETREE', 'OBJECT', 'PAINTCURVE', 'PALETTE', 'PARTICLE', 'LIGHT_PROBE', 'SCENE', 'SIMULATION', 'SOUND', 'SPEAKER', 'TEXT', 'TEXTURE', 'HAIR', 'POINTCLOUD', 'VOLUME', 'WINDOWMANAGER', 'WORLD', 'WORKSPACE'], (optional)) – ID Type

  • old_id (enum in [], (optional)) – Old ID, Old ID to replace

  • new_id (enum in [], (optional)) – New ID, New ID to remap all selected IDs’ users to

bpy.ops.outliner.item_activate(extend=True, extend_range=False, deselect_all=False)

Handle mouse clicks to select and activate items

Parameters

  • extend (boolean, (optional)) – Extend, Extend selection for activation

  • extend_range (boolean, (optional)) – Extend Range, Select a range from active element

  • deselect_all (boolean, (optional)) – Deselect On Nothing, Deselect all when nothing under the cursor

bpy.ops.outliner.item_drag_drop()

Drag and drop element to another place

bpy.ops.outliner.item_openclose(all=False)

Toggle whether item under cursor is enabled or closed

Parameters

all (boolean, (optional)) – All, Close or open all items

bpy.ops.outliner.item_rename(use_active=False)

Rename the active element

Parameters

use_active (boolean, (optional)) – Use Active, Rename the active item, rather than the one the mouse is over

bpy.ops.outliner.keyingset_add_selected()

Add selected items (blue-gray rows) to active Keying Set

bpy.ops.outliner.keyingset_remove_selected()

Remove selected items (blue-gray rows) from active Keying Set

bpy.ops.outliner.lib_operation(type='RENAME')

Undocumented, consider contributing.

Parameters

type (enum in ['RENAME', 'DELETE', 'RELOCATE', 'RELOAD'], (optional)) –

Library Operation

  • RENAME Rename.

  • DELETE Delete, Delete this library and all its item from Blender - WARNING: no undo.

  • RELOCATE Relocate, Select a new path for this library, and reload all its data.

  • RELOAD Reload, Reload all data from this library.

bpy.ops.outliner.lib_relocate()

Relocate the library under cursor

bpy.ops.outliner.material_drop()

Drag material to object in Outliner

bpy.ops.outliner.modifier_operation(type='TOGVIS')

Undocumented, consider contributing.

Parameters

type (enum in ['TOGVIS', 'TOGREN', 'DELETE'], (optional)) – Modifier Operation

bpy.ops.outliner.object_operation(type='SELECT')

Undocumented, consider contributing.

Parameters

type (enum in ['SELECT', 'DESELECT', 'SELECT_HIERARCHY', 'REMAP', 'RENAME', 'OBJECT_MODE_ENTER', 'OBJECT_MODE_EXIT', 'OBJECT_PROXY_TO_OVERRIDE'], (optional)) –

Object Operation

  • SELECT Select.

  • DESELECT Deselect.

  • SELECT_HIERARCHY Select Hierarchy.

  • REMAP Remap Users, Make all users of selected data-blocks to use instead a new chosen one.

  • RENAME Rename.

  • OBJECT_MODE_ENTER Enter Mode.

  • OBJECT_MODE_EXIT Exit Mode.

  • OBJECT_PROXY_TO_OVERRIDE Convert Proxy to Override, Convert a Proxy object to a full library override, including all its dependencies.

bpy.ops.outliner.operation()

Context menu for item operations

bpy.ops.outliner.orphans_purge(num_deleted=0)

Clear all orphaned data-blocks without any users from the file

bpy.ops.outliner.parent_clear()

Drag to clear parent in Outliner

bpy.ops.outliner.parent_drop()

Drag to parent in Outliner

bpy.ops.outliner.scene_drop()

Drag object to scene in Outliner

bpy.ops.outliner.scene_operation(type='DELETE')

Context menu for scene operations

Parameters

type (enum in ['DELETE'], (optional)) – Scene Operation

bpy.ops.outliner.scroll_page(up=False)

Scroll page up or down

Parameters

up (boolean, (optional)) – Up, Scroll up one page

bpy.ops.outliner.select_all(action='TOGGLE')

Toggle the Outliner selection of items

Parameters

action (enum in ['TOGGLE', 'SELECT', 'DESELECT', 'INVERT'], (optional)) –

Action, Selection action to execute

  • TOGGLE Toggle, Toggle selection for all elements.

  • SELECT Select, Select all elements.

  • DESELECT Deselect, Deselect all elements.

  • INVERT Invert, Invert selection of all elements.

bpy.ops.outliner.select_box(tweak=False, xmin=0, xmax=0, ymin=0, ymax=0, wait_for_input=True, mode='SET')

Use box selection to select tree elements

Parameters

  • tweak (boolean, (optional)) – Tweak, Tweak gesture from empty space for box selection

  • xmin (int in [-inf, inf], (optional)) – X Min

  • xmax (int in [-inf, inf], (optional)) – X Max

  • ymin (int in [-inf, inf], (optional)) – Y Min

  • ymax (int in [-inf, inf], (optional)) – Y Max

  • wait_for_input (boolean, (optional)) – Wait for Input

  • mode (enum in ['SET', 'ADD', 'SUB'], (optional)) –

    Mode

    • SET Set, Set a new selection.

    • ADD Extend, Extend existing selection.

    • SUB Subtract, Subtract existing selection.

bpy.ops.outliner.select_walk(direction='UP', extend=False, toggle_all=False)

Use walk navigation to select tree elements

Parameters

  • direction (enum in ['UP', 'DOWN', 'LEFT', 'RIGHT'], (optional)) – Walk Direction, Select/Deselect element in this direction

  • extend (boolean, (optional)) – Extend, Extend selection on walk

  • toggle_all (boolean, (optional)) – Toggle All, Toggle open/close hierarchy

bpy.ops.outliner.show_active()

Open up the tree and adjust the view so that the active object is shown centered

bpy.ops.outliner.show_hierarchy()

Open all object entries and close all others

bpy.ops.outliner.show_one_level(open=True)

Expand/collapse all entries by one level

Parameters

open (boolean, (optional)) – Open, Expand all entries one level deep

bpy.ops.outliner.unhide_all()

Unhide all objects and collections