com.vaadin.flow.component.map.configuration.source.XYZSource API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.map.configuration.source.

java.lang.Object
- com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
- - com.vaadin.flow.component.map.configuration.source.Source
  - - com.vaadin.flow.component.map.configuration.source.TileSource
    - - com.vaadin.flow.component.map.configuration.source.UrlTileSource
      - com.vaadin.flow.component.map.configuration.source.TileImageSource
        
        com.vaadin.flow.component.map.configuration.source.XYZSource

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OSMSource
```
public class XYZSource
extends TileImageSource
```
Source for loading tiled images from a map service using the Slippy Map tile numbering scheme, also known as XYZ format.
This is commonly used by OpenStreetMap, as well as other services who have adopted the OSM tile numbering scheme.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class XYZSource.Options

Field Summary
- Fields inherited from class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
  propertyChangeSupport

Constructor Summary

Constructors
Constructor Description

XYZSource()

XYZSource(XYZSource.Options options)

Method Summary

All Methods
Modifier and Type	Method	Description
`String`	`getType()`	The unique type name of this class.
`String`	`getUrl()`	The URL template in XYZ format (see also Slippy map tilenames) used to load individual image tiles.
`void`	`setUrl(String url)`	Sets the URL template in XYZ format.

Methods inherited from class com.vaadin.flow.component.map.configuration.source.TileImageSource
getCrossOrigin

Methods inherited from class com.vaadin.flow.component.map.configuration.source.TileSource
isOpaque

Methods inherited from class com.vaadin.flow.component.map.configuration.source.Source
getAttributions, getProjection, isAttributionsCollapsible, setAttributions

Methods inherited from class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
addChild, addPropertyChangeListener, collectChanges, deepMarkAsDirty, getId, markAsDirty, notifyChange, notifyChange, removeChild, removePropertyChangeListener, setId, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XYZSource
```
public XYZSource()
```
  - XYZSource
```
public XYZSource(XYZSource.Options options)
```
- Method Detail
  - getType
```
public String getType()
```
    Description copied from class: AbstractConfigurationObject
    
    The unique type name of this class. Used by the client-side synchronization mechanism to determine which OpenLayers class to synchronize into.
    
    Specified by:
    
    getType in class AbstractConfigurationObject
  - getUrl
```
public String getUrl()
```
    The URL template in XYZ format (see also Slippy map tilenames) used to load individual image tiles. The URL must include the x, y or -y, and z placeholders, where x and y identify the tile in the tile grid for the zoom level z.
    Example: https://a.tile.openstreetmap.org/{z}/{x}/{y}.png
    
    Overrides:
    
    getUrl in class UrlTileSource
    
    Returns:
    
    the URL template
  - setUrl
```
public void setUrl(String url)
```
    Sets the URL template in XYZ format.
    
    Overrides:
    
    setUrl in class UrlTileSource
    
    Parameters:
    
    url - the new URL template