Options
All
  • Public
  • Public/Protected
  • All
Menu

A PanoramaModel that understands the LuciadFusion panorama feature structure and images location.

Example usage:

since

2020.1

Hierarchy

Implements

  • {}

Overview

Constructors

constructor

Accessors

baseURL

  • get baseURL(): string
  • set baseURL(val: string): void
  • The base URL configures the location of the panoramic image server. See getPanoramicImageURL for details on how the base URL is used to construct actual image URLs.

    Returns string

  • The base URL configures the location of the panoramic image server. See getPanoramicImageURL for details on how the base URL is used to construct actual image URLs.

    Parameters

    • val: string

    Returns any

credentials

  • get credentials(): boolean
  • set credentials(credentials: boolean): void

requestHeaders

  • get requestHeaders(): {} | null
  • set requestHeaders(requestHeaders: {} | null): void

requestParameters

  • get requestParameters(): {} | null
  • set requestParameters(value: {} | null): void
  • Custom request parameters to send along with panoramic requests. The object literal can contain simple key/value pairs. Accepted values are strings, numbers and booleans. 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, can call invalidate.

    since

    2021.0

    Returns {} | null

  • Custom request parameters to send along with panoramic requests. The object literal can contain simple key/value pairs. Accepted values are strings, numbers and booleans. 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, can call invalidate.

    since

    2021.0

    Parameters

    • value: {} | null

    Returns any

subdomains

  • get subdomains(): string[]
  • set subdomains(subdomains: string[]): void
  • getPanoramicImageURL will replace the {s} pattern in baseURL with values from subdomains. This will cause tile requests to be spread across different subdomains. Browsers limit the amount of connections to a single domain. Using subdomains avoids hitting this limit.

    The subdomains array cannot be empty if the model's baseURL contains the {s} subdomain hook.

    Returns string[]

  • getPanoramicImageURL will replace the {s} pattern in baseURL with values from subdomains. This will cause tile requests to be spread across different subdomains. Browsers limit the amount of connections to a single domain. Using subdomains avoids hitting this limit.

    The subdomains array cannot be empty if the model's baseURL contains the {s} subdomain hook.

    Parameters

    • subdomains: string[]

    Returns any

Methods

getPanoramaDescriptor

getPanoramicImage

getPanoramicImageURL

replaceURLPatterns

  • Replaces patterns in the given URL.

    By default, it will replace {x}, {y}, {z}, {face} and {id} with the values of request.x, request.y, request.level, request.face (mapped) and feature.id respectively. Additionally, it will replace {context.*} with a corresponding property on your context object.

    It is not uncommon that the tile rows are seem to be reversed in the visualisation. This means that the Y-axis in the tile coordinate system of the tile service is reversed with respect to the tile coordinate system used by LuciadRIA. You can use the {-y} placeholder in the baseURL to compensate for this.

    If the URL contains the {s} subdomains hook, replaceURLPatterns will replace the hook with one of the values of subdomains.

    Parameters

    • urlWithPatterns: string

      The URL that contains the patterns to replace.

    • request: PanoramicImageTileRequest

      The request for the panoramic image

    Returns string | null

    The URL with its patterns replaced, or null if no replacement could be made. This can happen when the URL is null, or no panorama descriptor could be found for the request (getPanoramaDescriptor returns null).

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