new module:models/RangeFilter(field)
Constructs a new RangeFilter.
Document representing a range filter.
Parameters:
| Name | Type | Description |
|---|---|---|
field |
String | The search field. |
- Source:
Members
(inner) field :String
The search field.
Type:
- String
- Source:
(inner) from :Object
The lower bound of the filter 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) from_inclusive :Boolean
Indicates whether the lower bound of the range is inclusive. If not specified, the default is true. Set to false to make the lower bound exclusive.
Type:
- Boolean
- Source:
(inner) to :Object
The upper bound of the filter 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:
(inner) to_inclusive :Boolean
Indicates whether the upper bound of the range is inclusive. If not specified, the default is true. Set to false to made the upper bound exclusive.
Type:
- Boolean
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/RangeFilter}
Constructs a RangeFilter 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/RangeFilter | Optional instance to populate. |
- Source:
Returns:
The populated RangeFilter instance.