outlinerPanel

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

outlinerPanel( [panelName] , [control=boolean], [copy=string], [defineTemplate=string], [docTag=string], [exists=boolean], [init=boolean], [isUnique=boolean], [label=string], [menuBarVisible=boolean], [needsInit=boolean], [outlinerEditor=boolean], [parent=string], [popupMenuProcedure=script], [replacePanel=string], [tearOff=boolean], [tearOffCopy=string], [unParent=boolean], [useTemplate=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

outlinerPanel is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
exists(ex)	boolean
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
defineTemplate(dt)	string
Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
useTemplate(ut)	string
Force the command to use a command template other than the current one.
init(init)	boolean
Initializes the panel's default state. This is usually done automatically on file -new and file -open.
label(l)	string
Specifies the user readable label for the panel.
copy(cp)	string
Makes this panel a copy of the specified panel. Both panels must be of the same type.
control(ctl)	boolean
Returns the top level control for this panel. Usually used for getting a parent to attach popup menus. CAUTION: panels may not have controls at times. This flag can return "" if no control is present.
isUnique(iu)	boolean
Returns true if only one instance of this panel type is allowed.
parent(p)	string
Specifies the parent layout for this panel.
popupMenuProcedure(pmp)	script
Specifies the procedure called for building the panel's popup menu(s). The default value is "buildPanelPopupMenu". The procedure should take one string argument which is the panel's name.
unParent(up)	boolean
Specifies that the panel should be removed from its layout. This (obviously) cannot be used with query.
replacePanel(rp)	string
Will replace the specifed panel with this panel. If the target panel is within the same layout it will perform a swap.
tearOff(to)	boolean
Will tear off this panel into a separate window with a paneLayout as the parent of the panel. When queried this flag will return if the panel has been torn off into its own window.
tearOffCopy(toc)	string
Will create this panel as a torn of copy of the specified source panel.
menuBarVisible(mbv)	boolean
Controls whether the menu bar for the panel is displayed.
needsInit(ni)	boolean
(Internal) On Edit will mark the panel as requiring initialization. Query will return whether the panel is marked for initialization. Used during file -new and file -open.
docTag(dtg)	string
Attaches a tag to the maya panel.
outlinerEditor(oe)	boolean
This flag returns the name of the outliner editor contained by the panel.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Create a new regular outliner in its own window
#
cmds.window()
cmds.frameLayout( labelVisible=False )
panel = cmds.outlinerPanel()
outliner = cmds.outlinerPanel(panel, query=True,outlinerEditor=True)
cmds.outlinerEditor( outliner, edit=True, mainListConnection='worldList', selectionConnection='modelList', showShapes=False, showAttributes=False, showConnected=False, showAnimCurvesOnly=False, autoExpand=False, showDagOnly=True, ignoreDagHierarchy=False, expandConnections=False, showCompounds=True, showNumericAttrsOnly=False, highlightActive=True, autoSelectNewObjects=False, doNotSelectNewObjects=False, transmitFilters=False, showSetMembers=True, setFilter='defaultSetFilter' )
cmds.showWindow()