Constructor.
Optional props: object | PropMap | Map<string, any>initial property values
Readonly propsThe object that all properties are stored on.
An accumulating property name.
This manages the first available value from the accumulatingPropertyNames property.
Set to null to remove.
An array of accumulating property names. Set to null to remove.
An aggregation.
Including this in a filter will cause SolarNet to return aggregated results, rather
than raw results. Set to null to remove.
Get the combining type.
Use this to combine nodes and/or sources into virtual groups. Requires some combination
of Domain.DatumFilter#nodeIdMaps or Domain.DatumFilter#sourceIdMaps also be specified.
Set to null to remove.
A data path, in dot-delimited notation like i.watts.
Set to null to remove.
A maximum date. Set to null to remove.
An instantaneous property name.
This manages the first available value from the instantaneousPropertyNames property.
Set to null to remove.
An array of instantaneous property names. Set to null to remove.
A local maximum date. Set to null to remove.
Alocal minimumin date. Set to null to remove.
A location ID.
This manages the first available location ID from the locationIds property.
Set to null to remove.
An array of location IDs. Set to null to remove.
A metadata filter (LDAP style search criteria). Set to null to remove.
The "most recent" flag. Set to null to remove.
A node ID.
This manages the first available node ID from the nodeIds property.
Set to null to remove.
A mapping of virtual node IDs to sets of real node IDs to combine. Set to null to remove.
An array of node IDs. Set to null to remove.
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.
Set to null to remove.
A property name.
This manages the first available value from the propertyNames property.
Set to null to remove.
An array of property names. Set to null to remove.
A general full-text style query string. Set to null to remove.
Get the number of properties configured.
A source ID.
This manages the first available source ID from the sourceIds property.
Set to null to remove.
A mapping of virtual source IDs to sets of real source IDs to combine. Set to null to remove.
An array of source IDs. Set to null to remove.
A minimumin date. Set to null to remove.
A property name.
This manages the first available value from the statusPropertyNames property.
Set to null to remove.
An array of property names. Set to null to remove.
A stream ID.
This manages the first available stream ID from the streamIds property.
Set to null to remove.
An array of stream IDs. Set to null to remove.
An array of tags. Set to null to remove.
A user ID.
This manages the first available location ID from the userIds property.
Set to null to remove.
An array of user IDs. Set to null to remove.
Get the without total results flag. Set to null to remove.
Private #cleanupGet a property value.
the key to get
the associated value for the given key
Set or remove a property value.
the key to set the value for
the new value to set for the given key;
if null then the key property will be removed
this object
Get all properties.
all properties of this object copied into a simple object
Set or remove multiple properties.
the new values to set; if any value is null that property
will be deleted
this object
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 Util.Enum values will have their name property used.
Optional propertyName: stringan optional object property prefix to add to all properties
Optional callbackFn: PropMapUriEncodingCallbackFnAn optional function that will be called for each property.
The function will be passed property name and value arguments, and must
return either undefined to skip the property, a 2 or 3-element array with the
property name and value to use, and an optional boolean to force array
values to use mutliple parameter keys. Any other return value causes the
property to be used as-is.
the URI encoded string
Get this object as a standard URI encoded (query parameters) string value with sorting and pagination parameters.
This calls Util.PropMap.toUriEncoding first, then encodes
the sorts and pagination parameters, if provided.
Optional sorts: SortDescriptor[]optional sort settings to use
Optional pagination: Paginationoptional pagination settings to use
Optional propertyName: stringan optional object property prefix to add to all properties
Optional callbackFn: PropMapUriEncodingCallbackFnAn optional function that will be called for each property.
The function will be passed property name and value arguments, and must
return either undefined to skip the property, a 2-element array with the property
name and value to use, or anything else to use the property as-is.
the URI encoded string
Generated using TypeDoc
A filter criteria object for datum.
This filter is used to query both node datum and location datum. Not all properties are applicable to both types. Be sure to consult the SolarNet API documentation on the supported properties for each type.