mapillary-js/src/api/interfaces/IFalcorDataProviderOptions.ts

WebGL JavaScript library for displaying street level imagery from mapillary.com

import ModelCreator from "../ModelCreator";

/**
 * Interface for the options that can be provided to the {@link FalcorDataProvider}.
 *
 * @interface IFalcorDataProviderOptions
 */
export interface IFalcorDataProviderOptions {
    /**
     * API v3 host.
     *
     * @description Used for calling the API for image data.
     *
     * @default {"a.mapillary.com"}
     */
    apiHost?: string;

    /**
     * Client token for API requests.
     */
    clientToken: string;

    /**
     * Cluster reconstruction host.
     *
     * @description Used for retrieving the cluster reconstructions
     * for showing point clouds.
     *
     * @default {"cluster-reconstructions.mapillary.com"}
     */
    clusterReconstructionHost?: string;

    /**
     * Optional model creator instance.
     */
    creator?: ModelCreator;

    /**
     * Image host.
     *
     * @description Used for retrieving image thumbnails.
     *
     * @default {"images.mapillary.com"}
     */
    imageHost?: string;

    /**
     * Image tile host.
     *
     * @description Used for retrieving high resolution
     * image tiles when zooming.
     *
     * @default {"loris.mapillary.com"}
     */
    imageTileHost?: string;

    /**
     * Mesh host.
     *
     * @description Used for retriving a 3D mesh for
     * each image.
     *
     * @default {"meshes.mapillary.com"}
     */
    meshHost?: string;

    /**
     * Scheme.
     *
     * @description Used for all hosts.
     *
     * @default {"https"}
     */
    scheme?: string;

    /**
     * Optional OAuth user token for API requests of
     * protected resources.
     */
    userToken?: string;
}

export default IFalcorDataProviderOptions;