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

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

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

/**
 * Interface for configuration of sequence component.
 *
 * @interface
 * @example
 * ```
 * var viewer = new Mapillary.Viewer('<element-id>', '<client-id>', '<image-key>',
 *     {
 *         component: {
 *             sequence: {
 *                 minWidth: 40,
 *                 maxWidth: 80,
 *                 visible: false,
 *             },
 *         },
 *     })
 * ```
 */
export interface ISequenceConfiguration extends IComponentConfiguration {
    /**
     * Set the direction to follow when playing.
     *
     * @default EdgeDirection.Next
     */
    direction?: EdgeDirection;

    /**
     * The node key representing the direction arrow to be highlighted.
     *
     * @description When set to null no direction will be highlighted.
     *
     * @default undefined
     */
    highlightKey?: string;

    /**
     * The max width of the sequence container.
     *
     * @description If the min width is larger than the max width the
     * min width value will be used.
     * @default 117
     */
    maxWidth?: number;

    /**
     * The min width of the sequence container.
     *
     * @description If the min width is larger than the max width the
     * min width value will be used.
     * @default 70
     */
    minWidth?: number;

    /**
     * Indicating wheter the component is playing.
     *
     * @default false
     */
    playing?: boolean;

    /**
     * Determine if the component should be visible.
     *
     * @default true
     */
    visible?: boolean;
}

export default ISequenceConfiguration;