@antonio-goncalves/react-regional-data-display-test
Advanced tools
Comparing version 1.0.1 to 1.0.2
@@ -9,2 +9,5 @@ # Changelog | ||
## [1.0.2] - 2022-10-11 | ||
- Updated README.md | ||
## [1.0.1] - 2022-10-11 | ||
@@ -11,0 +14,0 @@ - Test release |
{ | ||
"name": "@antonio-goncalves/react-regional-data-display-test", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "source": "src/index.ts", |
@@ -21,21 +21,21 @@ # React Regional Data Display | ||
| Name | Type | Is Optional | Default Value | Description | | ||
|-----------------------|------------------|-------------|---------------|----------------------------------------------------------------------------------------------------------------| | ||
| dataSets | DataSet[] | no | | Data sets containing values for each region. | | ||
| regions | Region[] | no | | GeoJSON data of regions that should be included on the map | | ||
| center | Center | yes | {zoom:1,lng:0,lat:0} | Map position and zoom | | ||
| mapBoxToken | string | no | | Access token required to use mapbox | | ||
| mapHeight | string or number | yes | 500 | Height of the map | | ||
| mapBoxOptions | object | yes | | Extra [options](https://docs.mapbox.com/mapbox-gl-js/api/map/#map-parameters) passed to the mapbox constructor | | ||
| onDataSetChange | (dataSetId:string)=>void| yes | | Fired when a new data set is selected | | ||
| className | string | yes | | Custom class for the container | | ||
| sliderClassName | string | yes | | Custom class for the slider element | | ||
| dropdownClassName | string | yes | | Custom class for the dropdown element | | ||
| placeholderClassName | string | yes | | Custom class for the placeholder text | | ||
| mapContainerClassName | string | yes | | Custom class for map container | | ||
| style | object | yes | | Custom style for the container | | ||
| sliderStyle | object | yes | | Custom style for the slider element | | ||
| dropdownStyle | object | yes | | Custom style for the dropdown element | | ||
| placeholderStyle | object | yes | | Custom style for the placeholder text | | ||
| mapContainerStyle | object | yes | | Custom style for map container | | ||
| Name | Type | Is Optional | Default Value | Description | | ||
|-----------------------|------------------|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------| | ||
| dataSets | DataSet[] | no | | Data sets containing values for each region. | | ||
| regions | Region[] | no | | GeoJSON data of regions that should be included on the map | | ||
| center | Center | yes | {<br/> zoom:1,<br/> lng:0,<br/> lat:0<br/>} | Map position and zoom | | ||
| mapBoxToken | string | no | | Access token required to use mapbox | | ||
| mapHeight | string or number | yes | 500 | Height of the map | | ||
| mapBoxOptions | object | yes | | Extra [options](https://docs.mapbox.com/mapbox-gl-js/api/map/#map-parameters) passed to the mapbox constructor | | ||
| onDataSetChange | (dataSetId:string)=>void| yes | | Fired when a new data set is selected | | ||
| className | string | yes | | Custom class for the container | | ||
| sliderClassName | string | yes | | Custom class for the slider element | | ||
| dropdownClassName | string | yes | | Custom class for the dropdown element | | ||
| placeholderClassName | string | yes | | Custom class for the placeholder text | | ||
| mapContainerClassName | string | yes | | Custom class for map container | | ||
| style | object | yes | | Custom style for the container | | ||
| sliderStyle | object | yes | | Custom style for the slider element | | ||
| dropdownStyle | object | yes | | Custom style for the dropdown element | | ||
| placeholderStyle | object | yes | | Custom style for the placeholder text | | ||
| mapContainerStyle | object | yes | | Custom style for map container | | ||
@@ -52,3 +52,3 @@ ## RegionsMap | ||
| regions | Region[] | no | | GeoJSON data of regions that should be included on the map | | ||
| center | Center | yes | {zoom:1,lng:0,lat:0} | Map position and zoom | | ||
| center | Center | yes | {<br/> zoom:1,<br/> lng:0,<br/> lat:0<br/>} | Map position and zoom | | ||
| mapBoxToken | string | no | | Access token required to use mapbox | | ||
@@ -99,14 +99,14 @@ | mapHeight | string or number | yes | 500 | Height of the map | | ||
| Name | Type | Is Optional | Default Value | Description | | ||
|-------------|---------------|-------------|----------------------|-----------------------------------------------------------------------| | ||
| id | string | no | | Id of the data set | | ||
| name | string | no | | Name of the data set | | ||
| description | string | no | | Description of the data set | | ||
| center | Center | yes | {lng:0,lat:0,zoom:1} | Position and zoom of the map (overrides "center" property of the map) | | ||
| source | DataSetSource | no | | Source of the data | | ||
| dates | DataSetDates | no | | Dates of the data set | | ||
| unit | Unit | no | | Unit of the data set | | ||
| scale | DataScale | no | | Scale info for the data set | | ||
| Name | Type | Is Optional | Default Value | Description | | ||
|-------------|---------------|-------------|---------------|-----------------------------------------------------------------------| | ||
| id | string | no | | Id of the data set | | ||
| name | string | no | | Name of the data set | | ||
| description | string | no | | Description of the data set | | ||
| center | Center | no | | Position and zoom of the map (overrides "center" property of the map) | | ||
| source | DataSetSource | no | | Source of the data | | ||
| dates | DataSetDates | no | | Dates of the data set | | ||
| unit | Unit | no | | Unit of the data set | | ||
| scale | DataScale | no | | Scale info for the data set | | ||
| data | RegionData[] or null | no | | Data value for each region | | ||
| footnotes | Footnote[] | yes | | Footnotes texts used by data points | | ||
| footnotes | Footnote[] | yes | | Footnotes texts used by data points | | ||
@@ -113,0 +113,0 @@ ## Center |
310812