Skip to main content

NumberRangeParameter

The class for defining and interacting with number range parameters.

Static / Class Methods​

In addition to the static methods specified on this page, see the Parameter page for details on the Create and CreateFromSource factory methods.

For NumberRangeParameter in particular:

CreateSimple​

Creates the configurations for a number range parameter by providing a list of NumberRangeParameterOption instances, and adds it to an abstract pool of parameter configurations.

Unlike the Create factory method, this factory method assumes only one parameter option is needed with no arguments for "user_attribute" and "parent_name".

Required Arguments:

  • name: A string for the name of the parameter
  • label: A string for human-friendly display name for this parameter
  • min_value: A string, int, or Decimal (from decimal package). This is the minimum selectable value for both the lower and upper selected values of the number range parameter
  • max_value: A string, int, or Decimal (from decimal package). This is the maximum selectable value for both the lower and upper selected values of the number range parameter
    • Must be greater than "min_value"

Optional Keyword Arguments:

  • increment: A string, int, or Decimal (from decimal package). This is the increment of selectable values. Default is 1
    • Must fit evenly between "min_value" and "max_value"
  • default_lower_value: A string, int, Decimal (from decimal package), or None. This is the default selected lower value. When None, the "min_value" is used. Default is None
    • Must be selectable based on "min_value", "max_value", and "increment"
  • default_upper_value: A string, int, Decimal (from decimal package), or None. This is the default selected upper value. When None, the "max_value" is used. Default is None
    • Must be selectable based on "min_value", "max_value", and "increment"
    • Must be greater than "default_lower_value"
  • is_hidden: A boolean for whether the parameter is hidden in the response of the Parameters API. Default is False

Returns: None

Non-Static Methods​

In the context.py file or data model, the methods below can be invoked on a NumberRangeParameter object to retrieve details for the selected parameter option at runtime. For example, the following code demonstrates getting the NumberRangeParameter object in context.py, and calling the "get_selected_lower_value" method on it.

if "my_nr_param" in prms:
    my_nr_param: sr.NumberRangeParameter = prms["my_nr_param"]
    my_num: str = my_nr_param.get_selected_lower_value()
    ...

get_selected_lower_value​

Get the selected lower value number. This method takes no arguments.

Returns: A string that's parsable into a decimal number.

get_selected_upper_value​

Get the selected upper value number. This method takes no arguments.

Returns: A string that's parsable into a decimal number.