1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsmaptip.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMapTip : QWidget
{
%Docstring(signature="appended")
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. :py:class:`QgsMapTip` is a
:py:class:`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
%End
%TypeHeaderCode
#include "qgsmaptip.h"
%End
public:
QgsMapTip();
%Docstring
Default constructor
%End
void showMapTip( QgsMapLayer *thepLayer, QgsPointXY &mapPosition, const QPoint &pixelPosition, QgsMapCanvas *mpMapCanvas );
%Docstring
Show a maptip at a given point on the map canvas
:param thepLayer: a qgis vector map layer pointer that will be used to
provide the attribute data for the map tip.
:param mapPosition: a reference to the position of the cursor in map
coordinatess.
:param pixelPosition: a reference to the position of the cursor in pixel
coordinates.
:param mpMapCanvas: a map canvas on which the tip is drawn
%End
void clear( QgsMapCanvas *mpMapCanvas = 0, int msDelay = 0 );
%Docstring
Clear the current maptip if it exists
:param mpMapCanvas: the canvas from which the tip should be cleared.
:param msDelay: optional time in ms to defer clearing the maptip (since
QGIS 3.26)
%End
static QString vectorMapTipPreviewText( QgsMapLayer *layer, QgsMapCanvas *mapCanvas, const QString &mapTemplate, const QString &displayExpression );
%Docstring
Returns the html that would be displayed in a maptip for a given layer.
If the layer has features, the first feature is used to evaluate the
expressions.
.. versionadded:: 3.32
%End
static QString rasterMapTipPreviewText( QgsMapLayer *layer, QgsMapCanvas *mapCanvas, const QString &mapTemplate );
%Docstring
Returns the html that would be displayed in a maptip for a given layer.
The center pixel of the raster is used to evaluate the expressions.
.. versionadded:: 3.32
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsmaptip.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
