Position class

Pacote:

azure-maps-control

Um objeto Posição GeoJSON - uma matriz que especifica a longitude e a latitude de uma localização. A descrição completa é detalhada no RFC 7946.

Extends

Array<number>

Construtores

Position(number, number, number)

Constrói uma Posição.

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

areEqual(Position, Position, number)	Compara os valores de longitude e latitude de duas posições para ver se são iguais a uma precisão de 6 casas decimais.
fromLatLng(number, number, number)	Gera um objeto Posição a partir de valores de latitude e longitude.
fromLatLng(number[])	Gera um objeto Posição a partir de uma matriz que tem o formato; [lat, lng] ou [lat, lng, elv]
fromLatLng(object)	Gera um objeto Posição a partir de um objeto que contém informações de coordenadas. O objeto é analisado para obter as seguintes propriedades através de um teste não sensível a maiúsculas e minúsculas. Longitude: lng, longitude, lon, x Latitude: lat, latitude, y Elevação: elv, elevação, alt, altitude, z
fromLatLngs(Array<object | number[]>)	Converte uma matriz de objetos que contêm informações de coordenadas numa matriz de Posições. Os objetos que não podem ser convertidos são eliminados. Cada objeto é uma matriz no formato; [lat, lng] ou [lat, lng, elv], ou um objeto com qualquer combinação das seguintes propriedades: Longitude: lng, longitude, lon, x Latitude: lat, latitude, y Elevação: elv, elevação, alt, altitude, z
fromPosition(Position)	Clona uma posição.

Métodos Herdados

concat((T | ConcatArray<T>)[])	Combina duas ou mais matrizes.
concat(ConcatArray<number>[])	Combina duas ou mais matrizes.
every((value: number, index: number, array: number[]) => unknown, any)	Determina se todos os membros de uma matriz satisfazem o teste especificado.
filter((value: number, index: number, array: number[]) => unknown, any)	Devolve os elementos de uma matriz que cumprem a condição especificada numa função de chamada de retorno.
filter<S>((value: number, index: number, array: number[]) => value, any)	Devolve os elementos de uma matriz que cumprem a condição especificada numa função de chamada de retorno.
forEach((value: number, index: number, array: number[]) => void, any)	Executa a ação especificada para cada elemento numa matriz.
indexOf(number, 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 separação especificada.
lastIndexOf(number, number)	Devolve o índice da última ocorrência de um valor especificado numa matriz.
map<U>((value: number, index: number, array: number[]) => 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(number[])	Acrescenta novos elementos a uma matriz e devolve o novo comprimento da matriz.
reduce((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number)	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 chamada seguinte para a função de chamada de retorno.
reduce((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, number)
reduce<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => 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 chamada seguinte para a função de chamada de retorno.
reduceRight((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number)	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 chamada seguinte para a função de chamada de retorno.
reduceRight((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, number)
reduceRight<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => 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 chamada seguinte 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: number, index: number, array: number[]) => unknown, any)	Determina se a função de chamada de retorno especificada devolve verdadeiro para qualquer elemento de uma matriz.
sort((a: number, b: number) => 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, number[])	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 uma matriz. Os elementos são convertidos em cadeia com os respetivos métodos toLocalString.
toString()	Devolve uma representação de cadeia de uma matriz.
unshift(number[])	Insere novos elementos no início de uma matriz.

Detalhes do Construtor

Position(number, number, number)

Constrói uma Posição.

new Position(longitude: number, latitude: number, elevation?: number)

Parâmetros

longitude

number

A longitude da posição.

latitude

number

A latitude da posição.

elevation

number

A elevação da posição.

Detalhes de Propriedade

Array

static 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 Matriz.length

Detalhes de Método

areEqual(Position, Position, number)

Compara os valores de longitude e latitude de duas posições para ver se são iguais a uma precisão de 6 casas decimais.

static function areEqual(pos1: Position, pos2: Position, precision?: number): boolean

Parâmetros

pos1

Position

Primeira posição a comparar.

pos2

Position

Segunda posição a comparar.

precision

number

O número de casas decimais a comparar. Predefinição: 6.

Devoluções

boolean

Um valor booleano que indica se duas posições para ver se são iguais a uma precisão da precisão especificada ou 6 casas decimais.

fromLatLng(number, number, number)

Gera um objeto Posição a partir de valores de latitude e longitude.

static function fromLatLng(lat: number, lng: number, elv?: number): Position

Parâmetros

lat

number

O valor de latitude.

lng

number

Um valor de longitude.

elv

number

Um valor de elevação em metros.

Devoluções

Position

Um objeto Posição que representa as informações de LatLng fornecidas.

fromLatLng(number[])

Gera um objeto Posição a partir de uma matriz que tem o formato; [lat, lng] ou [lat, lng, elv]

static function fromLatLng(latLng: number[]): Position

Parâmetros

latLng

number[]

Uma matriz que contém informações de latitude/longitude no formato; [lat, lng] ou [lat, lng, elv]

Devoluções

Position

Um objeto Posição que representa as informações de LatLng fornecidas.

fromLatLng(object)

Gera um objeto Posição a partir de um objeto que contém informações de coordenadas. O objeto é analisado para obter as seguintes propriedades através de um teste não sensível a maiúsculas e minúsculas. Longitude: lng, longitude, lon, x Latitude: lat, latitude, y Elevação: elv, elevação, alt, altitude, z

static function fromLatLng(latLng: object): Position

Parâmetros

latLng

object

O objeto a partir do qual extrair informações coordenadas.

Devoluções

Position

Um objeto Posição que representa as informações de LatLng fornecidas.

fromLatLngs(Array<object | number[]>)

Converte uma matriz de objetos que contêm informações de coordenadas numa matriz de Posições. Os objetos que não podem ser convertidos são eliminados. Cada objeto é uma matriz no formato; [lat, lng] ou [lat, lng, elv], ou um objeto com qualquer combinação das seguintes propriedades: Longitude: lng, longitude, lon, x Latitude: lat, latitude, y Elevação: elv, elevação, alt, altitude, z

static function fromLatLngs(latLngs: Array<object | number[]>): Position[]

Parâmetros

latLngs

Array<object | number[]>

Os objetos que contêm informações coordenadas.

Devoluções

Position[]

Uma matriz de objetos de Posição que contêm todas as informações de coordenada fornecidas.

fromPosition(Position)

Clona uma posição.

static function fromPosition(position: Position): Position

Parâmetros

position

Position

A posição a clonar.

Devoluções

Position

Detalhes do Método Herdado

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

Combina duas ou mais matrizes.

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

Parâmetros

items

(T | ConcatArray<T>)[]

Itens adicionais a adicionar ao final da matriz1.

Devoluções

number[]

Herdado de Matriz.concat

concat(ConcatArray<number>[])

Combina duas ou mais matrizes.

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

Parâmetros

items

ConcatArray<number>[]

Itens adicionais a adicionar ao final da matriz1.

Devoluções

number[]

Herdado de Matriz.concat

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

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

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

Parâmetros

callbackfn

(value: number, index: number, array: number[]) => 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 chamada de retorno 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, não definido é utilizado como este valor.

Devoluções

boolean

Herdado de Matriz.a cada

filter((value: number, index: number, array: number[]) => 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: number, index: number, array: number[]) => unknown, thisArg?: any): number[]

Parâmetros

callbackfn

(value: number, index: number, array: number[]) => 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, não definido é utilizado como este valor.

Devoluções

number[]

Herdado de Matriz.filtro

filter<S>((value: number, index: number, array: number[]) => 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: number, index: number, array: number[]) => value, thisArg?: any): S[]

Parâmetros

callbackfn

(value: number, index: number, array: number[]) => 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, não definido é utilizado como este valor.

Devoluções

S[]

Herdado de Matriz.filtro

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

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

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

Parâmetros

callbackfn

(value: number, index: number, array: number[]) => 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, não definido é utilizado como este valor.

Herdado de Matriz.forEach

indexOf(number, number)

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

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

Parâmetros

searchElement

number

O valor a localizar na matriz.

fromIndex

number

O índice de matriz para 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 separação 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(number, number)

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

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

Parâmetros

searchElement

number

O valor a localizar na matriz.

fromIndex

number

O índice de matriz para iniciar a pesquisa. Se fromIndex for omitido, a pesquisa será iniciada no último índice da matriz.

Devoluções

number

Herdado de Array.lastIndexOf

map<U>((value: number, index: number, array: number[]) => 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: number, index: number, array: number[]) => U, thisArg?: any): U[]

Parâmetros

callbackfn

(value: number, index: number, array: number[]) => 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, não definido é utilizado como este valor.

Devoluções

U[]

Herdado de Matriz.map

pop()

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

function pop(): number | undefined

Devoluções

number | undefined

Herdado de Matriz.pop

push(number[])

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

function push(items: number[]): number

Parâmetros

items

number[]

Novos elementos da Matriz.

Devoluções

number

Herdado de Matriz.push

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

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 chamada seguinte para a função de chamada de retorno.

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

Parâmetros

callbackfn

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

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

Devoluções

number

Herdado de Array.reduce

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

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

Parâmetros

callbackfn

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

initialValue

number

Devoluções

number

Herdado de Array.reduce

reduce<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => 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 chamada seguinte para a função de chamada de retorno.

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

Parâmetros

callbackfn

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

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

initialValue

U

Se initialValue for especificado, é 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: number, currentValue: number, currentIndex: number, array: number[]) => number)

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 chamada seguinte para a função de chamada de retorno.

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

Parâmetros

callbackfn

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

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

number

Herdado de Array.reduceRight

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

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

Parâmetros

callbackfn

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

initialValue

number

Devoluções

number

Herdado de Array.reduceRight

reduceRight<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => 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 chamada seguinte para a função de chamada de retorno.

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

Parâmetros

callbackfn

(previousValue: U, currentValue: number, currentIndex: number, array: number[]) => 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, é 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(): number[]

Devoluções

number[]

Herdado de Matriz.inverso

shift()

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

function shift(): number | undefined

Devoluções

number | undefined

Herdado de Matriz.shift

slice(number, number)

Devolve uma secção de uma matriz.

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

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 "fim" do índice.

Devoluções

number[]

Herdado de Matriz.segmentação

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

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

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

Parâmetros

callbackfn

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

Uma função que aceita até três argumentos. O método alguns chama a função callbackfn para cada elemento na matriz até que a chamada de retorno 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, não definido é utilizado como este valor.

Devoluções

boolean

Herdado de Matriz.alguns

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

Ordena uma matriz.

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

Parâmetros

compareFn

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

Função utilizada para determinar a ordem dos elementos. Espera-se que devolva um valor negativo se o primeiro argumento for inferior a segundo argumento, zero se for igual e um valor positivo de outra forma. Se omitidos, 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 Matriz.ordenar

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): number[]

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

number[]

Herdado de Matriz.splice

splice(number, 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, items: number[]): number[]

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

number[]

Elementos a inserir na matriz em vez dos elementos eliminados.

Devoluções

number[]

Herdado de Matriz.splice

toLocaleString()

Devolve uma representação de cadeia 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 uma matriz.

function toString(): string

Devoluções

string

Herdado de Matriz.toString

unshift(number[])

Insere novos elementos no início de uma matriz.

function unshift(items: number[]): number

Parâmetros

items

number[]

Elementos a inserir no início da Matriz.

Devoluções

number

Herdado de Matriz.unshift