solarnetwork-api-core
    Preparing search index...

    Class DatumFilter

    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.

    Hierarchy (View Summary)

    Implements

    Index
    constructor
    props
    accumulatingPropertyName accumulatingPropertyNames aggregation combiningType dataPath endDate instantaneousPropertyName instantaneousPropertyNames localEndDate localStartDate location locationId locationIds metadataFilter mostRecent nodeId nodeIdMaps nodeIds partialAggregation propertyName propertyNames query rollupType rollupTypes size sourceId sourceIdMaps sourceIds startDate statusPropertyName statusPropertyNames streamId streamIds tags userId userIds withoutTotalResultsCount
    [iterator] prop properties toUriEncoding toUriEncodingWithSorting
    props: Map<string, any>

    The object that all properties are stored on.

    • get accumulatingPropertyName(): string | undefined

      An accumulating property name.

      This manages the first available value from the accumulatingPropertyNames property. Set to null to remove.

      Returns string | undefined

    • set accumulatingPropertyName(name: string | null): void

      Parameters

      • name: string | null

      Returns void

    • get accumulatingPropertyNames(): string[] | undefined

      An array of accumulating property names. Set to null to remove.

      Returns string[] | undefined

    • set accumulatingPropertyNames(names: string[] | null): void

      Parameters

      • names: string[] | null

      Returns void

    • get dataPath(): string | undefined

      A data path, in dot-delimited notation like i.watts. Set to null to remove.

      Returns string | undefined

    • set dataPath(path: string | null): void

      Parameters

      • path: string | null

      Returns void

    • get endDate(): Date | undefined

      A maximum date. Set to null to remove.

      Returns Date | undefined

    • set endDate(date: Date | null): void

      Parameters

      • date: Date | null

      Returns void

    • get instantaneousPropertyName(): string | undefined

      An instantaneous property name.

      This manages the first available value from the instantaneousPropertyNames property. Set to null to remove.

      Returns string | undefined

    • set instantaneousPropertyName(name: string | null): void

      Parameters

      • name: string | null

      Returns void

    • get instantaneousPropertyNames(): string[] | undefined

      An array of instantaneous property names. Set to null to remove.

      Returns string[] | undefined

    • set instantaneousPropertyNames(names: string[] | null): void

      Parameters

      • names: string[] | null

      Returns void

    • get localEndDate(): Date | undefined

      A local maximum date. Set to null to remove.

      Returns Date | undefined

    • set localEndDate(date: Date | null): void

      Parameters

      • date: Date | null

      Returns void

    • get localStartDate(): Date | undefined

      Alocal minimumin date. Set to null to remove.

      Returns Date | undefined

    • set localStartDate(date: Date | null): void

      Parameters

      • date: Date | null

      Returns void

    • get locationId(): number | undefined

      A location ID.

      This manages the first available location ID from the locationIds property. Set to null to remove.

      Returns number | undefined

    • set locationId(locationId: number | null): void

      Parameters

      • locationId: number | null

      Returns void

    • get locationIds(): number[] | undefined

      An array of location IDs. Set to null to remove.

      Returns number[] | undefined

    • set locationIds(locationIds: number[] | null): void

      Parameters

      • locationIds: number[] | null

      Returns void

    • get metadataFilter(): string | undefined

      A metadata filter (LDAP style search criteria). Set to null to remove.

      Returns string | undefined

    • set metadataFilter(val: string | null): void

      Parameters

      • val: string | null

      Returns void

    • get mostRecent(): boolean | undefined

      The "most recent" flag. Set to null to remove.

      Returns boolean | undefined

    • set mostRecent(value: boolean | null): void

      Parameters

      • value: boolean | null

      Returns void

    • get nodeId(): number | undefined

      A node ID.

      This manages the first available node ID from the nodeIds property. Set to null to remove.

      Returns number | undefined

    • set nodeId(nodeId: number | null): void

      Parameters

      • nodeId: number | null

      Returns void

    • get nodeIdMaps(): Map<number, Set<number>> | undefined

      A mapping of virtual node IDs to sets of real node IDs to combine. Set to null to remove.

      Returns Map<number, Set<number>> | undefined

    • set nodeIdMaps(map: Map<number, Set<number>> | null): void

      Parameters

      • map: Map<number, Set<number>> | null

      Returns void

    • get nodeIds(): number[] | undefined

      An array of node IDs. Set to null to remove.

      Returns number[] | undefined

    • set nodeIds(nodeIds: number[] | null): void

      Parameters

      • nodeIds: number[] | null

      Returns void

    • get partialAggregation(): Aggregation | undefined

      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.

      Returns Aggregation | undefined

    • set partialAggregation(agg: Aggregation | null): void

      Parameters

      Returns void

    • get propertyName(): string | undefined

      A property name.

      This manages the first available value from the propertyNames property. Set to null to remove.

      Returns string | undefined

    • set propertyName(name: string | null): void

      Parameters

      • name: string | null

      Returns void

    • get propertyNames(): string[] | undefined

      An array of property names. Set to null to remove.

      Returns string[] | undefined

    • set propertyNames(names: string[] | null): void

      Parameters

      • names: string[] | null

      Returns void

    • get query(): string | undefined

      A general full-text style query string. Set to null to remove.

      Returns string | undefined

    • set query(val: string | null): void

      Parameters

      • val: string | null

      Returns void

    • get size(): number

      Get the number of properties configured.

      Returns number

    • get sourceId(): string | undefined

      A source ID.

      This manages the first available source ID from the sourceIds property. Set to null to remove.

      Returns string | undefined

    • set sourceId(sourceId: string | null): void

      Parameters

      • sourceId: string | null

      Returns void

    • get sourceIdMaps(): Map<string, Set<string>> | undefined

      A mapping of virtual source IDs to sets of real source IDs to combine. Set to null to remove.

      Returns Map<string, Set<string>> | undefined

    • set sourceIdMaps(map: Map<string, Set<string>> | null): void

      Parameters

      • map: Map<string, Set<string>> | null

      Returns void

    • get sourceIds(): string[] | undefined

      An array of source IDs. Set to null to remove.

      Returns string[] | undefined

    • set sourceIds(sourceIds: string[] | null): void

      Parameters

      • sourceIds: string[] | null

      Returns void

    • get startDate(): Date | undefined

      A minimumin date. Set to null to remove.

      Returns Date | undefined

    • set startDate(date: Date | null): void

      Parameters

      • date: Date | null

      Returns void

    • get statusPropertyName(): string | undefined

      A property name.

      This manages the first available value from the statusPropertyNames property. Set to null to remove.

      Returns string | undefined

    • set statusPropertyName(name: string | null): void

      Parameters

      • name: string | null

      Returns void

    • get statusPropertyNames(): string[] | undefined

      An array of property names. Set to null to remove.

      Returns string[] | undefined

    • set statusPropertyNames(names: string[] | null): void

      Parameters

      • names: string[] | null

      Returns void

    • get streamId(): string | undefined

      A stream ID.

      This manages the first available stream ID from the streamIds property. Set to null to remove.

      Returns string | undefined

    • set streamId(streamId: string | null): void

      Parameters

      • streamId: string | null

      Returns void

    • get streamIds(): string[] | undefined

      An array of stream IDs. Set to null to remove.

      Returns string[] | undefined

    • set streamIds(streamIds: string[] | null): void

      Parameters

      • streamIds: string[] | null

      Returns void

    • get tags(): string[] | undefined

      An array of tags. Set to null to remove.

      Returns string[] | undefined

    • set tags(val: string[] | null): void

      Parameters

      • val: string[] | null

      Returns void

    • get userId(): number | undefined

      A user ID.

      This manages the first available location ID from the userIds property. Set to null to remove.

      Returns number | undefined

    • set userId(userId: number | null): void

      Parameters

      • userId: number | null

      Returns void

    • get userIds(): number[] | undefined

      An array of user IDs. Set to null to remove.

      Returns number[] | undefined

    • set userIds(userIds: number[] | null): void

      Parameters

      • userIds: number[] | null

      Returns void

    • get withoutTotalResultsCount(): boolean | undefined

      Get the without total results flag. Set to null to remove.

      Returns boolean | undefined

    • set withoutTotalResultsCount(val: boolean | null): void

      Parameters

      • val: boolean | null

      Returns void

    • Get an iterator over the property entries.

      Returns MapIterator<[string, any]>

      iterator over [k, v] values

    • Get a property value.

      Parameters

      • key: string

        the key to get

      Returns any

      the associated value for the given key

    • Set or remove a property value.

      Parameters

      • key: string

        the key to set the value for

      • newValue: any

        the new value to set for the given key; if null then the key property will be removed

      Returns this

      this object

    • Get all properties.

      Returns Record<string, any>

      all properties of this object copied into a simple object

    • Set or remove multiple properties.

      Parameters

      • newProps: object | Map<string, any>

        the new values to set; if any value is null that property will be deleted

      Returns this

      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.

      Parameters

      • OptionalpropertyName: string

        an optional object property prefix to add to all properties

      • OptionalcallbackFn: PropMapUriEncodingCallbackFn

        An 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.

      Returns string

      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.

      Parameters

      • Optionalsorts: SortDescriptor[]

        optional sort settings to use

      • Optionalpagination: Pagination

        optional pagination settings to use

      • OptionalpropertyName: string

        an optional object property prefix to add to all properties

      • OptionalcallbackFn: PropMapUriEncodingCallbackFn

        An 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.

      Returns string

      the URI encoded string

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods