Skip to content

README.ja.md

Latest commit

 

History

History
166 lines (126 loc) · 6.45 KB

README.ja.md

File metadata and controls

166 lines (126 loc) · 6.45 KB
Raw

English | 日本語 | Español (Latinoamérica)

@mapconductor/react-for-openlayers

MapConductor React SDK の OpenLayers プロバイダです。MapConductor のプロバイダ非依存なカメラ・マーカー・オーバーレイ API を通じて OpenLayers の地図を描画するため、同じアプリケーションコードが Google Maps、MapLibre、Mapbox、Leaflet、ArcGIS、Cesium、HERE でもそのまま動作します。

インストール

npm install @mapconductor/react-for-openlayers

@mapconductor/js-sdk-core と @mapconductor/js-sdk-react(マーカーなどの共有コンポーネントで使用)は依存関係として自動的にインストールされます。ただしアプリケーションコードはこの2つから直接 import するため、pnpm の strict(isolated)な node_modules を使う場合や、import するものをすべて明示的に宣言したい場合は、次のように明示的にインストールしてください:

npm install @mapconductor/react-for-openlayers @mapconductor/js-sdk-core @mapconductor/js-sdk-react

ol は依存関係として同梱されています。デフォルトの OpenStreetMap ソースに API キーは不要です。

Hello Map チュートリアル

MapConductor + OpenLayers で作る、いちばん簡単な地図アプリです。マーカーをクリックすると「Hello, MapConductor」の吹き出しが出ます。この地図は、次の 5 ステップで作れます。API キー不要の OpenLayers の OpenStreetMap ソースを使うので、コピペで動きます。

ステップ 1: React プロジェクトを作る

Vite で React + TypeScript のプロジェクトを作成します。

npm create vite@latest hello-map -- --template react-ts
cd hello-map
npm install
npm run dev

ステップ 2: MapConductor（OpenLayers）をインストール

地図表示に必要なパッケージを入れます。ここでは OpenLayers を使いますが、他の地図モジュールを使うこともできます。

npm install @mapconductor/react-for-openlayers
  • @mapconductor/react-for-openlayers — OpenLayers 用のコンポーネント/フック
  • @mapconductor/js-sdk-react / @mapconductor/js-sdk-core は依存関係として自動的にインストールされます。

ステップ 3: 地図を表示する

useOpenLayersMapViewState で地図の状態を作り、<OpenLayersMapView> で描画します。スタイル用の CSS import を忘れずに。外側の要素に高さを与えると全画面になります。

import {
  OpenLayersDesign,
  OpenLayersMapView,
  useOpenLayersMapViewState,
} from '@mapconductor/react-for-openlayers';
import '@mapconductor/react-for-openlayers/style.css';
import { createGeoPoint, createMapCameraPosition } from '@mapconductor/js-sdk-core';

const TOKYO = createGeoPoint({ latitude: 35.6812, longitude: 139.7671 });
const INITIAL_CAMERA = createMapCameraPosition({ position: TOKYO, zoom: 14 });

export default function App() {
  const mapViewState = useOpenLayersMapViewState({
    mapDesignType: OpenLayersDesign.OpenStreetMap,
    cameraPosition: INITIAL_CAMERA,
  });

  return (
    <div style={{ width: '100vw', height: '100vh' }}>
      <OpenLayersMapView state={mapViewState} />
    </div>
  );
}

ステップ 4: マーカーを置く

createMarkerState でマーカーの状態を作り、<Marker> で登録します。オーバーレイは地図コンポーネントの子要素として書きます。

import { useMemo } from 'react';
import { createMarkerState } from '@mapconductor/js-sdk-core';
import { Marker } from '@mapconductor/js-sdk-react';

// ...App の中...
const marker = useMemo(
  () => createMarkerState({ id: 'hello', position: TOKYO }),
  [],
);

// ...return の中...
<OpenLayersMapView state={mapViewState}>
  <Marker state={marker} />
</OpenLayersMapView>

ステップ 5: クリックで InfoBubble を表示する

選択中かどうかを useState で持ち、マーカーの onClick で true にします。選択中のときだけ <InfoBubble> を描画します。これが完成形です。

import { useMemo, useState } from 'react';
import {
  OpenLayersDesign,
  OpenLayersMapView,
  useOpenLayersMapViewState,
} from '@mapconductor/react-for-openlayers';
import '@mapconductor/react-for-openlayers/style.css';
import {
  createGeoPoint,
  createMapCameraPosition,
  createMarkerState,
} from '@mapconductor/js-sdk-core';
import { InfoBubble, Marker } from '@mapconductor/js-sdk-react';

const TOKYO = createGeoPoint({ latitude: 35.6812, longitude: 139.7671 });
const INITIAL_CAMERA = createMapCameraPosition({ position: TOKYO, zoom: 14 });

export default function App() {
  const mapViewState = useOpenLayersMapViewState({
    mapDesignType: OpenLayersDesign.OpenStreetMap,
    cameraPosition: INITIAL_CAMERA,
  });

  const [selected, setSelected] = useState(false);

  const marker = useMemo(
    () => createMarkerState({
      id: 'hello',
      position: TOKYO,
      onClick: () => setSelected(true),
    }),
    [],
  );

  return (
    <div style={{ width: '100vw', height: '100vh' }}>
      <OpenLayersMapView state={mapViewState} onMapClick={() => setSelected(false)}>
        <Marker state={marker} />
        {selected && (
          <InfoBubble marker={marker}>
            <div style={{ padding: '8px 12px', fontWeight: 600 }}>
              Hello, MapConductor
            </div>
          </InfoBubble>
        )}
      </OpenLayersMapView>
    </div>
  );
}

ポイント

  • 座標・カメラ・マーカーは js-sdk-core の関数で作る（プロバイダー非依存）
  • 地図コンポーネントとフックは react-for-openlayers から来る（プロバイダー固有）
  • オーバーレイは地図コンポーネントの子要素として書く
  • 表示・非表示は React の useState で制御する

関連パッケージ