worldKit :: easy web mapping

config.xml is a simple XML file, which sets the parameters of worldKit. It is requested from the same directory as the HTML file that embeds worldKit.swf.

The following is the sample config.xml included in the package.

The root node of config.xml is <worldkitconf>. The rest of the file is simply child nodes, specifying the values of the configuration paramaters. The parameters relating to visual appearance are described in the next sections. Other parameters are described throughout the manual.

Important: Two parameters always required are <width> and <height>, and their values should match the WIDTH and HEIGHT attributes in the HTML. (This repitition is required because worldKit.swf does not have access to the HTML attributes.)

Sizes and Colors

<plotshape>: The shape of an annotation marker. Accepted values are "square", "circle", and "triangle", The default value is "square".
<plotsize>: A numeric value specifying the size of the annotation point. The default value is "3".
<textsize>: The size, in pixels, of annotation text. The default value is "10".
<textboxsize>: The width, in pixels, of the text box visible when an annotation is activated. The default value is "200".
<singletextfield>: If set to true, text is displayed at the top of the map, rather than adjacent to the annotation. The default value is "false".
<initialplotcolor>: A hex color value. New annotations will be displayed in this color for 60 seconds. The default value is "0xFF0000".
<restingplotcolor>: A hex color value. Annotations will change to this color after 60 seconds. Set to the same value as "initialplotcolor" if you don't want the change. The default value is "0x00FFFF" (cyan).
<activatecolor>: A hex color value. Annotations will change to this color when activated by the JActComm Javascript API. The default value is "0xFF0000".
<track>: Set to "true" to display lines between successive annotations, as in a GPS track log. Default value is "false".
<linecolor>: A hex color value. Points, tracks, lines, and polygons will be displayed in this color. The default value is "0x000000" (black).
<linealpha>: A numeric value, 0-100, specifying the degree of transparency of lines in points, tracks, line and polygon annotations. "0" is invisible, "100" is full visible. The default value is "100".
<linethickness>: A numeric value, specifying the thickness of lines in points, tracks, line and polygon annotations. The default value is "0".
<fillalpha>: A numeric value, 0-100, specifying the degree of transparency of fill in points and polygon annotations. "0" is invisible, "100" is full visible. The default value is "100".
<visible>: Set to "false" and annotations will be invisible on load. They can be made visible via Javascript. Default value is "true".

Zoom and Pan

Besides the toolbar options below, the keyboard can be used to control zoom and pan. The arrow keys control pan, Z zooms in, and A zooms out.

<zoomselect>: Set to "true" to enable Zoom and Pan by drawing a red selection box on the map. By default, it is "false".
<grabber>: Set to "true" to enable click and drag Pan. By default it is enabled.
<toolbar>: Set to "true" to display the Toolbar. The default value is "false".
<controlscale>: A numeric value specifying the scale of the Toolbar. The default value is "100".
<controlalpha>: A numeric value, 0-100, specifying the degree of transparency of the Toolbar. "0" is invisible, "100" is full visible. The default value is "70".
<maxscale>: A numeric value, 1 or greater, specifying the maximum level of zoom permissible. The default value is "64".
<panc>: A numeric value controlling the speed when panning across the map. Higher values correspond to slower panning. The default value is 16.
<zoomc>: A float value, greater than 1, controlling the speed of zoom in and out of the map. Higher values correspond to faster zoom. Default value is 1.5.
<maxzoom>: If set to "true", the map will zoom and pan to a bounding box surrounding the area where annotations are initially present. The default value is "false".
<initialzoom>: On startup, the map will be zoomed to this magnitude, set from 1 to "maxscale". The default value is 1.
<initiallat>: On startup, the map will pan to center on this latitude. By default, it is midway between north and south.
<initiallong>: On startup, the map will pan to center on the longitude. By default, it is midway between east and west.
<zoomto>: If set to a numeric value, annotation clicks will zoom to the level specified, centered on the annotation, rather than opening a url.

Window and Plot Timing

<window>: Specifies the name of the window links are opened in. Use "_self" for the same window, "_blank" for a new window, etc. The default value is "_blank".
<plotinterval>: The number of seconds between plots of successive annotations. For simultaneous display of all annotations, use "0". The default value is "5".
<textinterval>: The number of seconds the text box is visible after an annotation is first plotted. The default value is "5".
<visinterval>: The number of seconds the text box is visible after mouse activation. The default value is "5".
<fade>: Specifies a number seconds for an annotation to fade to transparent. Useful for visualizing transient information. The default value is "-1", which means no fade.
<showload>: Set to "true" to display messages while images and RSS are loading. Default value is "false".
<loadimgmsg>: Specify a string for display while images are loading. Must set to "true" for this to be effective. Default value is "Loading Images...".
<loadrssmsg>: Specify a string for display while RSS is loading. Must set to "true" for this to be effective. Default value is "Loading Points...".
<zlevel>: Set to "-1" to plot newer annotations below older ones. Default value is "1", meaning newer annotations are positioned above older ones.