panelConfiguration

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

Synopsis

panelConfiguration [-addPanel boolean string string string string] [-configString string] [-createStrings] [-defaultImage string] [-defineTemplate string] [-editStrings] [-exists] [-image string] [-isFixedState] [-label string] [-labelStrings] [-numberOfPanels] [-removeAllPanels] [-removeLastPanel] [-replaceCreateString int string] [-replaceEditString int string] [-replaceFixedState int boolean] [-replaceLabel int string] [-replacePanel int boolean string string string string] [-replaceTypeString int string] [-sceneConfig boolean] [-typeStrings] [-useTemplate string] [-userCreated boolean] [name]

panelConfiguration is undoable, queryable, and editable.

Once a panel configuration is created you can make it appear in the main Maya window by selecting it from any panel's "Panels->Saved Layouts" menu.

Return value

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

Flags

Long name (short name)	Argument types	Properties
-addPanel(-ap)	boolean string string string string
Adds the specified panel to the configuration. Arguments are: isFixed, label string, type string, create string, edit string.
-configString(-cfs)	string
Specifies the string that arranges the panels.
-createStrings(-cs)
Returns an string array of the panel creation strings.
-defaultImage(-di)	string
The default image for this configuration. Once the default image is set it may not be changed. If an image is set with the -i/image flag then it's value will take precedence.
-defineTemplate(-dt)	string
Puts the command in a mode where any other flags and arguments 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.
-editStrings(-es)
Returns an string array of the panel edit strings.
-exists(-ex)
Returns whether the specified object exists or not. Other flags are ignored.
-image(-i)	string
The user specified image for this configuration. Use this flag to override the default image.
-isFixedState(-if)
Returns an integer array of whether the panels have fixed states or not.
-label(-l)	string
Configuration label.
-labelStrings(-ls)
Returns an string array of the panel labels.
-numberOfPanels(-np)
Returns the number of panels in the configuration.
-removeAllPanels(-rap)
Removes the last panel in the config.
-removeLastPanel(-rlp)
Removes the last panel in the config.
-replaceCreateString(-rcs)	int string
Replaces the specified create string. The index is 1 based.
-replaceEditString(-res)	int string
Replaces the specified edit string. The index is 1 based.
-replaceFixedState(-rfs)	int boolean
Replaces the specified fixed state value (true|false). The index is 1 based.
-replaceLabel(-rl)	int string
Replaces the specified label. The index is 1 based.
-replacePanel(-rp)	int boolean string string string string
Replaces the specified panel in the configuration. Arguments are: index, isFixed, label string, type string, create string, edit string. The index is 1 based.
-replaceTypeString(-rts)	int string
Replaces the specified type string. The index is 1 based.
-sceneConfig(-sc)	boolean
Specifies whether the configuration is associated with the scene. Scene configurations are created when the scene is opened and deleted when the scene is closed.
-typeStrings(-ts)
Returns an string array of the panel types.
-useTemplate(-ut)	string
Forces the command to use a command template other than the current one.
-userCreated(-uc)	boolean
Returns true if the configuration was created by the user. If it is user created, the configuration will show up in the RMB menu in the toolbox's saved layouts.

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 be used more than once in a command.

MEL examples

//    Create a custom panel configuration.
//
string $configName = `panelConfiguration -label "Custom Panel Layout"
    -sceneConfig false
    -configString "paneLayout -e -cn \"vertical2\" -ps 1 39 100 -ps 2 61 100 $gMainPane;"
    -addPanel false
        "Outliner"
        "outlinerPanel"
        ("{global int $gUseMenusInPanels;\
            $panelName = `outlinerPanel -mbv $gUseMenusInPanels -unParent -l \"Outliner\"`;\
            outlinerEditor -e -highlightActive true $panelName;}")
        "outlinerPanel -edit -l \"Outliner\"  $panelName"
    -addPanel true
        "Persp View"
        "modelPanel"
        ("{global int $gUseMenusInPanels;\
            modelPanel -mbv $gUseMenusInPanels\
            -unParent -l \"Persp View\" -cam persp;}" )
        "modelPanel -edit -l \"Persp View\"  -cam \"persp\" $panelName"`;

//    Update the main Maya window to reflect the custom panel configuration.
//    Note also that your custom configuration may be selected from any
//    panel's "Panels->Saved Layouts" menu.
//
setNamedPanelLayout "Custom Panel Layout";