@plantquest/assetmap

PlantQuest is a supplier of asset mapping solutions to the Life Science sector. The industry focused PlantQuest Asset Map allows users to intergrate the PlantQuest mapping technology into their technology stack. Upon doing so, users can manipulate maps and display asset information within the context of where it is generated helping workers to make smarter, quicker and more insightful decisions. In turn, increasing their operational effeciency.

Install

npm install --save @plantquest/assetmap

Usage

Debug Log

Set window.PLANTQUEST_ASSETMAP_LOG to true to enable logging.

Options

• width: Pixel width of map
• height: Pixel height of map
• mapBounds: Pixel bounds of map
• mapStart: Pixel start position of map
• mapStartZoom: Starting zoom level
• mapRoomFocusZoom: Zoom level for room focus
• mapMaxZoom: Maximum zoom
• mapMinZoom: Minimum zoom
• states: State definitions
  • { [stateName]: { color: COLOR, name: STRING, marker: 'standard'|'alert'}, ...}
• start.map: Starting map
• start.level: Starting level
• room.color: Room highlight color

Messages

SEND MESSAGES

ZOOM

    {
      srv: 'plantquest',
      part: 'assetmap',
      ZOOM: <INTEGER>,     
    }
  

Where:
<INTEGER>: Zoom level (default: -4 to +2)

GET RELATION

    {
      srv: 'plantquest',
      part: 'assetmap',
      relate: 'room-asset',
    }
  

Listen: RELATION

SHOW ROOM

    {
      srv: 'plantquest',
      part: 'assetmap',
      show: 'room',
      room: <ROOM-ID>,     
    }
  

Where:
<ROOM-ID>: Room Identifier String

SET ASSET STATUS

    {
      srv: 'plantquest',
      part: 'assetmap',
      status: <STATUS>,
      asset: <ASSET-ID>,     
    }
  

Where:
<STATUS>: Status String ('red', 'green')
<ASSET-ID>: Asset Identifier String

LISTEN MESSAGES

STATE

    {
      srv: 'plantquest',
      part: 'assetmap',
      state: <STATE>,
    }
  

Where:
<STATE>: 'ready'

RELATION

    {
      srv: 'plantquest',
      part: 'assetmap',
      relate: 'room-asset',
      relation: <RELATION>,
    }
  

Where:
<RELATION>:

      { '<ROOM-ID>': [ '<ASSET-ID>', ... ] }
    

USER SELECT ROOM

    {
      srv: 'plantquest',
      part: 'assetmap',
      select: 'room',
      room: <ROOM-ID>,     
    }
  

Where:
<ROOM-ID>: Room Identifier String

Licenses

MIT © Plantquest Ltd BSD 2-Clause © Vladimir Agafonkin, Cloudmade MIT © Justin Manley