Archived

Documentation for Layer Cake v10, before Svelte 5 runes. Current docs at layercake.graphics

Menu

Map.canvas.svelte component

Generates a canvas map using the geoPath function from d3-geo.

Param Default Required Description
projection Function None
yes
A D3 projection function. Pass this in as an uncalled function, e.g. projection={geoAlbersUsa}.
stroke string '#ccc'
no
The shape's stroke color.
strokeWidth number 1
no
The shape's stroke width.
fill (string | undefined) None
no
The shape's fill color. By default, the fill will be determined by the c-scale, unless this prop is set.
features (Array<Object> | undefined) None
no
A list of GeoJSON features. Use this if you want to draw a subset of the features in k.data while keeping the zoom on the whole GeoJSON feature set. By default, it plots everything in k.data.features if left unset.

Used in these examples:

SSR Examples:

<!--
  @component
  Generates a canvas map using the `geoPath` function from [d3-geo](https://github.com/d3/d3-geo).
 -->
<script>
  import { getLayerCakeContext, getCanvasContext } from 'layercake';
  import { geoPath } from 'd3-geo';

  /** @type {import('layercake').LayerCakeContext<any, { features: Array<any> }>} */
  const k = getLayerCakeContext();
  const canvas = getCanvasContext();

  /**
   * @typedef {Object} Props
   * @property {Function} projection - A D3 projection function. Pass this in as an uncalled function, e.g. `projection={geoAlbersUsa}`.
   * @property {string} [stroke='#ccc'] - The shape's stroke color.
   * @property {number} [strokeWidth=1] - The shape's stroke width.
   * @property {string|undefined} [fill] - The shape's fill color. By default, the fill will be determined by the c-scale, unless this prop is set.
   * @property {Array<Object>|undefined} [features] - A list of GeoJSON features. Use this if you want to draw a subset of the features in `k.data` while keeping the zoom on the whole GeoJSON feature set. By default, it plots everything in `k.data.features` if left unset.
   */

  /** @type {Props} */
  let { projection, stroke = '#ccc', strokeWidth = 1, fill, features } = $props();

  let projectionFn = $derived(projection().fitSize([k.width, k.height], k.data));

  let geoPathFn = $derived(geoPath(projectionFn));

  let featuresToDraw = $derived(features || k.data.features);

  // Layer Cake runs this on every repaint: resize, new data or a prop change
  canvas.draw(ctx => {
    // geoPath draws into whichever context it was given last, so hand it this one first
    geoPathFn.context(ctx);
    featuresToDraw.forEach(feature => {
      ctx.beginPath();
      geoPathFn(feature);

      // Fall back to a neutral fill when the chart has no c dimension
      ctx.fillStyle = fill ?? k.cGet?.(feature.properties) ?? '#ccc';
      ctx.fill();

      ctx.lineWidth = strokeWidth;
      ctx.strokeStyle = stroke;
      ctx.stroke();
    });
  });
</script>