On this page

Type Alias AnimatedRouteLayerOptions

AnimatedRouteLayerOptions: {
    autoplay?: boolean;
    cameraAnimation?: AnimatedCameraOptions;
    delay?: number;
    duration?: number;
    easing?: EasingFunctionName;
    iterations?: number;
    manualUpdate?: boolean;
    pathStrokeAnimation?: AnimatedStrokeOptions;
} & (
    | { keyframes: Keyframe[]; source?: never }
    | { keyframes?: never; source: SourceData }
)

Configuration options for the AnimatedRouteLayer. This type supports either providing keyframes directly OR source data for the animation.

Type Declaration

  • Optionalautoplay?: boolean

    Whether the animation should autoplay

  • OptionalcameraAnimation?: AnimatedCameraOptions

    The camera animation options

  • Optionaldelay?: number

    The delay in ms before playing

  • Optionalduration?: number

    The Duration in ms

  • Optionaleasing?: EasingFunctionName

    The default easing to use if not provided in teh GeoJSON

  • Optionaliterations?: number

    The number of iterations

  • OptionalmanualUpdate?: boolean

    Whether the animation should auto matically animated or whether the frameAdvance method should be called

  • OptionalpathStrokeAnimation?: AnimatedStrokeOptions

    The stroke animation options, only viable for LineString geometries

  • { keyframes: Keyframe[]; source?: never }
    • keyframes: Keyframe[]

      The keyframes for the the animation OR

    • Optionalsource?: never
  • { keyframes?: never; source: SourceData }
    • Optionalkeyframes?: never
    • source: SourceData

      The source data

Was this helpful?
SDK JS
Reference
AnimatedRouteLayerOptions