Interface ParameterDefinitions
Hierarchy
- ParameterDefinitions
Indexable
Each field of the object represents one parameter.
...
params: {
offset: {
type: "number",
def: 2.0,
restrictions: {
step: 0.25,
min: 0.0
}
}
}
...
Instantiated indicator's Calculator
has access to user-specified values via this.props
property using the same field names.
...
map(d) {
return d.value() - this.props.offset;
}
...
Each parameter specification is an object that declares the type of parameter in type
field, default value via def
field, and an optional restriction for its values (depending on parameter type).
Generated using TypeDoc
The implementation specifies a set of parameters that should be submitted by the user to the indicator.