StacGetItemCollectionOptionalParams interface

Parâmetros opcionais.

Extends

Propriedades

boundingBox

Somente os recursos que têm uma geometria que cruza a caixa delimitadora são selecionados. A caixa delimitadora é fornecida como quatro ou seis números, dependendo se o sistema de referência de coordenadas inclui um eixo vertical (altura ou profundidade):

  • Canto inferior esquerdo, eixo de coordenadas 1
  • Canto inferior esquerdo, eixo de coordenadas 2
  • Valor mínimo, eixo de coordenadas 3 (opcional)
  • Canto superior direito, eixo de coordenadas 1
  • Canto superior direito, eixo de coordenadas 2
  • Valor máximo, eixo de coordenadas 3 (opcional)

O sistema de referência de coordenadas dos valores é WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84).

Para WGS 84 longitude/latitude os valores são, na maioria dos casos, a sequência de longitude mínima, latitude mínima, longitude máxima e latitude máxima. No entanto, nos casos em que a caixa se estende pelo antimeridiano, o primeiro valor (borda da caixa mais a oeste) é maior do que o terceiro valor (borda da caixa mais a leste).

Se o eixo vertical estiver incluído, o terceiro e o sexto números são a parte inferior e a parte superior da caixa delimitadora de 3 dimensões.

Se um recurso tiver várias propriedades de geometria espacial, é a decisão do servidor se apenas uma única propriedade de geometria espacial é usada para determinar a extensão ou todas as geometrias relevantes.

datetime

Uma data-hora ou um intervalo, aberto ou fechado. As expressões de data e hora aderem ao RFC 3339. Os intervalos abertos são expressos usando pontos duplos.

Examples:

  • Data-hora: "2018-02-12T23:20:50Z"
  • Um intervalo fechado: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
  • Intervalos abertos: "2018-02-12T00:00:00Z/.." ou ".. /2018-03-18T12:31:12Z"

Somente os recursos que têm uma propriedade temporal que cruza o valor de datetime são selecionados.

Se um recurso tiver várias propriedades temporais, é a decisão do servidor se apenas uma única propriedade temporal é usada para determinar a extensão ou todas as propriedades temporais relevantes.

durationInMinutes

Duração da assinatura de URL em minutos.

limit

O parâmetro limite opcional recomenda o número de itens que devem estar presentes no documento de resposta.

Se o valor do parâmetro limite for maior do que o limite máximo anunciado, o servidor deverá retornar o número máximo possível de itens, em vez de responder com um erro.

Só são contados os itens que estão no primeiro nível da coleção no documento de resposta. Os objetos aninhados contidos nos itens explicitamente solicitados não devem ser contados.

Mínimo = 1. Máximo = 10000. Padrão = 10.

sign

Se deve assinar URLs de assets na resposta.

token

Token de paginação para obter o próximo conjunto de resultados.

Propriedades Herdadas

abortSignal

O sinal que pode ser usado para abortar solicitações.

onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

tracingOptions

Opções usadas quando o rastreamento está habilitado.

Detalhes de Propriedade

boundingBox

Somente os recursos que têm uma geometria que cruza a caixa delimitadora são selecionados. A caixa delimitadora é fornecida como quatro ou seis números, dependendo se o sistema de referência de coordenadas inclui um eixo vertical (altura ou profundidade):

  • Canto inferior esquerdo, eixo de coordenadas 1
  • Canto inferior esquerdo, eixo de coordenadas 2
  • Valor mínimo, eixo de coordenadas 3 (opcional)
  • Canto superior direito, eixo de coordenadas 1
  • Canto superior direito, eixo de coordenadas 2
  • Valor máximo, eixo de coordenadas 3 (opcional)

O sistema de referência de coordenadas dos valores é WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84).

Para WGS 84 longitude/latitude os valores são, na maioria dos casos, a sequência de longitude mínima, latitude mínima, longitude máxima e latitude máxima. No entanto, nos casos em que a caixa se estende pelo antimeridiano, o primeiro valor (borda da caixa mais a oeste) é maior do que o terceiro valor (borda da caixa mais a leste).

Se o eixo vertical estiver incluído, o terceiro e o sexto números são a parte inferior e a parte superior da caixa delimitadora de 3 dimensões.

Se um recurso tiver várias propriedades de geometria espacial, é a decisão do servidor se apenas uma única propriedade de geometria espacial é usada para determinar a extensão ou todas as geometrias relevantes.

boundingBox?: string[]

Valor de Propriedade

string[]

datetime

Uma data-hora ou um intervalo, aberto ou fechado. As expressões de data e hora aderem ao RFC 3339. Os intervalos abertos são expressos usando pontos duplos.

Examples:

  • Data-hora: "2018-02-12T23:20:50Z"
  • Um intervalo fechado: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
  • Intervalos abertos: "2018-02-12T00:00:00Z/.." ou ".. /2018-03-18T12:31:12Z"

Somente os recursos que têm uma propriedade temporal que cruza o valor de datetime são selecionados.

Se um recurso tiver várias propriedades temporais, é a decisão do servidor se apenas uma única propriedade temporal é usada para determinar a extensão ou todas as propriedades temporais relevantes.

datetime?: string

Valor de Propriedade

string

durationInMinutes

Duração da assinatura de URL em minutos.

durationInMinutes?: number

Valor de Propriedade

number

limit

O parâmetro limite opcional recomenda o número de itens que devem estar presentes no documento de resposta.

Se o valor do parâmetro limite for maior do que o limite máximo anunciado, o servidor deverá retornar o número máximo possível de itens, em vez de responder com um erro.

Só são contados os itens que estão no primeiro nível da coleção no documento de resposta. Os objetos aninhados contidos nos itens explicitamente solicitados não devem ser contados.

Mínimo = 1. Máximo = 10000. Padrão = 10.

limit?: number

Valor de Propriedade

number

sign

Se deve assinar URLs de assets na resposta.

sign?: string

Valor de Propriedade

string

token

Token de paginação para obter o próximo conjunto de resultados.

token?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

Herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

Herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

Herdado de OperationOptions.requestOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

Herdado de OperationOptions.tracingOptions