Mini Tokyo 3D

# Mini Tokyo 3D の使用

Mini Tokyo 3D を Web ページに埋め込んで利用する、もしくは API を使って操作する方法は非常にシンプルです。まずは、このセクションの説明に従って設定してください。

# 使用の準備

Mini Tokyo 3D は ES2018 に対応した主要ブラウザで動作します。Internet Explorer には非対応です。

Mini Tokyo 3D は次のデータソースを使用しており、実行時にそれぞれのデータソースに対するアクセストークンが必要です。下記の手順に従って、アクセストークンを入手してください。

データソース サインアップ用 URL アクセストークンの形式
公共交通オープンデータセンター (opens new window) リンク (opens new window) 数字と英小文字からなる文字列
公共交通オープンデータセンター
（公共交通オープンデータチャレンジ2024 (opens new window)）		 リンク (opens new window) 数字と英小文字からなる文字列
Mapbox (opens new window) リンク (opens new window) pk. で始まるピリオドを含む英数字文字列

# 公共交通オープンデータセンターアクセストークンの入手

Mini Tokyo 3D は公共交通オープンデータセンター (opens new window)で配信されている列車データや旅客機データを利用しています。データの入手には開発者としての登録が必要ですが、無料で利用可能です。

  1. 開発者サイトへの登録 (opens new window)ページでユーザー情報を入力して、開発者登録をします。登録完了のメールが届くまでに数日かかる場合があります。
  2. 開発者アカウントでログイン後、画面右上の「ログイン中」と表示されているメニューから「ODPTセンター用アクセストークン」を選びます。
  3. ODPTセンター用アクセストークン一覧が表示されます。アカウント作成直後はデフォルトの「DefaultApplication」のみが表示されます。「追加」をクリックします。
  4. 「名称」に任意のアプリケーション名を入力して、「この内容で更新する」ボタンをクリックします。
  5. アクセストークン一覧に新たに作成されたトークンが表示されます。

# 公共交通オープンデータチャレンジ2024アクセストークンの入手

公共交通オープンデータセンターでは、公共交通オープンデータチャレンジ2024 (opens new window)向けに追加の列車データや旅客機データも配信されており、これらは専用のアクセストークンで取得します。専用アクセストークンの入手には公共交通オープンデータチャレンジ2024へのエントリーが必要ですが、データは無料で利用可能です。

  1. 公共交通オープンデータセンター開発者サイト (opens new window)の案内に従って、チャレンジへのエントリーを行います。
  2. 画面右上の「ログイン中」と表示されているメニューから「チャレンジ2024専用アクセストークン」を選びます。
  3. チャレンジ2024専用アクセストークン一覧が表示されます。エントリー直後はデフォルトの「Challenge2024DefaultApplication」のみが表示されます。「追加」をクリックします。
  4. 「名称」に任意のアプリケーション名を入力して、「この内容で更新する」ボタンをクリックします。
  5. アクセストークン一覧に新たに作成されたトークンが表示されます。

# Mapbox アクセストークンの入手

Mini Tokyo 3D は地図タイルに Mapbox (opens new window) のサービスを利用しているため、利用には Mapbox のアクセストークンが必要です。Map Loads for Web (opens new window) セッションを利用しており、月間 50,000 接続までは無料です。下記の手順に従って、アクセストークンを入手してください。

  1. サインアップ (opens new window)ページでユーザー情報を入力して、Mapbox アカウントを作成します。
  2. Mapbox アカウントログイン後、画面上部のメニューから「Tokens」をクリックしてアクセストークン一覧を表示します。アカウント作成直後はデフォルトの「Default public token」のみが表示されます。
  3. 「Create a token」ボタンをクリックして、アクセストークン作成ページに進みます。
  4. 「Token name」にはあなたの Web サイト名やアプリ名など、任意の名前を入力します。
  5. 「Token scopes」はデフォルト設定（Public scopes にすべてチェックが入った状態）のままにします。
  6. 「Token restrictions」の「URL」欄には、Mini Tokyo 3D を設置するサイトの URL を入力して「Add URL」ボタンをクリックします。URL の形式は、URL restrictions (opens new window) を参考にしてください。この URL 制限を設定しておくことで、他のサイトからこのアクセストークンを利用されることを防ぎます。
  7. 最後に画面下部の「Create token」ボタンをクリックすると、アクセストークン一覧に新たに作成されたトークンが表示されます。

# 直接 Web ページに組み込む

単純に Web ページに Mini Tokyo 3D のマップを表示するだけであれば、次のように HTML ファイルを編集するだけです。

まず、jsDelivr CDN のリンクを使用して、Mini Tokyo 3D のスタイルシートと JavaScript コードを HTML ファイルの <head> エレメント内で読み込みます。

<head>
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/mini-tokyo-3d@latest/dist/mini-tokyo-3d.min.css" />
  <script src="https://cdn.jsdelivr.net/npm/mini-tokyo-3d@latest/dist/mini-tokyo-3d.min.js"></script>
</head>

同じ HTML ファイルの <body> エレメント内で、id のついた HTML エレメント（下の例では <div> エレメント）を追加し、<script> エレメントで Mini Tokyo 3D インスタンスを作成する JavaScript コードを記述します。コンストラクタに渡す options オブジェクトの container には HTML エレメントの id を指定します。また、accessToken には、上のステップで入手した Mapbox アクセストークン、secrets には公共交通オープンデータセンターアクセストークンと公共交通オープンデータチャレンジ2024アクセストークンを指定します。

<body>
  <div id="mini-tokyo-3d" style="width: 400px; height: 400px;"></div>

  <script>
    const options = {
      container: 'mini-tokyo-3d',
      accessToken: '<Mapbox アクセストークン>',
      secrets: {
        odpt: '<公共交通オープンデータセンターアクセストークン>',
        challenge2024: '<公共交通オープンデータチャレンジ2024アクセストークン>'
      }
    };
    const map = new mt3d.Map(options);
  </script>
</body>

# モジュールとしてアプリに組み込む

バンドラーを使って Mini Tokyo 3D を自分のアプリケーションのコードに組み込む場合には、次の手順に従ってください。

まず、Mini Tokyo 3D の npm モジュールをインストールし、あなたのアプリケーションの package.json に登録します。

npm install mini-tokyo-3d --save

CommonJS 形式でモジュールを読み込む場合は、コードの先頭で次のように記載します。

const {Map} = require('mini-tokyo-3d');

ES6 形式でモジュールを読み込む場合は、コードの先頭で次のように記載します。

import {Map} from 'mini-tokyo-3d';

アプリケーションのコード内で、次のようにして Map オブジェクトを初期化します。options オブジェクトの container には Mini Tokyo 3D がマップを表示する HTML エレメントの ID を指定します。また、accessToken には、上のステップで入手した Mapbox アクセストークン、secrets には公共交通オープンデータセンターアクセストークンと公共交通オープンデータチャレンジ2024アクセストークンを指定します。

const options = {
  container: '<コンテナエレメントの ID>',
  accessToken: '<Mapbox アクセストークン>',
  secrets: {
    odpt: '<公共交通オープンデータセンターアクセストークン>',
    challenge2024: '<公共交通オープンデータチャレンジ2024アクセストークン>'
  }
};
const map = new Map(options);

# プラグインの追加

3Dマップ上に付加的な情報を表示する、様々なプラグインが利用可能です。プラグインは Mini Tokyo 3D 本体とは別に提供されており、サイト設置時もしくはアプリケーションビルド時に好みに応じて組み込むことができます。下記では例として、降水プラグイン (opens new window)と花火プラグイン (opens new window)を組み込む手順を示します。

直接 Web ページに組み込む場合は、次のように HTML ファイルの <head> エレメント内でプラグインを読み込み、plugins プロパティを指定して Map オブジェクトを初期化します。

  <script src="https://cdn.jsdelivr.net/npm/mt3d-plugin-precipitation@latest/dist/mt3d-plugin-precipitation.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/mt3d-plugin-fireworks@latest/dist/mt3d-plugin-fireworks.min.js"></script>

  <script>
    const options = {
      /* ... */
      plugins: [mt3dPrecipitation(), mt3dFireworks()]
    };
    const map = new mt3d.Map(options);
  </script>

モジュールとしてアプリに組み込む場合は、次の手順に従ってアプリケーションをビルドしてください。

CommonJS 形式でモジュールを読み込む場合は、コードの先頭で次のように記載します。

const mt3dPrecipitation = require('mt3d-plugin-precipitation');
const mt3dFireworks = require('mt3d-plugin-fireworks');

ES6 形式でモジュールを読み込む場合は、コードの先頭で次のように記載します。

import mt3dPrecipitation from 'mt3d-plugin-precipitation';
import mt3dFireworks from 'mt3d-plugin-fireworks';

アプリケーションのコード内で、次のように plugins プロパティを指定して Map オブジェクトを初期化します。

const options = {
  /* ... */
  plugins: [mt3dPrecipitation(), mt3dFireworks()]
};
const map = new Map(options);
最終更新日時: 2024/10/6 16:31:34

← Mini Tokyo 3D のビルド →