@abi-software/flatmap-viewer

Flatmap viewer using Mapbox GL

Usage no npm install needed!

<script type="module">
  import abiSoftwareFlatmapViewer from 'https://cdn.skypack.dev/@abi-software/flatmap-viewer';
</script>

README

============== Flatmap Viewer

A viewer for anatomical flatmaps generated by flatmap-maker <https://github.com/dbrnz/flatmap-maker>. The viewer is intended to be a component of a larger Javascript web application, although may be used standalone for local flatmap development and testing. Flatmap content is obtained from a flatmap-server <https://github.com/dbrnz/flatmap-server>.

Standalone Use

Requirements

  • nodejs <https://nodejs.org/en/download/>_

Installation

  1. Clone this repository.
  2. Run npm install

Running

::

$ npm start

Maps can then be viewed at http://localhost:3000

Configuration


The map server endpoint is specified as ``MAP_ENDPOINT`` in ``src/main.js``. It defaults to ``http:localhost:4329/``, which matches the default endpoint of a local flatmap server.

Package Installation
====================

* ``npm install @dbrnz/flatmap-viewer``

Documentation
-------------

Documentation for the API is available `here <https://celldl.org/docs/flatmap-viewer/API.html>`_.