import TimeserieDatasetBuilder from 'opengate-js/src/searching/builder/TimeserieDatasetBuilder.js'

public class | source

TimeserieDatasetBuilder

Extends:

SearchBuilder → TimeserieDatasetBuilder

Defined a search over timeseries

Example:

ogapi.timeserieDatasetBuilder(organization, timeserieId)

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Method Summary

Public Methods
public	addColumn(name: string, aggregation: string, alias: string): TimeserieDatasetBuilder Add column that will be requested
public	build(): Search Build a instance of Search
public	columns(columns: array): TimeserieDatasetBuilder Add columns that will be requested
public	group()
public	select(select: object): TimeserieDatasetBuilder The search request will have
public	sort()

Inherited Summary

From class SearchBuilder
public	[route]: *
public	addSortAscendingBy(filterField: string): SearchBuilder Add ascending param into the sort search object
public	addSortBy(filterField: string, typeSort: string): SearchBuilder Add ascending/descending param into the sort search object
public	addSortDescendingBy(filterField: string): SearchBuilder Add descending param into the sort search object
public	build(): Search Build a instance of Search
public	filter(filter: FilterBuilder \| object): SearchBuilder The search request will have this filter
public	findAllFields(input: *): Promise Return a promise which it will contains an array with fields recommended with complete structure
public	findFieldPath(field: *): Promise Return a promise which it will contains an string with the path of a field
public	findFields(input: *): Promise Return a promise which it will contains an array with fields recommended with only identifier
public	limit(size: number, start: number): SearchBuilder Set reponse pagination.
public	removeSortBy(filterField: string): SearchBuilder Remove sort param from the search object
public	withTimeout(ms: number): SearchBuilder The request will have a specific time out if it will be exceeded then the promise throw an exception

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Constructor

Override:

SearchBuilder#constructor

Params:

Name	Type	Attribute	Description
parent	InternalOpenGateAPI	nullable: false	Instance of our InternalOpenGateAPI

Public Methods

public addColumn(name: string, aggregation: string, alias: string): TimeserieDatasetBuilder source

Add column that will be requested

Params:

Name	Type	Attribute	Description
name	string
aggregation	string
alias	string

Return:

TimeserieDatasetBuilder

public build(): Search source

Build a instance of Search

Override:

SearchBuilder#build

Return:

Throw:

SearchBuilderError

Throw error on url build

Example:

 ogapi.timeserieDatasetBuilder(organization, timeserieId).build()

public columns(columns: array): TimeserieDatasetBuilder source

Add columns that will be requested

Params:

Name	Type	Attribute	Description
columns	array

Return:

TimeserieDatasetBuilder

public group() source

public select(select: object): TimeserieDatasetBuilder source

The search request will have

Params:

Name	Type	Attribute	Description
select	object

Return:

TimeserieDatasetBuilder

TimeserieDatasetBuilder

Extends:

Example:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Override:

Params:

Public Methods

public addColumn(name: string, aggregation: string, alias: string): TimeserieDatasetBuilder source

Params:

Return:

public build(): Search source

Override:

Return:

Throw:

Example:

public columns(columns: array): TimeserieDatasetBuilder source

Params:

Return:

public group() source

public select(select: object): TimeserieDatasetBuilder source

Params:

Return:

public sort() source