Reference 〉 Function

Params.group( str name, list[str] params, bool opened = True )

For models with a large number of global parameters, this method allows them to be grouped into a collapsible section in the control panel and optionally hidden by default.

This method is purely for display convenience, and does not otherwise affect the behavior of the grouped parameters.

Parameters

  • name str, required

    The title to be displayed for the parameter group.

  • params list[str], required

    A list or tuple of parameter names. Note that checkgrid parameters, per-breed parameters, and per-good parameters cannot be members of a group.

  • opened bool, optional

    Whether the group should display open or collapsed by default.

    Default value: True

Return Value ParamGroup

The ParamGroup object containing the parameters.

Notes and Examples

  1. Contribute a Note

    Your email address will not be published.

    You may use limited HTML for formatting. Please embed blocks of code in <pre><code> </code></pre> tags.

History