Get scale_bar from locale

[RobAndrewHurst]

Pull Request: Get scale_bar from locale 🌐📏

Description

This pull request addresses the need to retrieve the scale_bar information from the locale. The changes aim to improve the localization of the scale bar in our application, enhancing the user experience by dynamically obtaining this information based on the user's locale.

Changes Made

• Updated the scale_bar property in the default mapview to take the scaleBar property from the locales configuration. 🗺️🔄

Testing Done

• Tested against a workspace with multiple locales. One with 'imperial', 'Metric' and default (no scaleBar). ✔️🌍

[simon-leech]

@RobAndrewHurst Tested this and it works all good when you provide either metric or imperial.
However, I tested this using a bogus term test and it fails with an error on Invalid Units. I wonder if this should be using a ternary or checking that the scaleBar value is either metric or imperial to guard against this.

Please could you also update the Config Docs to explain this is a new option available? Thanks! 🙂

[RobAndrewHurst]

@simon-leech I have made the changes!

[RobAndrewHurst]

https://github.com/GEOLYTIX/xyz/wiki/Workspace-Configuration#scalebar

[AlexanderGeere]

Looks good on my end

[simon-leech]

Thanks @RobAndrewHurst - good with me!

[dbauszus-glx]

The scalebar line can be completely removed from the default view script.

The scalebar should not be there by default but only if configured in the locale.

Please check if you are happy with the changes.

[RobAndrewHurst]

The scalebar line can be completely removed from the default view script.

The scalebar should not be there by default but only if configured in the locale.

Please check if you are happy with the changes.

I still think we need a check if the config has a bogus unit provided. ie something not 'metric' or 'imperial'

[RobAndrewHurst]

  mapview.locale.scalebar && mapview.Map.addControl(new ol.control.ScaleLine({
    units: mapview.locale.scalebar === 'imperial' ? 'imperial' : 'metric',
  }))

@dbauszus-glx Also should scalebar not be scaleBar to keep in consistency with other properties that we use like minZoom and maxZoom?

[dbauszus-glx]

That's all good points. If changing the name I would probably opt for matching the OL dictionary, ie. ScaleLine

I think there is only the options for imperial or metric. A check if ScaleLine === 'imperial' ? 'imperial' : 'metric' could work.

[RobAndrewHurst]

Ok cool! I am happy to change to ScaleLine.

I have already added in that check! 👍

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[RobAndrewHurst]

Updated Docs: https://github.com/GEOLYTIX/xyz/wiki/Workspace-Configuration#scaleline