param.Magnitude#

class param.Magnitude(default=1.0, *, bounds=(0.0, 1.0), softbounds=None, inclusive_bounds=(True, True), step=None, set_hook=None, doc=None, label=None, precedence=None, instantiate=False, constant=False, readonly=False, pickle_default_value=True, allow_None=False, per_instance=True, allow_refs=False, nested_refs=False)[source]#

Numeric Parameter required to be in the range [0.0-1.0].

__init__(default=1.0, *, bounds=(0.0, 1.0), softbounds=None, inclusive_bounds=(True, True), step=None, set_hook=None, allow_None=False, doc=None, label=None, precedence=None, instantiate=False, constant=False, readonly=False, pickle_default_value=True, per_instance=True, allow_refs=False, nested_refs=False)[source]#

Initialize this parameter object and store the bounds.

Non-dynamic default values are checked against the bounds.

Methods

`__init__`([default, bounds, softbounds, ...])	Initialize this parameter object and store the bounds.
`crop_to_bounds`(val)	Return the given value cropped to be within the hard bounds for this parameter.
`deserialize`(value)	Given a serializable Python value, return a value that the parameter can be set to
`get_soft_bounds`()
`schema`([safe, subset, mode])
`serialize`(value)	Given the parameter value, return a Python value suitable for serialization
`set_in_bounds`(obj, val)	Set to the given value, but cropped to be within the legal bounds.

Attributes

`allow_None`
`allow_refs`
`bounds`
`constant`
`default`
`doc`
`inclusive_bounds`
`instantiate`
`label`
`name`
`nested_refs`
`owner`
`per_instance`
`pickle_default_value`
`precedence`
`readonly`
`rx`
`set_hook`
`softbounds`
`step`
`time_dependent`
`time_fn`
`watchers`