1.2.0 • Published 1 year ago

mt3d-plugin-precipitation v1.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Precipitation plugin for Mini Tokyo 3D

Precipitation plugin displays live rain animations on the the Mini Tokyo 3D map.

Screenshot

Precipitation plugin is used in Mini Tokyo 3D Live Demo.

How to Use

First, load the Mini Tokyo 3D and this plugin within the <head> element of the HTML file.

<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>
<script src="https://cdn.jsdelivr.net/npm/mt3d-plugin-precipitation@latest/dist/mt3d-plugin-precipitation.min.js"></script>

Then, create a MiniTokyo3D instance specifying the plugins property, which is the array containing the plugin instance returned by mt3dPrecipitation().

<div id="map" style="width: 400px; height: 400px;"></div>
<script>
    const map = new mt3d.MiniTokyo3D({
        container: 'map',
        plugins: [mt3dPrecipitation()]
    });
</script>

About Data

The data for this visualization are sourced from RainViewer, which also gathers data from different data sources.

How to Build

The latest version of Node.js is required. Move to the root directory of the plugin, run the following commands, then the plugin scripts will be generated in the dist directory.

npm install
npm run build

License

Precipitation plugin for Mini Tokyo 3D is available under the MIT license.