Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IViewerOptions

Interface for the options that can be provided to the viewer.

interface

Hierarchy

  • IViewerOptions

Index

Properties

Optional attribution

attribution: boolean

Show attribution

default

true

Optional background

background: boolean

Display a background if no key is set.

default

false

Optional baseImageSize

baseImageSize: ImageSize

Default size of the thumbnail used in the viewer

default

{ImageSize.Size640}

Optional basePanoramaSize

basePanoramaSize: ImageSize

Default size of the thumbnail used for panoramas in the viewer

default

{ImageSize.Size2048}

Optional bearing

bearing: boolean

Show indicator for panoramas.

default

true

Optional cache

cache: boolean

Cache images ahead.

default

true

Optional cover

cover: boolean

Use a cover and avoid loading initial data from Mapillary.

default

true

Optional debug

debug: boolean

Show debug interface.

default

false

Optional detection

detection: boolean

Show detection rectangles in images

default

false

Optional direction

direction: boolean

Show direction arrows for navigation.

default

true

Optional image

image: boolean

Show static images without transitions.

default

false

Optional imageplane

imageplane: boolean

Show image planes in 3D using WebGL.

default

true

Optional keyboard

keyboard: boolean

Enable use of keyboard commands.

default

true

Optional loading

loading: boolean

Show indication of loading.

default

true

Optional marker

marker: boolean

Enable an interface for showing markers in the viewer

default

false

Optional maxImageSize

maxImageSize: ImageSize

The max size of an image shown in the viewer will be used when user pauses.

default

{ImageSize.Size2048}

Optional mouse

mouse: boolean

Enable mouse interface (needed for panorama navigation)

default

true

Optional navigation

navigation: boolean

Show static navigation arrows in the corners.

default

false

Optional renderMode

renderMode: RenderMode

The render mode in the viewer.

default

{RenderMode.Letterbox}

Optional route

route: boolean

Create a route with a story inside mapillary js

default

false

Optional sequence

sequence: boolean

Show sequence related navigation.

default

true

Optional slider

slider: boolean

Show a slider for transitioning between image planes.

default

false

Optional sprite

sprite: string

A base URL for retrieving a png sprite image and json metadata file. File name extensions will be automatically appended.

Optional tag

tag: boolean

Show detection rectangles in images

default

false

Generated using TypeDoc