UI Configuration
- Example

UI Configuration

The OrbitFlashMapUIConfig.xml file defines how FlashMap is presented to the user.

Some toolbar buttons appear automatically, depending on the configuration :

If a selection layer is defined, the select mode button and properties button will appear automatically.
If a hyperlink layer is defined, the hyperlink mode button will appear automatically.
If a maptip layer is defined, the select mode button will appear automatically.

Example

<?xml version="1.0" encoding="UTF-8"?>
<OrbitFlashMapUIConfigs>
 
   <TotalWidth>600</TotalWidth>
   <TotalHeight>500</TotalHeight>
   <ToolbarStyle>consumer</ToolbarStyle/>
   <StartupMode>smartzoom</StartupMode>
 
   <HasZoomNavigation>false</HasZoomNavigation>
   <HasFocus>false</HasFocus>
   <HasLayers>false</HasLayers>
   <ShowLocation>false</ShowLocation>
   <ShowScalebar>true</ShowScalebar>
   <ShowScaledisplay>true</ShowScaledisplay>
   <HasMeasure>false</HasMeasure>
   <HasSubselect>true</HasSubselect>
 
   <UnitDescription>
     <System>
       <Abbr>yd</Abbr>
       <Name>yards</Name>
     </System>
     <SubUnit>
       <SysUnits>5280</SysUnits>
       <Abbr>ml</Abbr>
       <Name>miles</Name>
     </SubUnit>
   </UnitDescription>
 
   <Watermark>
      <Transparent>watermark.png</Transparent>
      <NonTransparent>watermark-nontransparent.jpg</NonTransparent>
   </Watermark>
 
   <OFMParameters>
      <Parameter>
         <Name>ShowActiveCentroid</Name>
         <Value>true</Value>
      </Parameter>
   </OFMParameters>
 
</OrbitFlashMapUIConfigs>

Tag overview :

Parameter	Comment	Default value
TotalWidth	Defines the total width the component can use.	<available width> ¹⁾
TotalHeight	Defines the total height the component can use.	<available height>
ToolbarStyle	Defines the default setup of the toolbar. Its possible values are prof, consumer, toolbarless or decorationless.	prof
HasZoomNavigation	Defines whether buttons for navigating zooms are available (zoom previous, zoom next).	true
HasFocus	Defines whether focus behavior is available.	false
HasLayers	Defines whether the user can access the list of layers and change layer visibility.	false
ShowLocation	Defines whether a map overlay is added, displaying the current location.	true
ShowScalebar	Defines whether a map overlay is added, displaying a scale bar.	true
ShowScaledisplay	Defines whether a map overlay is added, displaying a scale display.	false
HasMeasure	Defines whether a measurement utility is available.	false
HasSubquery	Defines whether the subselect mode button is added, when map configuration defines a selection layer.	false
StartupMode	Defines the mode FlashMap should be in after startup.	zoomin
UnitDescription	Defines how to describe map units.	english description of metric units
Watermark	Defines where to look for the watermarking images.	no watermark
OFMParameters	Defines additional parameters to tweak OFM layout and functionality.	no parameters

All UI configuration can also be set using FlashVars. If you do so, keep in mind they will override any other setting.
Metal skin only supports HasFocus, HasLayers, ShowLocation, ShowScalebar, ShowScaledisplay parameters. Its size is fixed at 570×487 px.
Configuration parameters are case sensitive!
Note: FlashMap 4.0 and 4.1 used the LAYOUT FlashVar instead of UICONFIG.

¹⁾

Flash parameter scale must be set to noscale

Table of Contents

UI Configuration

Example