TomTom Maps for JavaScript
    Preparing search index...

    Class TomTomMapError

    A failure of a TomTomMap, named by its SDKErrorCode.

    • The constructor throws one with WEBGL_UNSUPPORTED when the browser cannot create a WebGL2 context, or INSECURE_BASE_URL when commonBaseURL is neither https: nor http: on a loopback address.
    • Every failure after construction reaches the handlers TomTomMap.addErrorHandler registers. These are a style, tile, sprite or glyph that failed to load, a plugin's data that failed to load, such as the Landmarks 3D tiles, and a lost WebGL context. TomTomMap.setStyle also rejects with a style that fails to load, and so do module creation and the module calls that wait for the map, until a later switch loads a style.
    map.addErrorHandler((error) => {
      if (error.code === 'INVALID_CREDENTIALS') showMessage('The map could not load: check the API key');
      else if (error.privatePreviewAccess) showMessage(`Request access to ${error.privatePreviewAccess.product}: ${error.privatePreviewAccess.requestAccessURL}`);
      else if (error.apiErrorCode === 'InvalidReferer') showMessage('The map could not load: add this domain to the API key');
      else if (error.code === 'INSUFFICIENT_PERMISSIONS') showMessage('The map could not load: check the APIs the key allows');
    });

    Hierarchy

    • Error
      • TomTomMapError

    Implements

    Index
    constructor
    apiErrorCode? canRetry cause? code message name privatePreviewAccess? sdkVersion sourceId? stack? status? stackTraceLimit
    captureStackTrace isError prepareStackTrace

    • Parameters

      • message: string
      • options: APIErrorDetails & {
            cause?: unknown;
            code:
                | "INVALID_REQUEST"
                | "INSECURE_BASE_URL"
                | "INVALID_CREDENTIALS"
                | "INSUFFICIENT_PERMISSIONS"
                | "NOT_FOUND"
                | "RATE_LIMITED"
                | "LIVE_SERVICE_NOT_AVAILABLE"
                | "NETWORK_NOT_AVAILABLE"
                | "ABORTED"
                | "WEBGL_UNSUPPORTED"
                | "WEBGL_CONTEXT_LOST"
                | "STYLE_LOAD_FAILED"
                | "INTERNAL";
            sourceId?: string;
            status?: number;
        }

      Returns TomTomMapError

    apiErrorCode?: string

    The API's own name for the error, from its detailedError.code, when its response carries one.

    On an INSUFFICIENT_PERMISSIONS it tells the causes apart: 'Forbidden' when the API is not enabled for the key, 'InvalidReferer' when the key's domain restriction refused the page.

    canRetry: boolean

    Whether the condition clears on its own, so the map is likely to load later: true for RATE_LIMITED, LIVE_SERVICE_NOT_AVAILABLE and NETWORK_NOT_AVAILABLE.

    cause?: unknown
    code:
        | "INVALID_REQUEST"
        | "INSECURE_BASE_URL"
        | "INVALID_CREDENTIALS"
        | "INSUFFICIENT_PERMISSIONS"
        | "NOT_FOUND"
        | "RATE_LIMITED"
        | "LIVE_SERVICE_NOT_AVAILABLE"
        | "NETWORK_NOT_AVAILABLE"
        | "ABORTED"
        | "WEBGL_UNSUPPORTED"
        | "WEBGL_CONTEXT_LOST"
        | "STYLE_LOAD_FAILED"
        | "INTERNAL"

    What went wrong. Branch on it, not on the message.

    message: string
    name: string
    privatePreviewAccess?: PrivatePreviewAccess

    The access the API key lacks, on an INSUFFICIENT_PERMISSIONS from a Private Preview API, such as Calculate Reachable Range or the Landmarks 3D tiles, that named no other cause. The message names it too.

    sdkVersion: string = __SDK_VERSION__

    The version of the SDK that raised the error, for bug reports.

    sourceId?: string

    The map source whose tiles or data failed to load, when the failure was one of a source's.

    stack?: string
    status?: number

    The HTTP status of the request that failed, when a response came back.

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods