Map source JSON format

[Hipska]

Hi, I can't seem to find anywhere what the correct format for the map source JSON should be, what each item means, which items are required, ...

[daldoyle]

There are some examples in the README to help get started. The map JSON is fairly complex and we are actually working on creating a 2.0 rev of this that has some dynamic editing via point and click vs building out the JSON objects manually or (how we do it) with scripts.

Generally speaking each item in the results.links array is a line on the map. The links.endpoints defines how to map data coming back from your datasource onto the map. The target in Grafana needs to match the links.endpoints.name exactly in order to be associated correctly. The label for the endpoint is a more human friendly name that can be utilized in say the hover tooltip.

The path is the series of points to draw the line along. You need at least two to make a straight line - additional points in between cause the line to bend towards those points and is how to accomplish curvature.

The results.endpoints array is a set of end point locations to draw. Normally this is a reduced set of the endpoints on the paths, but also provides info for things like names. Most of the fields in the example aren't really used most of the time - just name, lat, and lon.

Hopefully that helps. As I said above, we're working on making the UX of designing and updating maps a lot more cleaner in a future rev of this. Ideally people would not need to look at the raw JSON going forward at all.

[Hipska]

That's nice to hear. Could this text be added to the README please? I also found that there can be a results.endpoints.label field.

[TimWeberCoM]

daldoyle,

I love the look of your product. I'm trying to pull data from an Influx DB and I'm not very good with coding. I've got the map set up and I'm getting the endpoints and link set up, but there's no data.

Do you have any examples of the JSON file we'd need to use?

Here's what I have so far:

JSON:
{
"results": [
{
"links": [
{
"endpoints": [
{
"name": "MDC-MCH-In",
"label": "MDC to MCH Input"
},
{
"name": "MDC-MCH-Out",
"label": "MDC to MCH Output"
}
],
"name": "MDC-MCH",
"path": [
{
"lat": "xx.xxxxxx",
"lon": "-xx.xxxxxx",
"name": "MDC"
},
{
"lat": "xx.xxxxxx",
"lon": "-xx.xxxxxx",
"name": "MCH"
}
]
}
]
}
]
}

[TimWeberCoM]

Hey, I got it. Here's what I did if anyone else needs to use it.

And here's the JSON:

{
"results": [
{
"links": [
{
"endpoints": [{"name": "MDC-MCH-In","label": "MDC to MCH Input"},{"name": "MDC-MCH-Out","label": "MDC to MCH Output"}],
"name": "MDC to MCH",
"path": [{"lat": "xx.xxxxxx","lon": "-xx.xxxxxx","name": "MDC"},{"lat": "xx.xxxxxx","lon": "-xx.xxxxxx","name": "MCH"}]
}
]
}
]
}