Skip to content

Commit f5bdadf

Browse files
committed
Update plugin name to "panodata-map-panel"
1 parent c74d0fc commit f5bdadf

File tree

9 files changed

+61
-44
lines changed

9 files changed

+61
-44
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22

33
## development
44
- Add compatibility with Grafana 8
5-
65
- Add Makefile to assist in packaging and publishing
76
- Overlay image can now be refreshed with the dashboard. Thanks, @jreyesr!
87
- Revert "Support multiple metrics in popup content for Elasticsearch" again.
98
The feature was not ready to be used with PostgreSQL and InfluxDB datasources yet.
10-
Thanks, @matschaffer!
9+
- Update plugin name to "panodata-map-panel"
1110

1211
## v0.15.0
1312
- Support multiple metrics in popup content for Elasticsearch. Thanks, @matschaffer!

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Hacking on the Grafana Map Panel
1+
# Hacking on the Panodata Map Panel
22

33
## Introduction
44
The easiest way to get started is to git clone the project repository
@@ -14,10 +14,10 @@ refreshing the page will be sufficient.
1414
The easiest way to invoke a development sandbox is by using Docker.
1515
```shell
1616
# Run with Grafana 7
17-
docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/grafana-map-panel grafana/grafana:7.5.7
17+
docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/panodata-map-panel grafana/grafana:7.5.10
1818

1919
# Run with Grafana 8
20-
docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/grafana-map-panel --env=GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=grafana-map-panel grafana/grafana:8.0.0
20+
docker run --publish=3000:3000 --volume=$PWD/dist:/var/lib/grafana/plugins/panodata-map-panel --env=GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=panodata-map-panel grafana/grafana:8.0.6
2121
```
2222

2323
Because the version of `node-sass` used as transitive dependency is apparently

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ publish: check-tools check-token
1616
$(eval version=$(shell cat package.json | jq --raw-output .version))
1717

1818
@# Create release on GitHub.
19-
github-release release --user panodata --repo grafana-map-panel --tag $(version) || true
19+
github-release release --user panodata --repo panodata-map-panel --tag $(version) || true
2020

2121
@# Upload distribution package.
22-
$(eval distfile=ci/packages/grafana-map-panel-$(version).zip)
23-
github-release upload --user panodata --repo grafana-map-panel --tag $(version) --name $(notdir $(distfile)) --file $(distfile)
22+
$(eval distfile=ci/packages/panodata-map-panel-$(version).zip)
23+
github-release upload --user panodata --repo panodata-map-panel --tag $(version) --name $(notdir $(distfile)) --file $(distfile)
2424

2525

2626
check-tools:

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1-
# Grafana Map Panel
1+
# Panodata Map Panel
22

3-
The Grafana Map Panel is a tile map of the world that can be overlaid with circles representing data points from a query. It can be used with time series metrics, with geohash data from Elasticsearch or data in the Table format.
3+
## Background
44

5-
![Grafana Map](https://raw.githubusercontent.com/grafana/worldmap-panel/54f83cfdc7339fee02df00933422c35630677330/src/images/worldmap-world.png)
5+
The Panodata Map Panel is an enhanced and maintained friendly fork of the original [Grafana Worldmap Panel].
6+
We will be happy to receive feedback and contributions from the community at the [upstream discussion topic]
7+
and on [GitHub].
8+
You are also encouraged to follow the development in more detail at [first steps], [Developing Grafana Worldmap NG]
9+
and by reading the [changelog].
10+
11+
[changelog]: https://github.com/panodata/panodata-map-panel/blob/develop/CHANGELOG.md
12+
[Developing Grafana Worldmap NG]: https://community.hiveeyes.org/t/grafana-worldmap-panel-ng/1824
13+
[first steps]: https://github.com/grafana/worldmap-panel/issues/197
14+
[GitHub]: https://github.com/panodata/panodata-map-panel
15+
[Grafana Worldmap Panel]: https://github.com/grafana/worldmap-panel
16+
[upstream discussion topic]: https://community.grafana.com/t/giving-the-grafana-worldmap-panel-some-love/17210
17+
18+
19+
## About
20+
21+
The map panel displays a tile map of the world that can be overlaid with circles representing data points from a query.
22+
It can be used with time series metrics, with geohash data from Elasticsearch or data in the Table format.
23+
24+
![Map example](https://raw.githubusercontent.com/grafana/worldmap-panel/54f83cfdc7339fee02df00933422c35630677330/src/images/worldmap-world.png)
625

726
## How this works (theory and examples)
827

@@ -190,7 +209,7 @@ Similar to the Elasticsearch query above, 3 fields are expected (2 of them are m
190209
- A *geohash* field. This is used to calculate where the circle should be drawn.
191210
- an optional location name field (shown in the mouse over). Used to label each circle on the map. If it is empty then the geohash value is used as the label.
192211

193-
The field mappings have to be specified on the Grafana Map settings tab.
212+
The field mappings have to be specified on the "settings" tab.
194213

195214
![Example influxdb query](https://cloud.githubusercontent.com/assets/434655/16535977/8cd520be-3fec-11e6-8dc9-2ecf7b16ad5f.png)
196215

@@ -281,7 +300,7 @@ The threshold field also accepts 2 or more comma-separated values. For example,
281300

282301
Optionally, you can show an image over the base map (but below the data points). This could be useful, for example, to show a more detailed/up-to-date image of the area of interest, in case the map provider only has old or low-resolution images. See below for an example of displaying interpolated sensor data (for example, temperatures in a field while only knowing the temperatures at a few sensors).
283302

284-
![Image overlay example](https://raw.githubusercontent.com/panodata/grafana-map-panel/develop/src/images/overlay_example.png)
303+
![Image overlay example](https://raw.githubusercontent.com/panodata/panodata-map-panel/develop/src/images/overlay_example.png)
285304

286305
**Enable overlay**
287306

@@ -307,4 +326,4 @@ Specify the limits of the image in the map. Enter the minimum and maximum latitu
307326

308327
### CHANGELOG
309328

310-
The latest changes can be found here: [CHANGELOG.md](https://github.com/panodata/grafana-map-panel/blob/master/CHANGELOG.md)
329+
The latest changes can be found here: [CHANGELOG.md](https://github.com/panodata/panodata-map-panel/blob/develop/CHANGELOG.md)

doc/backlog.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
#########################
2-
Grafana Map Panel Backlog
3-
#########################
1+
##########################
2+
Panodata Map Panel Backlog
3+
##########################
44

55
- "Zoom to fit data" option stopped working.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "grafana-map-panel",
2+
"name": "panodata-map-panel",
33
"version": "0.15.0",
44
"description": "Map Panel",
55
"scripts": {

src/libs/leaflet_plus.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// 04bcb59 added an autoWidth setting to the Popup options.
22
// This option, when disabled, will mask the whole section for computing
33
// the width for the popup automatically within the _updateLayout method.
4-
// https://github.com/panodata/grafana-map-panel/issues/79#issuecomment-723290476
4+
// https://github.com/panodata/panodata-map-panel/issues/79#issuecomment-723290476
55
import { Popup } from 'leaflet';
66

77
// @option autoWidth: Boolean = true

src/partials/editor.html

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22
<span>
33

44
The
5-
<a href="https://github.com/panodata/grafana-map-panel" class="editor-link-color" target="_blank">
6-
Grafana Map Panel NG
5+
<a href="https://github.com/panodata/panodata-map-panel" class="editor-link-color" target="_blank">
6+
Panodata Map Panel
77
</a>
8-
(<a href="https://github.com/panodata/grafana-map-panel/blob/develop/CHANGELOG.md" class="editor-link-color"
9-
target="_blank">changes</a>)
10-
is work in progress.
11-
12-
Enjoy
13-
<a href="https://community.hiveeyes.org/t/grafana-worldmap-panel-ng/1824" class="editor-link-color" target="_blank">following the development</a>
14-
and testing it.
15-
16-
We will be happy to receive feedback from the community at
17-
<a href="https://community.grafana.com/t/giving-the-grafana-worldmap-panel-some-love/17210" class="editor-link-color"
18-
target="_blank">[1]</a>,
19-
<a href="https://github.com/grafana/worldmap-panel/issues/197" class="editor-link-color" target="_blank">[2]</a>
20-
and
21-
<a href="https://github.com/panodata/grafana-map-panel" class="editor-link-color" target="_blank">[3]</a>.
22-
23-
Please don't use this software in production yet.
8+
is an enhanced and maintained friendly fork of the original
9+
<a href="https://github.com/grafana/worldmap-panel">Grafana Worldmap Panel</a>.
10+
11+
We will be happy to receive feedback and contributions from the community at the
12+
<a href="https://community.grafana.com/t/giving-the-grafana-worldmap-panel-some-love/17210" class="editor-link-color"
13+
target="_blank">upstream discussion topic</a>
14+
and on
15+
<a href="https://github.com/panodata/panodata-map-panel" class="editor-link-color" target="_blank">GitHub</a>.
16+
17+
You are also encouraged to follow the development in more detail at
18+
<a href="https://github.com/grafana/worldmap-panel/issues/197" class="editor-link-color" target="_blank">first steps</a>,
19+
<a href="https://community.hiveeyes.org/t/grafana-worldmap-panel-ng/1824" class="editor-link-color"
20+
target="_blank">Developing Grafana Worldmap NG</a>
21+
and by reading the
22+
<a href="https://github.com/panodata/panodata-map-panel/blob/develop/CHANGELOG.md" class="editor-link-color"
23+
target="_blank">changelog</a>.
2424

2525
</span>
2626
<hr/>
@@ -31,7 +31,6 @@
3131

3232
<h3 class="main-section-heading">Location source</h3>
3333

34-
3534
<h5>Data format and mapping</h5>
3635
<div class="gf-form-group">
3736
<div class="gf-form">

src/plugin.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
{
22
"type": "panel",
3-
"name": "Map Panel",
4-
"id": "grafana-map-panel",
3+
"name": "Panodata Map Panel",
4+
"id": "panodata-map-panel",
55

66
"info": {
7-
"description": "Grafana Map Panel. Displays time series data or geohash data on a world map.",
7+
"description": "Panodata Map Panel, a descendant of the original Grafana Worldmap Panel. Displays time series data or geohash data on a world map.",
88
"author": {
99
"name": "Grafana Labs",
1010
"url": "https://grafana.com"
1111
},
12-
"keywords": ["map", "panel", "worldmap"],
12+
"keywords": ["map", "panel"],
1313
"logos": {
1414
"small": "images/worldmap_logo.svg",
1515
"large": "images/worldmap_logo.svg"
1616
},
1717
"links": [
18-
{"name": "Project site", "url": "https://github.com/panodata/grafana-map-panel"},
19-
{"name": "MIT License", "url": "https://github.com/panodata/grafana-map-panel/blob/master/LICENSE"}
18+
{"name": "Project site", "url": "https://github.com/panodata/panodata-map-panel"},
19+
{"name": "MIT License", "url": "https://github.com/panodata/panodata-map-panel/blob/develop/LICENSE"}
2020
],
2121
"screenshots": [
2222
{"name": "World", "path": "images/worldmap-world.png"},

0 commit comments

Comments
 (0)