Class: QgsLayoutItemHtml

class qgis.core.QgsLayoutItemHtml(layout: QgsLayout)

Bases: qgis._core.QgsLayoutMultiFrame

Constructor for QgsLayoutItemHtml, with the specified parent layout.

Ownership is transferred to the layout.

A layout multiframe subclass for HTML content.

New in version 3.0: Methods

childEvent
connectNotify
contentMode Returns the source mode for item’s HTML content.
create Returns a new QgsLayoutItemHtml for the specified parent layout.
customEvent
disconnectNotify
displayName
evaluateExpressions Returns whether html item will evaluate QGIS expressions prior to rendering the HTML content.
findNearbyPageBreak
html Returns the HTML source displayed in the item if the item is using the QgsLayoutItemHtml.ManualHtml mode.
icon
isSignalConnected
loadHtml Reloads the html source from the url and redraws the item.
maxBreakDistance Returns the maximum distance allowed when calculating where to place page breaks in the html.
readObjectPropertiesFromElement
readPropertiesFromElement
recalculateFrameSizes Recalculates the frame sizes for the current viewport dimensions
receivers
refreshDataDefinedProperty
render
sender
senderSignalIndex
setContentMode Sets the source mode for item’s HTML content.
setEvaluateExpressions Sets whether the html item will evaluate QGIS expressions prior to rendering the HTML content.
setHtml Sets the html to display in the item when the item is using the QgsLayoutItemHtml.ManualHtml mode.
setMaxBreakDistance Sets the maximum distance allowed when calculating where to place page breaks in the html.
setUrl Sets the url for content to display in the item when the item is using the QgsLayoutItemHtml.Url mode.
setUseSmartBreaks Sets whether the html item should use smart breaks.
setUserStylesheet Sets the user stylesheet CSS rules to use while rendering the HTML content.
setUserStylesheetEnabled Sets whether user stylesheets are enabled for the HTML content.
timerEvent
totalSize
type
url Returns the URL of the content displayed in the item if the item is using the QgsLayoutItemHtml.Url mode.
useSmartBreaks Returns whether html item is using smart breaks.
userStylesheet Returns the user stylesheet CSS rules used while rendering the HTML content.
userStylesheetEnabled Returns whether user stylesheets are enabled for the HTML content.
writeObjectPropertiesToElement
writePropertiesToElement

Signals

Attributes

ManualHtml
Url
class ContentMode

Bases: int

ManualHtml = 1
Url = 0
childEvent()
connectNotify()
contentMode(self) → QgsLayoutItemHtml.ContentMode

Returns the source mode for item’s HTML content.

See also

setContentMode()

See also

url()

See also

html()

create(layout: QgsLayout) → QgsLayoutItemHtml

Returns a new QgsLayoutItemHtml for the specified parent layout.

customEvent()
disconnectNotify()
displayName(self) → str
evaluateExpressions(self) → bool

Returns whether html item will evaluate QGIS expressions prior to rendering the HTML content. If set, any content inside [% %] tags will be treated as a QGIS expression and evaluated against the current atlas feature.

findNearbyPageBreak(self, yPos: float) → float
html(self) → str

Returns the HTML source displayed in the item if the item is using the QgsLayoutItemHtml.ManualHtml mode.

See also

setHtml()

See also

contentMode()

icon(self) → QIcon
isSignalConnected()
loadHtml(self, useCache: bool = False, context: QgsExpressionContext = None)

Reloads the html source from the url and redraws the item.

Parameters:
  • useCache – set to true to use a cached copy of remote html content
  • context – expression context for evaluating data defined urls and expressions in html

See also

setUrl()

See also

url()

maxBreakDistance(self) → float

Returns the maximum distance allowed when calculating where to place page breaks in the html. This distance is the maximum amount of empty space allowed at the bottom of a frame after calculating the optimum break location. This setting is only effective if useSmartBreaks is true.

See also

useSmartBreaks()

readObjectPropertiesFromElement()
readPropertiesFromElement(self, itemElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool
recalculateFrameSizes(self)

Recalculates the frame sizes for the current viewport dimensions

receivers()
refreshDataDefinedProperty(self, property: QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties)
render(self, context: QgsLayoutItemRenderContext, renderExtent: QRectF, frameIndex: int)
sender()
senderSignalIndex()
setContentMode(self, mode: QgsLayoutItemHtml.ContentMode)

Sets the source mode for item’s HTML content.

See also

contentMode()

See also

setUrl()

See also

setHtml()

setEvaluateExpressions(self, evaluateExpressions: bool)

Sets whether the html item will evaluate QGIS expressions prior to rendering the HTML content. If set, any content inside [% %] tags will be treated as a QGIS expression and evaluated against the current atlas feature.

setHtml(self, html: str)

Sets the html to display in the item when the item is using the QgsLayoutItemHtml.ManualHtml mode. Setting the HTML using this function does not automatically refresh the item’s contents. Call loadHtml to trigger a refresh of the item after setting the HTML content.

See also

html()

See also

contentMode()

See also

loadHtml()

setMaxBreakDistance(self, distance: float)

Sets the maximum distance allowed when calculating where to place page breaks in the html. This distance is the maximum amount of empty space allowed at the bottom of a frame after calculating the optimum break location. Setting a larger value will result in better choice of page break location, but more wasted space at the bottom of frames. This setting is only effective if useSmartBreaks is true.

setUrl(self, url: QUrl)

Sets the url for content to display in the item when the item is using the QgsLayoutItemHtml.Url mode. Content is automatically fetched and the HTML item refreshed after calling this function.

See also

url()

See also

contentMode()

setUseSmartBreaks(self, useSmartBreaks: bool)

Sets whether the html item should use smart breaks. Smart breaks prevent the html frame contents from breaking mid-way though a line of text.

See also

useSmartBreaks()

setUserStylesheet(self, stylesheet: str)

Sets the user stylesheet CSS rules to use while rendering the HTML content. These allow for overriding the styles specified within the HTML source. Setting the stylesheet using this function does not automatically refresh the item’s contents. Call loadHtml to trigger a refresh of the item after setting the stylesheet rules.

See also

userStylesheet()

See also

loadHtml()

setUserStylesheetEnabled(self, enabled: bool)

Sets whether user stylesheets are enabled for the HTML content.

timerEvent()
totalSize(self) → QSizeF
type(self) → int
url(self) → QUrl

Returns the URL of the content displayed in the item if the item is using the QgsLayoutItemHtml.Url mode.

See also

setUrl()

See also

contentMode()

useSmartBreaks(self) → bool

Returns whether html item is using smart breaks. Smart breaks prevent the html frame contents from breaking mid-way though a line of text.

userStylesheet(self) → str

Returns the user stylesheet CSS rules used while rendering the HTML content. These overriding the styles specified within the HTML source.

userStylesheetEnabled(self) → bool

Returns whether user stylesheets are enabled for the HTML content.

See also

userStylesheet()

writeObjectPropertiesToElement()
writePropertiesToElement(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool