Class OfflineMapComponent

An additional image displayed when the user’s location is above the currently displayed level.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.aboveImage = 'marker-location-down.png';

How accurate the system (GPS) location must be before it will be displayed and used by the map, in metres.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.accuracy = 10;

The image used to display a location that is detected using BLE beacons.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.beaconImage = 'marker-location.png';

An additional image displayed when the user’s location is below the currently displayed level.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.belowImage = 'marker-location-up.png';

Parameters for a custom feed (defined in JavaScript).

var mapComp = uComps.cast.toOfflineMap(comp);
var currentParameters = mapComp.customFeedParameters;

Url of feed data from website or Umajin Cloud.

var mapComp = uComps.cast.toOfflineMap(comp);
var currentUrl = mapComp.dataUrl;

This image is placed over top of the location image, and rotated to match the compass heading of the phone.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.directionIndicator = 'marker-arrow.png';

When true, a centred cross hair is placed over the map so you can be sure where the map is centred.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.displayCrosshair = true;

If true, a text title will be displayed next to each POI.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.displayPoiTitle = true;

Draws the data used for route finding over top of the tiles. This allows you to visually confirm the correct data is available.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.displayRouteMap = true;

Id of the Umajin Cloud feed.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.feedId = 14725;

Find if there is a beacon that is currently active.

var mapComp = uComps.cast.toOfflineMap(comp);
var beaconActive = mapComp.isBeaconActive;

Find if the current location of the user is know.

var mapComp = uComps.cast.toOfflineMap(comp);
var locationKnown = mapComp.isLocationKnown;

Find if the app is currently navigating through a route.

var mapComp = uComps.cast.toOfflineMap(comp);
var activeNavigation = mapComp.isNavigationActive;

Find if there is a route currently active.

var mapComp = uComps.cast.toOfflineMap(comp);
var activeRoute = mapComp.isRouteActive;

When true, the map can not be scrolled outside the bounds as defined by the tiles.json file.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.limitDisplay = true;

The length of time, in seconds, the last location will stay visible, if beacon or GPS location dissappears. Range 1 to 60. Default is 10.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.lingerTime = 10;

The various location images will be scaled to this physical size, allowing them to adjust to different device resolutions. Range 2 to 20. Default is 5.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.locationSize = 5;

The image used to display a location set using the Set Manual Location on Map action.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.manualImage = 'marker-location.png';

Location of the map tile images.Tile images should be in numbered folders.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.mapTilesDefinition = 'Umajin/metadata.json'

When markers are set, their images will be scaled to this physical size, allowing them to adjust to different device resolutions. Range 2 to 20. Default is 5.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.markerSize = 8;

Selects if the POI image will be positioned with the location at the bottom center (in the style of a pin in the map) or centered on the location.. uComps.PoiAlignment: 1 - CENTER, 2 - CENTER_BOTTOM

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.poiAlignment = uComps.PoiAlignment.CENTER;

Color for the POI text as a hexadecimal value. The alpha channel will be added, if not included.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.poiFontColor = '#631B1B';

The font file to use for the POI text.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.poiFontFilename = 'vera.ttf';

The font size for the POI text.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.poiFontSize = 8;

The distance between text characters. Range -5 to 10. Default is 0.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.poiFontTracking = 0.5;

Defines the width to display POI images, in millimetres. Range 2 to 20. Default is 5.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.poiSize = 4;

Defines the color of the line drawn to show a route, once found.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.routeLineColor = '#f6a950';

The width in pixels of the route line. Range 1 to 50. Default is 5.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.routeLineColor = 6;

The .OSM file containing the data to be used for finding routes on the map.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.routingDataFile = 'Umajin/umajin.osm'

for Routing After trying to find a route, this will show a marker at every node (point) on the route map that was checked in the search. This allows you to find gaps in paths, by looking for nodes that are not marked when it seems they should be.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.showVisitedNodes = true;

The minimum signal level to consider the beacon “close” enough to define location. Range -120 to 0. Default is -80.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.signalThreshold = -50;

The image used to display System (GPS) location, if enabled.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.systemImage = 'marker-location.png';

This image is displayed if the beacon is not showing a close image, and has not been visited before.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.unvisitedImage = 'unvisited.png';

When true, location from GPS/wifi/cellular is displayed on the map.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.useSystemLocation = true;

This image is displayed if the beacon is not showing a close image, and has been visited before.

var mapComp = uComps.cast.toOfflineMap(comp);
mapComp.visitedImage = 'visited.png';