wrolpi/app/src/components/mapExport.js

740 lines
37 KiB
JavaScript
Raw Normal View History

A map is exported as a PDF: a 1:24,000 quadrangle, in layers, on a sheet, which says where it is (#1006) * The map can choose a 1:24,000 quadrangle to export (#971) The first part of exporting a map as a PDF: a grid of 7.5-minute quadrangles is drawn over the map, and a click chooses one. The grid is arithmetic, so it needs no data. Exporting itself is not here yet; the button is disabled. Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * A quadrangle of the map is exported as a PDF with a layer for each map layer (#972) * A quadrangle of the map is exported as a PDF with a layer for each map layer The browser draws the quadrangle off the screen at the size of a 1:24,000 sheet, once for each layer which is on, and the API puts the images in a PDF, each in a layer of its own which a reader can show and hide. A layer in which nothing is drawn is left out. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * The exported map's canvas keeps what was drawn, and an export's memory is bounded - The drawing buffer is asked for where this MapLibre reads it (canvasContextAttributes); as an option of the map it was ignored, so the canvas could be read after it was cleared. - Each layer's pixels are compressed in the PDF as the layer is added. PyMuPDF kept them uncompressed until the PDF was written: about 90 MB a layer of a quadrangle, all at once. - The pixels of all the layers together are limited, before any image is decoded. - pymupdf is imported when a PDF is made, not when the API starts. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported map says where on the Earth it is (#973) * An exported map says where on the Earth it is The PDF's page has a geospatial viewport (ISO 32000-2): the page is the map in Web Mercator, with the latitude and longitude of each corner. The corners are the edges of the picture the browser drew, read from the map which drew it. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A map whose edge is the antimeridian can be exported The map's arithmetic puts the east edge of the last quadrangle before the antimeridian a rounding error past 180 degrees, and the export was refused. An edge within 1e-8 of a degree of 180 is at 180 (it is not wrapped to -180); a map which is really across the antimeridian is still refused. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported map is on a sheet: a margin, a grid, scale bars and notes (#974) * An exported map is on a sheet: a margin, a grid, scale bars and notes The map is put on a larger page with what a topographic map has around it: a title, the latitude and longitude of its corners and of ticks between them, scale bars (kilometers, miles, feet), and notes of the projection, the grid and where the map's data is from. Over the map is a 1,000 meter UTM grid, each line named in the margin. The grid and the margin are PDF layers of their own. The PDF says where the map is, not where the page is. The picker has a box to export the map alone. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * The scale of a narrow map is written under its name, not over it A quadrangle near a pole is two inches wide, which is not room for its name and its scale on one line. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported map says where a compass points (#975) * An exported map says where a compass points The sheet has a diagram of the three norths (true, grid and magnetic) beside its scale bars, and a note of how far magnetic north is from true north on the day the map was made, and how fast it moves. The declination is from the World Magnetic Model 2025 (NOAA NCEI and the British Geological Survey; public domain), whose coefficient file is shipped: nothing is downloaded. The model is good until 2030; outside its years nothing is said of a compass. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A corner of an exported map is not also a tick The edges of the picture the browser draws are a hair outside the quadrangle's, so the quadrangle's own edges were taken for ticks inside the map, and each was written over the coordinate of its corner. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A compass which passes due south has moved a little, not most of the way around Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * A map can be exported at 400 DPI (#976) The picker has a choice of 300 or 400 DPI. A map is drawn less sharp than was asked for, rather than refused, when it would be more pixels than the API makes a PDF of: a quadrangle near the equator, or one with many layers on. The picker says so while it draws. Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported quadrangle goes by the name the USGS gives it (#977) * An exported quadrangle goes by the name the USGS gives it The picker says what the chosen quadrangle is called, and the sheet's title, the PDF's title and the file's name have it. Where the USGS has no name, which is most of the world, a quadrangle goes by where it is, as before. The names are an index of the 65,600 7.5 minute quadrangles of The National Map (U.S. Geological Survey; public domain), which is shipped: nothing is downloaded. In Alaska a USGS quadrangle is wider than 7.5 minutes, so a quadrangle of the picker's grid there is "Part of" the one which has its middle. The places the tests of the map export are of are changed for others. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * An area half of which is the last quadrangle of the land is a part of it The middle of such an area is on the quadrangle's east or north edge, with no quadrangle beyond it, and it was given no name. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * The PDF of a map is made by a Job, which the browser watches (#978) * The PDF of a map is made by a Job, which the browser watches A PDF of a quadrangle is a minute or two of work on a Raspberry Pi 4, and the request which waited for it was cut off after a minute: only the smallest quadrangles could be exported there. Now the browser describes the map, sends the image of each layer in a request of its own, and starts a Job; it watches the Job, shows how far along it is, and fetches the PDF when the Job is done. Cancel stops the Job. The images are kept on disk until the PDF is made of them, and an export is removed when it is an hour old. The credits on the sheet are no longer cut off: an attribution which names many sources is each of them. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A cancelled map export stops, and is removed - A cancelled Job is not over until the thread making the PDF has stopped, so the next Job does not start beside it; the work can also be stopped while the sheet is drawn and the PDF written. - DELETE /api/map/export/<id> stops an export at any step and removes what was sent; the browser calls it when the person exporting cancels, while layers are sent as well as while the PDF is made. - An export whose Job is waiting or running is not removed for being old; one whose Job was cancelled is removed at once. - Cancel while the map is drawn stops the drawing between two layers. - Exports are kept in a directory made for this user alone, which is refused when it is a link or is another user's; only what is an export there is removed. - A request for the finished PDF which is lost is made again. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An overlay's areas and lines go under the map's labels, and its own labels over them (#979) An overlay was drawn whole over the basemap, so an area it filled covered the names of what is in it. Labels are now always on top: the areas, lines and pictures of every overlay are under the basemap's labels, and the text, icons and points of every overlay are over them. It is so in the map, the standalone viewer, and an exported PDF, where an overlay with both is two layers ("Towers" and "Towers (labels)"). Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An overlay's ground is over the ground of every basemap file (#980) * An overlay's ground is over the ground of every basemap file On a map of several basemap files, the ground of an overlay was put before the first label of the first file, which is under the land, water and roads of every file after it: an overlay's areas and lines were hidden, and in an exported PDF its layer was just above the background. It goes where the basemap's labels begin: the first of the labels which are over all of the basemap's ground. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * The labels of every basemap file are over the ground of every file A map of several basemap files was their layers one file after another, so only the labels of the last file were on top: the labels of the others were under the land, water and roads of the files after them, and under the ground of an overlay. Both viewers now draw the ground of every file and then the labels of every file. The contour lines are drawn after the basemap's labels and are not of the basemap: an overlay's ground goes under the basemap's labels, not under the contours instead. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * Contours are drawn from as deep as the terrain file goes (#981) The map read a terrain file to zoom 8, which is how deep the terrain WROLPi offers goes, however deep the file was. It now reads a file as deep as the file says it goes, in both viewers, and draws finer contour lines from a deeper file: every 40 feet (or 20 meters) from zoom 11, as a 1:24,000 sheet has. A file which goes to zoom 8 is drawn as it was. Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported map names its small roads (#982) * An exported map names its small roads A quadrangle is drawn at about zoom 13. The basemap's style names small roads from zoom 15, and its tiles have no names for them below zoom 14, so the streets of a town were printed as lines with no names. Before the map is drawn, the tiles of zoom 14 which the quadrangle is in are read, and the roads in them which have a name are given to the export map as a source of its own. The layer which names small roads draws from that source, as its style says to. At the scale of a sheet most streets are shorter than their names, and a map writes a name along a line only where the line is longer. Such a road is named over its middle, turned as the road goes; a road in pieces is named once. A source whose tiles can not be read is exported as before. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * The names of small roads are placed by the export, at every latitude A quadrangle nearer the equator is drawn at a little over zoom 14, where the names were not read and the style still kept them for zoom 15: such a map had no names of small roads. They are now read wherever a layer would not name roads. Every name of a small road is now a point: over the middle of its road, turned as the road goes under it, again every 400 pixels of a long road. Before, a road long enough was left for the map to name along its line, which the map often does not (the line bends, or is in pieces), and a short piece beside it was named too. One place decides where a road is named, so a road in pieces is named once, and a piece of another kind of road does not take the name. Reading the names can be cancelled. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * A sheet has a bar of meters, its norths in mils, and how far apart its contour lines are (#983) Under the map are bars of kilometers, meters, miles and feet. How far the grid's north and a compass's north are from true north is written in mils as well as in degrees, in the diagram and in the notes: a compass may be marked in either. A map which is exported with its contour lines says how far apart they are (CONTOUR INTERVAL 40 FEET), under the bars. The browser knows: it is the interval of the tiles the lines are made for at the zoom of the sheet, in the unit the map measures in. It says so with the sheet, and what is not an interval is not written. Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * A sheet says what the quadrangles around it are called (#984) * A sheet says what the quadrangles around it are called Under the scale bars is a diagram of nine squares, the map the middle one, and beside it what the USGS calls each of the eight around it: the sheets to print to carry on off the edge of this one. The names are from the index of quadrangles which names the sheet itself. A quadrangle with no name (out to sea, or over a border) has no number; a map of where the USGS names nothing, and a map too narrow for the diagram, go without. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A sheet is never beside itself Where a quadrangle of the USGS is wider than the map (Alaska), the area the size of the map to its east or west is often more of the quadrangle the map is in, and the diagram named the sheet as its own neighbor. The quadrangle on a side is now the next one which is not the map's own. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * A sheet has a legend of the lines of its map (#985) * A sheet has a legend of the lines of its map Under the scale bars is what each kind of line of the map is: highway, major road, minor road, path, railway, boundary, contour and index contour, each a piece of the line as the map draws it, on the color of the map's land. The map's style says how a line is drawn at each zoom, and a sheet is drawn at one. The browser, which has the style, says what each line's color, width, dashes and edges are at that zoom; the API draws them. A line is in the legend when its layer is exported and draws something at that zoom. What the browser sends is made into lines before it is kept: what is not a line is left out, and the map is exported. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A legend has no line too thin to see, and no name longer than its room A style brings a line in from nothing as the map is zoomed in: a path is a few hundredths of a point wide on a quadrangle near the equator. It was in the legend, drawn several times wider than on the map. A line under a tenth of a point is now left out, by the browser and by the API. What a line is called is cut to the room beside its line, as the name of an adjoining quadrangle is. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * Fixes to the map PDF export: wrong neighbors, leftover exports, exports which outlive the map (#989) * A sheet names what is around it, and its edges, by where they are and not a hair from there The edges the browser gives of a map are a hair outside its quadrangle. The quadrangles around a map whose middle is on the edge two share (every other map of Alaska) were those around the map west of it, and one of them was the map itself. An edge a hair south of the equator was 0 degrees south, a map which ended where the UTM zones do had no grid, and a sheet dated in the last year there is could not be made. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * An export is removed when it is over, and its work stops when the API does The images and the PDF of an export were kept until the next export began, however long that was. The browser now has the export removed however it ends, and old exports are removed when a PDF is made too. The work of a Job which ended because the API was stopping went on to the end of the PDF, with the API waiting for it. What is said of an export, and each image, is written whole. Text which is no text is taken out when an export begins, not found by the Job. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * An export stops with its map, and waits for a page which can not be seen Leaving the map while it was exported left the export going, to fail or to hand a PDF to another page; so did closing the picker, which is now left open. A PDF which arrives after the export was stopped is not saved. The time a page is behind another tab is not counted against a map which is drawing. The name of a road is one line. A photograph which ends a little inside the map is not made a JPEG with a black strip. An accent in the name of a quadrangle is not a gap in the name of its file. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A PDF is not kept from who made it by a server slow to remove the export Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported map has its water over its parks (#990) * A sheet names what is around it, and its edges, by where they are and not a hair from there The edges the browser gives of a map are a hair outside its quadrangle. The quadrangles around a map whose middle is on the edge two share (every other map of Alaska) were those around the map west of it, and one of them was the map itself. An edge a hair south of the equator was 0 degrees south, a map which ended where the UTM zones do had no grid, and a sheet dated in the last year there is could not be made. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * An export is removed when it is over, and its work stops when the API does The images and the PDF of an export were kept until the next export began, however long that was. The browser now has the export removed however it ends, and old exports are removed when a PDF is made too. The work of a Job which ended because the API was stopping went on to the end of the PDF, with the API waiting for it. What is said of an export, and each image, is written whole. Text which is no text is taken out when an export begins, not found by the Job. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * An export stops with its map, and waits for a page which can not be seen Leaving the map while it was exported left the export going, to fail or to hand a PDF to another page; so did closing the picker, which is now left open. A PDF which arrives after the export was stopped is not saved. The time a page is behind another tab is not counted against a map which is drawing. The name of a road is one line. A photograph which ends a little inside the map is not made a JPEG with a black strip. An accent in the name of a quadrangle is not a gap in the name of its file. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * An exported map has its water over its parks A layer of the PDF was one image, drawn where the topmost of its layers is. The parks of Land Cover are under the water on the map and its piers are over it, so all of Land Cover was drawn over the water: a lake in a park, or among houses, was not on the PDF. A second basemap file put its water over the first's buildings. A layer is now as many images as it must be, each where it is on the map, in one layer of the PDF: a part which fills an area stays where it is, and a part which is only lines is drawn with the next. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A PDF is not kept from who made it by a server slow to remove the export Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A map file which is of somewhere else is not drawn when a map is exported Each basemap file is several images of an exported map, and most files of a library are of other places: each was an image of nothing, counted against how many images an export may be and how sharp it may be. A file whose own edges are outside the quadrangle is now left out before the layers are counted. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported map has its streams (#991) A basemap draws streams from zoom 14, and service roads and taxiways from 13. A quadrangle is drawn a little short of that (zoom 13.8 at 40 degrees, 13.2 at 61), from tiles which have them: none were on the PDF. What is drawn from a zoom no deeper than a quadrangle's detail is drawn. Names are left as they are. Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An export which is cancelled stops at once, in the middle of a request (#993) * An export which is cancelled stops at once, in the middle of a request An export was stopped between two requests. The image of a layer is tens of megabytes, which is a long request on a slow connection, and a request to a server which has stopped answering never ends: the export said it was stopping until then. Cancel, and leaving the map, now end the request. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * The requests an export makes after its layers are sent are seen to be stopped too Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * A map is exported as it is printed: on white, in dark lines (#996) * A map is exported as it is printed: on white, in dark lines The light and dark maps are made for a screen. On paper their roads are white on pale gray and their streams half a pixel of pale blue. The printed map is a third look, of the map's own: white ground, dark road edges and names, blue streams wide enough to see, paths drawn, brown contours. It is what a map is exported in unless Light or Dark is chosen where the quadrangle is, and the choice is remembered in the browser. While a quadrangle is chosen the map is shown in the look it will be exported in. The light and dark maps are as they were. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * Changing the look of the map does not move it What is done when a new style is in place was asked for after the style was set. A style which only differs from the one the map has is in place before that, so it was done at the next change of style instead, with where the map had been at this one: the map went back there when a quadrangle was chosen, and again when it was not. It is asked for first, and the map is not moved at all. An export no longer waits for the map to be still, which it need not and which nothing ended. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * The colors of the printed map are chosen where its layers are (#997) * The colors of the printed map are chosen where its layers are While a quadrangle is chosen and the map is shown as it is printed, each layer of the layer control has its color beside it, to be changed: one for most, three for the land (what grows, what was built, sand and ice) and two for names (the name, and what is around it). A basemap has several colors where one is chosen, which are shades of it. The edge of a road stays dark. What is chosen is remembered in the browser, and can be put back. The map on the screen is as it was. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A ramp on a bridge is the color of a major road, as it is off one A basemap draws a ramp on a bridge in the color of a minor road on a bridge: on the printed map it was white where the rest of the ramp is yellow, and followed the color chosen for minor roads. What puts the colors back is a button, which a keyboard reaches. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * A layer with nothing in it does not make an exported map less sharp (#1001) * A layer with nothing in it does not make an exported map less sharp How sharp a map may be depends on how many images it is, and every group of layers was counted: a basemap file with no runway, highway or boundary in the quadrangle was images of nothing, drawn, sent, and counted against the rest. A map of 23 images asked for at 400 DPI was made at 330. The groups are now looked at first, on a small map, and only those with something in them are drawn, as sharp as that many may be. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * An image which arrives after its export was removed is not kept, and one mil is a mil Stopping an export while an image was on its way left the image behind it, in a directory nothing would remove for an hour. An angle of one mil was "1 mils" on the sheet. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * The map which is exported from is made as sharp as it is to be (#1002) * The map which is exported from is made as sharp as it is to be The groups of a map are looked at on a small map, which was then made larger to draw them. A browser lets a canvas be larger when it is made than it lets one be made larger afterwards: a quadrangle asked for at 400 DPI was 33 million pixels, 288 DPI at 40 degrees, less than before the groups were looked at first. The small map is now removed, and the map which is exported from is made in its place. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * A canvas the browser stopped drawing on is not a layer with nothing in it A canvas whose drawing was taken away by the browser reads as clear, and a group looked at then was left out of the PDF without a word: the export fails instead. An export stopped as the last group is looked at does not make the map it would have been drawn on. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * An exported map says where it is in a projection Adobe Acrobat knows (#1003) * An exported map says where it is in a projection Adobe Acrobat knows The page was said to be in Web Mercator, which it is drawn in. Acrobat does not know Web Mercator, in the words of the standard or in Esri's: it took the page for a map, and put every place on it at 0, 0. The page is now said to be Mercator on the WGS 84 ellipsoid, which it reads, with the same corners. Between the corners the two differ by under three centimeters on the ground. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * How well a page is said to be where it is, is measured from what the PDF says The test of it measured two formulas of its own. It now reads the corners and the projection from the PDF and does a reader's sum with them. The few centimeters are of a quadrangle: a taller page is less well said, by the square of how tall it is, which the comment now says and a test measures. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> * The help says how a map is exported as a PDF (#1004) The help of the map is five pages, one of them the PDF export. Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-20 17:22:21 -07:00
// Exporting a quadrangle of the map as a PDF.
//
// The browser draws the map, because nothing else draws it as the user sees it. A second map, off
// the screen and the size of the printed sheet, is drawn once for each layer the user has turned on,
// with only that layer showing; the API puts the images in a PDF, each in a layer of its own, and
// (when it is asked to) on a sheet: with a margin, a grid, scale bars and notes around the map.
import {QUAD_DEGREES, QUAD_SCALE, quadLabel, quadSize, quadTitle} from "./mapQuads";
import {isOverlayLabelLayer, isOverlayLayerId} from "./mapOverlays";
export const EXPORT_DPI = 300;
// How sharp a map may be asked for. More is four times the work for twice the sharpness: a
// quadrangle at 600 is more than a browser will draw, or a Raspberry Pi will make a PDF of.
export const EXPORT_DPIS = [300, 400];
// The most the API makes a PDF of: the pixels of one layer, and of all the layers of a map together
// (MAX_PIXELS and MAX_TOTAL_PIXELS in modules/map/export.py).
const MAX_LAYER_PIXELS = 64_000_000;
const MAX_TOTAL_PIXELS = 1_000_000_000;
// The map's style is made for a screen, where its sizes (of text, of lines) are in CSS pixels. This
// is how many of those are an inch of paper: fewer is larger text and less detail. At 150 a 12 pixel
// label prints at about 6 points, which is what a topographic map uses, and a quadrangle is drawn at
// about zoom 13 to 14.
export const EXPORT_CSS_DPI = 150;
// No browser makes a canvas larger than this, and few need to be asked for more.
const MAX_CANVAS_SIDE = 16384;
const FALLBACK_CANVAS_SIDE = 4096;
const MILLIMETERS_PER_INCH = 25.4;
const TILE_SIZE = 512;
const RENDER_TIMEOUT_MS = 120_000;
// How often it is asked whether the map has been too long in drawing.
const RENDER_WATCH_MS = 1000;
// How sharp the map is on which the groups are looked at, to see which have anything in them:
// half as many pixels each way as there are CSS pixels. Anything drawn is still drawn.
const LOOKING_PIXEL_RATIO = 0.5;
// How many rows of a canvas are looked at at once.
const BLANK_BAND_ROWS = 256;
export const BACKGROUND_GROUP = "Background";
// The largest canvas (in pixels a side) this browser will draw a map on.
export function maxCanvasSide() {
try {
const canvas = document.createElement("canvas");
const gl = canvas.getContext("webgl2") || canvas.getContext("webgl");
if (!gl) return FALLBACK_CANVAS_SIDE;
const viewport = gl.getParameter(gl.MAX_VIEWPORT_DIMS) || [];
const side = Math.min(gl.getParameter(gl.MAX_TEXTURE_SIZE), viewport[0], viewport[1], MAX_CANVAS_SIDE);
gl.getExtension("WEBGL_lose_context")?.loseContext();
return Number.isFinite(side) && side > 0 ? side : FALLBACK_CANVAS_SIDE;
} catch (e) {
return FALLBACK_CANVAS_SIDE;
}
}
// The most pixels each layer of a map of `layerCount` layers may be.
export function maxExportPixels(layerCount) {
return Math.min(MAX_LAYER_PIXELS, Math.floor(MAX_TOTAL_PIXELS / Math.max(1, layerCount)));
}
function mercatorY(latitude) {
return Math.log(Math.tan(Math.PI / 4 + latitude * Math.PI / 360));
}
function latitudeOfMercatorY(y) {
return (2 * Math.atan(Math.exp(y)) - Math.PI / 2) * 180 / Math.PI;
}
// How to draw a quadrangle at 1:24,000: the size of the map to make (in CSS pixels), where to put it
// (center, zoom), and how many real pixels each CSS pixel is.
//
// The map is Web Mercator, in which a quadrangle is exactly a rectangle. It is as wide as the sheet
// is at the quadrangle's middle, and as tall as Mercator makes that.
//
// The map is as sharp as was asked for (`dpi`), or as sharp as it can be: no side of it longer than
// `maxSide` (the browser's largest canvas), and no more of it than `maxPixels` (what the API takes).
export function exportFrame(quad, {
dpi = EXPORT_DPI, cssDpi = EXPORT_CSS_DPI, maxSide = MAX_CANVAS_SIDE, maxPixels = Infinity,
} = {}) {
const widthInches = quadSize(quad).sheetWidthMm / MILLIMETERS_PER_INCH;
const cssWidth = Math.round(widthInches * cssDpi);
// The width of the whole world at the zoom where the quadrangle is `cssWidth` wide.
const world = cssWidth * 360 / QUAD_DEGREES;
const [south, north] = [mercatorY(quad.south), mercatorY(quad.north)];
const cssHeight = Math.round((north - south) / (2 * Math.PI) * world);
// A hair under what the pixels allow: each side of the canvas is rounded to a whole pixel.
const pixelRatio = Math.min(
dpi / cssDpi,
maxSide / Math.max(cssWidth, cssHeight),
Math.sqrt(maxPixels / (cssWidth * cssHeight)) * 0.999);
return {
cssWidth,
cssHeight,
pixelRatio,
dpi: pixelRatio * cssDpi,
zoom: Math.log2(world / TILE_SIZE),
bounds: [quad.west, quad.south, quad.east, quad.north],
center: [(quad.west + quad.east) / 2, latitudeOfMercatorY((south + north) / 2)],
};
}
// The name of a basemap layer without the source it is of ("oregon.pmtiles:water" is "water").
function basemapLayerName(layerId) {
return layerId.includes(":") ? layerId.split(":").slice(1).join(":") : layerId;
}
// The kinds of layer which are drawn over what is under them without hiding it: a line, a name.
const THIN_LAYER_TYPES = new Set(["line", "symbol", "circle"]);
// The layers of the PDF: the visible layers of the map's style, gathered as the layer control
// gathers them, from the bottom up. Each is {name, ids, raster}. An overlay is one layer, or two
// when it has both ground and labels (see orderOverlayLayers).
//
// A layer of the PDF is drawn as images, and an image is in one place among the others. The layers
// of a group are not always together in the style: the parks of Land Cover are under the water and
// its piers are over it, and a second basemap file has all of its layers over the first's. So a
// group is as many images as it must be, each with the name of the group (they are one layer of the
// PDF): a part of it which fills an area stays where it is, because moved over what was above it,
// it would hide that; a part which is only lines or names is drawn with the group's next part.
//
// styleLayers: the layers of the map's style, as the map has them now.
// layerGroups: {name: [part of a layer id, ...]}, the basemap groups of the layer control.
// overlayLabels: {source id: label} of the overlay files.
export function exportGroups(styleLayers, {layerGroups = {}, overlayLabels = {}} = {}) {
const groupNames = Object.keys(layerGroups);
// What each visible layer is of: {key, name, overlay}.
const groupOf = layer => {
if (isOverlayLayerId(layer.id)) {
// An overlay is drawn in two places: its ground under the basemap's labels, and its own
// labels over them. Each is a layer of the PDF.
const part = isOverlayLabelLayer(layer) ? "labels" : "ground";
return {
key: `overlay ${part} ${layer.source}`, name: overlayLabels[layer.source] || layer.source,
overlay: {source: layer.source, part},
};
}
const name = basemapLayerName(layer.id);
// A layer in more than one group (a water label) is of the last, which is the labels.
const group = [...groupNames].reverse().find(g => layerGroups[g].some(part => name.includes(part)));
// What is in no group is the ground everything else is drawn on.
return group ? {key: `group ${group}`, name: group} : {key: "background", name: BACKGROUND_GROUP};
};
// The style from the bottom up, as runs of layers which are of one group and are together.
const runs = [];
for (const layer of styleLayers) {
if (layer.layout?.visibility === "none") continue;
const group = groupOf(layer);
let run = runs[runs.length - 1];
if (run?.key !== group.key) {
run = {...group, ids: [], raster: true, thin: true};
runs.push(run);
}
run.ids.push(layer.id);
run.raster = run.raster && layer.type === "raster";
run.thin = run.thin && THIN_LAYER_TYPES.has(layer.type);
}
// A run of lines is drawn with the next run of its group, when there is one.
const waiting = new Map();
const placed = [];
for (const [index, run] of runs.entries()) {
const ids = [...(waiting.get(run.key) || []), ...run.ids];
waiting.delete(run.key);
if (run.thin && runs.slice(index + 1).some(later => later.key === run.key)) {
waiting.set(run.key, ids);
} else {
placed.push({...run, ids});
}
}
// The labels of an overlay are named as its labels when its ground is a layer too.
const grounds = new Set(placed.filter(g => g.overlay?.part === "ground").map(g => g.overlay.source));
// Two groups of one name are told apart; the images of one group have one name.
const used = new Set();
const names = new Map();
return placed.map(({key, name, ids, raster, overlay}) => {
if (!names.has(key)) {
if (overlay?.part === "labels" && grounds.has(overlay.source)) name = `${name} (labels)`;
let unique = name;
for (let n = 2; used.has(unique); n++) unique = `${name} (${n})`;
used.add(unique);
names.set(key, unique);
}
return {name: names.get(key), ids, raster};
});
}
// The sources of a style whose map file has nothing of an area: a map of another state. Their
// layers are not drawn, each of which would be an image of nothing, counted against how sharp the
// map may be. A source is only left out when its file says where it is of, and that is elsewhere.
//
// bounds: the west, south, east and north edges of the area.
// readBounds(url): the edges of the map file a source has as its `url`, or null (see mapTiles.js).
export async function sourcesOutside(style, bounds, readBounds) {
const [west, south, east, north] = bounds;
const outside = new Set();
await Promise.all(Object.entries(style.sources || {}).map(async ([id, source]) => {
if (typeof source.url !== "string" || !source.url.startsWith("pmtiles://")) return;
try {
const edges = await readBounds(source.url);
if (!edges) return;
const [fileWest, fileSouth, fileEast, fileNorth] = edges;
if (fileEast <= west || fileWest >= east || fileNorth <= south || fileSouth >= north) outside.add(id);
} catch (e) {
// A file which can not be asked is drawn, as it was going to be.
console.warn("Could not read where a map file is of:", source.url, e);
}
}));
return outside;
}
// A basemap's tiles name its small roads from this zoom on. A quadrangle is drawn at about zoom 13,
// from tiles in which the streets of a town are lines with no names.
export const EXPORT_DETAIL_ZOOM = 14;
// The layers of a basemap which name roads.
const ROAD_LABELS = "roads_labels";
const ROAD_NAMES_SOURCE = "export-road-names:";
// More room (ems) than the name of a road is long: a name is one line.
const ROAD_NAME_MAX_EMS = 1000;
// Which way the name of a road is turned (degrees, clockwise), in what is said of the road.
const NAME_ANGLE = "export:angle";
const ROAD_TEXT_SIZE = 12;
// About how wide a letter is, in its own height.
const LETTER_WIDTH = 0.55;
// A long road is named again each time it has gone this far (CSS pixels: 2.7 inches of a sheet).
const NAME_EVERY = 400;
// Two names of one road are never nearer than this (CSS pixels).
const SAME_NAME_APART = 150;
// The most tiles names are read from. A quadrangle is 20 to 40 of them, and more only where it is a
// sliver near a pole (455 at 85 degrees); more than this is not a quadrangle.
const MAX_DETAIL_TILES = 512;
// The layers of `style` which name roads, but not on a map drawn at `zoom`: their style keeps the
// names for a zoom at which a street is inches long on a screen. On a sheet a road is found by its
// name.
export function unnamedRoadLayers(style, zoom) {
return (style.layers || []).filter(layer => layer.type === "symbol" && layer["source-layer"]
&& String(layer.id).includes(ROAD_LABELS) && layer.minzoom > zoom);
}
// The tiles of `zoom` which have part of `bounds` (west, south, east, north) in them: [{z, x, y}].
export function tilesOfBounds([west, south, east, north], zoom) {
const count = 2 ** zoom;
const column = longitude => (longitude + 180) / 360 * count;
const row = latitude => (1 - mercatorY(latitude) / Math.PI) / 2 * count;
const clamp = n => Math.min(count - 1, Math.max(0, n));
// A tile whose edge is the edge of the bounds has nothing of them in it.
const [left, right] = [clamp(Math.floor(column(west))), clamp(Math.ceil(column(east)) - 1)];
const [top, bottom] = [clamp(Math.floor(row(north))), clamp(Math.ceil(row(south)) - 1)];
const tiles = [];
for (let x = left; x <= right; x++) {
for (let y = top; y <= bottom; y++) tiles.push({z: zoom, x, y});
}
return tiles;
}
// The roads of one layer of a tile which have a name, as GeoJSON features with all that the tile says
// of them: what a layer of the style draws a name from is whatever its style asks for.
//
// tile: a tile as @mapbox/vector-tile reads it.
export function namedRoads(tile, sourceLayer, {z, x, y}) {
const layer = tile?.layers?.[sourceLayer];
const features = [];
for (let i = 0; layer && i < layer.length; i++) {
const feature = layer.feature(i);
if (!Object.keys(feature.properties).some(key => key === "name" || key.startsWith("name:"))) continue;
const {geometry, properties} = feature.toGeoJSON(x, y, z);
features.push({type: "Feature", geometry, properties});
}
return features;
}
// What two pieces of one road have in common: its name, and what kind of road it is. The layers
// which name roads each name some kinds of them, so a piece of another kind may not be named at all.
function roadOf(properties) {
return `${properties.kind ?? ""}\n${nameOf(properties)}`;
}
function nameOf(properties) {
return String(properties.name ?? Object.entries(properties).find(([key]) => key.startsWith("name:"))?.[1] ?? "");
}
// Where a line (of points, with the length of each of its parts) is when it has gone `along`.
function pointAlong(points, lengths, along) {
let i = 0;
while (i < lengths.length - 1 && along > lengths[i]) along -= lengths[i++];
const part = lengths[i] ? Math.min(1, Math.max(0, along / lengths[i])) : 0;
const [from, to] = [points[i], points[i + 1]];
return [from[0] + (to[0] - from[0]) * part, from[1] + (to[1] - from[1]) * part];
}
// Where named roads (of namedRoads) are named on a map drawn at `zoom` with text of `textSize` CSS
// pixels: a GeoJSON FeatureCollection of points, each with all that is said of its road, and which
// way the road goes there (NAME_ANGLE).
//
// A map writes a name along a road only where the road is longer than the name and bends little,
// and at the scale of a sheet most streets of a town are shorter than their names. So the names
// are placed here, as a map maker places them: over the middle of the road, turned as the road goes
// under the name, and over its ends when it is short; again every NAME_EVERY of a long road.
//
// A road is in pieces where two tiles meet, and where what is said of it changes. The longest
// pieces are named first, and a piece is not named near where its road already is.
export function placeRoadNames(features, zoom, textSize = ROAD_TEXT_SIZE) {
const world = TILE_SIZE * 2 ** zoom;
const pixel = ([longitude, latitude]) => [
(longitude + 180) / 360 * world, (1 - mercatorY(latitude) / Math.PI) / 2 * world];
const pieces = [];
for (const {geometry, properties} of features) {
const parts = geometry.type === "MultiLineString" ? geometry.coordinates
: geometry.type === "LineString" ? [geometry.coordinates] : [];
for (const coordinates of parts) {
if (coordinates.length < 2) continue;
const pixels = coordinates.map(pixel);
const lengths = pixels.slice(1).map((point, i) => Math.hypot(point[0] - pixels[i][0], point[1] - pixels[i][1]));
const length = lengths.reduce((sum, n) => sum + n, 0);
if (length) pieces.push({coordinates, pixels, lengths, length, properties});
}
}
const named = new Map();
const points = [];
for (const {coordinates, pixels, lengths, length, properties} of pieces.sort((a, b) => b.length - a.length)) {
const road = roadOf(properties);
if (!named.has(road)) named.set(road, []);
const places = named.get(road);
const width = nameOf(properties).length * textSize * LETTER_WIDTH;
const count = Math.max(1, Math.floor(length / NAME_EVERY));
for (let n = 0; n < count; n++) {
const along = (n + 0.5) * length / count;
const at = pointAlong(pixels, lengths, along);
if (places.some(other => Math.hypot(other[0] - at[0], other[1] - at[1]) < SAME_NAME_APART)) continue;
places.push(at);
// From where the name begins to where it ends, and never upside down.
const first = pointAlong(pixels, lengths, Math.max(0, along - width / 2));
const last = pointAlong(pixels, lengths, Math.min(length, along + width / 2));
let angle = Math.atan2(last[1] - first[1], last[0] - first[0]) * 180 / Math.PI;
if (angle > 90) angle -= 180;
if (angle <= -90) angle += 180;
points.push({
type: "Feature",
geometry: {type: "Point", coordinates: pointAlong(coordinates, lengths, along)},
properties: {...properties, [NAME_ANGLE]: Math.round(angle * 10) / 10},
});
}
}
return {type: "FeatureCollection", features: points};
}
// The names of the roads of the map which a map drawn for `frame` would not have: {source id: where
// they are named (see placeRoadNames)}, for exportStyle. They are read from tiles of EXPORT_DETAIL_ZOOM.
//
// readTile(url, {z, x, y}): resolves to a tile of the source with that URL (as @mapbox/vector-tile
// reads it), or to nothing when the source has no such tile.
//
// They are read wherever a layer would not name roads, whatever tiles the map itself is drawn from:
// nearer the equator a quadrangle is drawn at a little over zoom 14, from tiles which have the names,
// but its streets are as short there as anywhere.
//
// isCancelled(): asked before each source is read; when it is so no more is read.
//
// A source whose names can not be read is left out, and the map is exported without them.
export async function loadRoadNames(style, frame, readTile, isCancelled) {
const names = {};
// Each source once: the layers which name its roads are of one layer of its tiles.
const unnamed = new Map(unnamedRoadLayers(style, frame.zoom).map(layer => [layer.source, layer]));
if (!readTile || !unnamed.size) return names;
const tiles = tilesOfBounds(frame.bounds, EXPORT_DETAIL_ZOOM);
if (tiles.length > MAX_DETAIL_TILES) return names;
for (const [sourceId, layer] of unnamed) {
if (isCancelled && isCancelled()) break;
const sourceLayer = layer["source-layer"];
const textSize = Number.isFinite(layer.layout?.["text-size"]) ? layer.layout["text-size"] : ROAD_TEXT_SIZE;
const url = style.sources?.[sourceId]?.url;
if (!url) continue;
try {
const read = await Promise.all(tiles.map(async tile => namedRoads(await readTile(url, tile), sourceLayer, tile)));
const features = read.flat();
if (features.length) names[sourceId] = placeRoadNames(features, frame.zoom, textSize);
} catch (e) {
console.warn(`The road names of ${sourceId} could not be read`, e);
}
}
return names;
}
// A copy of the map's style in which nothing is drawn, for the map which is exported from; the
// layers are shown a group at a time. Layers which are of the app and not of the map (those whose
// id starts with one of `ignoredPrefixes`) are not in it.
//
// roadNames: what loadRoadNames gave for a map drawn at `zoom`. A layer which would not name roads
// at that zoom names those instead, in its own style, where placeRoadNames put the names.
export function exportStyle(style, ignoredPrefixes = [], {zoom = null, roadNames = {}} = {}) {
const ignored = id => ignoredPrefixes.some(prefix => String(id).startsWith(prefix));
const sources = Object.fromEntries(Object.entries(style.sources || {}).filter(([id]) => !ignored(id)));
for (const [id, data] of Object.entries(roadNames)) {
if (sources[id]) sources[ROAD_NAMES_SOURCE + id] = {type: "geojson", data};
}
const unnamed = new Set(zoom === null ? [] : unnamedRoadLayers(style, zoom).map(layer => layer.id));
const layers = (style.layers || [])
.filter(layer => !ignored(layer.id))
.map(layer => {
if (!unnamed.has(layer.id) || !sources[ROAD_NAMES_SOURCE + layer.source]) {
const hidden = {...layer, layout: {...layer.layout, visibility: "none"}};
// What a basemap draws from a zoom a little deeper than the map is drawn at (a
// stream, a service road) is on a map of this scale, and is in the tiles it is
// drawn from: it is drawn. Not names, of which there would be too many.
if (zoom !== null && layer.type !== "symbol" && layer.minzoom > zoom
&& layer.minzoom <= EXPORT_DETAIL_ZOOM) {
hidden.minzoom = Math.floor(zoom);
}
return hidden;
}
const {minzoom, "source-layer": sourceLayer, ...named} = layer;
return {
...named,
source: ROAD_NAMES_SOURCE + layer.source,
layout: {
...layer.layout,
"symbol-placement": "point",
"text-rotate": ["get", NAME_ANGLE],
"text-rotation-alignment": "map",
// A name along a line is one line; a name at a point is broken into several
// unless it is told it has the room.
"text-max-width": ROAD_NAME_MAX_EMS,
visibility: "none",
},
};
});
return {...style, sources, layers};
}
// The map's arithmetic can put the edge of the world a hair past where it is (180.00000000000125
// degrees). Such an edge is the edge of the world; one further past it is of a map which crosses the
// antimeridian, and is left as it is.
const LONGITUDE_SLIVER = 1e-8;
function edgeLongitude(longitude) {
if (Math.abs(longitude) > 180 && Math.abs(longitude) - 180 < LONGITUDE_SLIVER) return Math.sign(longitude) * 180;
return longitude;
}
// Only the time the page can be seen is counted: a browser does not draw a page which can not be
// seen (another tab is in front of it), and the map is not slow for that.
function once(map, event, timeoutMs = RENDER_TIMEOUT_MS) {
return new Promise((resolve, reject) => {
let seenMs = 0;
const timer = setInterval(() => {
if (typeof document !== "undefined" && document.hidden) return;
seenMs += RENDER_WATCH_MS;
if (seenMs >= timeoutMs) {
clearInterval(timer);
reject(new Error("The map took too long to draw"));
}
}, RENDER_WATCH_MS);
map.once(event, () => {
clearInterval(timer);
resolve();
});
});
}
function canvasBlob(canvas, type, quality) {
return new Promise((resolve, reject) => canvas.toBlob(
blob => (blob ? resolve(blob) : reject(new Error("The map could not be made into an image"))),
type, quality));
}
// Whether a canvas has no transparent part. It is reduced first: looking at every pixel of a sheet
// is slow, and a part too small to survive the reduction is too small to matter. Its four edges are
// looked at by themselves: a photograph which ends a little inside the map leaves a strip along an
// edge, which is narrow enough to be lost in the reduction and wide enough to be seen.
export function isOpaque(canvas) {
const small = document.createElement("canvas");
small.width = 64;
small.height = Math.max(1, Math.round(64 * canvas.height / canvas.width));
const context = small.getContext("2d");
if (!context) return false;
const {width, height} = canvas;
const parts = [
[0, 0, width, height],
[0, 0, width, 1], [0, height - 1, width, 1], [0, 0, 1, height], [width - 1, 0, 1, height],
];
for (const [x, y, w, h] of parts) {
context.clearRect(0, 0, small.width, small.height);
context.drawImage(canvas, x, y, w, h, 0, 0, small.width, small.height);
const {data} = context.getImageData(0, 0, small.width, small.height);
for (let i = 3; i < data.length; i += 4) {
if (data[i] !== 255) return false;
}
}
return true;
}
// Whether nothing is drawn on a canvas: every pixel of it is clear. Every pixel is looked at (a
// lone well is a few of them), a band of rows at a time so that no more is in memory than a band.
export function isBlankCanvas(canvas) {
const band = document.createElement("canvas");
band.width = canvas.width;
band.height = Math.min(BLANK_BAND_ROWS, canvas.height);
const context = band.getContext("2d", {willReadFrequently: true});
// Not known to be blank, so it is drawn.
if (!context) return false;
for (let top = 0; top < canvas.height; top += band.height) {
const rows = Math.min(band.height, canvas.height - top);
context.clearRect(0, 0, band.width, band.height);
context.drawImage(canvas, 0, top, canvas.width, rows, 0, 0, canvas.width, rows);
// Only whether a pixel is seen at all: one which is not may still have a trace of a color.
const {data} = context.getImageData(0, 0, canvas.width, rows);
for (let i = 3; i < data.length; i += 4) {
if (data[i] !== 0) return false;
}
}
return true;
}
// Whether the browser has stopped drawing on a map's canvas (it does when it has too many, or is
// short of memory): such a canvas reads as clear.
function contextLost(canvas) {
if (typeof canvas.getContext !== "function") return false;
const context = canvas.getContext("webgl2") || canvas.getContext("webgl");
return Boolean(context && typeof context.isContextLost === "function" && context.isContextLost());
}
// Draw each group of layers of `style` on a map of its own, and return the images:
// {width, height, dpi, bounds, layers: [{name, blob}]}. `bounds` is the west, south, east and north
// edges of the images (degrees), which is what says where the PDF is on the Earth: they are read
// from the map which was drawn, so they are of the picture and not of what was asked for.
//
// MapClass: maplibregl.Map. setup(map): called with the new map before it draws anything.
// readTile: how to read a tile of a source (see loadRoadNames); without it small roads have no names.
// onProgress(name, index, count, frame): called before each group is drawn, with the frame it is
// drawn in. isCancelled(): asked before each group whether to stop; when it is so nothing more is
// drawn, and this rejects with an error whose `cancelled` is true.
//
// frame: how the map is drawn (see exportFrame). Or frameFor(count): the frame of a map of that
// many images. How sharp a map may be depends on how many images it is, and a group in which
// nothing is drawn (a basemap file with no runway in the quadrangle) is no image: so the groups are
// first looked at on a small map, onLooking() is told, and only those with something in them are
// drawn, as sharp as that many may be. isBlank(canvas): whether nothing is drawn on a canvas.
export async function renderExport({
MapClass, style, frame, frameFor, groups, setup, onProgress, onLooking, isCancelled, readTile,
ignoredPrefixes = [], isBlank = isBlankCanvas,
}) {
const cancelled = () => Object.assign(new Error("The export was cancelled"), {cancelled: true});
// The size, the middle and the zoom of the map are the same however many images it is.
if (frameFor) frame = frameFor(groups.length);
const roadNames = await loadRoadNames(style, frame, readTile, isCancelled);
// Reading the names is the first of the work, and may be the slowest of it.
if (isCancelled && isCancelled()) throw cancelled();
const container = document.createElement("div");
// Off the screen, but laid out and drawn as any element is.
container.style.cssText = `position:fixed;left:-100000px;top:0;width:${frame.cssWidth}px;`
+ `height:${frame.cssHeight}px;pointer-events:none;`;
document.body.appendChild(container);
let map;
try {
const exported = exportStyle(style, ignoredPrefixes, {zoom: frame.zoom, roadNames});
// A map which draws as sharp as `pixelRatio` says. A map is made as sharp as it is to be:
// a browser lets a canvas be larger when it is made than it lets one be made larger later
// (some 33 million pixels, less than a quadrangle at 400 DPI).
const makeMap = async pixelRatio => {
const side = Math.ceil(Math.max(frame.cssWidth, frame.cssHeight) * pixelRatio);
map = new MapClass({
container,
style: exported,
center: frame.center,
zoom: frame.zoom,
interactive: false,
attributionControl: false,
pixelRatio,
maxCanvasSize: [side, side],
// The canvas is read after it is drawn, so what was drawn must still be in it.
canvasContextAttributes: {preserveDrawingBuffer: true},
// A label is all there at once: nothing is caught half faded in.
fadeDuration: 0,
});
if (setup) setup(map);
await once(map, "load");
return map.getCanvas();
};
let canvas = await makeMap(frameFor ? Math.min(LOOKING_PIXEL_RATIO, frame.pixelRatio) : frame.pixelRatio);
// Draw a group alone, have `drawn()` look at the canvas, and hide the group again.
const draw = async (group, drawn) => {
if (isCancelled && isCancelled()) {
throw cancelled();
}
const show = visibility => {
for (const id of group.ids) {
if (map.getLayer(id)) map.setLayoutProperty(id, "visibility", visibility);
}
};
show("visible");
const idle = once(map, "idle");
map.triggerRepaint();
await idle;
const result = await drawn();
show("none");
return result;
};
if (frameFor) {
if (onLooking) onLooking();
const seen = [];
for (const group of groups) {
const blank = await draw(group, () => isBlank(canvas));
// A canvas the browser has stopped drawing on is clear, whatever was to be drawn:
// that is not a group with nothing in it, to be left out and not missed.
if (blank && contextLost(canvas)) throw new Error("The browser stopped drawing the map");
if (!blank) seen.push(group);
}
if (!seen.length) throw new Error("Nothing is drawn in any layer of the map");
// Stopped while the groups were looked at: the map to export from is not made.
if (isCancelled && isCancelled()) throw cancelled();
groups = seen;
frame = frameFor(groups.length);
// The small map is done with; the map which is exported from is made in its place.
map.remove();
map = null;
canvas = await makeMap(frame.pixelRatio);
}
const layers = [];
for (const [index, group] of groups.entries()) {
// A group is not said to be drawn when it will not be.
if (isCancelled && isCancelled()) throw cancelled();
if (onProgress) onProgress(group.name, index, groups.length, frame);
const blob = await draw(group, async () => {
// A photograph with no gaps is far smaller as a JPEG; anything else needs to be seen through.
return group.raster && isOpaque(canvas)
? await canvasBlob(canvas, "image/jpeg", 0.9)
: await canvasBlob(canvas, "image/png");
});
layers.push({name: group.name, blob});
}
const edges = map.getBounds();
return {
width: canvas.width,
height: canvas.height,
bounds: [edgeLongitude(edges.getWest()), edges.getSouth(), edgeLongitude(edges.getEast()), edges.getNorth()],
dpi: canvas.width / frame.cssWidth * (frame.dpi / frame.pixelRatio),
layers,
};
} finally {
if (map) map.remove();
container.remove();
}
}
// Where the data of the exported layers is from: what each of their sources says of itself, once
// each, as text.
//
// map: the map on the screen, whose sources have been loaded (a source may only learn its
// attribution from its file).
export function exportCredits(map, groups) {
const style = map.getStyle();
const exported = new Set(groups.flatMap(group => group.ids));
const credits = [];
for (const layer of style.layers || []) {
if (!layer.source || !exported.has(layer.id)) continue;
const attribution = map.getSource(layer.source)?.attribution || style.sources?.[layer.source]?.attribution;
if (!attribution) continue;
// An attribution is HTML: links, mostly. One may name many sources, with a bar between them.
const html = new DOMParser().parseFromString(String(attribution), "text/html");
for (const part of (html.body.textContent || "").split("|")) {
const text = part.replace(/\s+/g, " ").trim();
if (text && !credits.includes(text)) credits.push(text);
}
}
return credits;
}
// The day, as the person exporting the map has it: 2026-11-15.
export function exportDate(now = new Date()) {
const pad = value => String(value).padStart(2, "0");
return `${now.getFullYear()}-${pad(now.getMonth() + 1)}-${pad(now.getDate())}`;
}
// What is written on the sheet a quadrangle is printed on. `named` is what the USGS calls the
// quadrangle ({name, state, exact}), when it calls it anything: else it goes by where it is.
//
// contours: {interval, unit} ("feet" or "meters"): how far apart the contour lines of the exported
// map are, when it has them.
//
// legend: the lines of the map as they are drawn (of exportLegend), when it has any.
export function exportSheet(quad, map, groups, now = new Date(), named = null, contours = null, legend = null) {
return {
name: quadTitle(named) || quadLabel(quad),
credits: exportCredits(map, groups),
date: exportDate(now),
...(contours ? {contours} : {}),
...(legend ? {legend} : {}),
};
}
// How far apart the contour lines of an exported map are, for exportSheet; null when no layer of
// `contourLayers` (parts of ids, as the layer control has them) is among the `groups` which are
// exported, or no line is drawn at the zoom.
//
// interval: [minor, major] at the zoom the map is exported at (see contourInterval).
export function exportContours(groups, contourLayers, interval, imperial) {
const exported = groups.some(group => group.ids.some(id => contourLayers.some(part => id.includes(part))));
if (!exported || !interval) return null;
return {interval: interval[0], unit: imperial ? "feet" : "meters"};
}
// "N40.250_W105.125": where a quadrangle's southwest corner is, in a form a file can be named.
function quadFileStem(quad) {
const part = (value, positive, negative) => `${value < 0 ? negative : positive}${Math.abs(value).toFixed(3)}`;
return `${part(quad.south, "N", "S")}_${part(quad.west, "E", "W")}`;
}
// A name as a part of a file's: "Berthoud".
function fileNamePart(name) {
// An accent is left off its letter (Cañon is Canon), not made a gap in the name.
return String(name).normalize("NFKD").replace(/\p{M}+/gu, "").replace(/[^A-Za-z0-9]+/g, "_").replace(/^_+|_+$/g, "").slice(0, 60);
}
export function exportFileName(quad, named = null) {
const name = named?.name ? fileNamePart(named.name) : "";
return `wrolpi-map_${QUAD_SCALE / 1000}k_${name ? `${name}_` : ""}${quadFileStem(quad)}.pdf`;
}
export function exportTitle(quad, named = null) {
return `1:${QUAD_SCALE.toLocaleString("en-US")} ${quadTitle(named) || quadLabel(quad)}`;
}
// Give the user a file to keep.
export function saveBlob(blob, filename) {
const url = URL.createObjectURL(blob);
const a = document.createElement("a");
a.href = url;
a.download = filename;
a.style.display = "none";
document.body.appendChild(a);
a.click();
a.remove();
// Not at once: a large file is still being read when the click returns.
setTimeout(() => URL.revokeObjectURL(url), 60_000);
}