Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PanoramaModelConstructorOptions

Options for the PanoramaModel constructor.

since

2020.1

Hierarchy

Overview

Properties

baseURL

baseURL: string

The base URL for this PanoramaModel. See PanoramaModel.getPanoramicImageURL for details on how this value is used.

If you don't want to fetch images from URL's, but want to implement your own image loading in getPanoramicImage, you can set this to any string of choice. It is only used in getPanoramicImage, so if you replace that with a custom implementation, you can ignore the result of getPanoramicImageURL.

Optional credentials

credentials: boolean

Whether credentials should be included with every HTTP request.

Optional facePatternMap

facePatternMap: Map<CubeMapFace, string>

A mapping of CubeMapFace to strings to be used by the {face} URL pattern. By default, the following mapping will be used:

new Map([
  [CubeMapFace.FRONT, "front"],
  [CubeMapFace.BACK, "back"],
  [CubeMapFace.LEFT, "left"],
  [CubeMapFace.RIGHT, "right"],
  [CubeMapFace.TOP, "top"],
  [CubeMapFace.BOTTOM, "bottom"],
]);

panoramaDescriptor

Describes type and tileset structure used by panoramas in this model.

By default, this descriptor is used for all panoramas in the model. If your layer contains panoramas of varying types or tileset structures, you should override PanoramaModel.getPanoramaDescriptor

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

Optional subdomains

subdomains: string[]

When specified, PanoramaModel.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. By default, it's an empty array.

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