Parameter Items#

An individual parameter item has several pieces of information, as described in the source code documentation, see ParameterItemBase. There are different types, depending on the type of parameter to be edited. Here is an example of a dictionary of Parameter Items.

Example dictionary of Parameter Items

import pyQParamWidget as qpw
parms = {
    "title": qpw.ParameterItemText("title", "Suggested title"),
    "color": qpw.ParameterItemChoice(
        "color",
        "",
        choices=["", "red", "green", "blue"],
        tooltip="Pick a color.",
    ),
    "autoscale": qpw.ParameterItemCheckbox(
        "autoscale",
        True,
        tooltip="Otherwise, not autoscale.",
    ),
}

The Parameter Item types are listed next:

ParameterItemCheckbox#

ParameterItemCheckbox uses a QCheckBox widget to edit a boolean parameter.

ParameterItemCheckbox(
    "autoscale", True, tooltip="Otherwise, not autoscale."
    )

Example widget to edit a ParameterItemCheckbox.

../_images/ParameterItemCheckbox.png — Example widget to edit a `ParameterItemCheckbox`.#

ParameterItemChoice#

ParameterItemChoice uses a QComboBox widget to select a value from a list of choices.

ParameterItemChoice(
    "color", "",
    choices=["", "red", "green", "blue"],
    tooltip="Pick a color.",
    )

Example widget to edit a ParameterItemChoice.

../_images/ParameterItemChoice.png — Example widget to edit a `ParameterItemChoice`. Drop-down menu is selected to show the list of choices.#

ParameterItemSpinBox#

ParameterItemSpinBox uses a QSpinBox widget to select a value within limits of lo and hi.

ParameterItemSpinBox(
    "x", 50,
    hi=100,
    lo=0,
    tooltip="Choose a value from the range.",
    )

Example widget to edit a ParameterItemSpinBox.

../_images/ParameterItemSpinBox.png — Example widget to edit a `ParameterItemSpinBox`.#

ParameterItemText#

ParameterItemText uses a QLineEdit widget to edit a value as text.

ParameterItemText("title", "Suggested title", tooltip="Set the title. Be brief.")

Example widget to edit a ParameterItemText.

../_images/ParameterItemText.png — Example widget to edit a `ParameterItemText`. The tooltip is also shown.#