Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 250 additions & 11 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,12 +13,15 @@
"dependencies": {
"@deck.gl/react": "^9.3.3",
"deck.gl": "^9.3.7",
"fflate": "^0.8.3",
"jspdf": "^4.2.1",
"maplibre-gl": "^5.24.0",
"next": "16.2.12",
"react": "19.2.8",
"react-dom": "19.2.8",
"react-map-gl": "^8.1.2",
"recharts": "^3.10.1",
"write-excel-file": "^4.1.1",
"zarrita": "^0.7.3"
},
"devDependencies": {
Expand Down
133 changes: 133 additions & 0 deletions src/components/map/DownloadButton.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
"use client";

import { useCallback, useState } from "react";
import { DownloadIcon } from "@/icons/DownloadIcon";
import { captureMapForExport } from "@/components/map/ExportMapStage";
import { capturePlotsForExport } from "@/components/map/ExportStage";
import { buildSeriesCsv } from "@/lib/export/csv";
import { downloadBlob } from "@/lib/export/download";
import { buildReportPdf, type ReportAssets } from "@/lib/export/pdf";
import { buildProvenance, exportFileBaseName } from "@/lib/export/provenance";
import { buildSeriesRows } from "@/lib/export/rows";
import { buildSeriesWorkbook } from "@/lib/export/xlsx";
import { blobToBytes, buildZip, dataUrlToBytes } from "@/lib/export/zip";
import type { GridSpec, MapSelection } from "@/types/map";

type DownloadButtonProps = {
selection: MapSelection;
gridSpec: GridSpec;
historyYears: number;
values: Float32Array | null;
units: string | null;
};

export function DownloadButton({
selection,
gridSpec,
historyYears,
values,
units,
}: DownloadButtonProps) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);

const runExport = useCallback(async () => {
if (!values) return;

setError(null);
setBusy(true);
try {
const prov = buildProvenance({
selection,
historyYears,
valueCount: values.length,
units,
});
const base = exportFileBaseName(prov);

// Both stages mount offscreen and are independent, so the map's tiles
// download while the plots lay out.
const [mapCapture, plots] = await Promise.all([
captureMapForExport({ cell: selection.grid, gridSpec }),
capturePlotsForExport({
values,
units,
hoursPerDay: prov.hoursPerDay,
}),
]);
const assets: ReportAssets = {
map: mapCapture.image,
timeSeries: plots.timeSeries,
fingerprint: plots.fingerprint,
};

const rows = buildSeriesRows(values, prov);
const [pdf, workbook] = await Promise.all([
buildReportPdf({
prov,
assets,
values,
attribution: mapCapture.attribution,
}),
buildSeriesWorkbook(rows, prov),
]);

// Everything but the CSV is compressed already, so only it is worth
// deflating. Every name carries the full stem: extracted loose among
// other downloads they still say which pixel and window they came from.
const archive = await buildZip([
{ name: `${base}.pdf`, data: await blobToBytes(pdf), stored: true },
{
name: `${base}.xlsx`,
data: await blobToBytes(workbook),
stored: true,
},
{
name: `${base}.csv`,
data: new TextEncoder().encode(buildSeriesCsv(rows, prov)),
},
{
name: `${base}_fingerprint.png`,
data: dataUrlToBytes(plots.fingerprintStandalone.dataUrl),
stored: true,
},
{
name: `${base}_timeseries.png`,
data: dataUrlToBytes(plots.timeSeries.dataUrl),
stored: true,
},
]);

downloadBlob(archive, `${base}.zip`);
} catch (cause) {
console.error("Export failed", cause);
setError("Export failed. Try again.");
} finally {
setBusy(false);
}
}, [gridSpec, historyYears, selection, units, values]);

return (
<div className="relative">
<button
type="button"
disabled={!values || busy}
onClick={() => void runExport()}
title="Downloads a zip: PDF report, Excel and CSV tables, and both plots as images"
className="inline-flex items-center gap-1.5 rounded-md border border-editor-border px-2 py-1 text-[11.5px] font-semibold text-editor-fg-secondary transition-colors hover:border-editor-border-strong hover:text-editor-fg-primary disabled:cursor-not-allowed disabled:opacity-40"
>
<DownloadIcon />
{busy ? "Preparing…" : "Download"}
</button>

{error ? (
<p
role="status"
className="absolute right-0 top-full mt-1.5 whitespace-nowrap text-[11.5px] text-editor-fg-tertiary"
>
{error}
</p>
) : null}
</div>
);
}
170 changes: 170 additions & 0 deletions src/components/map/ExportMapStage.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
"use client";

import { createRoot } from "react-dom/client";
import Map from "react-map-gl/maplibre";
import type { Map as MapLibreMap, MapLibreEvent } from "maplibre-gl";
import "maplibre-gl/dist/maplibre-gl.css";
import { GlobeSelectionOverlay } from "@/components/map/GlobeSelectionOverlay";
import {
MAP_BASE_STYLES,
SELECTION_FOCUS_ZOOM,
} from "@/lib/map/viewState";
import {
canvasToPng,
createOffscreenHost,
whenVisible,
type CapturedImage,
} from "@/lib/export/capture";
import { collectAttribution } from "@/lib/export/mapSnapshot";
import type { GridCell, GridSpec, MapViewState } from "@/types/map";

/**
* Stage size in CSS px, at the aspect ratio of the report's map box (88mm x
* 47mm). Matching it means the panel prints the whole frame instead of a
* centre crop of one shaped like the screen.
*/
const EXPORT_MAP_WIDTH = 704;
const EXPORT_MAP_HEIGHT = 376;

/**
* Fixed rather than inherited from the display, so the printed map has the same
* ~400dpi on every machine. 2 is where the labels stay crisp in print without
* the PNG dominating the file size.
*/
const EXPORT_MAP_PIXEL_RATIO = 2;

/** Style, glyphs and the first tiles, over the network. */
const LOAD_TIMEOUT_MS = 8000;

/** Extra grace for the remaining tiles once the map itself is up. */
const TILE_TIMEOUT_MS = 6000;

const MAP_CANVAS_ATTRIBUTES = { preserveDrawingBuffer: true } as const;

export type MapCapture = {
/** Null when the offscreen map could not be drawn; the report prints a note. */
image: CapturedImage | null;
/** Basemap credit, which the on-screen map hides but a distributed file must carry. */
attribution: string;
};

type CaptureOptions = {
cell: GridCell;
gridSpec: GridSpec;
};

/**
* The map as the report wants it, which is not the map on screen: always plan
* view, always the light basemap, always framed on the selected cell. The live
* map can be a dark globe tilted off its axis, and printing that into a light
* A4 report gives a black sphere floating in a white page.
*/
function ExportMapStage({
cell,
gridSpec,
onReady,
}: CaptureOptions & { onReady: (map: MapLibreMap) => void }) {
const viewState: MapViewState = {
longitude: cell.lon,
latitude: cell.lat,
zoom: SELECTION_FOCUS_ZOOM,
bearing: 0,
pitch: 0,
};

return (
<Map
mapStyle={MAP_BASE_STYLES.light}
initialViewState={viewState}
interactive={false}
attributionControl={false}
// Without it the drawing buffer is cleared after each paint, and there is
// nothing left to read back.
canvasContextAttributes={MAP_CANVAS_ATTRIBUTES}
onLoad={(event: MapLibreEvent) => onReady(event.target)}
style={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
>
<GlobeSelectionOverlay
cell={cell}
gridSpec={gridSpec}
viewState={viewState}
mapSize={{ width: EXPORT_MAP_WIDTH, height: EXPORT_MAP_HEIGHT }}
isLight
isSphere={false}
/>
</Map>
);
}

/**
* Resolve once the map has nothing left to draw, or once the grace period runs
* out. A timeout is not a failure: a map missing its outermost tiles still
* prints usefully, so whatever has painted by then is what gets captured.
*/
function waitForIdle(map: MapLibreMap, timeoutMs: number): Promise<void> {
if (map.areTilesLoaded() && map.isStyleLoaded()) return Promise.resolve();

return new Promise((resolve) => {
const finish = () => {
clearTimeout(timer);
map.off("idle", finish);
resolve();
};
const timer = setTimeout(finish, timeoutMs);
map.on("idle", finish);
});
}

/**
* Mount a map offscreen, wait for it to settle, and rasterise it for the
* report. The stage is torn down before this resolves.
*
* Never throws: the report treats a missing map as a layout case, and a failed
* basemap is not a reason to lose the data the user asked to download.
*/
export async function captureMapForExport({
cell,
gridSpec,
}: CaptureOptions): Promise<MapCapture> {
// A hidden tab paints nothing and fetches no tiles, so the load and idle
// budgets below would run out on a map that never had a chance to draw.
await whenVisible();

const host = createOffscreenHost(EXPORT_MAP_WIDTH, EXPORT_MAP_HEIGHT);
const root = createRoot(host);

try {
const map = await new Promise<MapLibreMap | null>((resolve) => {
const timer = setTimeout(() => resolve(null), LOAD_TIMEOUT_MS);
root.render(
<ExportMapStage
cell={cell}
gridSpec={gridSpec}
onReady={(instance) => {
clearTimeout(timer);
resolve(instance);
}}
/>,
);
});

if (!map) return { image: null, attribution: "" };

map.setPixelRatio(EXPORT_MAP_PIXEL_RATIO);
await waitForIdle(map, TILE_TIMEOUT_MS);
// The buffer holds the last painted frame, and the pixel-ratio resize may
// still be pending, so force one more frame before reading it back.
map.redraw();

return {
image: canvasToPng(map.getCanvas()),
attribution: collectAttribution(map.getStyle()?.sources),
};
} catch (cause) {
console.error("Map capture failed", cause);
return { image: null, attribution: "" };
} finally {
root.unmount();
host.remove();
}
}
Loading
Loading