21 #include "qgsexpression.h" 33 #include <QCoreApplication> 36 #include <QNetworkReply> 41 mHtmlUnitsToLayoutUnits = htmlUnitsToLayoutUnits();
42 mWebPage = qgis::make_unique< QgsWebPage >();
43 mWebPage->setIdentifier( tr(
"Layout HTML item" ) );
44 mWebPage->mainFrame()->setScrollBarPolicy( Qt::Horizontal, Qt::ScrollBarAlwaysOff );
45 mWebPage->mainFrame()->setScrollBarPolicy( Qt::Vertical, Qt::ScrollBarAlwaysOff );
48 QPalette palette = mWebPage->palette();
49 palette.setBrush( QPalette::Base, Qt::transparent );
50 mWebPage->setPalette( palette );
56 setExpressionContext(
mLayout->reportContext().feature(),
mLayout->reportContext().layer() );
65 mFetcher->deleteLater();
122 switch ( mContentMode )
127 QString currentUrl = mUrl.toString();
134 currentUrl = currentUrl.trimmed();
135 QgsDebugMsg( QString(
"exprVal Source Url:%1" ).arg( currentUrl ) );
137 if ( currentUrl.isEmpty() )
141 if ( !( useCache && currentUrl == mLastFetchedUrl ) )
143 loadedHtml = fetchHtml( QUrl( currentUrl ) );
144 mLastFetchedUrl = currentUrl;
148 loadedHtml = mFetchedHtml;
159 if ( mEvaluateExpressions )
161 loadedHtml = QgsExpression::replaceExpressionText( loadedHtml, evalContext, &mDistanceArea );
167 connect( mWebPage.get(), &QWebPage::loadFinished, &loop, [&loaded, &loop ] { loaded =
true; loop.quit(); } );
171 mWebPage->setViewportSize( QSize( maxFrameWidth() * mHtmlUnitsToLayoutUnits, 0 ) );
175 QUrl( mActualFetchedUrl ) :
176 QUrl::fromLocalFile(
mLayout->project()->fileInfo().absoluteFilePath() );
178 mWebPage->mainFrame()->setHtml( loadedHtml, baseUrl );
182 if ( mEnableUserStylesheet && ! mUserStylesheet.isEmpty() )
185 ba.append( mUserStylesheet.toUtf8() );
186 QUrl cssFileURL = QUrl(
"data:text/css;charset=utf-8;base64," + ba.toBase64() );
187 settings->setUserStyleSheetUrl( cssFileURL );
191 settings->setUserStyleSheetUrl( QUrl() );
195 loop.exec( QEventLoop::ExcludeUserInputEvents );
198 if ( !mAtlasFeatureJSON.isEmpty() )
200 JavascriptExecutorLoop jsLoop;
202 mWebPage->mainFrame()->addToJavaScriptWindowObject(
"loop", &jsLoop );
203 mWebPage->mainFrame()->evaluateJavaScript( QStringLiteral(
"if ( typeof setFeature === \"function\" ) { setFeature(%1); }; loop.done();" ).arg( mAtlasFeatureJSON ) );
205 jsLoop.execIfNotDone();
213 double QgsLayoutItemHtml::maxFrameWidth()
const 218 maxWidth = std::max( maxWidth, static_cast< double >(
frame->boundingRect().width() ) );
228 QSize contentsSize = mWebPage->mainFrame()->contentsSize();
231 double maxWidth = maxFrameWidth();
233 contentsSize.setWidth( maxWidth * mHtmlUnitsToLayoutUnits );
235 mWebPage->setViewportSize( contentsSize );
236 mSize.setWidth( contentsSize.width() / mHtmlUnitsToLayoutUnits );
237 mSize.setHeight( contentsSize.height() / mHtmlUnitsToLayoutUnits );
238 if ( contentsSize.isValid() )
246 void QgsLayoutItemHtml::renderCachedImage()
249 mRenderedPage = QImage( mWebPage->viewportSize(), QImage::Format_ARGB32 );
250 if ( mRenderedPage.isNull() )
254 mRenderedPage.fill( Qt::transparent );
256 painter.begin( &mRenderedPage );
257 mWebPage->mainFrame()->render( &painter );
261 QString QgsLayoutItemHtml::fetchHtml(
const QUrl &
url )
270 loop.exec( QEventLoop::ExcludeUserInputEvents );
273 mActualFetchedUrl = mFetcher->
reply()->url().toString();
291 painter->translate( 0.0, -renderExtent.top() * mHtmlUnitsToLayoutUnits );
292 mWebPage->mainFrame()->render( painter, QRegion( renderExtent.left(), renderExtent.top() * mHtmlUnitsToLayoutUnits, renderExtent.width() * mHtmlUnitsToLayoutUnits, renderExtent.height() * mHtmlUnitsToLayoutUnits ) );
296 double QgsLayoutItemHtml::htmlUnitsToLayoutUnits()
308 if ( c1.second < c2.second )
310 else if ( c1.second > c2.second )
312 else if ( c1.first > c2.first )
320 if ( !mWebPage || mRenderedPage.isNull() || !mUseSmartBreaks )
326 int idealPos = yPos * htmlUnitsToLayoutUnits();
329 if ( idealPos >= mRenderedPage.height() )
334 int maxSearchDistance = mMaxBreakDistance * htmlUnitsToLayoutUnits();
340 bool currentPixelTransparent =
false;
341 bool previousPixelTransparent =
false;
343 QList< QPair<int, int> > candidates;
344 int minRow = std::max( idealPos - maxSearchDistance, 0 );
345 for (
int candidateRow = idealPos; candidateRow >= minRow; --candidateRow )
348 currentColor = qRgba( 0, 0, 0, 0 );
350 for (
int col = 0; col < mRenderedPage.width(); ++col )
356 pixelColor = mRenderedPage.pixel( col, candidateRow );
357 currentPixelTransparent = qAlpha( pixelColor ) == 0;
358 if ( pixelColor != currentColor && !( currentPixelTransparent && previousPixelTransparent ) )
361 currentColor = pixelColor;
364 previousPixelTransparent = currentPixelTransparent;
366 candidates.append( qMakePair( candidateRow, changes ) );
370 std::sort( candidates.begin(), candidates.end(),
candidateSort );
377 int maxCandidateRow = candidates[0].first;
378 int minCandidateRow = maxCandidateRow + 1;
379 int minCandidateChanges = candidates[0].second;
381 QList< QPair<int, int> >::iterator it;
382 for ( it = candidates.begin(); it != candidates.end(); ++it )
384 if ( ( *it ).second != minCandidateChanges || ( *it ).first != minCandidateRow - 1 )
389 return ( minCandidateRow + ( maxCandidateRow - minCandidateRow ) / 2 ) / htmlUnitsToLayoutUnits();
391 minCandidateRow = ( *it ).first;
396 return candidates[0].first / htmlUnitsToLayoutUnits();
415 mUserStylesheet = stylesheet;
424 if ( mEnableUserStylesheet != stylesheetEnabled )
426 mEnableUserStylesheet = stylesheetEnabled;
434 return tr(
"<HTML frame>" );
439 htmlElem.setAttribute( QStringLiteral(
"contentMode" ), QString::number( static_cast< int >( mContentMode ) ) );
440 htmlElem.setAttribute( QStringLiteral(
"url" ), mUrl.toString() );
441 htmlElem.setAttribute( QStringLiteral(
"html" ), mHtml );
442 htmlElem.setAttribute( QStringLiteral(
"evaluateExpressions" ), mEvaluateExpressions ?
"true" :
"false" );
443 htmlElem.setAttribute( QStringLiteral(
"useSmartBreaks" ), mUseSmartBreaks ?
"true" :
"false" );
444 htmlElem.setAttribute( QStringLiteral(
"maxBreakDistance" ), QString::number( mMaxBreakDistance ) );
445 htmlElem.setAttribute( QStringLiteral(
"stylesheet" ), mUserStylesheet );
446 htmlElem.setAttribute( QStringLiteral(
"stylesheetEnabled" ), mEnableUserStylesheet ?
"true" :
"false" );
454 if ( !contentModeOK )
458 mEvaluateExpressions = itemElem.attribute( QStringLiteral(
"evaluateExpressions" ), QStringLiteral(
"true" ) ) == QLatin1String(
"true" );
459 mUseSmartBreaks = itemElem.attribute( QStringLiteral(
"useSmartBreaks" ), QStringLiteral(
"true" ) ) == QLatin1String(
"true" );
460 mMaxBreakDistance = itemElem.attribute( QStringLiteral(
"maxBreakDistance" ), QStringLiteral(
"10" ) ).toDouble();
461 mHtml = itemElem.attribute( QStringLiteral(
"html" ) );
462 mUserStylesheet = itemElem.attribute( QStringLiteral(
"stylesheet" ) );
463 mEnableUserStylesheet = itemElem.attribute( QStringLiteral(
"stylesheetEnabled" ), QStringLiteral(
"false" ) ) == QLatin1String(
"true" );
466 QString urlString = itemElem.attribute( QStringLiteral(
"url" ) );
467 if ( !urlString.isEmpty() )
480 mExpressionFeature = feature;
481 mExpressionLayer = layer;
509 mAtlasFeatureJSON.clear();
513 void QgsLayoutItemHtml::refreshExpressionContext()
520 vl =
mLayout->reportContext().layer();
521 feature =
mLayout->reportContext().feature();
524 setExpressionContext( feature, vl );
542 void JavascriptExecutorLoop::done()
548 void JavascriptExecutorLoop::execIfNotDone()
551 exec( QEventLoop::ExcludeUserInputEvents );
555 for (
int i = 0; i < 100; i++ )
556 qApp->processEvents();
bool isValid() const
Returns the validity of this feature.
The class is used as a container of context for various read/write operations on other objects...
ContentMode
Source modes for the HTML content to render in the item.
static QgsLayoutItemHtml * create(QgsLayout *layout)
Returns a new QgsLayoutItemHtml for the specified parent layout.
QgsExpressionContext createExpressionContext() const override
Creates an expression context relating to the objects' current state.
HTML content is manually set for the item.
void setUserStylesheet(const QString &stylesheet)
Sets the user stylesheet CSS rules to use while rendering the HTML content.
double findNearbyPageBreak(double yPos) override
Finds the optimal position to break a frame at.
void changed()
Emitted certain settings in the context is changed, e.g.
QIcon icon() const override
Returns the item's icon.
The QWebSettings class is a collection of stubs to mimic the API of a QWebSettings on systems where Q...
void setHtml(const QString &html)
Sets the html to display in the item when the item is using the QgsLayoutItemHtml::ManualHtml mode...
void recalculateFrameSizes() override
Recalculates the frame sizes for the current viewport dimensions.
static QIcon getThemeIcon(const QString &name)
Helper to get a theme icon.
QList< QgsLayoutFrame * > mFrameItems
QNetworkReply * reply()
Returns a reference to the network reply.
bool writePropertiesToElement(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override
Stores multiframe state within an XML DOM element.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
int frameCount() const
Returns the number of frames associated with this multiframe.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
QString contentAsString() const
Returns the fetched content as a string.
void setUserStylesheetEnabled(const bool enabled)
Sets whether user stylesheets are enabled for the HTML content.
QString html() const
Returns the HTML source displayed in the item if the item is using the QgsLayoutItemHtml::ManualHtml ...
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
QSizeF totalSize() const override
Returns the total size of the multiframe's content, in layout units.
void setEvaluateExpressions(bool evaluateExpressions)
Sets whether the html item will evaluate QGIS expressions prior to rendering the HTML content...
Layout graphical items for displaying a map.
~QgsLayoutItemHtml() override
void contentsChanged()
Emitted when the contents of the multi frame have changed and the frames must be redrawn.
QgsPropertyCollection mDataDefinedProperties
const QgsLayout * layout() const
Returns the layout the object is attached to.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
HTTP network content fetcher.
void setUseSmartBreaks(bool useSmartBreaks)
Sets whether the html item should use smart breaks.
Using this mode item fetches its content via a url.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
void setIncludeRelated(bool includeRelated)
Sets whether to include attributes of features linked via references in the JSON exports.
QPointer< QgsLayout > mLayout
void refreshDataDefinedProperty(const QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties) override
void finished()
Emitted when content has loaded.
QgsCoordinateReferenceSystem crs() const
Returns the layer's spatial reference system.
bool candidateSort(QPair< int, int > c1, QPair< int, int > c2)
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
QgsLayoutItemHtml(QgsLayout *layout)
Constructor for QgsLayoutItemHtml, with the specified parent layout.
virtual void recalculateFrameSizes()
Recalculates the portion of the multiframe item which is shown in each of its component frames...
Handles exporting QgsFeature features to GeoJSON features.
void setUrl(const QUrl &url)
Sets the url for content to display in the item when the item is using the QgsLayoutItemHtml::Url mod...
Contains settings and helpers relating to a render of a QgsLayoutItem.
QgsLayoutFrame * frame(int index) const
Returns the child frame at a specified index from the multiframe.
bool useSmartBreaks() const
Returns whether html item is using smart breaks.
QString valueAsString(int key, const QgsExpressionContext &context, const QString &defaultString=QString(), bool *ok=nullptr) const
Calculates the current value of the property with the specified key and interprets it as a string...
QPainter * painter()
Returns the destination QPainter for the render operation.
void render(QgsLayoutItemRenderContext &context, const QRectF &renderExtent, int frameIndex) override
Renders a portion of the multiframe's content into a render context.
QgsCoordinateReferenceSystem crs() const
Returns coordinate reference system used for rendering the map.
static QgsNetworkAccessManager * instance()
returns a pointer to the single instance
void setMaxBreakDistance(double distance)
Sets the maximum distance allowed when calculating where to place page breaks in the html...
void loadHtml(const bool useCache=false, const QgsExpressionContext *context=nullptr)
Reloads the html source from the url and redraws the item.
double maxBreakDistance() const
Returns the maximum distance allowed when calculating where to place page breaks in the html...
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
bool readPropertiesFromElement(const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context) override
Sets multiframe state from a DOM element.
QString exportFeature(const QgsFeature &feature, const QVariantMap &extraProperties=QVariantMap(), const QVariant &id=QVariant()) const
Returns a GeoJSON string representation of a feature.
void fetchContent(const QUrl &url)
Fetches content from a remote URL and handles redirects.
void changed()
Emitted when the object's properties change.
bool evaluateExpressions() const
Returns whether html item will evaluate QGIS expressions prior to rendering the HTML content...
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
Represents a vector layer which manages a vector based data sets.
DataDefinedProperty
Data defined properties for different item types.
Base class for frame items, which form a layout multiframe item.
A layout multiframe subclass for HTML content.
int type() const override
Returns unique multiframe type id.
QUrl url() const
Returns the URL of the content displayed in the item if the item is using the QgsLayoutItemHtml::Url ...
QString displayName() const override
Returns the multiframe display name.