Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface TokenPanningOptions

    interface TokenPanningOptions {
        duration?: number;
        easing?: string | Function;
        force?: boolean;
        speed?: number;
        transitionType?: string;
    }
    Index

    Properties

    duration?: number

    The duration of the pan or transition animation. Default: 250 for panning or the default duration of the given transition type.

    easing?: string | Function

    The easing function used for the panning animation. Default: "easeInOutCosine".

    force?: boolean

    If false, the canvas is not panned to the token if the token is already onscreen. Otherwise the canvas is panned such that the token is in the center of the screen. Default: false.

    speed?: number

    The speed of the panning animation in pixels per second; overrides duration if set.

    transitionType?: string

    The type of the transition animation. Default: null (no transition animation).