radicle-map v0.1.0

Radicle Map docs

Getting Started

• git clone git@git.2020.dev:gm/radicle-leaflet.git
• cd [directory]
• npm install
• npm run dev to view example in browser with live reload

To add to your project, include dist/radicleMap.js and dist/radicleMap.css in your HTML page, or import via bundler using import "dist/radicleMap.js or const Radicle = require("dist/radicleMap.js).

Simple Example

HTML:

    <script src="path/to/dist/radicleMap.js"></script>
    <div id="myMap"></div>

JAVASCRIPT:

const map = new Radicle.Map(
    "myMap",                    //Container ID into which to render the Map map (required)
    {                           //JavaScript object containing a map of options and callbacks
        onMapLoad: ()=> {}      //You SHOULD include an `onMapLoad` callback to avoid crashes
    }
)

map.cff.set(cff_array)          //Load in a client-farm-field array (as a JavaScript array of maps or the equivalent JSON string)

Full Example

See test.html and source files in the testAssets directory for a full example.

The Gist

Initialize a map

Initialize a map as demonstrated above. You should include an onMapLoad() callback in which you place all your mapping logic or set some "ready" flag; accessing the map before it is ready will cause the application to crash.

You can see a full list of options and callbacks for map initialization here. Many of these options can be changed on the fly by changing mapInstance.options.whatever or mapInstance.options.callbacks.whatever.

Useful actions

Camera control

Client/Farm/Field manipulation

|Action |Effect | |--- |--- f | |map.cff.set(cff_array) |Load in a client-farm-field array (as a JavaScript array of maps or the equivalent JSON string) | |map.cff.getField(uuid) |Return a field instance by UUID| |field.getZone(uuid) |Return a zone instance by UUID| |map.activeField |Return the currently-active field| |map.fieldList|| |map.fieldListUuids|| |map.fieldListNames|| |map.fieldListShortNames|| |map.clientList|| |map.activeClient|| |map.farmList|| |map.activeFarm||

Enabling Sampling View (setting active field) and getting sample data

Etc.