Options
All
  • Public
  • Public/Protected
  • All
Menu

EnvironmentMapImagery that supports equirectangular images. The width:height ratio is expected to be 2:1 for this type of imagery.

Use this class if you want to load the image (or URL) yourself.

You can use createEquirectangularImagery to create EquirectangularImagery with a URL.

since

2021.1

Hierarchy

Overview

Constructors

Accessors

Methods

Constructors

Protected constructor

Accessors

credentials

  • get credentials(): boolean
  • set credentials(credentials: boolean): void
  • 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 if the server is configured to allow cross-origin requests from all domains (Acces-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.

    see

    HttpRequestOptions.credentials

    Returns 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 if the server is configured to allow cross-origin requests from all domains (Acces-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.

    see

    HttpRequestOptions.credentials

    Parameters

    • credentials: boolean

    Returns any

requestHeaders

  • get requestHeaders(): {} | null
  • set requestHeaders(requestHeaders: {} | null): void
  • 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.

    see

    HttpRequestOptions.requestHeaders

    Returns {} | null

  • 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.

    see

    HttpRequestOptions.requestHeaders

    Parameters

    • requestHeaders: {} | null

    Returns any

type

Methods

Abstract getImage

  • (onSuccess: (image: string | HTMLImageElement | HTMLCanvasElement) => void, onError: (error?: Error) => void): void
  • Load the image or URL.

    Parameters

    • onSuccess: (image: string | HTMLImageElement | HTMLCanvasElement) => void

      the callback function that should be invoked when the image or URL was successfully loaded. The function will receive the image object or an URL.

        • (image: string | HTMLImageElement | HTMLCanvasElement): void
        • Parameters

          • image: string | HTMLImageElement | HTMLCanvasElement

          Returns void

    • onError: (error?: Error) => void

      the callback function that should be invoked when the image or URL could not be loaded. The function will receive an optional Error object.

        • Parameters

          Returns void

    Returns void

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