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

Synopsis

appHome([iconVisible=boolean], [instrument=string], [setTab=string], [toggleVisibility=boolean], [updateRecentFiles=boolean], [visible=boolean])

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

appHome is NOT undoable, queryable, and editable.

Used for displaying and hiding application home.

Return value

None

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

Flags

iconVisible, instrument, setTab, toggleVisibility, updateRecentFiles, visible
Long name (short name) Argument types Properties
iconVisible(iv) boolean createqueryedit
Query or set application home icon visibility preference.

Note: Icon visibility cannot be modified if the MAYA_NO_HOME_ICON environment variable is defined.

instrument(i) string create
Instrument the app home command with the given string.
setTab(t) string createedit
Navigate app home to the specified tab. Available tabs are: Recent GettingStarted Learning WhatsNew Community
toggleVisibility(tv) boolean createedit
Toggle application home widget visibility.
updateRecentFiles(urf) boolean createedit
Update the recent file list data.
visible(v) boolean createqueryedit
Query or set application home widget visibility.
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

# Hide app home
cmds.appHome(edit=True, visibility=False)

# Show app home
cmds.appHome(edit=True, visibility=True)

# Show app home on GettingStarted tab
cmds.appHome(visibility=True, setTab='GettingStarted')

# Update app home recent file data
cmds.appHome(updateRecentFiles=True)

# Query app home visilibity
visible = cmds.appHome(query=True, visibility=True)

# Toggle app home visibility
cmds.appHome(edit=True, toggleVisibility=True)