Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UrlStoreConstructorOptions

Constructor options for UrlStore.

Hierarchy

Overview

Properties

Optional accepts

accepts: string

The contents of the HTML accept header, which defines the content-types that are acceptable for the response. You want to change this if you want to support another format. In that case, you also need to change the Codec used by this Store.

default

"application/javascript, application/json"

Optional codec

codec: Codec

The Codec which will be used to convert the server response into LuciadRIA Feature instances. The Codec only needs to support the decode method. There is no need for an encode method as this is a read-only Store. You want to change this if you want to support another format. In that case, you also need to change the accept header by specifying the accept property.

default

the GeoJsonCodec is used by the UrlStore.

Optional credentials

credentials: boolean

Whether credentials should be included with every HTTP request.

Optional handleAs

handleAs: "string" | "arraybuffer" | "blob" | "json"

This value determines what type of data to pass into Codec.decode.

  • "string" uses a string primitive. This is the default and the fallback value.
  • "arraybuffer" uses a ArrayBuffer object.
  • "blob" uses a raw Blob object.
  • "json" parses a JSON response into a JS object.
default

"string"

since

2020.1

Optional requestHeaders

requestHeaders: {} | null

An object literal that represents headers (as a key-value map) to send with each HTTP request. If set (and not empty), an XHR with the specified headers will be performed instead of creating an Image.

Optional requestParameters

requestParameters: {} | null

An object literal that represents URL parameters (as a key-value map) to send with each HTTP request. If set (and not empty), an XHR with the specified query parameters will be performed instead of creating an Image.

since

2021.0

target

target: string

The base URL from which to retrieve the resource

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method