Wayfinder Settings Class

background

property (r)

An object containing: { color : {r, g, b}, url: '' }

destinations

property (r)

An object containing the default hover and selected destination colours:

{ hover: {r, g, b}, selected: {r, g, b} }

icons

property (r)

An object containing icon (eg: amenity) size information:

{ scale, minSize, maxSize, inFrontOfFloatingLabels, combineWithFloatingLabels, transitIconsHavePriority, fadeTime, overlapMargin }

idleMapAngle

property (r)

float: Map rotational angle to use at the start

idleMapTilt

property (r)

float: Map tilt to use at the start and after routes are cleared

inPerspectiveMode

property (r)

bool: set to true if the map should start in perspective mode

labels

property (r)

How labels should appear on the map:

{ style : { fontName, sizeInPx, alignment, weight },
color : { r, g, b },
hover : { r, g, b },
selected : { r, g, b },
shadowColor : { r, g, b },
shadowHover : { r, g, b },
shadowSelected : { r, g, b },
shadowDistance,
shadowSize,
float: {
    enabled,
    font: { name, size, weight, alignment },
    overlapMargin,
    stopAfterClashCount,
    prioritizeByLabelSize,
    centerOnLabel,
    showLabelOnFlagship,
    dots : { enabled, color, shadow, useLabelColor, shadowSize, shadowDistance }}}

language

property (r/w)

string: The current language being used by the wayfinder.

mapLighting

property (r)

Lighting rules for the 3D render:

{ light1 : { position, lookat, color, strength, castshadow },
    light2 : { position, lookat, color, strength, castshadow },
    ambient : { color: { r, g, b } },
    hemisphere : { groundcolor: { r, g, b }, skycolor: { r, g, b }, strength }, yahPoint : {
        color: { r : 0x22, g : 0x22, b : 0x22 },
        exp, linear, zposition, strength },
    rotateLights, enableSpecular, shadowBias }

maxZoomLevel

property (r)

float: Max zoom property (same as kiosk)

mapScaleFactor

property(r)

float: a number to convert coordinates into meters. You should not need to use this

positionChangeTime

property(r)

integer: Number of milliseconds defining the camera movement duration.

renderShadows

property (r)

bool: If shadows will be rendered on the map

routeAnimation

property (r)

How the route line should be drawn:

{ color, color2, size, yPosition }

routeMapTilt

property (r)

float: Map tilt to use while route is active (default)

routeByDistance

property(r)

bool: If routes generated are by shortest distance (true) or quickest time (false) - this can be overridden when requesting a route

scaleChangeTime

property (r)

integer: Number of milliseconds to change map scale while loading (animation)

screenPadding

property (r)

integer: Pixel border size to fit bounds within

shouldZoomToRoute

property (r)

bool: If when routing, the map should zoom to fit the route

startingFloorId

property (r)

integer: The primary map to show

timezone

property (r)

string: The timezone of the destination of the project

transitionTime

property (r)

integer: Time taken by default for all animations

transitPopup

property (r)

How popups should appear advising how to change to another floor/map:

{ font : { fontName, sizeInPx, weight },
colors : { background: { r, g, b }, text: { r, g, b }, border: { r, g, b }, arrow: { r, g, b }, shadow: { r, g, b },
}, borderRadius, borderWidth, shadowSize, shadowDistanceX, shadowDistanceY, shadowAlpha }

useAntialiasing

property (r)

bool: If antialiasing is enabled during render

useLowerQuality

property (r)

bool: If lower quality (less resource intensive) methods should be used.