def testFromString(self):
self.assertTrue(QgsMargins.fromString('').isNull())
self.assertTrue(QgsMargins.fromString('not good').isNull())
self.assertTrue(QgsMargins.fromString('1,2,3').isNull())
self.assertTrue(QgsMargins.fromString('1,2,3,4,5').isNull())
self.assertEqual(QgsMargins.fromString('1,2,3,4'), QgsMargins(1, 2, 3, 4))
self.assertEqual(QgsMargins.fromString('1,-2,3,-4'), QgsMargins(1, -2, 3, -4))
def testOperators(self):
m1 = QgsMargins(12.1, 14.1, 16.1, 18.1)
m2 = QgsMargins(2.1, 3.1, 4.1, 5.1)
added = m1 + m2
self.assertAlmostEqual(added.left(), 14.2)
self.assertAlmostEqual(added.top(), 17.2)
self.assertAlmostEqual(added.right(), 20.2)
self.assertAlmostEqual(added.bottom(), 23.2)
a = QgsMargins(m1)
a += m2
self.assertEqual(a, added)
subtracted = m1 - m2
self.assertAlmostEqual(subtracted.left(), 10.0)
self.assertAlmostEqual(subtracted.top(), 11.0)
self.assertAlmostEqual(subtracted.right(), 12.0)
self.assertAlmostEqual(subtracted.bottom(), 13.0)
a = QgsMargins(m1)
a -= m2
self.assertEqual(a, subtracted)
h = QgsMargins(m1)
h += 2.1
self.assertAlmostEqual(h.left(), 14.2)
self.assertAlmostEqual(h.top(), 16.2)
self.assertAlmostEqual(h.right(), 18.2)
self.assertAlmostEqual(h.bottom(), 20.2)
h -= 2.1
self.assertEqual(h, m1)
doubled = m1 * 2.0
self.assertEqual(doubled, QgsMargins(24.2, 28.2, 32.2, 36.2))
self.assertEqual(2.0 * m1, doubled)
self.assertEqual(m1 * 2.0, doubled)
a = QgsMargins(m1)
a *= 2.0
self.assertEqual(a, doubled)
halved = m1 / 2.0
self.assertAlmostEqual(halved.left(), 6.05)
self.assertAlmostEqual(halved.top(), 7.05)
self.assertAlmostEqual(halved.right(), 8.05)
self.assertAlmostEqual(halved.bottom(), 9.05)
a = QgsMargins(m1)
a /= 2.0
self.assertEqual(a, halved)
self.assertEqual(m1 + (-m1), QgsMargins())
m3 = QgsMargins(10.3, 11.4, 12.5, 13.6)
self.assertEqual(m3 + 1.1, QgsMargins(11.4, 12.5, 13.6, 14.7))
self.assertEqual(1.1 + m3, QgsMargins(11.4, 12.5, 13.6, 14.7))
m4 = m3 - 1.1
self.assertAlmostEqual(m4.left(), 9.2)
self.assertAlmostEqual(m4.top(), 10.3)
self.assertAlmostEqual(m4.right(), 11.4)
self.assertAlmostEqual(m4.bottom(), 12.5)
self.assertEqual(+m3, QgsMargins(10.3, 11.4, 12.5, 13.6))
self.assertEqual(-m3, QgsMargins(-10.3, -11.4, -12.5, -13.6))
def testGetSet(self):
margins = QgsMargins()
margins.setLeft(1.1)
self.assertEqual(margins.left(), 1.1)
margins.setTop(2.2)
self.assertEqual(margins.top(), 2.2)
margins.setBottom(3.3)
self.assertEqual(margins.bottom(), 3.3)
margins.setRight(4.4)
self.assertEqual(margins.right(), 4.4)
margins = QgsMargins()
self.assertTrue(margins.isNull())
margins.setLeft(5.5)
margins.setRight(5.5)
self.assertFalse(margins.isNull())
self.assertEqual(margins, QgsMargins(5.5, 0.0, 5.5, 0.0))
def testToString(self):
# null margin
self.assertFalse(QgsMargins().toString())
self.assertEqual(QgsMargins(1, 2, 3, 4).toString(), '1,2,3,4')
self.assertEqual(QgsMargins(1, -2, 3, -4).toString(), '1,-2,3,-4')
def testOperators(self):
m1 = QgsMargins(12.1, 14.1, 16.1, 18.1)
m2 = QgsMargins(2.1, 3.1, 4.1, 5.1)
added = m1 + m2
self.assertAlmostEqual(added.left(), 14.2)
self.assertAlmostEqual(added.top(), 17.2)
self.assertAlmostEqual(added.right(), 20.2)
self.assertAlmostEqual(added.bottom(), 23.2)
a = QgsMargins(m1)
a += m2
self.assertEqual(a, added)
subtracted = m1 - m2
self.assertAlmostEqual(subtracted.left(), 10.0)
self.assertAlmostEqual(subtracted.top(), 11.0)
self.assertAlmostEqual(subtracted.right(), 12.0)
self.assertAlmostEqual(subtracted.bottom(), 13.0)
a = QgsMargins(m1)
a -= m2
self.assertEqual(a, subtracted)
h = QgsMargins(m1)
h += 2.1
self.assertAlmostEqual(h.left(), 14.2)
self.assertAlmostEqual(h.top(), 16.2)
self.assertAlmostEqual(h.right(), 18.2)
self.assertAlmostEqual(h.bottom(), 20.2)
h -= 2.1
self.assertEqual(h, m1)
doubled = m1 * 2.0
self.assertEqual(doubled, QgsMargins(24.2, 28.2, 32.2, 36.2))
self.assertEqual(2.0 * m1, doubled)
self.assertEqual(m1 * 2.0, doubled)
a = QgsMargins(m1)
a *= 2.0
self.assertEqual(a, doubled)
halved = m1 / 2.0
self.assertAlmostEqual(halved.left(), 6.05)
self.assertAlmostEqual(halved.top(), 7.05)
self.assertAlmostEqual(halved.right(), 8.05)
self.assertAlmostEqual(halved.bottom(), 9.05)
a = QgsMargins(m1)
a /= 2.0
self.assertEqual(a, halved)
self.assertEqual(m1 + (-m1), QgsMargins())
m3 = QgsMargins(10.3, 11.4, 12.5, 13.6)
self.assertEqual(m3 + 1.1, QgsMargins(11.4, 12.5, 13.6, 14.7))
self.assertEqual(1.1 + m3, QgsMargins(11.4, 12.5, 13.6, 14.7))
m4 = m3 - 1.1
self.assertAlmostEqual(m4.left(), 9.2)
self.assertAlmostEqual(m4.top(), 10.3)
self.assertAlmostEqual(m4.right(), 11.4)
self.assertAlmostEqual(m4.bottom(), 12.5)
self.assertEqual(+m3, QgsMargins(10.3, 11.4, 12.5, 13.6))
self.assertEqual(-m3, QgsMargins(-10.3, -11.4, -12.5, -13.6))
def testGetSet(self):
margins = QgsMargins()
margins.setLeft(1.1)
self.assertEqual(margins.left(), 1.1)
margins.setTop(2.2)
self.assertEqual(margins.top(), 2.2)
margins.setBottom(3.3)
self.assertEqual(margins.bottom(), 3.3)
margins.setRight(4.4)
self.assertEqual(margins.right(), 4.4)
margins = QgsMargins()
self.assertTrue(margins.isNull())
margins.setLeft(5.5)
margins.setRight(5.5)
self.assertFalse(margins.isNull())
self.assertEqual(margins, QgsMargins(5.5, 0.0, 5.5, 0.0))
def testExportToImage(self):
md = QgsProject.instance().metadata()
md.setTitle('proj title')
md.setAuthor('proj author')
md.setCreationDateTime(
QDateTime(QDate(2011, 5, 3), QTime(9, 4, 5), QTimeZone(36000)))
md.setIdentifier('proj identifier')
md.setAbstract('proj abstract')
md.setKeywords({'kw': ['kw1', 'kw2'], 'KWx': ['kw3', 'kw4']})
QgsProject.instance().setMetadata(md)
l = QgsLayout(QgsProject.instance())
l.initializeDefaults()
# add a second page
page2 = QgsLayoutItemPage(l)
page2.setPageSize('A5')
l.pageCollection().addPage(page2)
# add some items
item1 = QgsLayoutItemShape(l)
item1.attemptSetSceneRect(QRectF(10, 20, 100, 150))
fill = QgsSimpleFillSymbolLayer()
fill_symbol = QgsFillSymbol()
fill_symbol.changeSymbolLayer(0, fill)
fill.setColor(Qt.green)
fill.setStrokeStyle(Qt.NoPen)
item1.setSymbol(fill_symbol)
l.addItem(item1)
item2 = QgsLayoutItemShape(l)
item2.attemptSetSceneRect(QRectF(10, 20, 100, 150))
item2.attemptMove(QgsLayoutPoint(10, 20), page=1)
fill = QgsSimpleFillSymbolLayer()
fill_symbol = QgsFillSymbol()
fill_symbol.changeSymbolLayer(0, fill)
fill.setColor(Qt.cyan)
fill.setStrokeStyle(Qt.NoPen)
item2.setSymbol(fill_symbol)
l.addItem(item2)
exporter = QgsLayoutExporter(l)
# setup settings
settings = QgsLayoutExporter.ImageExportSettings()
settings.dpi = 80
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagedpi.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertTrue(
self.checkImage('exporttoimagedpi_page1', 'exporttoimagedpi_page1',
rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagedpi_2.png')
self.assertTrue(
self.checkImage('exporttoimagedpi_page2', 'exporttoimagedpi_page2',
page2_path))
for f in (rendered_file_path, page2_path):
d = gdal.Open(f)
metadata = d.GetMetadata()
self.assertEqual(metadata['Author'], 'proj author')
self.assertEqual(metadata['Created'], '2011-05-03T09:04:05+10:00')
self.assertEqual(metadata['Keywords'], 'KWx: kw3,kw4;kw: kw1,kw2')
self.assertEqual(metadata['Subject'], 'proj abstract')
self.assertEqual(metadata['Title'], 'proj title')
# crop to contents
settings.cropToContents = True
settings.cropMargins = QgsMargins(10, 20, 30, 40)
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagecropped.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertTrue(
self.checkImage('exporttoimagecropped_page1',
'exporttoimagecropped_page1', rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagecropped_2.png')
self.assertTrue(
self.checkImage('exporttoimagecropped_page2',
'exporttoimagecropped_page2', page2_path))
# specific pages
settings.cropToContents = False
settings.pages = [1]
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagepages.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertFalse(os.path.exists(rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagepages_2.png')
self.assertTrue(
self.checkImage('exporttoimagedpi_page2', 'exporttoimagedpi_page2',
page2_path))
# image size
settings.imageSize = QSize(600, 851)
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagesize.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertFalse(os.path.exists(rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagesize_2.png')
self.assertTrue(
self.checkImage('exporttoimagesize_page2',
'exporttoimagesize_page2', page2_path))
# image size with incorrect aspect ratio
# this can happen as a result of data defined page sizes
settings.imageSize = QSize(851, 600)
rendered_file_path = os.path.join(
self.basetestpath, 'test_exporttoimagesizebadaspect.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagesizebadaspect_2.png')
im = QImage(page2_path)
self.assertTrue(
self.checkImage('exporttoimagesize_badaspect',
'exporttoimagedpi_page2', page2_path),
'{}x{}'.format(im.width(), im.height()))
def testResizeToContents(self):
p = QgsProject()
l = QgsLayout(p)
shape1 = QgsLayoutItemShape(l)
shape1.attemptResize(QgsLayoutSize(90, 50))
shape1.attemptMove(QgsLayoutPoint(90, 50))
shape1.setItemRotation(45, False)
l.addLayoutItem(shape1)
shape2 = QgsLayoutItemShape(l)
shape2.attemptResize(QgsLayoutSize(110, 50))
shape2.attemptMove(QgsLayoutPoint(100, 150), True, False, 0)
l.addLayoutItem(shape2)
shape3 = QgsLayoutItemShape(l)
l.addLayoutItem(shape3)
shape3.attemptResize(QgsLayoutSize(50, 100))
shape3.attemptMove(QgsLayoutPoint(210, 250), True, False, 0)
shape4 = QgsLayoutItemShape(l)
l.addLayoutItem(shape4)
shape4.attemptResize(QgsLayoutSize(50, 30))
shape4.attemptMove(QgsLayoutPoint(10, 340), True, False, 0)
shape4.setVisibility(False)
# resize with no existing pages
l.pageCollection().resizeToContents(QgsMargins(1, 2, 3, 4),
QgsUnitTypes.LayoutCentimeters)
self.assertEqual(l.pageCollection().pageCount(), 1)
self.assertAlmostEqual(
l.pageCollection().page(0).sizeWithUnits().width(), 290.3, 2)
self.assertAlmostEqual(
l.pageCollection().page(0).sizeWithUnits().height(), 380.36, 2)
self.assertAlmostEqual(
l.pageCollection().page(0).sizeWithUnits().units(),
QgsUnitTypes.LayoutMillimeters)
self.assertAlmostEqual(shape1.positionWithUnits().x(), 90.15, 2)
self.assertAlmostEqual(shape1.positionWithUnits().y(), 20.21, 2)
self.assertAlmostEqual(shape2.positionWithUnits().x(), 100.15, 2)
self.assertAlmostEqual(shape2.positionWithUnits().y(), 120.21, 2)
self.assertAlmostEqual(shape3.positionWithUnits().x(), 210.15, 2)
self.assertAlmostEqual(shape3.positionWithUnits().y(), 220.21, 2)
self.assertAlmostEqual(shape4.positionWithUnits().x(), 10.15, 2)
self.assertAlmostEqual(shape4.positionWithUnits().y(), 310.21, 2)
# add a second page
page2 = QgsLayoutItemPage(l)
page2.setPageSize("A4", QgsLayoutItemPage.Landscape)
l.pageCollection().addPage(page2)
# add some guides
g1 = QgsLayoutGuide(
Qt.Horizontal,
QgsLayoutMeasurement(2.5, QgsUnitTypes.LayoutCentimeters),
l.pageCollection().page(0))
l.guides().addGuide(g1)
g2 = QgsLayoutGuide(
Qt.Vertical,
QgsLayoutMeasurement(4.5, QgsUnitTypes.LayoutCentimeters),
l.pageCollection().page(0))
l.guides().addGuide(g2)
# second page should be removed
l.pageCollection().resizeToContents(QgsMargins(0, 0, 0, 0),
QgsUnitTypes.LayoutCentimeters)
self.assertEqual(l.pageCollection().pageCount(), 1)
self.assertAlmostEqual(
l.pageCollection().page(0).sizeWithUnits().width(), 250.3, 2)
self.assertAlmostEqual(
l.pageCollection().page(0).sizeWithUnits().height(), 320.36, 2)
self.assertAlmostEqual(
l.pageCollection().page(0).sizeWithUnits().units(),
QgsUnitTypes.LayoutMillimeters)
self.assertAlmostEqual(g1.position().length(), 0.5, 2)
self.assertAlmostEqual(g2.position().length(), 3.5, 2)
def testExportToImage(self):
l = QgsLayout(QgsProject.instance())
l.initializeDefaults()
# add a second page
page2 = QgsLayoutItemPage(l)
page2.setPageSize('A5')
l.pageCollection().addPage(page2)
# add some items
item1 = QgsLayoutItemShape(l)
item1.attemptSetSceneRect(QRectF(10, 20, 100, 150))
fill = QgsSimpleFillSymbolLayer()
fill_symbol = QgsFillSymbol()
fill_symbol.changeSymbolLayer(0, fill)
fill.setColor(Qt.green)
fill.setStrokeStyle(Qt.NoPen)
item1.setSymbol(fill_symbol)
l.addItem(item1)
item2 = QgsLayoutItemShape(l)
item2.attemptSetSceneRect(QRectF(10, 20, 100, 150))
item2.attemptMove(QgsLayoutPoint(10, 20), page=1)
fill = QgsSimpleFillSymbolLayer()
fill_symbol = QgsFillSymbol()
fill_symbol.changeSymbolLayer(0, fill)
fill.setColor(Qt.cyan)
fill.setStrokeStyle(Qt.NoPen)
item2.setSymbol(fill_symbol)
l.addItem(item2)
exporter = QgsLayoutExporter(l)
# setup settings
settings = QgsLayoutExporter.ImageExportSettings()
settings.dpi = 80
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagedpi.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertTrue(
self.checkImage('exporttoimagedpi_page1', 'exporttoimagedpi_page1',
rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagedpi_2.png')
self.assertTrue(
self.checkImage('exporttoimagedpi_page2', 'exporttoimagedpi_page2',
page2_path))
# crop to contents
settings.cropToContents = True
settings.cropMargins = QgsMargins(10, 20, 30, 40)
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagecropped.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertTrue(
self.checkImage('exporttoimagecropped_page1',
'exporttoimagecropped_page1', rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagecropped_2.png')
self.assertTrue(
self.checkImage('exporttoimagecropped_page2',
'exporttoimagecropped_page2', page2_path))
# specific pages
settings.cropToContents = False
settings.pages = [1]
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagepages.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertFalse(os.path.exists(rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagepages_2.png')
self.assertTrue(
self.checkImage('exporttoimagedpi_page2', 'exporttoimagedpi_page2',
page2_path))
# image size
settings.imageSize = QSize(600, 851)
rendered_file_path = os.path.join(self.basetestpath,
'test_exporttoimagesize.png')
self.assertEqual(exporter.exportToImage(rendered_file_path, settings),
QgsLayoutExporter.Success)
self.assertFalse(os.path.exists(rendered_file_path))
page2_path = os.path.join(self.basetestpath,
'test_exporttoimagesize_2.png')
self.assertTrue(
self.checkImage('exporttoimagesize_page2',
'exporttoimagesize_page2', page2_path))