new module:models/Range2Filter(fromField, toField)
Constructs a new Range2Filter.
Document representing a range compare with range filter, named Range2Filter.
Parameters:
| Name | Type | Description |
|---|---|---|
fromField |
String | The field name of the field that starts the first range. |
toField |
String | The field name of the field that ends the first range. |
- Source:
Members
(readonly) FilterModeEnum :String
Allowed values for the filter_mode property.
Type:
- String
- Source:
(inner, constant) contained
value: "contained"
- Source:
(inner, constant) containing
value: "containing"
- Source:
(inner) filter_mode :module:models/Range2Filter.FilterModeEnum
Compare mode: overlap, containing, or contained. If not specified, the default is overlap.
Type:
- module:models/Range2Filter.FilterModeEnum
- Source:
(inner) from_field :String
The field name of the field that starts the first range.
Type:
- String
- Source:
(inner) from_inclusive :Boolean
Indicates whether the lower bound of the second range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive.
Type:
- Boolean
- Source:
(inner) from_value :Object
The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.
Type:
- Object
- Source:
(inner, constant) overlap
value: "overlap"
- Source:
(inner) to_field :String
The field name of the field that ends the first range.
Type:
- String
- Source:
(inner) to_inclusive :Boolean
Indicates whether the upper bound of the second range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive.
Type:
- Boolean
- Source:
(inner) to_value :Object
The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.
Type:
- Object
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/Range2Filter}
Constructs a Range2Filter from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/Range2Filter | Optional instance to populate. |
- Source:
Returns:
The populated Range2Filter instance.