Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add function to overwrite elements displayed in LegendTool #320

Merged
merged 3 commits into from
Jan 31, 2023
Merged

Add function to overwrite elements displayed in LegendTool #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8dea647
Add function to overwrite elements displayed in LegendTool
ac-61 Jan 28, 2023
880ed0b
Add more checks to overwriteLegends function
ac-61 Jan 31, 2023
95df32f
Add overwriteLegends to mmgisAPI
ac-61 Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/pages/APIs/JavaScript/JavaScript_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,3 +730,55 @@ The following is an example of how to call the `unproject` function:
window.mmgisAPI.unproject({ x: 8120633.560692952, y: -237291.62355915268 });
// returns {lat: -4.000000000000019, lng: 137}
```

### overwriteLegends(legends)

This function can be used to overwrite the contents displayed in the LegendTool. This can be useful when used with the `toolChange` event listener in the mmgisAPI.

#### Function parameters

- `legends` - An array of objects, where each object must contain the following keys: legend, layerUUID, display_name, opacity. The value for the legend key should be in the same format as what is stored in the layers data under the `_legend` key (i.e. `L_.layers.data[layerName]._legend`). layerUUID and display_name should be strings and opacity should be a number between 0 and 1.

The following is an example of how to call the `overwriteLegends` function:
```javascript
const legends = [
{
color: '#00e400',
strokecolor: '#000000',
shape: 'continuous',
value: '0 - 54',
},
{
color: '#ffff00',
strokecolor: '#000000',
shape: 'continuous',
value: '54 - 154',
},
{
color: '#ff7e00',
strokecolor: '#000000',
shape: 'continuous',
value: '154 - 254',
},
{
color: '#8f3f97',
strokecolor: '#000000',
shape: 'continuous',
value: '254 - 354',
},
{
color: '#8f3f97',
strokecolor: '#000000',
shape: 'continuous',
value: '354 - 424',
},
{
color: '#7e0023',
strokecolor: '#000000',
shape: 'continuous',
value: '> 424',
},
];

window.mmgisAPI.overwriteLegends(legends);
```
Loading