QGIS API Documentation  3.22.4-Białowieża (ce8e65e95e)
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
QgsLayoutItemPicture Class Reference

A layout item subclass that displays SVG files or raster format images (jpg, png, ...). More...

#include <qgslayoutitempicture.h>

Inheritance diagram for QgsLayoutItemPicture:
Inheritance graph
[legend]

Public Types

enum  Format { FormatSVG , FormatRaster , FormatUnknown }
 Format of source image. More...
 
enum  NorthMode { GridNorth = 0 , TrueNorth }
 Method for syncing rotation to a map's North direction. More...
 
enum  ResizeMode {
  Zoom , Stretch , Clip , ZoomResizeFrame ,
  FrameToImageSize
}
 Controls how pictures are scaled within the item's frame. More...
 
- Public Types inherited from QgsLayoutItem
enum  ExportLayerBehavior { CanGroupWithAnyOtherItem , CanGroupWithItemsOfSameType , MustPlaceInOwnLayer , ItemContainsSubLayers }
 Behavior of item when exporting to layered outputs. More...
 
enum  Flag { FlagOverridesPaint = 1 << 1 , FlagProvidesClipPath = 1 << 2 }
 Flags for controlling how an item behaves. More...
 
enum  ReferencePoint {
  UpperLeft , UpperMiddle , UpperRight , MiddleLeft ,
  Middle , MiddleRight , LowerLeft , LowerMiddle ,
  LowerRight
}
 Fixed position reference point. More...
 
enum  UndoCommand {
  UndoNone = -1 , UndoIncrementalMove = 1 , UndoIncrementalResize , UndoStrokeColor ,
  UndoStrokeWidth , UndoBackgroundColor , UndoOpacity , UndoSetId ,
  UndoRotation , UndoShapeStyle , UndoShapeCornerRadius , UndoNodeMove ,
  UndoAtlasMargin , UndoMapRotation , UndoZoomContent , UndoOverviewStyle ,
  UndoGridFramePenColor , UndoMapGridFrameFill1Color , UndoMapGridFrameFill2Color , UndoMapAnnotationDistance ,
  UndoMapGridAnnotationFontColor , UndoMapGridLineSymbol , UndoMapGridMarkerSymbol , UndoMapGridIntervalRange ,
  UndoMapLabelMargin , UndoPictureRotation , UndoPictureFillColor , UndoPictureStrokeColor ,
  UndoPictureStrokeWidth , UndoPictureNorthOffset , UndoLabelText , UndoLabelFont ,
  UndoLabelMargin , UndoLabelFontColor , UndoLegendText , UndoLegendColumnCount ,
  UndoLegendSymbolWidth , UndoLegendSymbolHeight , UndoLegendMaxSymbolSize , UndoLegendMinSymbolSize ,
  UndoLegendWmsLegendWidth , UndoLegendWmsLegendHeight , UndoLegendTitleSpaceBottom , UndoLegendGroupSpace ,
  UndoLegendGroupIndent , UndoLegendSubgroupIndent , UndoLegendLayerSpace , UndoLegendSymbolSpace ,
  UndoLegendIconSymbolSpace , UndoLegendFontColor , UndoLegendBoxSpace , UndoLegendColumnSpace ,
  UndoLegendLineSpacing , UndoLegendRasterStrokeWidth , UndoLegendRasterStrokeColor , UndoLegendTitleFont ,
  UndoLegendGroupFont , UndoLegendLayerFont , UndoLegendItemFont , UndoScaleBarLineWidth ,
  UndoScaleBarSegmentSize , UndoScaleBarSegmentsLeft , UndoScaleBarSegments , UndoScaleBarHeight ,
  UndoScaleBarSubdivisions , UndoScaleBarSubdivisionsHeight , UndoScaleBarFontColor , UndoScaleBarFillColor ,
  UndoScaleBarFillColor2 , UndoScaleBarStrokeColor , UndoScaleBarUnitText , UndoScaleBarMapUnitsSegment ,
  UndoScaleBarLabelBarSize , UndoScaleBarBoxContentSpace , UndoArrowStrokeWidth , UndoArrowHeadWidth ,
  UndoArrowHeadFillColor , UndoArrowHeadStrokeColor , UndoCustomCommand
}
 Layout item undo commands, used for collapsing undo commands. More...
 
- Public Types inherited from QgsLayoutObject
enum  DataDefinedProperty {
  NoProperty = 0 , AllProperties , TestProperty , PresetPaperSize ,
  PaperWidth , PaperHeight , NumPages , PaperOrientation ,
  PageNumber , PositionX , PositionY , ItemWidth ,
  ItemHeight , ItemRotation , Transparency , Opacity ,
  BlendMode , ExcludeFromExports , FrameColor , BackgroundColor ,
  MapRotation , MapScale , MapXMin , MapYMin ,
  MapXMax , MapYMax , MapAtlasMargin , MapLayers ,
  MapStylePreset , MapLabelMargin , MapGridEnabled , MapGridIntervalX ,
  MapGridIntervalY , MapGridOffsetX , MapGridOffsetY , MapGridFrameSize ,
  MapGridFrameMargin , MapGridLabelDistance , MapGridCrossSize , MapGridFrameLineThickness ,
  MapGridAnnotationDisplayLeft , MapGridAnnotationDisplayRight , MapGridAnnotationDisplayTop , MapGridAnnotationDisplayBottom ,
  MapGridFrameDivisionsLeft , MapGridFrameDivisionsRight , MapGridFrameDivisionsTop , MapGridFrameDivisionsBottom ,
  PictureSource , PictureSvgBackgroundColor , PictureSvgStrokeColor , PictureSvgStrokeWidth ,
  SourceUrl , LegendTitle , LegendColumnCount , ScalebarFillColor ,
  ScalebarFillColor2 , ScalebarLineColor , ScalebarLineWidth , AttributeTableSourceLayer ,
  MapCrs , StartDateTime , EndDateTime
}
 Data defined properties for different item types. More...
 
enum  PropertyValueType { EvaluatedValue = 0 , OriginalValue }
 Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
 

Public Slots

void recalculateSize ()
 Forces a recalculation of the picture's frame size. More...
 
void refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties) override
 
void refreshPicture (const QgsExpressionContext *context=nullptr)
 Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture. More...
 
void setPictureRotation (double rotation)
 Sets the picture rotation within the item bounds, in degrees clockwise. More...
 
void setResizeMode (QgsLayoutItemPicture::ResizeMode mode)
 Sets the resize mode used for drawing the picture within the item bounds. More...
 
- Public Slots inherited from QgsLayoutItem
virtual void invalidateCache ()
 Forces a deferred update of any cached image the item uses. More...
 
virtual void redraw ()
 Triggers a redraw (update) of the item. More...
 
void refresh () override
 Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size. More...
 
virtual void refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
virtual void rotateItem (double angle, QPointF transformOrigin)
 Rotates the item by a specified angle in degrees clockwise around a specified reference point. More...
 
virtual void setItemRotation (double rotation, bool adjustPosition=true)
 Sets the layout item's rotation, in degrees clockwise. More...
 
- Public Slots inherited from QgsLayoutObject
virtual void refresh ()
 Refreshes the object, causing a recalculation of any property overrides. More...
 

Signals

void pictureRotationChanged (double newRotation)
 Emitted on picture rotation change. More...
 
- Signals inherited from QgsLayoutItem
void backgroundTaskCountChanged (int count)
 Emitted whenever the number of background tasks an item is executing changes. More...
 
void clipPathChanged ()
 Emitted when the item's clipping path has changed. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
void rotationChanged (double newRotation)
 Emitted on item rotation change. More...
 
void sizePositionChanged ()
 Emitted when the item's size or position changes. More...
 
- Signals inherited from QgsLayoutObject
void changed ()
 Emitted when the object's properties change. More...
 

Public Member Functions

 QgsLayoutItemPicture (QgsLayout *layout)
 Constructor for QgsLayoutItemPicture, with the specified parent layout. More...
 
QString evaluatedPath () const
 Returns the current evaluated picture path, which includes the result of data defined path overrides. More...
 
void finalizeRestoreFromXml () override
 Called after all pending items have been restored from XML. More...
 
QIcon icon () const override
 Returns the item's icon. More...
 
bool isMissingImage () const
 Returns true if the source image is missing and the picture cannot be rendered. More...
 
QgsLayoutItemMaplinkedMap () const
 Returns the linked rotation map, if set. More...
 
Format mode () const
 Returns the current picture mode (image format). More...
 
NorthMode northMode () const
 Returns the mode used to align the picture to a map's North. More...
 
double northOffset () const
 Returns the offset added to the picture's rotation from a map's North. More...
 
QgsLayoutItem::ReferencePoint pictureAnchor () const
 Returns the picture's current anchor, which controls how it is placed within the picture item's frame. More...
 
QString picturePath () const
 Returns the path of the source image. More...
 
double pictureRotation () const
 Returns the rotation used for drawing the picture within the item's frame, in degrees clockwise. More...
 
ResizeMode resizeMode () const
 Returns the resize mode used for drawing the picture within the layout item's frame. More...
 
void setLinkedMap (QgsLayoutItemMap *map)
 Sets the map object for rotation. More...
 
void setMode (Format mode)
 Sets the current picture mode (image format). More...
 
void setNorthMode (NorthMode mode)
 Sets the mode used to align the picture to a map's North. More...
 
void setNorthOffset (double offset)
 Sets the offset added to the picture's rotation from a map's North. More...
 
void setPictureAnchor (QgsLayoutItem::ReferencePoint anchor)
 Sets the picture's anchor point, which controls how it is placed within the picture item's frame. More...
 
void setPicturePath (const QString &path, Format format=FormatUnknown)
 Sets the source path of the image (may be svg or a raster format). More...
 
void setSvgDynamicParameters (const QMap< QString, QgsProperty > &parameters)
 Sets the SVG dynamic parameters. More...
 
void setSvgFillColor (const QColor &color)
 Sets the fill color used for parametrized SVG files. More...
 
void setSvgStrokeColor (const QColor &color)
 Sets the stroke color used for parametrized SVG files. More...
 
void setSvgStrokeWidth (double width)
 Sets the stroke width (in layout units) used for parametrized SVG files. More...
 
QMap< QString, QgsPropertysvgDynamicParameters () const
 Returns the SVG dynamic parameters. More...
 
QColor svgFillColor () const
 Returns the fill color used for parametrized SVG files. More...
 
QColor svgStrokeColor () const
 Returns the stroke color used for parametrized SVG files. More...
 
double svgStrokeWidth () const
 Returns the stroke width (in layout units) used for parametrized SVG files. More...
 
int type () const override
 
- Public Member Functions inherited from QgsLayoutItem
 QgsLayoutItem (QgsLayout *layout, bool manageZValue=true)
 Constructor for QgsLayoutItem, with the specified parent layout. More...
 
 ~QgsLayoutItem () override
 
virtual bool accept (QgsStyleEntityVisitorInterface *visitor) const
 Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item. More...
 
virtual void attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1)
 Attempts to move the item to a specified point. More...
 
void attemptMoveBy (double deltaX, double deltaY)
 Attempts to shift the item's position by a specified deltaX and deltaY, in layout units. More...
 
virtual void attemptResize (const QgsLayoutSize &size, bool includesFrame=false)
 Attempts to resize the item to a specified target size. More...
 
void attemptSetSceneRect (const QRectF &rect, bool includesFrame=false)
 Attempts to update the item's position and size to match the passed rect in layout coordinates. More...
 
QColor backgroundColor () const
 Returns the background color for this item. More...
 
void beginCommand (const QString &commandText, UndoCommand command=UndoNone)
 Starts new undo command for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void cancelCommand ()
 Cancels the current item command and discards it. More...
 
virtual void cleanup ()
 Called just before a batch of items are deleted, allowing them to run cleanup tasks. More...
 
virtual QgsGeometry clipPath () const
 Returns the clipping path generated by this item, in layout coordinates. More...
 
virtual bool containsAdvancedEffects () const
 Returns true if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item. More...
 
QgsAbstractLayoutUndoCommandcreateCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override
 Creates a new layout undo command with the specified text and parent. More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
virtual QString displayName () const
 Gets item display name. More...
 
void endCommand ()
 Completes the current item command and push it onto the layout's undo stack. More...
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool excludeFromExports () const
 Returns whether the item should be excluded from layout exports and prints. More...
 
virtual ExportLayerBehavior exportLayerBehavior () const
 Returns the behavior of this item during exporting to layered exports (e.g. More...
 
virtual QgsLayoutItem::ExportLayerDetail exportLayerDetails () const
 Returns the details for the specified current export layer. More...
 
virtual QgsLayoutSize fixedSize () const
 Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
bool frameEnabled () const
 Returns true if the item includes a frame. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
QColor frameStrokeColor () const
 Returns the frame's stroke color. More...
 
QgsLayoutMeasurement frameStrokeWidth () const
 Returns the frame's stroke width. More...
 
bool hasBackground () const
 Returns true if the item has a background. More...
 
QString id () const
 Returns the item's ID name. More...
 
bool isGroupMember () const
 Returns true if the item is part of a QgsLayoutItemGroup group. More...
 
bool isLocked () const
 Returns true if the item is locked, and cannot be interacted with using the mouse. More...
 
virtual Flags itemFlags () const
 Returns the item's flags, which indicate how the item behaves. More...
 
double itemOpacity () const
 Returns the item's opacity. More...
 
double itemRotation () const
 Returns the current rotation for the item, in degrees clockwise. More...
 
virtual QgsLayoutSize minimumSize () const
 Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
virtual void moveContent (double dx, double dy)
 Moves the content of the item, by a specified dx and dy in layout units. More...
 
virtual bool nextExportPart ()
 Moves to the next export part for a multi-layered export item, during a multi-layered export. More...
 
virtual Q_DECL_DEPRECATED int numberExportLayers () const
 Returns the number of layers that this item requires for exporting during layered exports (e.g. More...
 
int page () const
 Returns the page the item is currently on, with the first page returning 0. More...
 
QPointF pagePos () const
 Returns the item's position (in layout units) relative to the top left corner of its current page. More...
 
QgsLayoutPoint pagePositionWithUnits () const
 Returns the item's position (in item units) relative to the top left corner of its current page. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override
 Handles preparing a paint surface for the layout item and painting the item's content. More...
 
QgsLayoutItemGroupparentGroup () const
 Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group. More...
 
QgsLayoutPoint positionWithUnits () const
 Returns the item's current position, including units. More...
 
bool readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets the item state from a DOM element. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
ReferencePoint referencePoint () const
 Returns the reference point for positioning of the layout item. More...
 
virtual bool requiresRasterization () const
 Returns true if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats. More...
 
void setBackgroundColor (const QColor &color)
 Sets the background color for this item. More...
 
void setBackgroundEnabled (bool drawBackground)
 Sets whether this item has a background drawn under it or not. More...
 
void setBlendMode (QPainter::CompositionMode mode)
 Sets the item's composition blending mode. More...
 
void setExcludeFromExports (bool exclude)
 Sets whether the item should be excluded from layout exports and prints. More...
 
virtual void setFrameEnabled (bool drawFrame)
 Sets whether this item has a frame drawn around it or not. More...
 
void setFrameJoinStyle (Qt::PenJoinStyle style)
 Sets the join style used when drawing the item's frame. More...
 
void setFrameStrokeColor (const QColor &color)
 Sets the frame stroke color. More...
 
virtual void setFrameStrokeWidth (QgsLayoutMeasurement width)
 Sets the frame stroke width. More...
 
virtual void setId (const QString &id)
 Set the item's id name. More...
 
void setItemOpacity (double opacity)
 Sets the item's opacity. More...
 
void setLocked (bool locked)
 Sets whether the item is locked, preventing mouse interactions with the item. More...
 
virtual void setMoveContentPreviewOffset (double dx, double dy)
 Sets temporary offset for the item, by a specified dx and dy in layout units. More...
 
void setParentGroup (QgsLayoutItemGroup *group)
 Sets the item's parent group. More...
 
void setReferencePoint (ReferencePoint point)
 Sets the reference point for positioning of the layout item. More...
 
virtual void setSelected (bool selected)
 Sets whether the item should be selected. More...
 
virtual void setVisibility (bool visible)
 Sets whether the item is visible. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
QgsLayoutSize sizeWithUnits () const
 Returns the item's current size, including units. More...
 
virtual void startLayeredExport ()
 Starts a multi-layer export operation. More...
 
virtual void stopLayeredExport ()
 Stops a multi-layer export operation. More...
 
int type () const override
 Returns a unique graphics item type identifier. More...
 
virtual QString uuid () const
 Returns the item identification string. More...
 
bool writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores the item state in a DOM element. More...
 
virtual void zoomContent (double factor, QPointF point)
 Zooms content of item. More...
 
- Public Member Functions inherited from QgsLayoutObject
 QgsLayoutObject (QgsLayout *layout)
 Constructor for QgsLayoutObject, with the specified parent layout. More...
 
QgsExpressionContext createExpressionContext () const override
 Creates an expression context relating to the objects' current state. More...
 
QStringList customProperties () const
 Returns list of keys stored in custom properties for the object. More...
 
QVariant customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const
 Read a custom property from the object. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
QgsLayoutlayout ()
 Returns the layout the object is attached to. More...
 
const QgsLayoutlayout () const
 Returns the layout the object is attached to. More...
 
void removeCustomProperty (const QString &key)
 Remove a custom property from the object. More...
 
void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for the object. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the objects's property collection, used for data defined overrides. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 
- Public Member Functions inherited from QgsLayoutUndoObjectInterface
virtual ~QgsLayoutUndoObjectInterface ()=default
 Destructor for QgsLayoutUndoObjectInterface. More...
 

Static Public Member Functions

static QgsLayoutItemPicturecreate (QgsLayout *layout)
 Returns a new picture item for the specified layout. More...
 
- Static Public Member Functions inherited from QgsLayoutObject
static bool propertyAssociatesWithParentMultiframe (DataDefinedProperty property)
 Returns true if the specified property key is normally associated with the parent QgsLayoutMultiFrame object instead of a child QgsLayoutFrame object. More...
 
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the layout object property definitions. More...
 

Protected Member Functions

QSizeF applyItemSizeConstraint (QSizeF targetSize) override
 Applies any item-specific size constraint handling to a given targetSize in layout units. More...
 
void draw (QgsLayoutItemRenderContext &context) override
 Draws the item's contents using the specified item render context. More...
 
bool readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
 Sets item state from a DOM element. More...
 
bool writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
 Stores item state within an XML DOM element. More...
 
- Protected Member Functions inherited from QgsLayoutItem
QPointF adjustPointForReferencePosition (QPointF point, QSizeF size, ReferencePoint reference) const
 Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position. More...
 
QgsLayoutSize applyDataDefinedSize (const QgsLayoutSize &size)
 Applies any present data defined size overrides to the specified layout size. More...
 
virtual void drawBackground (QgsRenderContext &context)
 Draws the background for the item. More...
 
virtual void drawDebugRect (QPainter *painter)
 Draws a debugging rectangle of the item's current bounds within the specified painter. More...
 
virtual void drawFrame (QgsRenderContext &context)
 Draws the frame around the item. More...
 
virtual QPainterPath framePath () const
 Returns the path to use when drawing the item's frame or background. More...
 
QPointF positionAtReferencePoint (ReferencePoint reference) const
 Returns the current position (in layout units) of a reference point for the item. More...
 
void refreshBackgroundColor (bool updateItem=true)
 Refresh item's background color, considering data defined colors. More...
 
void refreshBlendMode ()
 Refresh item's blend mode, considering data defined blend mode. More...
 
void refreshFrame (bool updateItem=true)
 Refresh item's frame, considering data defined colors and frame size. More...
 
void refreshItemPosition ()
 Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning. More...
 
void refreshItemRotation (QPointF *origin=nullptr)
 Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation. More...
 
void refreshItemSize ()
 Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes. More...
 
void refreshOpacity (bool updateItem=true)
 Refresh item's opacity, considering data defined opacity. More...
 
virtual void setFixedSize (const QgsLayoutSize &size)
 Sets a fixed size for the layout item, which prevents it from being freely resized. More...
 
virtual void setMinimumSize (const QgsLayoutSize &size)
 Sets the minimum allowed size for the layout item. More...
 
QgsLayoutPoint topLeftToReferencePoint (const QgsLayoutPoint &point) const
 Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point. More...
 
- Protected Member Functions inherited from QgsLayoutObject
bool readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets object properties from a DOM element. More...
 
bool writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores object properties within an XML DOM element. More...
 

Friends

class QgsCompositionConverter
 
class TestQgsCompositionConverter
 

Additional Inherited Members

- Protected Attributes inherited from QgsLayoutObject
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QgsPropertyCollection mDataDefinedProperties
 
QPointer< QgsLayoutmLayout
 
- Properties inherited from QgsLayoutItem
bool locked
 

Detailed Description

A layout item subclass that displays SVG files or raster format images (jpg, png, ...).

Since
QGIS 3.0

Definition at line 35 of file qgslayoutitempicture.h.

Member Enumeration Documentation

◆ Format

Format of source image.

Enumerator
FormatSVG 

SVG image.

FormatRaster 

Raster image.

FormatUnknown 

Invalid or unknown image type.

Definition at line 55 of file qgslayoutitempicture.h.

◆ NorthMode

Method for syncing rotation to a map's North direction.

Enumerator
GridNorth 

Align to grid north.

TrueNorth 

Align to true north.

Definition at line 63 of file qgslayoutitempicture.h.

◆ ResizeMode

Controls how pictures are scaled within the item's frame.

Enumerator
Zoom 

Enlarges image to fit frame while maintaining aspect ratio of picture.

Stretch 

Stretches image to fit frame, ignores aspect ratio.

Clip 

Draws image at original size and clips any portion which falls outside frame.

ZoomResizeFrame 

Enlarges image to fit frame, then resizes frame to fit resultant image.

FrameToImageSize 

Sets size of frame to match original size of image without scaling.

Definition at line 43 of file qgslayoutitempicture.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemPicture()

QgsLayoutItemPicture::QgsLayoutItemPicture ( QgsLayout layout)

Constructor for QgsLayoutItemPicture, with the specified parent layout.

Definition at line 53 of file qgslayoutitempicture.cpp.

Member Function Documentation

◆ applyItemSizeConstraint()

QSizeF QgsLayoutItemPicture::applyItemSizeConstraint ( QSizeF  targetSize)
overrideprotectedvirtual

Applies any item-specific size constraint handling to a given targetSize in layout units.

Subclasses can override this method if they need to apply advanced logic regarding item sizes, which cannot be covered by setFixedSize() or setMinimumSize(). Item size constraints are applied after fixed, minimum and data defined size constraints.

See also
setFixedSize()
setMinimumSize()

Reimplemented from QgsLayoutItem.

Definition at line 214 of file qgslayoutitempicture.cpp.

◆ create()

QgsLayoutItemPicture * QgsLayoutItemPicture::create ( QgsLayout layout)
static

Returns a new picture item for the specified layout.

The caller takes responsibility for deleting the returned object.

Definition at line 83 of file qgslayoutitempicture.cpp.

◆ draw()

void QgsLayoutItemPicture::draw ( QgsLayoutItemRenderContext context)
overrideprotectedvirtual

Draws the item's contents using the specified item render context.

Note that the context's painter has been scaled so that painter units are pixels. Use the QgsRenderContext methods to convert from millimeters or other units to the painter's units.

Implements QgsLayoutItem.

Definition at line 88 of file qgslayoutitempicture.cpp.

◆ evaluatedPath()

QString QgsLayoutItemPicture::evaluatedPath ( ) const

Returns the current evaluated picture path, which includes the result of data defined path overrides.

See also
picturePath()
Since
QGIS 3.6

Definition at line 667 of file qgslayoutitempicture.cpp.

◆ finalizeRestoreFromXml()

void QgsLayoutItemPicture::finalizeRestoreFromXml ( )
overridevirtual

Called after all pending items have been restored from XML.

Items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. a scalebar can use this to connect to its linked map item after restoration from XML.

See also
readXml()

Reimplemented from QgsLayoutItem.

Definition at line 939 of file qgslayoutitempicture.cpp.

◆ icon()

QIcon QgsLayoutItemPicture::icon ( ) const
overridevirtual

Returns the item's icon.

Reimplemented from QgsLayoutItem.

Definition at line 78 of file qgslayoutitempicture.cpp.

◆ isMissingImage()

bool QgsLayoutItemPicture::isMissingImage ( ) const

Returns true if the source image is missing and the picture cannot be rendered.

Since
QGIS 3.6

Definition at line 662 of file qgslayoutitempicture.cpp.

◆ linkedMap()

QgsLayoutItemMap * QgsLayoutItemPicture::linkedMap ( ) const

Returns the linked rotation map, if set.

An nullptr means map rotation is disabled. If this is set then the picture is rotated by the same amount as the specified map object.

See also
setLinkedMap()

Definition at line 881 of file qgslayoutitempicture.cpp.

◆ mode()

Format QgsLayoutItemPicture::mode ( ) const
inline

Returns the current picture mode (image format).

See also
setMode()

Definition at line 235 of file qgslayoutitempicture.h.

◆ northMode()

QgsLayoutItemPicture::NorthMode QgsLayoutItemPicture::northMode ( ) const

Returns the mode used to align the picture to a map's North.

See also
setNorthMode()
northOffset()

Definition at line 886 of file qgslayoutitempicture.cpp.

◆ northOffset()

double QgsLayoutItemPicture::northOffset ( ) const

Returns the offset added to the picture's rotation from a map's North.

See also
setNorthOffset()
northMode()

Definition at line 896 of file qgslayoutitempicture.cpp.

◆ pictureAnchor()

QgsLayoutItem::ReferencePoint QgsLayoutItemPicture::pictureAnchor ( ) const
inline

Returns the picture's current anchor, which controls how it is placed within the picture item's frame.

See also
setPictureAnchor()

Definition at line 180 of file qgslayoutitempicture.h.

◆ picturePath()

QString QgsLayoutItemPicture::picturePath ( ) const

Returns the path of the source image.

Data defined picture source may override this value. The path can either be a local path or a remote (http) path.

Returns
path for the source image
See also
setPicturePath()
evaluatedPath()

Definition at line 775 of file qgslayoutitempicture.cpp.

◆ pictureRotation()

double QgsLayoutItemPicture::pictureRotation ( ) const
inline

Returns the rotation used for drawing the picture within the item's frame, in degrees clockwise.

See also
setPictureRotation()
linkedMap()

Definition at line 111 of file qgslayoutitempicture.h.

◆ pictureRotationChanged

void QgsLayoutItemPicture::pictureRotationChanged ( double  newRotation)
signal

Emitted on picture rotation change.

◆ readPropertiesFromElement()

bool QgsLayoutItemPicture::readPropertiesFromElement ( const QDomElement &  element,
const QDomDocument &  document,
const QgsReadWriteContext context 
)
overrideprotectedvirtual

Sets item state from a DOM element.

Parameters
elementis the DOM element for the item
documentDOM document
contextread write context

Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring a scalebar, the connection to the linked map's signals should be implemented in finalizeRestoreFromXml(), not readPropertiesFromElement().

See also
writePropertiesToElement()
readXml()

Reimplemented from QgsLayoutItem.

Definition at line 816 of file qgslayoutitempicture.cpp.

◆ recalculateSize

void QgsLayoutItemPicture::recalculateSize ( )
slot

Forces a recalculation of the picture's frame size.

Definition at line 748 of file qgslayoutitempicture.cpp.

◆ refreshDataDefinedProperty

void QgsLayoutItemPicture::refreshDataDefinedProperty ( QgsLayoutObject::DataDefinedProperty  property = QgsLayoutObject::AllProperties)
overrideslot

Definition at line 755 of file qgslayoutitempicture.cpp.

◆ refreshPicture

void QgsLayoutItemPicture::refreshPicture ( const QgsExpressionContext context = nullptr)
slot

Recalculates the source image (if using an expression for picture's source) and reloads and redraws the picture.

Parameters
contextexpression context for evaluating data defined picture sources

Definition at line 342 of file qgslayoutitempicture.cpp.

◆ resizeMode()

ResizeMode QgsLayoutItemPicture::resizeMode ( ) const
inline

Returns the resize mode used for drawing the picture within the layout item's frame.

See also
setResizeMode()

Definition at line 166 of file qgslayoutitempicture.h.

◆ setLinkedMap()

void QgsLayoutItemPicture::setLinkedMap ( QgsLayoutItemMap map)

Sets the map object for rotation.

If this is set then the picture will be rotated by the same amount as the specified map object. This is useful especially for syncing north arrows with a map item.

See also
setPictureRotation()
linkedMap()

Definition at line 731 of file qgslayoutitempicture.cpp.

◆ setMode()

void QgsLayoutItemPicture::setMode ( QgsLayoutItemPicture::Format  mode)

Sets the current picture mode (image format).

See also
mode()
Since
QGIS 3.14

Definition at line 930 of file qgslayoutitempicture.cpp.

◆ setNorthMode()

void QgsLayoutItemPicture::setNorthMode ( QgsLayoutItemPicture::NorthMode  mode)

Sets the mode used to align the picture to a map's North.

See also
northMode()
setNorthOffset()

Definition at line 891 of file qgslayoutitempicture.cpp.

◆ setNorthOffset()

void QgsLayoutItemPicture::setNorthOffset ( double  offset)

Sets the offset added to the picture's rotation from a map's North.

See also
northOffset()
setNorthMode()

Definition at line 901 of file qgslayoutitempicture.cpp.

◆ setPictureAnchor()

void QgsLayoutItemPicture::setPictureAnchor ( QgsLayoutItem::ReferencePoint  anchor)

Sets the picture's anchor point, which controls how it is placed within the picture item's frame.

See also
pictureAnchor()

Definition at line 906 of file qgslayoutitempicture.cpp.

◆ setPicturePath()

void QgsLayoutItemPicture::setPicturePath ( const QString &  path,
Format  format = FormatUnknown 
)

Sets the source path of the image (may be svg or a raster format).

Data defined picture source may override this value. The path can either be a local path or a remote (http) path.

Ideally, the format argument should specify the image format.

See also
picturePath()

Definition at line 768 of file qgslayoutitempicture.cpp.

◆ setPictureRotation

void QgsLayoutItemPicture::setPictureRotation ( double  rotation)
slot

Sets the picture rotation within the item bounds, in degrees clockwise.

This does not affect the item's frame, only the way the picture is drawn within the item.

See also
pictureRotation()

Definition at line 695 of file qgslayoutitempicture.cpp.

◆ setResizeMode

void QgsLayoutItemPicture::setResizeMode ( QgsLayoutItemPicture::ResizeMode  mode)
slot

Sets the resize mode used for drawing the picture within the item bounds.

Parameters
modeResizeMode to use for image file
See also
resizeMode

Definition at line 736 of file qgslayoutitempicture.cpp.

◆ setSvgDynamicParameters()

void QgsLayoutItemPicture::setSvgDynamicParameters ( const QMap< QString, QgsProperty > &  parameters)

Sets the SVG dynamic parameters.

Since
QGIS 3.20

Definition at line 678 of file qgslayoutitempicture.cpp.

◆ setSvgFillColor()

void QgsLayoutItemPicture::setSvgFillColor ( const QColor &  color)

Sets the fill color used for parametrized SVG files.

Note
This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.
See also
svgFillColor()
setSvgStrokeColor()

Definition at line 912 of file qgslayoutitempicture.cpp.

◆ setSvgStrokeColor()

void QgsLayoutItemPicture::setSvgStrokeColor ( const QColor &  color)

Sets the stroke color used for parametrized SVG files.

Parameters
colorstroke color.
Note
This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.
See also
svgStrokeColor()
setSvgFillColor()

Definition at line 918 of file qgslayoutitempicture.cpp.

◆ setSvgStrokeWidth()

void QgsLayoutItemPicture::setSvgStrokeWidth ( double  width)

Sets the stroke width (in layout units) used for parametrized SVG files.

Note
This setting only has an effect on parametrized SVG files, and is ignored for non-parametrized SVG files.
See also
svgStrokeWidth()
setSvgStrokeColor()

Definition at line 924 of file qgslayoutitempicture.cpp.

◆ svgDynamicParameters()

QMap< QString, QgsProperty > QgsLayoutItemPicture::svgDynamicParameters ( ) const

Returns the SVG dynamic parameters.

Since
QGIS 3.20

Definition at line 672 of file qgslayoutitempicture.cpp.

◆ svgFillColor()

QColor QgsLayoutItemPicture::svgFillColor ( ) const
inline

Returns the fill color used for parametrized SVG files.

See also
setSvgFillColor()
svgStrokeColor()

Definition at line 187 of file qgslayoutitempicture.h.

◆ svgStrokeColor()

QColor QgsLayoutItemPicture::svgStrokeColor ( ) const
inline

Returns the stroke color used for parametrized SVG files.

See also
setSvgStrokeColor()
svgFillColor()

Definition at line 203 of file qgslayoutitempicture.h.

◆ svgStrokeWidth()

double QgsLayoutItemPicture::svgStrokeWidth ( ) const
inline

Returns the stroke width (in layout units) used for parametrized SVG files.

See also
setSvgStrokeWidth()
svgStrokeColor()

Definition at line 220 of file qgslayoutitempicture.h.

◆ type()

int QgsLayoutItemPicture::type ( ) const
override

Definition at line 73 of file qgslayoutitempicture.cpp.

◆ writePropertiesToElement()

bool QgsLayoutItemPicture::writePropertiesToElement ( QDomElement &  element,
QDomDocument &  document,
const QgsReadWriteContext context 
) const
overrideprotectedvirtual

Stores item state within an XML DOM element.

Parameters
elementis the DOM element to store the item's properties in
documentDOM document
contextread write context
See also
writeXml()
readPropertiesFromElement()

Reimplemented from QgsLayoutItem.

Definition at line 780 of file qgslayoutitempicture.cpp.

Friends And Related Function Documentation

◆ QgsCompositionConverter

friend class QgsCompositionConverter
friend

Definition at line 391 of file qgslayoutitempicture.h.

◆ TestQgsCompositionConverter

friend class TestQgsCompositionConverter
friend

Definition at line 392 of file qgslayoutitempicture.h.


The documentation for this class was generated from the following files: