Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 based on the mouse location.

pressed

...

This sets the initial state of the map tip and is off by default. Setting it to turn will turn on map tip at startup. This can only be set at the action level.

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 this many or less 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 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. Only available at the action level.

data

...

The name of a Data configured that provides the data for this particular tip. Only available at the tip level.

datadefinition

...

The name of a Data Definition configured that provides the data for this particular tip. Only available at the tip level.

entity

...

The Entity that the datadefinition for the tip is associated with. Only available at the tip level.

label

...

The label to display for this particular tip. Only available at the tip level.

Notes

  • Only one of data or datadefinition should be set
  • If datadefintion 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

...

Code Block
xml
xml
linenumberstrue
	<item action="weave.maptips">
		<pressed>true</pressed>
		<tip>
			<label>Property</label>
			<entity>property</entity>
			<data>property<datadefinition>property_address<details</data>datadefinition>
			<isDefault>true</isDefault>
			<minScale>1000</minScale>
			<maxScale>10000</maxScale>
		</tip>
		<tip>
			<entity>roads<<label>Road</entity>label>
			<label>Roads<<entity>roads</label>entity>
			<datadefinition>road_details</datadefinition>
			<radius>5</radius>
			<minScale>250</minScale>
			<maxScale>1000</maxScale>
		</tip>
	</item>