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

#include <qgsmaptip.h>

Inheritance diagram for QgsMapTip:

Public Member Functions
	QgsMapTip ()
	Default constructor. More...

void	clear (QgsMapCanvas *mpMapCanvas=nullptr)
	Clear the current maptip if it exists. More...

void	showMapTip (QgsMapLayer thepLayer, QgsPointXY &mapPosition, QPoint &pixelPosition, QgsMapCanvas mpMapCanvas)
	Show a maptip at a given point on the map canvas. More...

Detailed Description

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/

Definition at line 51 of file qgsmaptip.h.

Constructor & Destructor Documentation

◆ QgsMapTip()

QgsMapTip::QgsMapTip ( )

Default constructor.

Definition at line 39 of file qgsmaptip.cpp.

Member Function Documentation

◆ clear()

void QgsMapTip::clear ( QgsMapCanvas * mpMapCanvas = nullptr )

Clear the current maptip if it exists.

Parameters

mpMapCanvas the canvas from which the tip should be cleared.

Definition at line 156 of file qgsmaptip.cpp.

◆ showMapTip()

void QgsMapTip::showMapTip	(	QgsMapLayer *	thepLayer,
		QgsPointXY &	mapPosition,
		QPoint &	pixelPosition,
		QgsMapCanvas *	mpMapCanvas
	)

Show a maptip at a given point on the map canvas.