Client Plugin Map Popup

The Map Popup tool provides the ability to display a map popup when there is one feature selected on the map. The feature may have been selected by any supported selection method (i.e. Quick Search, graphical selection, attribute selection, etc.)

The tool uses 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.

This plugin is available from Weave 2.5.28.

ID

weave.mappopup

Properties

name	description
multipleMaximum	If the selection returns more data results than this value, the default being 1, then `multipleText` will be shown to the user instead of the results. If this many or fewer results are available then they're all shown. This can only be set at the action level. This is used when one spatial feature returns more than one row in the Data Grid.
multipleText	The text to show to the user if more than `multipleMaximum` results are available. The default text is 'There are too many records at this location'. This can only be set at the action level.
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 popup. This is only available at the action level.
data	The name of a Data configuration that provides the data for this particular popup. This is only available at the tip level.
datadefinition	The name of a Data Definition configured that provides the data for this particular popup. This is only available at the tip level.
entity	The Entity that the data definition for the popup is associated with. This is only available at the tip level.
template	Used to apply HTML formatting to the tip for display in the popup.

Notes

Only one of data or datadefinition should be set.
If datadefinition is set then entity should also be set.
If data is set then entity does not need to be set (and will be ignored).

Examples

Simple popup example

<plugin id="weave.mappopup">
	<multipleMaximum>2</multipleMaximum>
	<multipleText>This features has too many details to be show</multipleText>
	<tips>
		<tip>
			<data>property_details</data>
		</tip>
		<tip>
			<datadefinition>road_details</datadefinition>
			<entity>roads</entity>
		</tip>
	</tips>
</plugin>

Example with text formatting

<plugin id="weave.mappopup">
	<multipleMaximum>5</multipleMaximum>
	<multipleText>This features has too many details to be shown</multipleText>
	<tips>
		<tip>
			<data>property_details</data>
			<template><![CDATA[<div><h1><i>ADDRESS DETAILS:</i></h1>{street_number} {street_name} {street_type}<br>{suburb_name}</div>]]></template>
		</tip>
	</tips>
</plugin>