Subgroup: Legend

Class: QgsLegendModel¶

class qgis.core.QgsLegendModel¶

Bases: qgis._core.QgsLayerTreeModel

Item model implementation based on layer tree model for layout legend.

Overrides some functionality of QgsLayerTreeModel to better fit the needs of layout legends.

New in version 2.6: Methods

`addLegendToLayer`
`autoCollapseLegendNodes`	Return at what number of legend nodes the layer node should be collapsed.
`beginInsertColumns`
`beginInsertRows`
`beginMoveColumns`
`beginMoveRows`
`beginRemoveColumns`
`beginRemoveRows`
`beginResetModel`
`blockSignals`
`buddy`
`canDropMimeData`
`canFetchMore`
`changePersistentIndex`
`changePersistentIndexList`
`childEvent`
`children`
`columnCount`
`connectNotify`
`connectToLayer`
`connectToLayers`
`connectToRootNode`
`createIndex`
`currentIndex`	Get index of the item marked as current.
`customEvent`
`data`
`decodeData`
`deleteLater`
`disconnect`
`disconnectFromLayer`
`disconnectFromLayers`
`disconnectFromRootNode`
`disconnectNotify`
`dropMimeData`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`encodeData`
`endInsertColumns`
`endInsertRows`
`endMoveColumns`
`endMoveRows`
`endRemoveColumns`
`endRemoveRows`
`endResetModel`
`event`
`eventFilter`
`fetchMore`
`filterLegendNodes`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`findLegendNode`	Searches through the layer tree to find a legend node with a matching layer ID and rule key.
`flags`
`hasChildren`
`hasIndex`
`headerData`
`iconGroup`
`index`
`index2legendNode`	Return legend node for given index.
`index2node`	Return layer tree node for given index.
`indexOfParentLayerTreeNode`
`indexes2nodes`	Convert a `list` of indexes to a list of layer tree nodes.
`inherits`
`insertColumn`
`insertColumns`
`insertRow`
`insertRows`
`installEventFilter`
`invalidateLegendMapBasedData`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`itemData`
`killTimer`
`layerLegendChanged`
`layerLegendNodes`	Return filtered list of active legend nodes attached to a particular layer node
`layerNeedsUpdate`
`layerOriginalLegendNodes`	Return original (unfiltered) list of legend nodes attached to a particular layer node
`layerStyleOverrides`	Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one
`layerTreeNodeFont`	Get font for a particular type of layer tree node.
`legendCleanup`
`legendEmbeddedInParent`
`legendFilterByScale`	Returns the scale which restricts the legend nodes which are visible.
`legendFilterMapSettings`	Returns the current map settings used for the current legend filter (or null if none is enabled)
`legendIconEmbeddedInParent`
`legendInvalidateMapBasedData`
`legendMapViewData`	Get hints about map view - to be used in legend nodes.
`legendNode2index`	Return index for a given legend node.
`legendNodeData`
`legendNodeDataChanged`
`legendNodeEmbeddedInParent`	Return legend node that may be embedded in parent (i.e.
`legendNodeFlags`
`legendNodeIndex`
`legendNodeRowCount`
`legendParent`
`legendRootIndex`
`legendRootRowCount`
`match`
`metaObject`
`mimeData`
`mimeTypes`
`moveColumn`
`moveColumns`
`moveRow`
`moveRows`
`moveToThread`
`node2index`	Return index for a given node.
`nodeAddedChildren`
`nodeCustomPropertyChanged`
`nodeLayerLoaded`
`nodeLayerWillBeUnloaded`
`nodeNameChanged`
`nodeRemovedChildren`
`nodeVisibilityChanged`
`nodeWillAddChildren`
`nodeWillRemoveChildren`
`objectName`
`parent`
`persistentIndexList`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`recursivelyEmitDataChanged`
`refreshLayerLegend`	Force a refresh of legend nodes of a layer node.
`refreshScaleBasedLayers`
`removeColumn`
`removeColumns`
`removeEventFilter`
`removeLegendFromLayer`
`removeRow`
`removeRows`
`resetInternalData`
`revert`
`roleNames`
`rootGroup`	Return pointer to the root node of the layer tree.
`rowCount`
`sender`
`senderSignalIndex`
`setAutoCollapseLegendNodes`	Set at what number of legend nodes the layer node should be collapsed.
`setCurrentIndex`	Set index of the current item.
`setData`
`setFlag`	Enable or disable a model flag
`setFlags`	Set OR-ed combination of model flags
`setHeaderData`
`setItemData`
`setLayerStyleOverrides`	Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one
`setLayerTreeNodeFont`	Set font for a particular type of layer tree node.
`setLegendFilter`	Filter display of legend nodes for given map settings
`setLegendFilterByMap`	Force only display of legend nodes which are valid for given map settings.
`setLegendFilterByScale`	Force only display of legend nodes which are valid for a given `scale`.
`setLegendMapViewData`	Give the layer tree model hints about the currently associated map view
`setObjectName`
`setParent`
`setProperty`
`setRootGroup`	Reset the model and use a new root group node
`sibling`
`signalsBlocked`
`sort`
`span`
`startTimer`
`submit`
`supportedDragActions`
`supportedDropActions`
`testFlag`	Check whether a flag is enabled
`thread`
`timerEvent`
`tr`

Attributes

`ActionHierarchical`
`AllowLegendChangeState`
`AllowNodeChangeVisibility`
`AllowNodeRename`
`AllowNodeReorder`
`DeferredLegendInvalidation`
`HorizontalSortHint`
`NoLayoutChangeHint`
`ShowLegend`
`ShowLegendAsTree`
`UseEmbeddedWidgets`
`VerticalSortHint`
`columnsAboutToBeInserted`	columnsAboutToBeInserted(self, QModelIndex, int, int) [signal]
`columnsAboutToBeMoved`	columnsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`columnsAboutToBeRemoved`	columnsAboutToBeRemoved(self, QModelIndex, int, int) [signal]
`columnsInserted`	columnsInserted(self, QModelIndex, int, int) [signal]
`columnsMoved`	columnsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`columnsRemoved`	columnsRemoved(self, QModelIndex, int, int) [signal]
`dataChanged`	dataChanged(self, QModelIndex, QModelIndex, Iterable[int] = []) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`layoutAboutToBeChanged`	layoutAboutToBeChanged(self, object = QList<QPersistentModelIndex>(), QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]
`layoutChanged`	layoutChanged(self, Iterable[QPersistentModelIndex] = [], QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]
`modelAboutToBeReset`	modelAboutToBeReset(self) [signal]
`modelReset`	modelReset(self) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`rowsAboutToBeInserted`	rowsAboutToBeInserted(self, QModelIndex, int, int) [signal]
`rowsAboutToBeMoved`	rowsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`rowsAboutToBeRemoved`	rowsAboutToBeRemoved(self, QModelIndex, int, int) [signal]
`rowsInserted`	rowsInserted(self, QModelIndex, int, int) [signal]
`rowsMoved`	rowsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`rowsRemoved`	rowsRemoved(self, QModelIndex, int, int) [signal]
`staticMetaObject`

addLegendToLayer()¶

beginInsertColumns()¶

beginInsertRows()¶

beginMoveColumns()¶

beginMoveRows()¶

beginRemoveColumns()¶

beginRemoveRows()¶

beginResetModel()¶

changePersistentIndex()¶

changePersistentIndexList()¶

childEvent()¶

connectNotify()¶

connectToLayer()¶

connectToLayers()¶

connectToRootNode()¶

createIndex()¶

customEvent()¶

data(self, index: QModelIndex, role: int) → Any¶

decodeData()¶

disconnectFromLayer()¶

disconnectFromLayers()¶

disconnectFromRootNode()¶

disconnectNotify()¶

encodeData()¶

endInsertColumns()¶

endInsertRows()¶

endMoveColumns()¶

endMoveRows()¶

endRemoveColumns()¶

endRemoveRows()¶

endResetModel()¶

filterLegendNodes()¶

flags(self, index: QModelIndex) → Qt.ItemFlags¶

iconGroup()¶

indexOfParentLayerTreeNode()¶

invalidateLegendMapBasedData()¶

isSignalConnected()¶

layerLegendChanged()¶

layerNeedsUpdate()¶

legendCleanup()¶

legendEmbeddedInParent()¶

legendIconEmbeddedInParent()¶

legendInvalidateMapBasedData()¶

legendNodeData()¶

legendNodeDataChanged()¶

legendNodeFlags()¶

legendNodeIndex()¶

legendNodeRowCount()¶

legendParent()¶

legendRootIndex()¶

legendRootRowCount()¶

nodeAddedChildren()¶

nodeCustomPropertyChanged()¶

nodeLayerLoaded()¶

nodeLayerWillBeUnloaded()¶

nodeNameChanged()¶

nodeRemovedChildren()¶

nodeVisibilityChanged()¶

nodeWillAddChildren()¶

nodeWillRemoveChildren()¶

persistentIndexList()¶

receivers()¶

recursivelyEmitDataChanged()¶

refreshScaleBasedLayers()¶

removeLegendFromLayer()¶

resetInternalData()¶

sender()¶

senderSignalIndex()¶

timerEvent()¶