mapillary-js/src/component/interfaces/ICacheConfiguration.ts

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

import {IComponentConfiguration} from "../../Component";

/**
 * Interface for configuration of cache depth.
 *
 * @interface
 * @example
 * ```
 * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
 *     {
 *         component: {
 *             cache: {
 *                 depth: {
 *                     pano: 2,
 *                     sequence: 3,
 *                 }
 *             },
 *         },
 *     })
 * ```
 */
export interface ICacheDepth {
    /**
     * Cache depth in the sequence directions.
     *
     * @description Max value is 4. Value will be coerced
     * to the interval [0, 4].
     * @default 2
     */
    sequence: number;

    /**
     * Cache depth in the pano direction.
     *
     * @description Max value is 2. Value will be coerced
     * to the interval [0, 2].
     * @default 1
     */
    pano: number;

    /**
     * Cache depth in the step directions.
     *
     * @description Max value is 3. Value will be coerced
     * to the interval [0, 3].
     * @default 1
     */
    step: number;

    /**
     * Cache depth in the turn directions.
     *
     * @description Max value is 1. Value will be coerced
     * to the interval [0, 1].
     * @default 0
     */
    turn: number;
}

/**
 * Interface for configuration of cache component.
 *
 * @interface
 */
export interface ICacheConfiguration extends IComponentConfiguration {
    /**
     * Cache depth struct.
     */
    depth?: ICacheDepth;
}

export default ICacheConfiguration;