Global

Methods

getRingWeight()

Ring weight for the auto-trail computation. Inner ring = highest weight (most "adopted"). For legacy 4×4 radars uses the hardcoded RING_WEIGHT map; for Flex radars derives the weight from the radar's own ordered `rings` array (index 0 = innermost = N-1, last = outermost = 0).
Source:

run(optionsopt) → {Promise.<void>}

Generate static sites from csv/json/yml radar declarations
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
input string <optional>
 globby pattern for input files (default `data/**\/*.{json,csv,yml}`)
output string <optional>
 output directory (default `radar`)
cwd string <optional>
 current working directory
basePrefix string <optional>
 web app root level prefix; URL-shaped values (`https://…`, `//…`) become absolute, others relative
autoscope boolean <optional>
 consider same-scoped files as subversions of a single radar
navPage boolean <optional>
 generate navigation page
navTitle string <optional>
 nav page title
navFooter string <optional>
 nav page footer
temp string <optional>
 temp directory
templates string <optional>
 path to a directory whose contents are merged on top of bundled templates
renderSettings Object <optional>
 custom render settings (rings, colors, dimensions) for `radar.js`
renderer 'zalando' | 'aurora' <optional>
 output backend (default `zalando`)
favicon string <optional>
 path to a custom favicon (`.ico`/`.png`) — copied to `/favicon.ico`. If not provided, the bundled default is used.
about string <optional>
 path to a .md or .html file with radar overview (aurora only)
credits boolean <optional>
 include the generator credit in the legend footer (default `true`; aurora only)
Source:
Returns:
Type
Promise.<void>