A read-only store that retrieves a collection of objects from a URL. The response content is decoded to LuciadRIA Codec.

Type Parameters

  • TFeature extends Feature = Feature

    Represents the type of Feature instances that are handled by the store. Default type is Feature without restrictions on shape and properties.


  • UrlStore



  • Creates a new UrlStore instance. This is typically a file on the network, but can also point to the Url of a webservice which dynamically generates the data.

    The default implementation uses a GeoJsonCodec to parse the server response. If you want to support another format, you can pass another Codec.

    Type Parameters


    Returns UrlStore<TFeature>


  • get credentials(): boolean
  • Indicates whether or not credentials should be included with HTTP requests.

    Set this to true if the server requires credentials, like HTTP basic authentication headers or cookies. You should disable credentials if the server is configured to allow cross-origin requests from all domains (Access-Control-Allow-Origin=*). If the server allows CORS requests from all domains, the browser will block all requests where credentials=true.

    Once set, all subsequent HTTP requests will use the newly set value.

    The default value is false.

    Returns boolean

  • set credentials(value): void
  • Parameters

    • value: boolean

    Returns void

  • get requestHeaders(): null | HttpRequestHeaders
  • Headers to send with every HTTP request.

    An object literal that represents the headers to send with every HTTP request. The property names represent HTTP header names, the property values represent the HTTP header values. This property can be set dynamically (post-construction). Once set, all subsequent HTTP requests will use the newly set headers.

    Note that when custom headers are being sent to a server on another domain, the server will have to properly respond to pre-flight CORS requests (a HTTP OPTION request sent by the browser before doing the actual request). The server has to indicate that the header can be used in the actual request, by including it in the pre-flight's Access-Control-Allow-Headers response header.

    The default value is null.

    Returns null | HttpRequestHeaders

  • set requestHeaders(value): void
  • Parameters

    Returns void

  • get requestParameters(): null | HttpRequestParameters
  • Custom request parameters to send along with requests. The object literal can contain simple key/value pairs. Accepted values are strings, numbers and booleans. A ProgrammingError will be thrown if values of another type are used. Values must not be URL encoded.

    Assignments of other values than object literals to requestParameters will throw an Error. Clearing the parameters can be done by assigning null or an empty object literal to requestParameters. In order to trigger a refresh of the visualization on the map use layer.loadingStrategy.queryProvider.invalidate() (QueryProvider.invalidate).

    Returns null | HttpRequestParameters



  • set requestParameters(value): void
  • Parameters

    Returns void


  • Query the store for objects. The response of the server will be passed to the Store.


    • Optional query: any

      An object which represents a query which may be understood and satisfied by the store. This object is ignored by the current implementation.

    • Optional options: UrlStoreQueryOptions

      An optional object specifying options specific to this Store

    Returns Promise<Cursor<TFeature>>

    a Feature instances corresponding to the server response or a promise for that Cursor.