Class: QgsMapTip

class qgis.gui.QgsMapTip

Bases: PyQt5.QtWidgets.QWidget

Default constructor

A maptip is a class to display a tip on a map canvas when a mouse is hovered over a feature.

Since QGIS 2.16 a maptip can show full html. QgsMapTip is a QgsWebView, so you can load full HTML/JS/CSS in it.

The code found in the map tips tab is inserted in a inline-block div so the frame can be resized based on the content size.

If no element in the html has a width attribute, the frame will squeeze down to the widest word. To avoid this you can wrap your HTML in a div style=”width:300px” or similar.

JS can be included using the script tag as usual, while CSS files must be linked using link rel=”stylesheet” href=”URL.css” the html specs discourages link rel=”stylesheet” in the body, but all browsers allow it. see https://jakearchibald.com/2016/link-in-body

Methods

actionEvent
applyFontSettings Apply font family and size to match user settings
changeEvent
childEvent
clear Clear the current maptip if it exists
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
receivers
resizeEvent
sender
senderSignalIndex
sharedPainter
showEvent
showMapTip Show a maptip at a given point on the map canvas
tabletEvent
timerEvent
updateMicroFocus
wheelEvent

Signals

Attributes

actionEvent()
applyFontSettings(self)

Apply font family and size to match user settings

changeEvent()
childEvent()
clear(self, mpMapCanvas: QgsMapCanvas = None)

Clear the current maptip if it exists

Parameters:mpMapCanvas – the canvas from which the tip should be cleared.
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
sender()
senderSignalIndex()
sharedPainter()
showEvent()
showMapTip(self, thepLayer: QgsMapLayer, mapPosition: QgsPointXY, pixelPosition: QPoint, mpMapCanvas: QgsMapCanvas)

Show a maptip at a given point on the map canvas

Parameters:
  • thepLayer – a qgis vector map layer pointer that will be used to provide the attribute data for the map tip.
  • mapPosition – a reference to the position of the cursor in map coordinatess.
  • pixelPosition – a reference to the position of the cursor in pixel coordinates.
  • mpMapCanvas – a map canvas on which the tip is drawn
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()