89 show multiple regions layers

srezacova commented 2 years ago

Description

Show multiple region layers. Create layerOptions in mapLayers config.

How has this been tested?

TEST singleLayer: true with 2 timeseries layers behavior:

upload this these files in to initial-data-load/data/Sample/attributes/daily_cases_test folder Daily_Covid19_cases1.csv Daily_Covid19_cases2.csv Daily_Covid19_cases3.csv
add these lines to initial-data-load/data/Sample/attributes/index.js

    referenceId: 'DailyCovid19Cases',
    date: new Date(now - 1 * oneDay).toISOString(),
    csvFileName: 'daily_cases_test/Daily_Covid19_cases1.csv',
  },
  {
    referenceId: 'DailyCovid19Cases',
    date: new Date(now - 2 * oneDay).toISOString(),
    csvFileName: 'daily_cases_test/Daily_Covid19_cases2.csv',
  },
  {
    referenceId: 'DailyCovid19Cases',
    date: new Date(now - 3 * oneDay).toISOString(),
    csvFileName: 'daily_cases_test/Daily_Covid19_cases3.csv',
  },

add test layer to MapLayers.yml

  geoReferenceId: "slovakiaRegions"
  layerType: "regions"
  category: "Baseline data"
  title: "Daily Covid-19"
  attribute: "Daily Covid19 Cases"
  attributeDescription:
    descriptionText: "COVID-19 New Cases: {{Daily Covid19 Cases}}"
    featureText: "{{featureId}} kraj"
  featureId: "name"
  style:
    fillColor:
      type: "colormap"
      value: "green"
    min: 0
    max: 100
    strokeColor:
      type: "color"
      value: "rgba(255,255,255,0.2)"
  legend:
    - type: "colormap"
      color: "green"
      min: 0
      max: 100
  metadata:
    description: "Sample data created just for this purpose. Do not represent the reality in any time."
    updateFrequency: "never"
    unit: "n/a"
    dataRetrievalDescription: "Data was randomly created."
  layerOptions: 
    singleDisplay: false   
    timeseries: true

Leave singleDisplay false for both timeseries layers to check functionality with more sliders shown on the map. Change singleDisplay to true in other layers for checking singleDisplay functionality. Add maxResolution: 1000 to any of the layers to check if it works.

Run ./start.sh, ./runinitialload.sh with COUNTRY=Sample. Check layers on the map. Now you have 2 timeseries layers for testing purposes, one in Baseline data and one in Covid-19. You can add one more for testing purposes.

check points in https://github.com/openkfw/Oscar/issues/89
check new functionality in publicMap.js and if comments are understandable
check layer without values, that it is transparent gray
run tests in api
check release notes
check documentation and schema changes
slider behavior is the same for all the layer types, singleDisplay behavior is added just for regions layers, other layer types will act like before, so they will appear together with regions layers, singleDisplay flag in them won't have any effect
this task doesn't solve layer ordering, when 2 region layers overlay each other, the color doesn't corespond to legend, because the colors are mixed together, we should use z-index later to fix this.
check group layer

Screenshots (if appropriate):

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[X] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

[X] I have read the CONTRIBUTING document.
[X] I have checked to ensure that there aren't other open Pull Requests for the same update/change.
[X] My code follows the code style of this project.
[X] My change requires a change to the documentation.
[X] I have updated the documentation accordingly.
[X] I have added tests to cover my changes.
[X] All new and existing tests passed.

srezacova commented 2 years ago

Hi, mark 'timeseries' on top level as deprecated in release notes

So I will add this in CHANGELOG.md?

[1.3.1] - 2021-12-29

Deprecated

'timeseries' key on top level is now deprecated, it is moved to 'layerOptions' key

or something like that?

bariela commented 2 years ago

Hi, mark 'timeseries' on top level as deprecated in release notes

So I will add this in CHANGELOG.md?

[1.3.1] - 2021-12-29

Deprecated

'timeseries' key on top level is now deprecated, it is moved to 'layerOptions' key

or something like that?

in the unreleased part for now, as we don't make new release just for this feature and with more specification, so the reader can understand what and where exactly should be changed

srezacova commented 2 years ago

Hi, mark 'timeseries' on top level as deprecated in release notes So I will add this in CHANGELOG.md?

[1.3.1] - 2021-12-29

Deprecated

'timeseries' key on top level is now deprecated, it is moved to 'layerOptions' key

or something like that?

in the unreleased part for now, as we don't make new release just for this feature and with more specification, so the reader can understand what and where exactly should be changed

I fixed this in release notes.

openkfw / Oscar