Class: QgsLayoutAligner¶
- class qgis.core.QgsLayoutAligner¶
Bases:
sip.wrapper
Handles aligning and distributing sets of layout items.
QgsLayoutAligner
contains methods for automatically aligning and distributing sets of layout items, e.g. aligning a group of items to top or left sides.Methods
Aligns a set of
items
from alayout
in place.Distributes a set of
items
from alayout
in place.Resizes a set of
items
from alayout
in place.Attributes
- AlignBottom = 5¶
- AlignHCenter = 1¶
- AlignLeft = 0¶
- AlignRight = 2¶
- AlignTop = 3¶
- AlignVCenter = 4¶
- class Alignment¶
Bases:
int
- DistributeBottom = 7¶
- DistributeHCenter = 1¶
- DistributeHSpace = 2¶
- DistributeLeft = 0¶
- DistributeRight = 3¶
- DistributeTop = 4¶
- DistributeVCenter = 5¶
- DistributeVSpace = 6¶
- class Distribution¶
Bases:
int
- class Resize¶
Bases:
int
- ResizeNarrowest = 0¶
- ResizeShortest = 2¶
- ResizeTallest = 3¶
- ResizeToSquare = 4¶
- ResizeWidest = 1¶
- alignItems(layout: QgsLayout, items: Iterable[QgsLayoutItem], alignment: QgsLayoutAligner.Alignment)¶
Aligns a set of
items
from alayout
in place.The
alignment
argument specifies the method to use when aligning the items.- Parameters
layout (QgsLayout) –
items (Iterable[QgsLayoutItem]) –
alignment (QgsLayoutAligner.Alignment) –
- distributeItems(layout: QgsLayout, items: Iterable[QgsLayoutItem], distribution: QgsLayoutAligner.Distribution)¶
Distributes a set of
items
from alayout
in place.The
distribution
argument specifies the method to use when distributing the items.- Parameters
layout (QgsLayout) –
items (Iterable[QgsLayoutItem]) –
distribution (QgsLayoutAligner.Distribution) –
- resizeItems(layout: QgsLayout, items: Iterable[QgsLayoutItem], resize: QgsLayoutAligner.Resize)¶
Resizes a set of
items
from alayout
in place.The
resize
argument specifies the method to use when resizing the items.- Parameters
layout (QgsLayout) –
items (Iterable[QgsLayoutItem]) –
resize (QgsLayoutAligner.Resize) –