Versions Compared

Key

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

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

...

NameTypeRequiredDescription
minScalenumberno

The minimum scale below which no map tips will be shown to the user.

maxScalenumberno

The maximum scale above which no map tips will be shown to the user.

radiusnumberno

The radius, in map units, of the area to be searched, centred on the mouse location.

isDefaultbooleanno

Should be set to 'true' in the tip that should be enabled by default.

dataDatayes, if datadefinition is not setThe id of a Data configuration that provides the data for this particular tip.
datadefinitionData Definitionyes, if data is not setThe id of a Data Definition configuration that provides the data for this particular tip.
entityEntityyes, if datadefinition is setThe id of the Entity that the Data Definition should generate the data for.
labelstring

yes, if datadefinition is set

no, if data is set

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.
autoSizebooleannoIndicating if the popup window should try and adjust its size
minSizesizenoThe minimum width and height in pixels that the popup window should use when auto-sizing.
maxSizesizenoThe maximum width and height in pixels that the popup window should use when auto-sizing.
sizesizenoThe default width and height in pixels that the popup windows should use
selectedOnlybooleannoRestrict the map tip to the selected features only.
visibleOnlybooleannoRestrict the map tip to display only if the associated layer is turned on in the ToC.
groupstringnoA 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
templatestringnoUsed to apply HTML formatting to the tip for display in the popup.

size

NameTypeRequiredDescription
widthnumberyesThe width of the "size", in pixels
heightnumberyesThe height of the "size' in pixels

...