Interface MapViewLoadConfig

Aegir Map load configuration

Hierarchy

  • MapViewLoadConfig

Properties

accessToken?: string

Mapbox access token. Required when useDefaultMapProvider is true.

artTilesetURL?: string

Specify a custom location for your venue's artistic map tiles.

buildingOutlines?: string

Specify a custom location for your venue's building outlines vector tiles

commonTilesetURL?: string

Specify a custom location for your venue's icon/label vector tiles

controlsPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right"

specify the position to add map controls. Valid values are "top-left", "top-right" , "bottom-left" , "bottom-right". Defaults to "top-right".

mapContainerId: string | HTMLElement

Dynamic variable for changing the id of the root div that the venue is rendered into

mapGlyphsURL?: string

URL pointing to font glyph files (in proto-buff format)

mapProviderType?: MapProviderType

Since

2.1 the map type provider, used to create the corresponding subfolder structure in the most recent directory layout

mapSpritesURL?: string

URL pointint to the spritemap files for icons and textures that are referenced in your map view.

rasterBuildingOutlinesURL?: string

Specify a custom location for your venue's building outlines raster tiles

rasterTilesetURL?: string

Specify a custom location for your venue's raster map tiles.

showCompassControls?: boolean

Add map controls that show the compass. Defaults to false.

showZoomControls?: boolean

Adds map controls for zooming in and out. Defaults to false.

streetMapJSON?: string

Mapbox style for world/street map tiles. Required when useDefaultMapProvider is true.

streetMapURL?: string

Mapbox vector tiles source url for world/street map tiles. Required when useDefaultMapProvider is true.

tilesetURL?: string

Specify a custom location for your venue's vector tiles

useDefaultMapProvider?: boolean

True to use the embedded Mapbox map provider or false to use a custom map (or none) map provider, e.g. Google maps

useLegacyBuildingTileURL?: boolean

Adds legacy support for building tiles that were dumped into a single directory instead of individual bulding directories.

venueBaseURL?: string

Base url for all venue map data files for a specific venue.

version?: string

Since

2.1 the corresponding application version number, used to determine wether we need a new directory layout or the old one

Deprecated

VMD version should be used

Generated using TypeDoc