ドキュメント / セットアップ / React / deck.gl

deck.gl セットアップ

Web で deck.gl を MapConductor の地図として使う手順です。キーは不要で、ベースマップには任意の XYZ ラスタータイルを使えます。

PACKAGE
react-for-deckgl
API KEY
不要
CSS
不要
3D CAMERA
傾き・回転

前提

Node.js 18 以上
React 18 または 19
STEP 01

インストールする

deck.gl(@deck.gl/core・layers・geo-layers 9.x)は依存として一緒に入ります。

terminalnpm
npm install @mapconductor/js-sdk-core @mapconductor/js-sdk-react \
            @mapconductor/react-for-deckgl
STEP 02

ベースマップを決める

deck.gl 自身は地図を持たないので、ベースマップは XYZ のラスタータイルから描きます。用意されたデザインのほかに、タイル URL のテンプレートを渡せば自前のタイルも使えます。帰属表示は attributionRules に書きます。

designs.tsTypeScript
import { DeckGLDesign } from '@mapconductor/react-for-deckgl';

const gsi = new DeckGLDesign({
  id: 'gsi-standard',
  tileUrl: 'https://cyberjapandata.gsi.go.jp/xyz/std/{z}/{x}/{y}.png',
  tileSize: 256,
  maxZoom: 18,
  attributionRules: [{ attribution: '国土地理院' }],
});

state.mapDesignType = gsi;
注意
OpenStreetMap の公開タイルサーバーには利用ポリシーがあります。本番トラフィックを流す場合は、自前のタイル配信か商用サービスを使ってください。
STEP 03

必要になるまで読み込まない

ルートの @mapconductor/react-for-deckgl を import すると deck.gl 本体が読み込まれます。状態とデザインだけなら @mapconductor/react-for-deckgl/state から取れるので、地図そのものは lazy() で後から読み込めます。DeckGLView は、ルートから DeckGLMapView を import して state を渡すだけのコンポーネントです。

Page.tsxTypeScript · React
import { lazy, Suspense } from 'react';
import { DeckGLDesign, useDeckGLMapViewState } from '@mapconductor/react-for-deckgl/state';

const DeckGLView = lazy(() => import('./DeckGLView'));

export function Page() {
  const state = useDeckGLMapViewState({ mapDesignType: DeckGLDesign.Dark });
  return (
    <Suspense fallback={null}>
      <DeckGLView state={state} />
    </Suspense>
  );
}

動作確認

ここまで動けば完了

地図とマーカーが出れば完了です。

DeckGLMap.tsxTypeScript · React
import { createGeoPoint, createMapCameraPosition, createMarkerState } from '@mapconductor/js-sdk-core';
import { Marker } from '@mapconductor/js-sdk-react';
import { DeckGLDesign, DeckGLMapView, useDeckGLMapViewState } from '@mapconductor/react-for-deckgl';
import { useState } from 'react';

const TOKYO = createGeoPoint({ latitude: 35.6812, longitude: 139.7671 });

export function DeckGLMap() {
  const state = useDeckGLMapViewState({
    mapDesignType: DeckGLDesign.Standard,
    cameraPosition: createMapCameraPosition({ position: TOKYO, zoom: 12 }),
  });
  const [markerState] = useState(() => createMarkerState({ id: 'tokyo', position: TOKYO }));

  return (
    <DeckGLMapView state={state} containerStyle={{ height: 480 }}>
      <Marker state={markerState} />
    </DeckGLMapView>
  );
}

地図デザイン

DeckGLDesign はタイル URL テンプレートを包んだ値です。自前のタイルを使う場合は同じ型を new します。

DeckGLDesign
Notes
Standard
OpenStreetMap の標準タイル。最大ズーム 19
Satellite
Esri World Imagery の航空写真
Dark
CARTO の暗い地図。最大ズーム 20
Light
CARTO の明るい地図。最大ズーム 20
None
ベースタイルなし。オーバーレイやベクタースタイルだけを描きたいとき

うまくいかないとき

Longdo や Mappls と同じページに置くとエラーになる

  • deck.gl は自分の版を globalThis.deck に登録し、別の版がすでにあると例外を投げます。Longdo の SDK は deck.gl 8.x を持ち込み、Mappls も同じことをします。同じページには置かず、/state と lazy() で必要になるまで deck.gl を読み込まないでください。

地図を回すと地名も回る

  • ベースマップはラスタータイルなので、文字も画像の一部です。文字を立てたままにしたいなら、ベクタースタイルを描ける MapLibre などを選んでください。

回転だけ・傾きだけを止められない

  • deck.gl の dragRotate が両方をまとめて扱うため、片方だけは止められません。そう指定するとどちらも有効のままになり、一度だけ警告が出ます。

次に

マーカー・円・ポリライン・ポリゴン・地表画像・ラスターレイヤーは、ほかのプロバイダと同じコードで描けます。ベクタースタイルを重ねたいときは、ベクタータイルレイヤーを DeckGLDesign.None と組み合わせてください。