Constructor
new DatumFilter(propsopt)
Constructor.
Name | Type | Attributes | Description |
---|---|---|---|
props | object | <optional> | initial property values |
- Source
Extends
Members
accumulatingPropertyName :string
An accumulating property name.
This manages the first available value from the accumulatingPropertyNames
property.
- string
- Source
accumulatingPropertyNames :Array.<string>
An array of accumulating property names.
- Array.<string>
- Source
aggregation :module:domain~Aggregation
An aggregation.
Including this in a filter will cause SolarNet to return aggregated results, rather than raw results.
- Source
combiningType :module:domain~CombiningType
Get the combining type.
Use this to combine nodes and/or sources into virtual groups. Requires some combination of #nodeIdMaps or #sourceIdMaps also be specified.
- Source
dataPath :string
A data path, in dot-delimited notation like i.watts
.
- string
- Source
endDate :Date
A maximum date.
- Date
- Source
instantaneousPropertyName :string
An instantaneous property name.
This manages the first available value from the instantaneousPropertyNames
property.
- string
- Source
instantaneousPropertyNames :Array.<string>
An array of instantaneous property names.
- Array.<string>
- Source
localEndDate :Date
A local maximum date.
- Date
- Source
localStartDate :Date
Alocal minimumin date.
- Date
- Source
location :module:domain~Location
A location, used as an example-based search criteria.
- Source
locationId :number
A location ID.
This manages the first available location ID from the locationIds
property.
- number
- Source
locationIds :Array.<number>
An array of location IDs.
- Array.<number>
- Source
metadataFilter :string
A metadata filter (LDAP style search criteria).
- string
- Source
mostRecent :boolean
The "most recent" flag.
- boolean
- Source
nodeId :number
A node ID.
This manages the first available node ID from the nodeIds
property.
- number
- Source
nodeIdMaps :Map.<Number, Set.<Number>>
A mapping of virtual node IDs to sets of real node IDs to combine.
- Map.<Number, Set.<Number>>
- Source
nodeIds :Array.<number>
An array of node IDs.
- Array.<number>
- Source
partialAggregation :module:domain~Aggregation
A partial aggregation.
Including this in a filter along with aggregation
will cause SolarNet to return aggregated results that include partial results of this granularity. For example if aggregation == 'Month'
and partialAggregation == 'Day'
and a date range of 15 Jan - 15 Mar was requested, 3 month results would be returned for the date ranges 15 Jan - 31 Jan, 1 Feb - 28 Feb, and 1 Mar - 14 Mar.
- Source
propertyName :string
A property name.
This manages the first available value from the propertyNames
property.
- string
- Source
propertyNames :Array.<string>
An array of property names.
- Array.<string>
- Source
props :object
The object that all properties are stored on.
- object
- Overrides
- Source
query :string
A general full-text style query string.
- string
- Source
sourceId :string
A source ID.
This manages the first available source ID from the sourceIds
property.
- string
- Source
sourceIdMaps :Map.<String, Set.<String>>
A mapping of virtual source IDs to sets of real source IDs to combine.
- Map.<String, Set.<String>>
- Source
sourceIds :Array.<string>
An array of source IDs.
- Array.<string>
- Source
startDate :Date
A minimumin date.
- Date
- Source
statusPropertyName :string
A property name.
This manages the first available value from the statusPropertyNames
property.
- string
- Source
statusPropertyNames :Array.<string>
An array of property names.
- Array.<string>
- Source
streamId :string
A stream ID.
This manages the first available stream ID from the streamIds
property.
- string
- Source
streamIds :Array.<string>
An array of stream IDs.
- Array.<string>
- Source
tags :Array.<string>
An array of tags.
- Array.<string>
- Source
userId :number
A user ID.
This manages the first available location ID from the userIds
property.
- number
- Source
userIds :Array.<number>
An array of user IDs.
- Array.<number>
- Source
withoutTotalResultsCount :boolean
Get the without total results flag.
- boolean
- Source
Methods
prop(key, newValueopt) → {*}
Get, set, or remove a property value.
Name | Type | Attributes | Description |
---|---|---|---|
key | string | the key to get or set the value for | |
newValue | * | <optional> | if defined, the new value to set for the given |
- Overrides
- Source
if called as a getter, the associated value for the given key
, otherwise this object
- Type:
- *
properties(newPropsopt) → {object}
Get, set, or remove multiple properties.
Name | Type | Attributes | Description |
---|---|---|---|
newProps | object | <optional> | the new values to set; if any value is |
- Overrides
- Source
if called as a getter, all properties of this object copied into a simple object; otherwise this object
- Type:
- object
toUriEncoding(propertyNameopt, callbackFnopt) → {string}
Get this object as a standard URI encoded (query parameters) string value.
All enumerable properties of the props
property will be added to the result. If any property value is an array, the values of the array will be joined by a comma. Any module:util~Enum values will have their name
property used. Any value that has a toUriEncoding()
function property will have that function invoked, passing the associated property name as the first argument, and the returned value will be used.
Name | Type | Attributes | Description |
---|---|---|---|
propertyName | string | <optional> | an optional object property prefix to add to all properties |
callbackFn | function | <optional> | An optional function that will be called for each property. The function will be passed property name and value arguments, and must return either |
- Overrides
- Source
the URI encoded string
- Type:
- string
toUriEncodingWithSorting(sortsopt, paginationopt, propertyNameopt, callbackFnopt) → {string}
Get this object as a standard URI encoded (query parameters) string value with sorting and pagination parameters.
This calls module:util~PropMap#toUriEncoding first, then encodes the `sorts` and `pagination` parameters, if provided.
Name | Type | Attributes | Description |
---|---|---|---|
sorts | Array.<module:domain~SortDescriptor> | <optional> | optional sort settings to use |
pagination | module:domain~Pagination | <optional> | optional pagination settings to use |
propertyName | string | <optional> | an optional object property prefix to add to all properties |
callbackFn | function | <optional> | An optional function that will be called for each property. The function will be passed property name and value arguments, and must return either |
- Source
the URI encoded string
- Type:
- string