Skip to main content Link Menu Expand (external link) Document Search Copy Copied
EvoMapJS Documentation

arrows.json (Optional)

Key-value pairs

Required

name : The name of the arrow as it will be displayed in the app >(also serves as a technical identifier inside the code).

  • Acceptable: Any string.

x : The x-coordinate of the arrow’s head.

  • Acceptable: Any number.
  • By default, all arrows tails are placed x = 0.

y : The y-coordinate of the arrow’s head.

  • Acceptable: Any number.
  • By default, all arrows tails are placed at y = 0.

time : The time at which the arrow’s head is located.

  • Acceptable: Any number in the range of time periods included in circle.json.

Support for missing time periods has not been tested. For each arrow identified in arrows.json, it is safest to provide x and y coordinates for all time periods included in circle.json.

Optional

length : The standardized length of the arrow expressed as a percentage of the maximum distance of all circles to the (0,0) origin.

  • Acceptable: A number.
  • If a length l is supplied at time t, the corresponding arrow arrow at time t will be drawn with a length of l * max_distance_to_origin where max_distance_to_origin is the maximum distance of all circles to the (0,0) origin.
  • The orientation of the arrow remains determined by the required x and y coordinates.
  • If no length is provided, the x and y coordinates are taken as absolute location parameters and directly used to draw the arrow.

Prototype of valid format 

[
  {
    "name": "FACTOR 1",
    "x": 6.4079211884,
    "y": 13.0098593574,
    "time": 1998
  },
  {
    "name": "FACTOR 1",
    "x": 6.4444474746,
    "y": 13.0361878325,
    "time": 1999
  },
  {
    "name": "FACTOR 1",
    "x": 6.4658528654,
    "y": 13.0025843621,
    "time": 2000
  }
  ]

For a full example of the data format, see url https://github.com/EvoMapViz/EvoMapJS/blob/main/src/data/arrows_TEMPLATE_DO_NOT_ERASE.json in this repository.

  • This is reference template that should not be erased. You should copy it, rename it to arrows.json, and experiment editing the latter with your own data (you can always revert to the template if you break the data format and want a fresh start).