Subgroup: Layout
Class: QgsLayoutItemLegend¶
-
class
qgis.core.
QgsLayoutItemLegend
(layout: QgsLayout)¶ Bases:
qgis._core.QgsLayoutItem
Constructor for QgsLayoutItemLegend, with the specified parent
layout
.A layout item subclass for map legends.
New in version 3.0: Methods
adjustBoxSize
Sets the legend’s item bounds to fit the whole legend content. adjustPointForReferencePosition
applyDataDefinedSize
applyItemSizeConstraint
autoUpdateModel
Returns whether the legend content should auto update to reflect changes in the project’s layer tree. boxSpace
Returns the legend box space. childEvent
columnCount
Returns the legend column count. columnSpace
Returns the legend column spacing. connectNotify
contextMenuEvent
create
Returns a new legend item for the specified layout
.customEvent
disconnectNotify
displayName
dragEnterEvent
dragLeaveEvent
dragMoveEvent
draw
drawBackground
drawDebugRect
drawFrame
drawRasterStroke
Returns whether a stroke will be drawn around raster symbol items. dropEvent
equalColumnWidth
Returns whether column widths should be equalized. finalizeRestoreFromXml
focusInEvent
focusOutEvent
fontColor
Returns the legend font color. hoverEnterEvent
hoverLeaveEvent
hoverMoveEvent
icon
inputMethodEvent
inputMethodQuery
isSignalConnected
itemChange
keyPressEvent
keyReleaseEvent
legendFilterByMapEnabled
Find out whether legend items are filtered to show just the ones visible in the associated map legendFilterOutAtlas
Returns whether to filter out legend elements outside of the current atlas feature. legendSettings
Returns the legend’s renderer settings object. lineSpacing
Returns the spacing in-between lines in layout units. linkedMap
Returns the associated map. model
Returns the legend model. mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
paint
positionAtReferencePoint
prepareGeometryChange
rasterStrokeColor
Returns the stroke color for the stroke drawn around raster symbol items. rasterStrokeWidth
Returns the stroke width (in layout units) for the stroke drawn around raster symbol items. readObjectPropertiesFromElement
readPropertiesFromElement
receivers
refresh
refreshBackgroundColor
refreshBlendMode
refreshDataDefinedProperty
refreshFrame
refreshItemPosition
refreshItemRotation
refreshItemSize
refreshOpacity
resizeToContents
Returns whether the legend should automatically resize to fit its contents. rstyle
Returns reference to modifiable legend style. sceneEvent
sceneEventFilter
sender
senderSignalIndex
setAutoUpdateModel
Sets whether the legend content should auto update to reflect changes in the project’s layer tree. setBoxSpace
Sets the legend box space
.setColumnCount
Sets the legend column count
.setColumnSpace
Sets the legend column spacing
.setDrawRasterStroke
Sets whether a stroke will be drawn around raster symbol items. setEqualColumnWidth
Sets whether column widths should be equalized. setFixedSize
setFontColor
Sets the legend font color
.setLegendFilterByMapEnabled
Set whether legend items should be filtered to show just the ones visible in the associated map. setLegendFilterOutAtlas
When set to true, during an atlas rendering, it will filter out legend elements where features are outside the current atlas feature. setLineSpacing
Sets the spacing
in-between multiple lines.setLinkedMap
Sets the map
to associate with the legend.setMinimumSize
setRasterStrokeColor
Sets the stroke color
for the stroke drawn around raster symbol items.setRasterStrokeWidth
Sets the stroke width for the stroke drawn around raster symbol items. setResizeToContents
Sets whether the legend should automatically resize to fit its contents. setSplitLayer
Sets whether the legend items from a single layer can be split over multiple columns. setStyle
Sets the style of component
tostyle
for the legend.setStyleFont
Sets the style font
for a legendcomponent
.setStyleMargin
Set the margin
for a legendcomponent
.setSymbolHeight
Sets the legend symbol height
.setSymbolWidth
Sets the legend symbol width
.setTitle
Sets the legend title
.setTitleAlignment
Sets the alignment
of the legend title.setWmsLegendHeight
Sets the WMS legend height
.setWmsLegendWidth
Sets the WMS legend width
.setWrapString
Sets the legend text wrapping string
.splitLayer
Returns whether the legend items from a single layer can be split over multiple columns. style
Returns legend style. styleFont
Returns the font settings for a legend component
.symbolHeight
Returns the legend symbol height. symbolWidth
Returns the legend symbol width. timerEvent
title
Returns the legend title. titleAlignment
Returns the alignment of the legend title. topLeftToReferencePoint
type
updateFilterByMap
Updates the legend content when filtered by map. updateLegend
Updates the model and all legend entries. updateMicroFocus
wheelEvent
wmsLegendHeight
Returns the WMS legend height. wmsLegendWidth
Returns the WMS legend width. wrapString
Returns the legend text wrapping string. writeObjectPropertiesToElement
writePropertiesToElement
Signals
Attributes
-
adjustBoxSize
(self)¶ Sets the legend’s item bounds to fit the whole legend content.
-
adjustPointForReferencePosition
()¶
-
applyDataDefinedSize
()¶
-
applyItemSizeConstraint
()¶
-
autoUpdateModel
(self) → bool¶ Returns whether the legend content should auto update to reflect changes in the project’s layer tree.
See also
-
boxSpace
(self) → float¶ Returns the legend box space.
See also
-
childEvent
()¶
-
columnCount
(self) → int¶ Returns the legend column count.
See also
-
columnSpace
(self) → float¶ Returns the legend column spacing.
See also
-
connectNotify
()¶
-
contextMenuEvent
()¶
-
create
(layout: QgsLayout) → QgsLayoutItemLegend¶ Returns a new legend item for the specified
layout
.The caller takes responsibility for deleting the returned object.
-
customEvent
()¶
-
disconnectNotify
()¶
-
displayName
(self) → str¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
draw
(self, context: QgsLayoutItemRenderContext)¶
-
drawBackground
()¶
-
drawDebugRect
()¶
-
drawFrame
()¶
-
drawRasterStroke
(self) → bool¶ Returns whether a stroke will be drawn around raster symbol items.
See also
See also
See also
-
dropEvent
()¶
-
equalColumnWidth
(self) → bool¶ Returns whether column widths should be equalized.
See also
-
finalizeRestoreFromXml
(self)¶
-
focusInEvent
()¶
-
focusOutEvent
()¶
-
fontColor
(self) → QColor¶ Returns the legend font color.
See also
-
hoverEnterEvent
()¶
-
hoverLeaveEvent
()¶
-
hoverMoveEvent
()¶
-
icon
(self) → QIcon¶
-
inputMethodEvent
()¶
-
inputMethodQuery
()¶
-
isSignalConnected
()¶
-
itemChange
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
legendFilterByMapEnabled
(self) → bool¶ Find out whether legend items are filtered to show just the ones visible in the associated map
See also
-
legendFilterOutAtlas
(self) → bool¶ Returns whether to filter out legend elements outside of the current atlas feature.
See also
-
legendSettings
(self) → QgsLegendSettings¶ Returns the legend’s renderer settings object.
-
lineSpacing
(self) → float¶ Returns the spacing in-between lines in layout units.
See also
-
linkedMap
(self) → QgsLayoutItemMap¶ Returns the associated map.
See also
-
model
(self) → QgsLegendModel¶ Returns the legend model.
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
paint
(self, painter: QPainter, itemStyle: QStyleOptionGraphicsItem, pWidget: QWidget)¶
-
positionAtReferencePoint
()¶
-
prepareGeometryChange
()¶
-
rasterStrokeColor
(self) → QColor¶ Returns the stroke color for the stroke drawn around raster symbol items. The stroke is only drawn if drawRasterStroke() is true.
See also
See also
See also
-
rasterStrokeWidth
(self) → float¶ Returns the stroke width (in layout units) for the stroke drawn around raster symbol items. The stroke is only drawn if drawRasterStroke() is true.
See also
See also
See also
-
readObjectPropertiesFromElement
()¶
-
readPropertiesFromElement
(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶
-
receivers
()¶
-
refresh
(self)¶
-
refreshBackgroundColor
()¶
-
refreshBlendMode
()¶
-
refreshDataDefinedProperty
(self, property: QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties)¶
-
refreshFrame
()¶
-
refreshItemPosition
()¶
-
refreshItemRotation
()¶
-
refreshItemSize
()¶
-
refreshOpacity
()¶
-
resizeToContents
(self) → bool¶ Returns whether the legend should automatically resize to fit its contents.
See also
-
rstyle
(self, s: QgsLegendStyle.Style) → QgsLegendStyle¶ Returns reference to modifiable legend style.
-
sceneEvent
()¶
-
sceneEventFilter
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setAutoUpdateModel
(self, autoUpdate: bool)¶ Sets whether the legend content should auto update to reflect changes in the project’s layer tree.
See also
-
setBoxSpace
(self, space: float)¶ Sets the legend box
space
.See also
-
setColumnCount
(self, count: int)¶ Sets the legend column
count
.See also
-
setColumnSpace
(self, spacing: float)¶ Sets the legend column
spacing
.See also
-
setDrawRasterStroke
(self, enabled: bool)¶ Sets whether a stroke will be drawn around raster symbol items.
Parameters: enabled – set to true to draw borders See also
See also
See also
-
setEqualColumnWidth
(self, equalize: bool)¶ Sets whether column widths should be equalized.
See also
-
setFixedSize
()¶
-
setFontColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the legend font
color
.See also
-
setLegendFilterByMapEnabled
(self, enabled: bool)¶ Set whether legend items should be filtered to show just the ones visible in the associated map.
See also
-
setLegendFilterOutAtlas
(self, doFilter: bool)¶ When set to true, during an atlas rendering, it will filter out legend elements where features are outside the current atlas feature.
See also
-
setLineSpacing
(self, spacing: float)¶ Sets the
spacing
in-between multiple lines.See also
-
setLinkedMap
(self, map: QgsLayoutItemMap)¶ Sets the
map
to associate with the legend.See also
-
setMinimumSize
()¶
-
setRasterStrokeColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the stroke
color
for the stroke drawn around raster symbol items. The stroke is only drawn if drawRasterStroke() is true.See also
See also
See also
-
setRasterStrokeWidth
(self, width: float)¶ Sets the stroke width for the stroke drawn around raster symbol items. The stroke is only drawn if drawRasterStroke() is true.
See also
See also
See also
-
setResizeToContents
(self, enabled: bool)¶ Sets whether the legend should automatically resize to fit its contents.
Parameters: enabled – set to false to disable automatic resizing. The legend frame will not be expanded to fit legend items, and items may be cropped from display. See also
-
setSplitLayer
(self, enabled: bool)¶ Sets whether the legend items from a single layer can be split over multiple columns.
See also
-
setStyle
(self, component: QgsLegendStyle.Style, style: QgsLegendStyle)¶ Sets the style of
component
tostyle
for the legend.
-
setStyleFont
(self, component: QgsLegendStyle.Style, font: QFont)¶ Sets the style
font
for a legendcomponent
.See also
-
setStyleMargin
(self, component: QgsLegendStyle.Style, margin: float)¶ Set the
margin
for a legendcomponent
.setStyleMargin(self, component: QgsLegendStyle.Style, side: QgsLegendStyle.Side, margin: float) Set the
margin
for a particularside
of a legendcomponent
.
-
setSymbolHeight
(self, height: float)¶ Sets the legend symbol
height
.See also
-
setSymbolWidth
(self, width: float)¶ Sets the legend symbol
width
.See also
-
setTitleAlignment
(self, alignment: Qt.AlignmentFlag)¶ Sets the
alignment
of the legend title.See also
-
setWmsLegendHeight
(self, height: float)¶ Sets the WMS legend
height
.See also
-
setWmsLegendWidth
(self, width: float)¶ Sets the WMS legend
width
.See also
-
setWrapString
(self, string: str)¶ Sets the legend text wrapping
string
.See also
-
splitLayer
(self) → bool¶ Returns whether the legend items from a single layer can be split over multiple columns.
See also
-
style
(self, s: QgsLegendStyle.Style) → QgsLegendStyle¶ Returns legend style.
-
styleFont
(self, component: QgsLegendStyle.Style) → QFont¶ Returns the font settings for a legend
component
.See also
-
symbolHeight
(self) → float¶ Returns the legend symbol height.
See also
-
symbolWidth
(self) → float¶ Returns the legend symbol width.
See also
-
timerEvent
()¶
-
title
(self) → str¶ Returns the legend title.
See also
-
titleAlignment
(self) → Qt.AlignmentFlag¶ Returns the alignment of the legend title.
See also
-
topLeftToReferencePoint
()¶
-
type
(self) → int¶
-
updateFilterByMap
(self, redraw: bool = True)¶ Updates the legend content when filtered by map.
-
updateLegend
(self)¶ Updates the model and all legend entries.
-
updateMicroFocus
()¶
-
wheelEvent
()¶
-
wmsLegendHeight
(self) → float¶ Returns the WMS legend height.
See also
-
wmsLegendWidth
(self) → float¶ Returns the WMS legend width.
See also
-
wrapString
(self) → str¶ Returns the legend text wrapping string.
See also
-
writeObjectPropertiesToElement
()¶
-
writePropertiesToElement
(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶
-