Skip to content

Commit d9ce59d

Browse files
gnibedagnibeda
committed
updated map section of readme, added geojsonKeyField description
1 parent 735c6c5 commit d9ce59d

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

‎README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ Axis 2: "Id 1", "Id 2", "Id 3"
292292
In this mode map can use any data source to display polygons. But some fields must exists in data source to be able to link data with polygons and display colors.
293293

294294
Required fields:
295-
1. "Key" - field used to link data record with GeoJSON polygon `name` property.
295+
1. "Key" - field used to link data record with GeoJSON polygon `name` property(if different property of GeoJSON is needed as key, it can be defined using `geojsonKeyField` data property).
296296
2. "Value" - field contains numeric value used to color polygon. Color of polygon is a gradient from green(minimum value) to red(maximum value).
297297

298298
You can use field with different names as well. In this case use `key`/`value` data properties and define field names as values of these properties respectively.
@@ -346,19 +346,20 @@ Data property `latitude` = "Lat", data property `longitude` = "Lon"
346346
## Map data properties
347347
Map supports following data properties, that can be used for customization:
348348

349-
| Data Property | Type | Description | Value | Default |
350-
|----------------------------|--------------|--------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------|
351-
| key | dataproperty | Define custom name of key field. Value from this field used to link data to GeoJSON polygon `name` property | Datasource column name | "Key" |
352-
| value | dataproperty | Define custom name of value field. Value from this field used to calculate color of polygon | Datasource column name | "Value" |
353-
| tileUrl | dataproperty | Tile server URL | | https://tile-c.openstreetmap.fr/hot/{z}/{x}/{y}.png |
354-
| polygonFile | dataproperty | File name with a JS or GeoJSON polygons. Requested from the root of a default web app for a namespace | Path with filename | Widget name |
355-
| latitude | dataproperty | Define custom name of latitude field. Used for marker mode | Datasource column name | "Latitude" |
356-
| longitude | dataproperty | Define custom name of longitude field. Used for marker mode | Datasource column name | "Longitude" |
357-
| tooltip | dataproperty | Define name of field with custom tooltip text. Tooltip appears when user's cursor hovers over a polygon or marker. | Datasource column name | "TooltipValue" |
358-
| coordsJsFile | deprecated | Use `polygonFile` instead | | |
359-
| tooltipProperty | deprecated | Use `tooltip` instead | Datasource column name | Row name |
360-
| coordsProperty | deprecated | Use `key` instead | Datasource column name | |
361-
| colorProperty | deprecated | Use `value` instead | | |
349+
| Data Property | Type | Description | Value | Default |
350+
|----------------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------------------------------|
351+
| key | dataproperty | Define custom name of key field. Value from this field used to link data to GeoJSON polygon `name`(can be override using `geojsonKeyField`) property | Datasource column name | "Key" |
352+
| value | dataproperty | Define custom name of value field. Value from this field used to calculate color of polygon | Datasource column name | "Value" |
353+
| geojsonKeyField | dataproperty | Define custom name of GeoJSON key field that used to link data with MDX | GeoJSON property name | "name" |
354+
| tileUrl | dataproperty | Tile server URL | | https://tile-c.openstreetmap.fr/hot/{z}/{x}/{y}.png |
355+
| polygonFile | dataproperty | File name with a JS or GeoJSON polygons. Requested from the root of a default web app for a namespace | Path with filename | Widget name |
356+
| latitude | dataproperty | Define custom name of latitude field. Used for marker mode | Datasource column name | "Latitude" |
357+
| longitude | dataproperty | Define custom name of longitude field. Used for marker mode | Datasource column name | "Longitude" |
358+
| tooltip | dataproperty | Define name of field with custom tooltip text. Tooltip appears when user's cursor hovers over a polygon or marker. | Datasource column name | "TooltipValue" |
359+
| coordsJsFile | deprecated | Use `polygonFile` instead | | |
360+
| tooltipProperty | deprecated | Use `tooltip` instead | Datasource column name | Row name |
361+
| coordsProperty | deprecated | Use `key` instead | Datasource column name | |
362+
| colorProperty | deprecated | Use `value` instead | | |
362363

363364
No longer supported:
364365

0 commit comments

Comments
 (0)