Partilhar via


AggregateExpression interface

Uma expressão de agregação define um cálculo que é processado através de um conjunto de dados. Esquema: operador [operador: cadeia, initialValue?: booleano | number, mapExpression: Expression] operador: uma função de expressão que é aplicada a todos os valores calculados pelo mapExpression para cada ponto no cluster. Operadores suportados: o Para números: +, *, max, min o Para Booleanos: all, any initialValue: Opcional, um valor inicial no qual o primeiro valor calculado é agregado. mapExpression: uma expressão que é aplicada a cada ponto no conjunto de dados.

Extends

Array<any>

Propriedades

Array

Propriedades Herdadas

length

Obtém ou define o comprimento da matriz. Este é um número um superior ao elemento mais alto definido numa matriz.

Métodos Herdados

concat((T | ConcatArray<T>)[])

Combina duas ou mais matrizes.

concat(ConcatArray<any>[])

Combina duas ou mais matrizes.

every((value: any, index: number, array: any[]) => unknown, any)

Determina se todos os membros de uma matriz satisfazem o teste especificado.

filter((value: any, index: number, array: any[]) => unknown, any)

Devolve os elementos de uma matriz que cumprem a condição especificada numa função de chamada de retorno.

filter<S>((value: any, index: number, array: any[]) => value, any)

Devolve os elementos de uma matriz que cumprem a condição especificada numa função de chamada de retorno.

forEach((value: any, index: number, array: any[]) => void, any)

Executa a ação especificada para cada elemento numa matriz.

indexOf(any, number)

Devolve o índice da primeira ocorrência de um valor numa matriz.

join(string)

Adiciona todos os elementos de uma matriz separada pela cadeia de separador especificada.

lastIndexOf(any, number)

Devolve o índice da última ocorrência de um valor especificado numa matriz.

map<U>((value: any, index: number, array: any[]) => U, any)

Chama uma função de chamada de retorno definida em cada elemento de uma matriz e devolve uma matriz que contém os resultados.

pop()

Remove o último elemento de uma matriz e devolve-o.

push(any[])

Acrescenta novos elementos a uma matriz e devolve o novo comprimento da matriz.

reduce((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

reduce((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, any)
reduce<U>((previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, U)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

reduceRight((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz, por ordem descendente. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

reduceRight((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, any)
reduceRight<U>((previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, U)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz, por ordem descendente. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

reverse()

Inverte os elementos numa Matriz.

shift()

Remove o primeiro elemento de uma matriz e devolve-o.

slice(number, number)

Devolve uma secção de uma matriz.

some((value: any, index: number, array: any[]) => unknown, any)

Determina se a função de chamada de retorno especificada devolve verdadeiro para qualquer elemento de uma matriz.

sort((a: any, b: any) => number)

Ordena uma matriz.

splice(number, number)

Remove elementos de uma matriz e, se necessário, insere novos elementos no respetivo local, devolvendo os elementos eliminados.

splice(number, number, any[])

Remove elementos de uma matriz e, se necessário, insere novos elementos no respetivo local, devolvendo os elementos eliminados.

toLocaleString()

Devolve uma representação de cadeia de carateres de uma matriz. Os elementos são convertidos em cadeia com os respetivos métodos toLocalString.

toString()

Devolve uma representação de cadeia de carateres de uma matriz.

unshift(any[])

Insere novos elementos no início de uma matriz.

Detalhes de Propriedade

Array

Array: ArrayConstructor

Valor de Propriedade

ArrayConstructor

Detalhes da Propriedade Herdada

length

Obtém ou define o comprimento da matriz. Este é um número um superior ao elemento mais alto definido numa matriz.

length: number

Valor de Propriedade

number

Herdado de Array.length

Detalhes do Método Herdado

concat((T | ConcatArray<T>)[])

Combina duas ou mais matrizes.

function concat(items: (T | ConcatArray<T>)[]): any[]

Parâmetros

items

(T | ConcatArray<T>)[]

Itens adicionais a adicionar ao fim da matriz1.

Devoluções

any[]

Herdado de Array.concat

concat(ConcatArray<any>[])

Combina duas ou mais matrizes.

function concat(items: ConcatArray<any>[]): any[]

Parâmetros

items

ConcatArray<any>[]

Itens adicionais a adicionar ao fim da matriz1.

Devoluções

any[]

Herdado de Array.concat

every((value: any, index: number, array: any[]) => unknown, any)

Determina se todos os membros de uma matriz satisfazem o teste especificado.

function every(callbackfn: (value: any, index: number, array: any[]) => unknown, thisArg?: any): boolean

Parâmetros

callbackfn

(value: any, index: number, array: any[]) => unknown

Uma função que aceita até três argumentos. Cada método chama a função callbackfn para cada elemento na matriz até que a função callbackfn devolva um valor que é coerciva para o valor booleano falso ou até ao fim da matriz.

thisArg

any

Um objeto ao qual esta palavra-chave pode referir-se na função callbackfn. Se thisArg for omitido, undefined é utilizado como este valor.

Devoluções

boolean

Herdado de Matriz.a cada

filter((value: any, index: number, array: any[]) => unknown, any)

Devolve os elementos de uma matriz que cumprem a condição especificada numa função de chamada de retorno.

function filter(callbackfn: (value: any, index: number, array: any[]) => unknown, thisArg?: any): any[]

Parâmetros

callbackfn

(value: any, index: number, array: any[]) => unknown

Uma função que aceita até três argumentos. O método de filtro chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual esta palavra-chave pode referir-se na função callbackfn. Se thisArg for omitido, undefined é utilizado como este valor.

Devoluções

any[]

Herdado de Array.filter

filter<S>((value: any, index: number, array: any[]) => value, any)

Devolve os elementos de uma matriz que cumprem a condição especificada numa função de chamada de retorno.

function filter<S>(callbackfn: (value: any, index: number, array: any[]) => value, thisArg?: any): S[]

Parâmetros

callbackfn

(value: any, index: number, array: any[]) => value

Uma função que aceita até três argumentos. O método de filtro chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual esta palavra-chave pode referir-se na função callbackfn. Se thisArg for omitido, undefined é utilizado como este valor.

Devoluções

S[]

Herdado de Array.filter

forEach((value: any, index: number, array: any[]) => void, any)

Executa a ação especificada para cada elemento numa matriz.

function forEach(callbackfn: (value: any, index: number, array: any[]) => void, thisArg?: any)

Parâmetros

callbackfn

(value: any, index: number, array: any[]) => void

Uma função que aceita até três argumentos. forEach chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual esta palavra-chave pode referir-se na função callbackfn. Se thisArg for omitido, undefined é utilizado como este valor.

Herdado de Array.forEach

indexOf(any, number)

Devolve o índice da primeira ocorrência de um valor numa matriz.

function indexOf(searchElement: any, fromIndex?: number): number

Parâmetros

searchElement

any

O valor a localizar na matriz.

fromIndex

number

O índice de matriz no qual iniciar a pesquisa. Se fromIndex for omitido, a pesquisa começa no índice 0.

Devoluções

number

Herdado de Array.indexOf

join(string)

Adiciona todos os elementos de uma matriz separada pela cadeia de separador especificada.

function join(separator?: string): string

Parâmetros

separator

string

Uma cadeia utilizada para separar um elemento de uma matriz do seguinte na Cadeia resultante. Se omitido, os elementos da matriz são separados por uma vírgula.

Devoluções

string

Herdado de Matriz.associação

lastIndexOf(any, number)

Devolve o índice da última ocorrência de um valor especificado numa matriz.

function lastIndexOf(searchElement: any, fromIndex?: number): number

Parâmetros

searchElement

any

O valor a localizar na matriz.

fromIndex

number

O índice de matriz no qual iniciar a pesquisa. Se fromIndex for omitido, a pesquisa começa no último índice da matriz.

Devoluções

number

Herdado de Array.lastIndexOf

map<U>((value: any, index: number, array: any[]) => U, any)

Chama uma função de chamada de retorno definida em cada elemento de uma matriz e devolve uma matriz que contém os resultados.

function map<U>(callbackfn: (value: any, index: number, array: any[]) => U, thisArg?: any): U[]

Parâmetros

callbackfn

(value: any, index: number, array: any[]) => U

Uma função que aceita até três argumentos. O método de mapa chama a função callbackfn uma vez para cada elemento na matriz.

thisArg

any

Um objeto ao qual esta palavra-chave pode referir-se na função callbackfn. Se thisArg for omitido, undefined é utilizado como este valor.

Devoluções

U[]

Herdado de Array.map

pop()

Remove o último elemento de uma matriz e devolve-o.

function pop(): any | undefined

Devoluções

any | undefined

Herdado de Matriz.pop

push(any[])

Acrescenta novos elementos a uma matriz e devolve o novo comprimento da matriz.

function push(items: any[]): number

Parâmetros

items

any[]

Novos elementos da Matriz.

Devoluções

number

Herdado de Array.push

reduce((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

function reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any): any

Parâmetros

callbackfn

(previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any

Uma função que aceita até quatro argumentos. O método reduce chama a função callbackfn uma vez para cada elemento na matriz.

Devoluções

any

Herdado de Array.reduce

reduce((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, any)

function reduce(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, initialValue: any): any

Parâmetros

callbackfn

(previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any

initialValue

any

Devoluções

any

Herdado de Array.reduce

reduce<U>((previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, U)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

function reduce<U>(callbackfn: (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, initialValue: U): U

Parâmetros

callbackfn

(previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U

Uma função que aceita até quatro argumentos. O método reduce chama a função callbackfn uma vez para cada elemento na matriz.

initialValue

U

Se initialValue for especificado, será utilizado como o valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de matriz.

Devoluções

U

Herdado de Array.reduce

reduceRight((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz, por ordem descendente. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

function reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any): any

Parâmetros

callbackfn

(previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any

Uma função que aceita até quatro argumentos. O método reduceRight chama a função callbackfn uma vez para cada elemento na matriz.

Devoluções

any

Herdado de Array.reduceRight

reduceRight((previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, any)

function reduceRight(callbackfn: (previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any, initialValue: any): any

Parâmetros

callbackfn

(previousValue: any, currentValue: any, currentIndex: number, array: any[]) => any

initialValue

any

Devoluções

any

Herdado de Array.reduceRight

reduceRight<U>((previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, U)

Chama a função de chamada de retorno especificada para todos os elementos numa matriz, por ordem descendente. O valor devolvido da função de chamada de retorno é o resultado acumulado e é fornecido como um argumento na próxima chamada para a função de chamada de retorno.

function reduceRight<U>(callbackfn: (previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U, initialValue: U): U

Parâmetros

callbackfn

(previousValue: U, currentValue: any, currentIndex: number, array: any[]) => U

Uma função que aceita até quatro argumentos. O método reduceRight chama a função callbackfn uma vez para cada elemento na matriz.

initialValue

U

Se initialValue for especificado, será utilizado como o valor inicial para iniciar a acumulação. A primeira chamada para a função callbackfn fornece este valor como um argumento em vez de um valor de matriz.

Devoluções

U

Herdado de Array.reduceRight

reverse()

Inverte os elementos numa Matriz.

function reverse(): any[]

Devoluções

any[]

Herdado de Matriz.inverso

shift()

Remove o primeiro elemento de uma matriz e devolve-o.

function shift(): any | undefined

Devoluções

any | undefined

Herdado de Matriz.shift

slice(number, number)

Devolve uma secção de uma matriz.

function slice(start?: number, end?: number): any[]

Parâmetros

start

number

O início da parte especificada da matriz.

end

number

O fim da parte especificada da matriz. Isto é exclusivo do elemento no índice "end".

Devoluções

any[]

Herdado de Matriz.setor

some((value: any, index: number, array: any[]) => unknown, any)

Determina se a função de chamada de retorno especificada devolve verdadeiro para qualquer elemento de uma matriz.

function some(callbackfn: (value: any, index: number, array: any[]) => unknown, thisArg?: any): boolean

Parâmetros

callbackfn

(value: any, index: number, array: any[]) => unknown

Uma função que aceita até três argumentos. O método chama a função callbackfn para cada elemento na matriz até que a função callbackfn devolva um valor que é coerciva para o valor booleano verdadeiro ou até ao fim da matriz.

thisArg

any

Um objeto ao qual esta palavra-chave pode referir-se na função callbackfn. Se thisArg for omitido, undefined é utilizado como este valor.

Devoluções

boolean

Herdado de Matriz.alguns

sort((a: any, b: any) => number)

Ordena uma matriz.

function sort(compareFn?: (a: any, b: any) => number): this

Parâmetros

compareFn

(a: any, b: any) => number

Função utilizada para determinar a ordem dos elementos. Espera-se que devolva um valor negativo se o primeiro argumento for inferior ao segundo argumento, zero se for igual e um valor positivo de outra forma. Se omitido, os elementos são ordenados por ordem ascendente de carateres ASCII.

[11,2,22,1].sort((a, b) => a - b)

Devoluções

this

Herdado de Array.sort

splice(number, number)

Remove elementos de uma matriz e, se necessário, insere novos elementos no respetivo local, devolvendo os elementos eliminados.

function splice(start: number, deleteCount?: number): any[]

Parâmetros

start

number

A localização baseada em zero na matriz a partir da qual começar a remover elementos.

deleteCount

number

O número de elementos a remover.

Devoluções

any[]

Herdado de Matriz.splice

splice(number, number, any[])

Remove elementos de uma matriz e, se necessário, insere novos elementos no respetivo local, devolvendo os elementos eliminados.

function splice(start: number, deleteCount: number, items: any[]): any[]

Parâmetros

start

number

A localização baseada em zero na matriz a partir da qual começar a remover elementos.

deleteCount

number

O número de elementos a remover.

items

any[]

Elementos a inserir na matriz em vez dos elementos eliminados.

Devoluções

any[]

Herdado de Matriz.splice

toLocaleString()

Devolve uma representação de cadeia de carateres de uma matriz. Os elementos são convertidos em cadeia com os respetivos métodos toLocalString.

function toLocaleString(): string

Devoluções

string

Herdado de Array.toLocaleString

toString()

Devolve uma representação de cadeia de carateres de uma matriz.

function toString(): string

Devoluções

string

Herdado de Matriz.toString

unshift(any[])

Insere novos elementos no início de uma matriz.

function unshift(items: any[]): number

Parâmetros

items

any[]

Elementos a inserir no início da Matriz.

Devoluções

number

Herdado de Matriz.unshift