hou.LabelParmTemplate class

Methods

Inherited from hou.ParmTemplate: asCode, clone, dataType, disableWhen, help, hide, hideLabel, isHidden, isLabelHidden, joinWithNext, joinsWithNext, label, look, name, namingScheme, numComponents, scriptCallback, scriptCallbackLanguage, setDisableWhen, setHelp, setJoinWithNext, setLabel, setLook, setName, setNamingScheme, setNumComponents, setScriptCallback, setScriptCallbackLanguage, setTags, tags, type

__init__(self, name, label, column_labels=(), is_hidden=False, is_label_hidden=False, join_with_next=False, help=None, tags={})

Create a new LabelParmTemplate instance.

name	See hou.ParmTemplate.name for more information.
label	See hou.ParmTemplate.label for more information.
column_labels	See the setColumnLabels method for more information.
is_hidden	See hou.ParmTemplate.isHidden for more information.
is_label_hidden	See hou.ParmTemplate.isLabelHidden for more information.
join_with_next	See hou.ParmTemplate.joinsWithNext for more information.
help	See hou.ParmTemplate.help for more information.
tags	See hou.ParmTemplate.tags for more information.

Note that the number of components in a label parm template corresponds to the number of column labels.

columnLabels() → tuple of str

Return the tuple of strings of column labels. Normally, label parm templates do not have any column labels. However, they may have these extra labels that are displayed in addition to the main label.

Note that the number of components in a label parm template corresponds to the number of column labels.

setColumnLabels(column_labels)

Set the column labels to a sequence of strings.

The parameter editor in the Type Properties Dialog always has at least one column label, so if you supply an empty sequence there will be one column label that is an empty string.

See the columnLabels method for more information.