jeff/umap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1632 from umap-project/fix-docs-l-u

Browse source 
docs: update namespace of uMap objects
This commit is contained in:
David Larlet 2024-02-20 08:23:22 -05:00 committed by GitHub
commit 69df1bb092
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/dev/frontend.md
View file

@ -27,9 +27,9 @@ Here are the important concepts and files:
- `umap.permissions.js` handles the permissions of the map. There is a different file handling the permissions of the datalayer: - `umap.permissions.js` handles the permissions of the map. There is a different file handling the permissions of the datalayer:
- `umap.datalayer.permissions.js`. - `umap.datalayer.permissions.js`.
## Map (`L.U.Map`) ## Map (`U.Map`)
`L.U.Map` is the class that's called by the server templates (in `map_init.html` and `map_fragment.html` used when we display lists of maps, like the homepage). `U.Map` is the class that's called by the server templates (in `map_init.html` and `map_fragment.html` used when we display lists of maps, like the homepage).
It contains references to datalayers, and to the controls (the buttons that appears on the map) It contains references to datalayers, and to the controls (the buttons that appears on the map)
@ -42,15 +42,15 @@ A map contains references to:
- controls - controls
- datalayers - datalayers
## DataLayers (`L.U.Datalayer`) ## DataLayers (`U.Datalayer`)
The datalayers contains data, and a layer (a way to represent them). The datalayers contains data, and a layer (a way to represent them).
Each data layer contains a "layer", to know what type of layer it is. It's one of: Each data layer contains a "layer", to know what type of layer it is. It's one of:
- Choropleth (`L.U.Layer.Choropleth`) - Choropleth (`U.Layer.Choropleth`)
- Cluster (`L.U.Layer.Cluster`) - Cluster (`U.Layer.Cluster`)
- Heat (`L.U.Layer.Heat`) - Heat (`U.Layer.Heat`)
When the data layers are initialized, they can have two states: When the data layers are initialized, they can have two states:
- `loaded`: the object is loaded in memory. At this stage we have access to all the datalayer's metada (name, type, id) - `loaded`: the object is loaded in memory. At this stage we have access to all the datalayer's metada (name, type, id)