Map tips provide the user with the ability to quickly retrieve information about entities underneath the mouse cursor.
...
ID
weave.maptips
Properties
...
name
...
description
...
minScale
...
Name | Type | Required | Default | Description | ||
---|---|---|---|---|---|---|
minScale | number | no | 0 | The default minimum scale below which no map tips will be shown to the user. | ||
maxScaleThis can be set at the action level, the tip level or not at all, and specifies the | number | no | infinity | The default maximum scale above which no map tips will be shown to the user. | ||
radiusThis can be set at the action level, the tip level or not at all, and specifies the | number | no | 3 | The default radius, in map units, of the area to be searched, centred on the mouse location. | ||
pressed | boolean | no | false | This sets the initial state of the map tip and it is off by defaulttips. Setting it to 'true' will turn on map tip tips at startup. This can only be set at the action level. The default is 'false'.multipleMaximum | ||
multipleMaximum | number | no | 1 | If the search returns more than this many results , the default being 1, then | ||
multipleText | string | no | There are too many features at that location | The text to show to the user if more than | ||
isDefault | Should be set to 'true' in the tip that should be enabled by default. | |||||
tiptip | tip | yes | 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. | |||||
autoSizeautoSize | boolean | no | false | true/false indicating if the popup window should try and adjust its size. The default is 'false'. | ||
minSize | size | no | 105,10 | The minimum width and height in pixels that the popup window should use when auto-sizing. The default is 105,10. | ||
maxSize | size | no | 1200,660 | The maximum width and height in pixels that the popup window should use when auto-sizing. The default is 1200,660. | ||
size | size | no | 200,200 | The default width and height in pixels that the popup windows should use. The default is 200,200. | ||
hideDelay | number | no | 2000 | The number of milliseconds to wait before hiding the popup window. The default is 2000. | ||
selectedOnly | boolean | no | false | Restrict the map tip to the selected features only. The default is 'false'. | ||
selectedOnlyMenu | boolean | no | false | 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 | boolean | no | false | 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 | boolean | no | false | 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 | boolean | no | true | Should the geometry of the related entity be drawn. The default is 'true'. Only available since 2.5.26 |
Sub-Tags
tip
Name | Type | Required | Description |
---|---|---|---|
minScale | number | no | The minimum scale below which no map tips will be shown to the user. |
maxScale | number | no | The maximum scale above which no map tips will be shown to the user. |
radius | number | no | The radius, in map units, of the area to be searched, centred on the mouse location. |
isDefault | boolean | no | Should be set to 'true' in the tip that should be enabled by default. |
data | Data | yes, if datadefinition is not set | The id of a Data configuration that provides the data for this particular tip. |
datadefinition | Data Definition | yes, if data is not set | The id of a Data Definition configuration that provides the data for this particular tip. |
entity | Entity | yes, if datadefinition is set | The id of the Entity that the Data Definition should generate the data for. |
label | string | yes, if no, if | The label to display as this tip in the menu. Will override the label provided by the Data if data is specified rather than datadefinition . |
autoSize | boolean | no | Indicating if the popup window should try and adjust its size |
minSize | size | no | The minimum width and height in pixels that the popup window should use when auto-sizing. |
maxSize | size | no | The maximum width and height in pixels that the popup window should use when auto-sizing. |
size | size | no | The default width and height in pixels that the popup windows should use |
selectedOnly | boolean | no | Restrict the map tip to the selected features only. |
visibleOnly | boolean | no | Restrict the map tip to display only if the associated layer is turned on in the ToC. |
group | string | no | 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 |
template | string | no | Used to apply HTML formatting to the tip for display in the popup. |
size
Name | Type | Required | Description |
---|---|---|---|
width | number | yes | The width of the "size", in pixels |
height | number | yes | The height of the "size' in pixels |
Notes
- If
data
is set thenlabel
isn't required, but will override the label set for the given data if setOnly one of data or
datadefinition
should be set. - If
datadefinition
is set thenentity
andlabel
should also be set. - If
data
is set thenentity
does not need to be set (and will be ignored). data or
datadefinition
should be set for a tip, but one of them must be set.- The default values for tips are taken from the matching attribute in the parent tag.
Examples
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<item action="weave.maptips"> <tip> <data>property_details</data> <isDefault>true</isDefault> </tip> <tip> <data>road_details</data> </tip> </item> |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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<<datadefinition>road_details</label>datadefinition> <entity>roads</entity> <datadefinition>road_details<<label>Road</datadefinition>label> <radius>5</radius> <minScale>250</minScale> <maxScale>1000</maxScale> </tip> </item> |
...