Parameters#
An attribute descriptor for declaring parameters. |
|
A String Parameter, with a default value and optional regular expression (regex) matching. |
|
A Bytes Parameter, with a default value and optional regular expression (regex) matching. |
|
Color parameter defined as a hex RGB string with an optional # prefix or (optionally) as a CSS3 color name. |
|
Binary or tristate Boolean Parameter. |
|
An Event Parameter is one whose value is intimately linked to the triggering of events for watchers to consume. |
|
Parameter whose value can be generated dynamically by a callable object. |
|
A numeric Dynamic Parameter, with a default value and optional bounds. |
|
Numeric Parameter required to be an Integer |
|
Numeric Parameter required to be in the range [0.0-1.0]. |
|
A tuple Parameter (e.g. ('a',7.6,[3,5])) with a fixed tuple length. |
|
A numeric tuple Parameter (e.g. (4.5,7.6,3)) with a fixed tuple length. |
|
A NumericTuple for an X,Y coordinate. |
|
A numeric range with optional bounds and softbounds. |
|
Date parameter of datetime or date type. |
|
A datetime or date range specified as (start, end). |
|
Parameter specifically allowing dates (not datetimes). |
|
A date range specified as (start_date, end_date). |
|
Parameter whose value is a list of objects, usually of a specified type. |
|
Parameter whose value is a list of callable objects. |
|
Parameter that can be set to a string specifying the path of a file or folder. |
|
Parameter that can be set to a string specifying the path of a file. |
|
Parameter that can be set to a string specifying the path of a folder. |
|
Parameter whose value must be one object from a list of possible objects. |
|
Given a path glob, allows one file to be selected from those matching. |
|
Variant of Selector where the value can be multiple objects from a list of possible objects. |
|
Given a path glob, allows multiple files to be selected from the list of matches. |
|
Parameter allowing selection of either a subclass or an instance of a class or tuple of classes. |
|
Parameter whose value is a dictionary. |
|
Parameter whose value is a numpy array. |
|
Parameter whose value is a pandas Series. |
|
Parameter whose value is a pandas DataFrame. |
|
Parameter holding a value that is a callable object, such as a function. |
|
A user-provided function that can be invoked like a class or object method using (). |
|
A Parameter that is a composite of a set of other attributes of the class. |