Table of Contents

OFM Parameters

During development, some internal parameters were added to OFM to make it more adaptable to different environments. This page documents these parameters.

You can specify these parameters using the setOFMParameter() function of the public interface or using the UI configuration file OFMParameters tag.

Although you can set parameters using the public interface, we encourage you strongly to use the UI configuration file OFMParameters tag (documented further on).
This way, the parameters can be applied earlier, without having to waiting for the public interface to become available. Waiting for the public interface to become available can result in problems (CustomizeCursor is one example where the custom mouse cursor does get rendered for a short while when setting it to false using the public interface function).
Parameter name Value type Comment
CustomizeCursor Boolean Use this setting to set whether OFM should render it's own mouse-cursor when hovering the map. This can be necessary if you want to provide application-wide cursors. You can use the mode listener to be notified of any changes in OFM's map mode.
MeasureLineWidth Number Use this setting to override the default measure line width.
MeasureLineColor Color Use this setting to override the default measure color. Example value : 0xFFFF00
ShowMeasurePanel Boolean Use this setting to show the measure panel.
ShowPropertiesPanel Boolean Use this setting to set if OFM automatically opens the properties panel, when a selection occurs.
ShowLayersPanel Boolean Use this setting to show the layers panel.
* PanClickMode String Use this setting to define the course of action when the user clicks the map in panning mode. Allowed values are 'pan' or 'query'
* ImageFormat String Use this setting to override the default image type used for requests. By default OFM uses a custom swf based image compression. Using gif on vector-based datasets often yields higher quality although it is slower.
* MeasureLineAlpha Number Sets alpha transparency used when rendering the measure line.
* SkipFirstView Boolean Skips loading the first view.
* TooltipModes String This setting can be used to add modes in which OFM will also request tooltips (provide a comma-separated list of mode identifiers like listed here)
* ViewBackingFactor Number This setting can be used to perform OFM View Backing.
* MapBorderColor String Set the color of the map border. This border is only visible when ofm runs using the decorationless toolbarStyle. Example value : 0xFFFF00
* MapBorderWidth Number Set the width of the map border. This border is only visible when ofm runs using the decorationless toolbarStyle.
* MapBorderAlpha Number Set the alpha percentage of the map border. This border is only visible when ofm runs using the decorationless toolbarStyle.

Setting Parameters Using UI Configuration

Starting from OFM versions higher than 4.20, OFM Parameters can also be specified without using the public interface (and having to embed OFM). You can specify the parameters you want using an OFMParameters tag inside the UI configuration file like the following snippet demonstrates : 

<OrbitFlashMapUIConfigs>
 
   <OFMParameters>
      <Parameter>
         <Name>PanClickMode</Name>
         <Value>query</Value>
      </Parameter>
 
      <Parameter>
         <Name>CustomizeCursor</Name>
         <Value>false</Value>
      </Parameter>
   </OFMParameters>	
 
</OrbitFlashMapUIConfigs>