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

update lat/lon/zoom documentation #116

Merged
merged 3 commits into from
Mar 16, 2023
Merged

update lat/lon/zoom documentation #116

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
c0ab01d
remove
AliyanH Mar 15, 2023
49d5c01
Update lat, lon and zoom content attribute (<mapml-viewer>) and IDL
prushforth Mar 16, 2023
70945d6
Merge branch 'main' into setterAPI
prushforth Mar 16, 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
32 changes: 13 additions & 19 deletions docs/api/mapml-viewer-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ The HTMLMapmlViewerElement interface represents the `<mapml-viewer>` element.
| [controls](#controls) | Turns native map controls on or off. Reflects the controls attribute. |
| [controlsList](#controlslist) | Allows to change the set of native controls. Reflects the controlslist attribute. |
| [extent](#extent) | Returns the extent of the current map view. Read only. |
| [lat](#lat) | Get the map's latitude. Reflects the lat attribute. Read only. |
| [lon](#lon) | Get the map's longitude. Reflects the lon attribute. Read only. |
| [lat](#lat) | Get or set the map's latitude. Reflects to the lat content attribute. No effect on map dynamic state. |
| [lon](#lon) | Get or set the map's longitude. Reflects to the lon content attribute. No effect on map dynamic state. |
| [projection](#projection) | The map's projection. Reflects the projection attribute. |
| [zoom](#zoom) | The map's zoom level. Reflects the zoom attribute. |
| [zoom](#zoom) | Get or set the map's zoom level. Reflects to the zoom content attribute. No effect on map dynamic state. |

### controls

Expand Down Expand Up @@ -139,15 +139,13 @@ let extent = map.extent;
### lat

To set the latitude:

:::caution
[Needs to be implemented](https://github.com/Maps4HTML/Web-Map-Custom-Element/issues/588), currently doesn't pan the map on changes
:::

```js
let map = document.querySelector('mapml-viewer');
map.lat = 21.4; // if it's an invalid value, nothing happens
```
Note that the value supplied does not affect the map viewer state, except at
document load, or when an instance of a `<mapml-viewer>` element is constructed
and programmatically added to the DOM. To change the value, use [zoomTo()](#zoomTo);

To get the latitude:
```js
Expand All @@ -160,15 +158,13 @@ let latitude = map.lat;
### lon

To set the longitude:

:::caution
[Needs to be implemented](https://github.com/Maps4HTML/Web-Map-Custom-Element/issues/588), currently doesn't pan the map on changes
:::

```js
let map = document.querySelector('mapml-viewer');
map.lon = 21.4; // if it's an invalid value, nothing happens
```
Note that the value supplied does not affect the map viewer state, except at
document load, or when an instance of a `<mapml-viewer>` element is constructed
and programmatically added to the DOM. To change the value, use [zoomTo()](#zoomTo);

To get the longitude:
```js
Expand Down Expand Up @@ -198,15 +194,13 @@ let projection = map.projection;
### zoom

To set the zoom:

:::caution
[Needs to be implemented](https://github.com/Maps4HTML/Web-Map-Custom-Element/issues/588), currently doesn't zoom the map on changes
:::

```js
let map = document.querySelector('mapml-viewer');
map.zoom = 3; // if it's an invalid value, nothing happens
map.zoom = 3; // if it's an invalid value, will default to 0
```
Note that the value supplied does not affect the map viewer state, except at
document load, or when an instance of a `<mapml-viewer>` element is constructed
and programmatically added to the DOM. To change the value, use [zoomTo()](#zoomTo);

To get the longitude:
```js
Expand Down
6 changes: 3 additions & 3 deletions docs/elements/mapml-viewer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,19 @@ The default projection is `OSMTILE`.

### `zoom`

`zoom` - a non-negative integer. The value establishes the initial zoom level of the map. For a small scale view of the world, use a lower value. Use larger values for larger scales (smaller area maps). The maximum value depends on the particular `projection` and data source. Many map data sources have limited zoom levels available.
`zoom` - a non-negative integer. The value establishes the _initial_ zoom level of the map, and is required. The value is updated when the map stops moving. For a smaller scale view of the world, use a lower value. Use larger values for larger scales (smaller area maps). The maximum value depends on the particular `projection` and data source. Many map data sources have limited zoom levels available.

---

### `lat`

`lat` - a real number latitude. The value establishes the initial latitude of the of the center of the map. Latitudes on Earth range from -90.0 (south) to 90.0 (north). Many projections are not able to display all latitudes, and most projections have a limited range of locations where distortion is controlled or limited. In particular, OSMTILE (Web Mercator) can only display content between the latitude range -84 to 84.
`lat` - a real number latitude. The value establishes the _initial_ latitude of the of the center of the map, and is required. The value is updated when the map stops moving. Latitudes on Earth range from -90.0 (south) to 90.0 (north). Many projections are not able to display all latitudes, and most projections have a limited range of locations where distortion is controlled or limited. In particular, OSMTILE (Web Mercator) can only display content between the latitude range -84 to 84.

---

### `lon`

`lon` - a real number longitude. The value establishes the initial longitude of the of the center of the map.Longitudes on Earth range from -180.0 (west) to 180.0 (east). Similar comments related to distortion apply to those for latitude. Be careful, this attribute is named "lon" NOT "long", and if you use "long" your map won't work properly.
`lon` - a real number longitude. The value establishes the _initial_ longitude of the of the center of the map, and is required. The value is updated when the map stops moving. Longitudes on Earth range from -180.0 (west) to 180.0 (east). Similar comments related to distortion apply to those for latitude. Be careful, this attribute is named "lon" NOT "long", and if you use "long" your map won't work properly.

---

Expand Down
33 changes: 15 additions & 18 deletions i18n/fr/docusaurus-plugin-content-docs/current/api/mapml-viewer-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ L’interface HTMLMapmlViewerElement représente l’élément `<mapml-viewer>`.
| [controls](#controls) | Active ou désactive les contrôles natifs de la carte. Reproduit l’attribut controls. |
| [controlsList](#controlslist) | Permet de changer l’ensemble des contrôles natifs. Reproduit l’attribut controlslist. |
| [extent](#extent) | Retourne l’étendue de la carte affichée. En lecture seule. |
| [lat](#lat) | Permet d’obtenir la latitude de la carte. Reproduit l’attribut lat. En lecture seule. |
| [lon](#lon) | Permet d’obtenir la longitude de la carte. Reproduit l’attribut lon. En lecture seule. |
| [lat](#lat) | Obtient ou définit la latitude de la carte. Reproduit dans l’attribut de contenu lat. Aucun effet sur l'état dynamique de la carte. |
| [lon](#lon) | Obtient ou définit la longitude de la carte. Reproduit dans l’attribut de contenu lon. Aucun effet sur l'état dynamique de la carte.|
| [projection](#projection) | Projection de la carte. Reproduit l’attribut projection. |
| [zoom](#zoom) | Niveau de zoom de la carte. Reproduit l’attribut zoom. |
| [zoom](#zoom) | Obtient ou définit le niveau de zoom de la carte. Reproduit dans l’attribut de contenu zoom. Aucun effet sur l'état dynamique de la carte.|

### controls

Expand Down Expand Up @@ -139,15 +139,14 @@ let extent = map.extent;
### lat

Pour définir la latitude :

:::caution
[À mettre en œuvre](https://github.com/Maps4HTML/Web-Map-Custom-Element/issues/588), à l’heure actuelle, n’effectue pas de mouvements panoramiques vers les modifications de la carte
:::

```js
let map = document.querySelector('mapml-viewer');
map.lat = 21.4; // rien ne se produit si la valeur n’est pas valide
```
Notez que la valeur fournie n'affecte pas l'état de la visionneuse de carte,
sauf au chargement du document, ou lorsqu'une instance d'un élément `<mapml-viewer>`
est construite et ajoutée par programme au DOM. Pour modifier la valeur, utilisez
[zoomTo()](#zoomTo)

Pour obtenir la latitude :
```js
Expand All @@ -160,15 +159,14 @@ let latitude = map.lat;
### lon

Pour définir la longitude :

:::caution
[À mettre en œuvre](https://github.com/Maps4HTML/Web-Map-Custom-Element/issues/588), à l’heure actuelle, n’effectue pas de mouvements panoramiques vers les modifications de la carte
:::

```js
let map = document.querySelector('mapml-viewer');
map.lon = 21.4; // rien ne se produit si la valeur n’est pas valide
```
Notez que la valeur fournie n'affecte pas l'état de la visionneuse de carte,
sauf au chargement du document, ou lorsqu'une instance d'un élément `<mapml-viewer>`
est construite et ajoutée par programme au DOM. Pour modifier la valeur, utilisez
[zoomTo()](#zoomTo)

Pour obtenir la longitude :
```js
Expand Down Expand Up @@ -198,15 +196,14 @@ let projection = map.projection;
### zoom

Pour définir le niveau de zoom :

:::caution
[À mettre en œuvre](https://github.com/Maps4HTML/Web-Map-Custom-Element/issues/588), à l’heure actuelle, n’effectue pas un zoom sur les changements apportés à la carte
:::

```js
let map = document.querySelector('mapml-viewer');
map.zoom = 3; // rien ne se produit si la valeur n’est pas valide
```
Notez que la valeur fournie n'affecte pas l'état de la visionneuse de carte,
sauf au chargement du document, ou lorsqu'une instance d'un élément `<mapml-viewer>`
est construite et ajoutée par programme au DOM. Pour modifier la valeur, utilisez
[zoomTo()](#zoomTo)

Pour obtenir la longitude :
```js
Expand Down
6 changes: 3 additions & 3 deletions i18n/fr/docusaurus-plugin-content-docs/current/elements/mapml-viewer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,19 @@ La projection par défaut est `OSMTILE`.

### `zoom`

`zoom` - entier non négatif. Cette valeur établit le niveau de zoom initial de la carte. Pour obtenir une vue du monde à petite échelle, utilisez une valeur faible. Utilisez des valeurs supérieures pour obtenir une vue à grande échelle (cartes de petites zones). La valeur maximale dépend de la `projection` en question et de la source des données. Bon nombre des sources de données cartographiques offrent des niveaux de zoom limités.
`zoom` - entier non négatif. Cette valeur définit le niveau de zoom initial de la carte et est obligatoire. La valeur est mise à jour lorsque la carte cesse de se déplacer. Pour obtenir une vue du monde à petite échelle, utilisez une valeur faible. Utilisez des valeurs supérieures pour obtenir une vue à grande échelle (cartes de petites zones). La valeur maximale dépend de la `projection` en question et de la source des données. Bon nombre des sources de données cartographiques offrent des niveaux de zoom limités.

---

### `lat`

`lat` - nombre réel de la latitude. Cette valeur établit la latitude initiale du centre de la carte. Sur Terre, les latitudes vont de -90.0 (Sud) à 90.0 (Nord). De nombreuses projections ne permettent pas d’afficher toutes les latitudes et la plupart permettent de contrôler ou de limiter la distorsion dans un certain nombre d’emplacements. En particulier, OSMTILE (Web Mercator) peut afficher seulement le contenu compris entre les latitudes -84 à 84.
`lat` - nombre réel de la latitude. Cette valeur établit la latitude initiale du centre de la carte. La valeur est mise à jour lorsque la carte cesse de se déplacer. Sur Terre, les latitudes vont de -90.0 (Sud) à 90.0 (Nord). De nombreuses projections ne permettent pas d’afficher toutes les latitudes et la plupart permettent de contrôler ou de limiter la distorsion dans un certain nombre d’emplacements. En particulier, OSMTILE (Web Mercator) peut afficher seulement le contenu compris entre les latitudes -84 à 84.

---

### `lon`

`lon` - nombre réel de la longitude. Cette valeur établit la longitude initiale du centre de la carte. Sur Terre, les longitudes vont de -180.0 (Ouest) à 180.0 (Est). Les mêmes commentaires formulés précédemment concernant la distorsion s’appliquent. Faites attention, le nom de cet attribut est « lon » et non « long »; votre carte ne fonctionnera pas correctement si vous utilisez « long ».
`lon` - nombre réel de la longitude. Cette valeur établit la longitude initiale du centre de la carte. La valeur est mise à jour lorsque la carte cesse de se déplacer. Sur Terre, les longitudes vont de -180.0 (Ouest) à 180.0 (Est). Les mêmes commentaires formulés précédemment concernant la distorsion s’appliquent. Faites attention, le nom de cet attribut est « lon » et non « long »; votre carte ne fonctionnera pas correctement si vous utilisez « long ».

---

Expand Down