Class: QgsLayoutItemHtml

class qgis.core.QgsLayoutItemHtml(layout: QgsLayout)

Bases: 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.

Parameters

layout

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()

Return type

QgsLayoutItemHtml.ContentMode

create(layout: QgsLayout) → QgsLayoutItemHtml

Returns a new QgsLayoutItemHtml for the specified parent layout.

Parameters

layout (QgsLayout) –

Return type

QgsLayoutItemHtml

customEvent()
disconnectNotify()
displayName(self) → str
Return type

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.

Return type

bool

findNearbyPageBreak(self, yPos: float) → float
Parameters

yPos (float) –

Return type

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()

Return type

str

icon(self) → QIcon
Return type

QIcon

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

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

Parameters
  • useCache (bool = False) – set to True to use a cached copy of remote html content

  • context (QgsExpressionContext = None) – 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()

Return type

float

readObjectPropertiesFromElement()
readPropertiesFromElement(self, itemElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
Return type

bool

recalculateFrameSizes(self)

Recalculates the frame sizes for the current viewport dimensions

receivers()
refreshDataDefinedProperty(self, property: QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties)
Parameters

property (QgsLayoutObject.DataDefinedProperty = QgsLayoutObject.AllProperties) –

render(self, context: QgsLayoutItemRenderContext, renderExtent: QRectF, frameIndex: int)
Parameters
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()

Parameters

mode (QgsLayoutItemHtml.ContentMode) –

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.

Parameters

evaluateExpressions (bool) –

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()

Parameters

html (str) –

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.

Parameters

distance (float) –

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()

Parameters

url (QUrl) –

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()

Parameters

useSmartBreaks (bool) –

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()

Parameters

stylesheet (str) –

setUserStylesheetEnabled(self, enabled: bool)

Sets whether user stylesheets are enabled for the HTML content.

Parameters

enabled (bool) –

timerEvent()
totalSize(self) → QSizeF
Return type

QSizeF

type(self) → int
Return type

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()

Return type

QUrl

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.

Return type

bool

userStylesheet(self) → str

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

Return type

str

userStylesheetEnabled(self) → bool

Returns whether user stylesheets are enabled for the HTML content.

See also

userStylesheet()

Return type

bool

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

bool