Client Actions Redline

Weave uses the term “Redline” to refer to a graphic added to a Weave client map display. Redlines may be points , lines, polygons, circles, rectangles or text, and once added to the display, they may be readily edited or deleted.

Redlines differ from Weave entity features because they are not associated with features contained in the entity’s layer; Rather they can be thought of as floating graphics, displayed atop underlying feature layers.

ID

com.cohga.client.actions.redline

weave.redline

Properties

Name	Type	Cardinality	Default	Description	i18n resource
tooltip\title	string	0..1	Redline	The title for the tooltip.	redline.tooltip.title
tooltip\text	string	0..1	Add elements to the map	The text for the tooltip.	redline.tooltip.text
title	string	0..1	Redline	The title of the redline toolbar window.	redline.title
hideOnClick	boolean	0..1	false	Should menus automatically hide when an item within is clicked?
scale	string	0..1	'small'	The size of the icons in the toolbar, 'small', 'medium' or 'large'.
geometryTool	string	0..n		A list of the geometry tools that should be included in the redline toolbar. `point`, `polyline`, `polygon`, `circle`, `square`, `rectangle`, `marker` and `text`
settingTool	string	0..n		A list of the settings menus that should be included in the redline toolbar. `fill`, `stroke`, `font`, `markerMenu`
tool	string	0..n		A list of additional tools that should be included in the redline toolbar.
multilineLabel	boolean	0..1	false	Should the label field be a multi-line input field.

Available Tools

Redline Tools are used to create and manipulate Redlines on a map display. Such tools are available to the user from the Redline Toolbar. The Redline toolbar may be declared with the below XML :

<item action="com.cohga.client.actions.redline"/>

The above specification is the simplest specification for the Redline Toolbar. When declared in this way a default set of Redline tools are included on the Toolbar. These default tools are denoted as Enabled in the below table.
To add tools that are not enabled by default, new tool elements are added to to the com.cohga.client.actions.redline item, using the Id property of the tool, e.g :

<item action="com.cohga.client.actions.redline">
	<tool>entity</tool>
	<tool>buffer</tool>
	<tool>bufferAll</tool>
	<tool>bufferSelected</tool>
</item>

The Delete, Delete All and Load items can have an optional warning parameter to prompt a user before deleting/loading redlines. This parameter is specified as an XML attribute, e.g :

<item action="com.cohga.client.actions.redline">
	<item action="weave.redline.delete" warning="true"/>
	<item action="weave.redline.deleteall" warning="true"/>
	<item action="weave.redline.load" warning="true" />
	...
</item>

Id	Name	Enabled	Description
circle	Circle	yes¹	Add a circle to the map
circleByRadius	Circle by Radius		Define a circle for a specified radius
defaults	Save Settings	yes^1,2	Save the current settings as the default
delete	Delete	yes¹	Delete the currently selected redline element
deleteall	Delete All	yes¹	Delete all redline elements
entity	Get		Create a redline item from the currently selected entity
fill	Fill Settings	yes¹	Change the fill colour and transparency of the selected feature
font	Font Settings	yes¹	Change the Font colour and style of the selected features text
load	Load	yes^1,2	Load and manage your saved redlines
marker	Marker	yes¹	Add a marker to the map
markerMenu	Marker Settings	yes¹	Change the marker colour
modify	Modify	yes¹	Click on the redline to modify
point	Point	yes¹	Add a point to the map
polygon	Polygon	yes¹	Add a polygon to the map
polyline	Polyline	yes¹	Add a polyline to the map
rectangle	Rectangle	yes¹	Add a rectangle to the map
label	Label	yes¹	Add a text box to the Redline Toolbar; Used to enter text that will be added to the map with the Text tool.
save	Save	yes^1,2	Save the current set of redlines
snap	Snap Settings	yes¹	Alter the current snapping settings
square	Square	yes¹	Add a square to the map
stroke	Line Settings	yes¹	Change the line colour and transparency of the selected feature
text	Text	yes¹	Add text to the map
buffer	Buffer		Generate a buffer around the selected features
bufferAll	Buffer All Redlines		Generate a buffer around all redline objects
bufferSelected	Buffer Selected Redline		Generate a buffer around the selected redline object
exportMarkers	Export to Shapefile		Export all redlines to Shapefile
exportKml	Export to KML		Export all redlines to KML
coordsCreate³	Create Geometry		Create some geometry by entering the coordinates.
coordsUpdate³	Update Geometry		Update some geometry by editing the coordinates.
upload³	Upload Geometry		Create some geometry by uploading it from a file.
spatialSelect⁴	Spatial Select		Select entities from redline geometry
manage^5,6	Organise	yes	List and organise redlines

This tool is enabled by default, if an entry is not marked as enabled it will need to be added with a tool entry in the redline items configuration (see the Properties section above)
Only if storage is available for the user
Weave 2.6.4 or later. Requires spatial upload extension to be installed, which is done automatically as part of a 2.6.4 update.
Weave 2.6.6 or later
Weave 2.6.7 or later
This tool does not currently affect text, which is always displayed on top of all geometries.

Customise available markers

You can replace the content of the marker menu to change the available markers, beyond the default ref, green and blue ones.

Changing available markers

<item action="weave.redline">
	<!--
		rest of config goes here
	-->
	<!-- this replaces the configuration of the maker menu and the markers that it supports -->
	<item action="weave.redline.markerMenu">
		<!-- these are the defaults -->
		<!-- you can also use brown, dark, orange, purple, silver and yellow -->
		<marker graphic="resources/images/markers/w-marker-green.png" text="Green"/>
		<marker graphic="resources/images/markers/w-marker-red.png" text="Red" />
		<marker graphic="resources/images/markers/w-marker-blue.png" text="Blue" />

		<!-- these are extras and the graphics, sizeX, sizeY, offsetX and offsetY are dependent upon the image -->

		<!-- this is assuming there is bundle installed in Weave that is exposing these images -->
		<!-- Note these icons currently will only display on the client, not in reports, etc -->
		<marker graphic="custom/markers/marker1.png" sizeX="18" sizeY="18" offsetX="-9" offsetY="-9" text="Marker 1" />
		<marker graphic="custom/markers/marker2.png" sizeX="18" sizeY="18" offsetX="-9" offsetY="-9" text="Marker 2" />
		<marker graphic="custom/markers/marker3.png" sizeX="18" sizeY="18" offsetX="-9" offsetY="-9" text="Marker 3" />

		<!-- this is assuming example.com is serving up icons (via http and https) -->
		<!-- Note these icons currently will only display on the client, not in reports, etc -->
		<marker graphic="//example.com/custom/markers/marker4.png" sizeX="18" sizeY="18" offsetX="-9" offsetY="-9" text="Marker 4" />
		<marker graphic="//example.com/custom/markers/marker5.png" sizeX="18" sizeY="18" offsetX="-9" offsetY="-9" text="Marker 5" />
		<marker graphic="//example.com/custom/markers/marker6.png" sizeX="18" sizeY="18" offsetX="-9" offsetY="-9" text="Marker 6" />
	</item>
</item>