param.Parameter.label

property Parameter.label: str

Get the label for this parameter.

The label property returns a human-readable text label associated with the parameter.

Returns:

The label for the parameter, either automatically generated from the name or the custom label if explicitly set.

Return type:

str

Examples

>>> import param
>>> class MyClass(param.Parameterized):
...     param_1 = param.Parameter()
...     param_2 = param.Parameter(label="My Label")
>>> instance = MyClass()

Access the automatically generated label:

>>> instance.param.param_1.label
'Param 1'  # Based on `label_formatter` applied to the name

Access the manually specified label:

>>> instance.param.param_2.label
'My Label'