Map Enquiry

The Map Enquiry module displays facility data using site maps and building floor plans.

Map Enquiry Settings

Launch URL

The URL used to launch Map Enquiry may include the following querystring parameters to specify its initial display:

stylethe GUI style to use for the remainder of the session, as the name of a GUI style folder (see Custom Files below), or default to return to the default.
mapthe name of a site map or building floor plan to be displayed. If specified, loc_code is ignored.
loc_code a comma separated list of location codes specifying:
  • a site or floor plan to display; or
  • a list of buildings or rooms to highlight on a single plan specified by the first code; or
  • two or more floor plans to display, when querystring parameters other than colourtheme, themevalues and layers are ignored.
site_id
data_type
bl_id
build_no
fl_id
rm_id
Site, facility type, building (code or number), floor, room IDs to specify a site or floor plan to display with optional building or room highlight. Ignored if the map or loc_code parameter is present.
BIM if set, the Building Information Model is displayed for the building specified by the loc_code parameter:
  • true - loc_code.x3d is displayed.
  • subset - loc_code-subset.x3d is displayed instead if it exists. This can be used to display subsets of the full model.
projectionone of SW SE NE NW to specify that isometric projection.
skewDimetric projection angle in degrees, default 15 for SW NE and -15 for SE NW isometric projection.
zoomtrue (default) or false to specify whether zoom occurs when loc_code specifies a building/room.
layerscomma separated list of names of layers to turn on, or if preceded by "-" to turn off.
colourthemefield name of colour theme to turn on, matching a colour MapTheme field, but with prefix rm. for room fields. Use colourtheme=none to specify no colour theme.
themevaluescomma-separated list of values to restrict a colourtheme (as used in MapLegend settings, excluding value ranges).
lat
lon
the approximate latitude and longitude in degrees of a position, if MapGPSUnit is set to LatLonDeg, otherwise
e
n
the easting and northing of a position.
rotationthe initial plan rotation in clockwise degrees.
radiusthe radius in metres to be displayed about the position, if omitted the whole plan is displayed.
iconUrlposition marker icon - a gif, jpeg, jpg or png URL relative to the mapEnquiry subfolder of the web application, if omitted the Locator pin icon is used, if invalid no icon is shown.
iconScaleposition marker icon scale factor, default 1.
mode module usage mode:
  • mode=simple for the Space Manager module's embedded maps, to omit the information panel.
  • mode=peoplespace for the People Manager module's Available Space screen.
  • mode=wb for the Workstation Bookings module.
viewpointlayer
viewpointwhere
Replace the SQL where clause of View Points layer viewpointlayer by viewpointwhere. Only one View Points layer can be modified. The validity of the SQL where clause is not checked. The URL encoded value %27 must be used to represent the single quote character. Example (using the supplied test data):
  • viewpointlayer=View Points
  • viewpointwhere=map_name=%27MLsite%27 AND icon=%27Camera.gif%27
footprint display site plan footprint:
  • footprint=owner|bu_id[|dv_id[|dp_id]] for bu/db/dp ownership.
  • footprint=class|rm_cat[|rm_type]] for rmcat/rmtype classification.
option display using option:
  • option=FindWay to show the Find Way dialog.
  • option=FeatureLayer to show the link layer with name specified by param.
paramas required by the option parameter.

For example, the following URL can be used to launch Map Enquiry showing the site with code ML with the "Buildings" link layer displayed:

http://servername/SISfm/mapEnquiry?map=MLsite&option=FeatureLayer&param=View+Points

Custom Files

In addition to configuration settings, the following files in the custom folder are accessed:

STYLE

mapEnquiry\menuIcons\Name.gif Folder of top menu icons, one for each Name in the MapTopMenuButtons setting). If this folder exists, all required icons must be present.
mapEnquiry\compass.png Compass image, to appear on plans. Optional. See style class compass below.
mapEnquiry\feature.gif The Features menu button icon for a feature layer.
mapEnquiry\featureFolderClosed.gif The Features menu button icon for a folder when closed.
mapEnquiry\featureFolderOpen.gif The Features menu button icon for a folder when open.
mapEnquiry\logo.gif Logo for inclusion in top menu. Optional.
mapEnquiry\logoFull.gif Logo for inclusion in title page of help page when printed.
mapEnquiry\logoHelp.jpg Logo for help page header.
mapEnquiry\map.css Style sheet (see below).

Alternative versions of these files, plus infoPanel.css, may be placed in one or more GUI style subfolders, specified by the style querystring parameter (see Launch URL above). An example subfolder named classic is supplied.

MISCELLANEOUS

mapEnquiry\infoPanel.css Style sheet (see below).
mapEnquiry\drawPointIcons\ Folder of *.gif,jpg,png image files for the drawing tools point symbol selector. These are drawn centred.
mapEnquiry\apple-touch-icon.png Device home screen bookmark icon. Optional.
mapEnquiry\arriving.mp3 Sound to play when arriving at a route destination (see the MapRouteDestMargin setting).
mapEnquiry\home.aspx Home page.
mapEnquiry\homeHelp.aspx Home page help, included in the help page. Optional.
mapEnquiry\hpattern.svg Hatch patterns, based on the Archibus file \archibus\WEB-INF\config\context\controls\drawing\hpattern.svg. Optional if hatch patterns are not in use.
mapEnquiry\point.aspx Point feature details page, with hearsay function.
mapEnquiry\popupFloor.aspx Hints popup content for floor plans. Used unless MapDialogHintsDisable is TRUE.
mapEnquiry\popupSite.aspx Hints popup content for site plans. Used unless MapDialogHintsDisable is TRUE.
mapEnquiry\print.svg
mapEnquiry\print2.svg
etc.
Additional graphics to include in prints. To create this file:
  1. Create a Cadcorp SWD with a single overlay containing the required graphics at an arbitrary size, in a cartesian coordinate system such as Paper.
  2. Save this SWD with view extents corresponding to the print, at the same aspect ratio as MapPrintSize.
  3. Temporarily replace a site SWD with this one and use Map Compiler to compile that site.
  4. Copy the resulting SVG to mapEnquiry\print.svg.
  5. If the SVG contains references to image files:
    • copy these image files be be alongside mapEnquiry\print.svg and rename them suitably.
    • edit the SVG to update image file names.
    • edit the SVG to move <image> element lines higher if they obscure other elements.
  6. Restore the site SWD and use Map Compiler to compile that site.

Home page behaviour can be modified using the MapHomeNoMenu setting.

Home page script variables homePageOption and homePageParam may be set as the option and param querystring parameters to be used by the home page site selector.

Style Sheets

Custom file mapEnquiry\infoPanel.css specifies the appearance of the Map Enquiry information panel, using the following classes:

infoPanelDiv The <div> element containing the infoPanelFrame element (this must provide a way for the user to select it for resizing).
infoPanelFrame The <iframe> element containing the information panel.
infoPanelMenuTable The <table> element containing the information panel menu (see MapInfoPanelMenu setting).
infoPanelMenuItem The <td> elements containing the information panel menu items (Site, Building, Floor, Room, Person, Asset, BIM).
accordionButton The <input> accordion button elements (Site, Building, Floor, Room, Person, Asset, BIM).
subSectionTitleBar The <td> sub-section title bar elements (e.g. Building, Floor).
subSectionButton The <input> sub-section expand button elements.

Custom file mapEnquiry\map.css specifies the appearance of the top menu, side menu and popup menu, using the following classes:

compass The compass <img> element.
topMenu The top menu enclosing <div> element.
topMenuLogo The top menu logo <img> element.
topMenuButton The top menu <button> elements.
topMenuButtonImage The top menu button <img> elements.
topMenuSearchBox The top menu search box <input> element.
popMenu The popup menu enclosing <div> element.
popMenuButtonTop The popup menu top <button> element.
popMenuButton The popup menu intermediate <button> elements.
popMenuButtonSelected The popup menu intermediate <button> elements when selected.
popMenuButtonBottom The popup menu bottom <button> element.
sideMenu The side menu enclosing <div> element.
sideMenuButtonTop The side menu top <button> element.
sideMenuButton The side menu intermediate <button> elements.
sideMenuButtonSelected The side menu intermediate <button> elements when selected.
sideMenuButtonBottom The side menu bottom <button> element.
featuresMenuButton1 The popup or side Features menu <button> elements, at folder tree level 1.
featuresMenuButton1Selected The popup or side Features menu <button> elements when selected, at folder tree level 1.
featuresMenuButton1FolderClosed The popup or side Features menu <button> elements for folders when closed, at folder tree level 1.
featuresMenuButton1FolderOpen The popup or side Features menu <button> elements for folders when open, at folder tree level 1.
featuresMenuButton2
featuresMenuButton2Selected
featuresMenuButton2FolderClosed
featuresMenuButton2FolderOpen
As above, at folder tree level 2, etc.
featuresMenuButtonImage The popup or side Features menu intermediate button <img> elements.
featuresMenuBIMStructureListRoot The BIM Features menu Structure root <ul> element.
featuresMenuBIMStructureList The BIM Features menu Structure list <ul> elements.
featuresMenuBIMStructureFolderOpen The BIM Features menu Structure folder <li> elements when open.
featuresMenuBIMStructureFolderClosed The BIM Features menu Structure folder<li> elements when closed.
featuresMenuBIMStructureItem The BIM Features menu Structure item <li> elements.

If side menu classes are not defined, the equivalent popup menu classes are used.

If the featuresMenuButton1 class is not defined, the Features menus will not include the folder tree feature.

If the featuresMenuButtonImage class specifies display:none, Features menu folder tree button images will not be shown.

Additional classes may be used to specify the appearance of:

Examples are provided in comments in the supplied mapEnquiry\map.css. Menu names are defined in mapEnquiry\js\map.js.

Reports

Selecting the Reports icon displays a list of reports from the Report Maker module whose AVW files are in a subfolder whose name contains "Map Enquiry".

Web Storage

Web Storage (the successor to cookies) is used to persist the following between browser sessions (unless MapNoWebStorage is in effect):

Browser Compatibility

The following chart indicates browser support for functions not available for all browsers:

Edge Chrome Firefox iOS ** Android *
Print
Load layer on demand

** all browsers use the iOS browser engine, regardless of supplier.

* only the native Android browser is tested.