Client Actions Map Tips

Map tips provide the user with the ability to quickly retrieve information about entities underneath the mouse cursor.

They use data definitions to supply the data, meaning that the data available to the user can come from any provider, not just the attributes attached to the underlying spatial feature.

The map tip tool can query any entity and is not dependent upon the active entity. The user chooses from the map tip menu what data they're interested in and when they move the mouse around the map that's the data they will be shown.

ID

weave.maptips

Properties

name	description
minScale	This can be set at the action level, the tip level or not at all, and specifies the minimum scale below which no map tips will be shown to the user.
maxScale	This can be set at the action level, the tip level or not at all, and specifies the maximum scale above which no map tips will be shown to the user.
radius	This can be set at the action level, the tip level or not at all, and specifies the radius, in map units, of the area to be searched, centred on the mouse location.
pressed	This sets the initial state of the map tip and it is off by default. Setting it to 'true' will turn on map tip at startup. This can only be set at the action level. The default is 'false'.
multipleMaximum	If the search returns more than this many results, the default being 1, then `multipleText` will be shown to the user instead of the results. If these many or fewer results are available then they're all shown. This can only be set at the action level.
multipleText	The text to show to the user if more than `multipleMaximum` results are available. The default text is 'There are too many features at that location'. This can only be set at the action level.
isDefault	Should be set to 'true' in the tip that should be enabled by default.
tip	A tip tag must be created for each set of data that's to be made available to the user for display in a map tip. This is only available at the action level.
data	The name of a Data configuration that provides the data for this particular tip. This is only available at the tip level.
datadefinition	The name of a Data Definition configured that provides the data for this particular tip. This is only available at the tip level.
entity	The Entity that the data definition for the tip is associated with. This is only available at the tip level.
label	The label to display for this particular tip. This is only available at the tip level.
autoSize	true/false indicating if the popup window should try and adjust its size. The default is 'false'.
minSize	The minimum width and height in pixels that the popup window should use when auto-sizing. The default is 105,10.
maxSize	The maximum width and height in pixels that the popup window should use when auto-sizing. The default is 1200,660.
size	The default width and height in pixels that the popup windows should use. The default is 200,200.
hideDelay	The number of milliseconds to wait before hiding the popup window. The default is 2000.
selectedOnly	Restrict the map tip to the selected features only. The default is 'false'.
selectedOnlyMenu	Add a menu to the map tips tool to allow the user to turn on or off the selectedOnly flag. The default is 'false'.
visibleOnly	Restrict the map tip to display only if the associated layer is turned on in the ToC. The default is 'false'. Only available since 2.5.26
visibleOnlyMenu	Add a menu to the map tips tool to allow the user to turn on or off the visibleOnly flag. The default is 'false'. Only available since 2.5.26
showGeometry	Should the geometry of the related entity be drawn. The default is 'true'. Only available since 2.5.26
group	A map tip with a group set will be placed under a sub-menu where the text of the sub-menu item will be taken from the group value, if a group isn't specified then the map tip will appear directly in the menu. Only available since 2.5.26

Notes

Only one of data or datadefinition should be set.
If datadefinition is set then entity and label should also be set.
If data is set then entity does not need to be set (and will be ignored).
If data is set then label isn't required, but will override the label set for the given data if set.

Examples

<item action="weave.maptips">
	<tip>
		<data>property_details</data>
		<isDefault>true</isDefault>
	</tip>
	<tip>
		<data>road_details</data>
	</tip>
</item>

<item action="weave.maptips">
	<multipleMaximum>2</multipleMaximum>
	<multipleText>Too many features</multipleText>
	<minScale>1000</minScale>
	<maxScale>50000</maxScale>
	<radius>3</radius>
	<tip>
		<data>property_details</data>
		<isDefault>true</isDefault>
	</tip>
	<tip>
		<data>road_details</data>
	</tip>
</item>

<item action="weave.maptips">
	<pressed>true</pressed>
	<tip>
		<label>Property</label>
		<entity>property</entity>
		<datadefinition>property_details</datadefinition>
		<isDefault>true</isDefault>
		<minScale>1000</minScale>
		<maxScale>10000</maxScale>
	</tip>
	<tip>
		<label>Road</label>
		<entity>roads</entity>
		<datadefinition>road_details</datadefinition>
		<radius>5</radius>
		<minScale>250</minScale>
		<maxScale>1000</maxScale>
	</tip>
</item>

Adjusting the size of the popup

<item action="weave.maptips">
	<autoSize>true</autoSize>
	<minSize width="100" height="100"/>
	<maxSize width="200" height="400"/>
	<size width="150" height="150"/>
	<tips>
		<tip label="Property" entity="property" datadefinition="property_details" isDefault="true"/>
		<tip label="Image" entity="property" datadefinition="property_images">
			<maxSize width="800" height="800"/>
		</tip>
	</tips>
</item>

Map tips with groups

<item action="weave.maptips">
	<tip>
		<data>property_details</data>
		<isDefault>true</isDefault>
		<group>Property</group>
	</tip>
	<tip>
		<data>property_summary</data>
		<group>Property</group>
	</tip>
	<tip>
		<data>property_owner</data>
		<group>Property</group>
	</tip>
	<tip>
		<data>road_details</data>
	</tip>
	<tip>
		<data>serwer_details</data>
		<group>Sewer</group>
	</tip>
	<tip>
		<data>sewer_summary</data>
		<group>Sewer</group>
	</tip>
</item>

The above example will result in a menu like the following

Property
- Property Details
- Property Summary
- Property Owner
Road Details
Sewer
- Sewer Details
- Sewer Summary