All Classes All Packages
A
- AbstractConfigurationObject - Class in com.vaadin.flow.component.map.configuration
-
Base class for all map configuration objects that represent an OL class.
- AbstractConfigurationObject() - Constructor for class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
- addChild(AbstractConfigurationObject) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Adds a nested object reference to keep track of.
- addClickEventListener(ComponentEventListener<MapClickEvent>) - Method in class com.vaadin.flow.component.map.MapBase
-
Adds a click listener for the map.
- addFeature(Feature) - Method in class com.vaadin.flow.component.map.configuration.layer.FeatureLayer
-
Adds a feature to the layer
- addFeature(Feature) - Method in class com.vaadin.flow.component.map.configuration.source.VectorSource
- addFeatureClickListener(ComponentEventListener<MapFeatureClickEvent>) - Method in class com.vaadin.flow.component.map.MapBase
-
Adds a click listener for geographical features.
- addFeatureClickListener(VectorLayer, ComponentEventListener<MapFeatureClickEvent>) - Method in class com.vaadin.flow.component.map.MapBase
-
Adds a click listener for geographical features.
- addLayer(Layer) - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
Adds a layer to the map.
- addLayer(Layer) - Method in class com.vaadin.flow.component.map.Map
-
Adds a layer to the map.
- addPropertyChangeListener(PropertyChangeListener) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Adds a change listener to the object.
- addPropertyChangeListener(PropertyChangeListener) - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
For internal use only.
- addThemeVariants(MapVariant...) - Method in class com.vaadin.flow.component.map.MapBase
-
Adds theme variants to the component.
- addViewMoveEndEventListener(ComponentEventListener<MapViewMoveEndEvent>) - Method in class com.vaadin.flow.component.map.MapBase
-
Adds an event listener for changes to the map's viewport.
- Anchor() - Constructor for class com.vaadin.flow.component.map.configuration.style.Icon.Anchor
- Anchor(float, float) - Constructor for class com.vaadin.flow.component.map.configuration.style.Icon.Anchor
- Assets - Class in com.vaadin.flow.component.map
-
Defines the default assets that the Map component provides
- Assets() - Constructor for class com.vaadin.flow.component.map.Assets
- Assets.Asset - Class in com.vaadin.flow.component.map
- Assets.ImageAsset - Class in com.vaadin.flow.component.map
B
- BORDERLESS - com.vaadin.flow.component.map.MapVariant
- BOTTOM_LEFT - com.vaadin.flow.component.map.configuration.style.Icon.AnchorOrigin
- BOTTOM_RIGHT - com.vaadin.flow.component.map.configuration.style.Icon.AnchorOrigin
C
- collectChanges(Consumer<AbstractConfigurationObject>) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Collects all changed objects from a configuration hierarchy.
- collectChanges(Consumer<AbstractConfigurationObject>) - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
For internal use only.
- com.vaadin.flow.component.map - package com.vaadin.flow.component.map
- com.vaadin.flow.component.map.configuration - package com.vaadin.flow.component.map.configuration
- com.vaadin.flow.component.map.configuration.feature - package com.vaadin.flow.component.map.configuration.feature
- com.vaadin.flow.component.map.configuration.geometry - package com.vaadin.flow.component.map.configuration.geometry
- com.vaadin.flow.component.map.configuration.layer - package com.vaadin.flow.component.map.configuration.layer
- com.vaadin.flow.component.map.configuration.source - package com.vaadin.flow.component.map.configuration.source
- com.vaadin.flow.component.map.configuration.style - package com.vaadin.flow.component.map.configuration.style
- com.vaadin.flow.component.map.events - package com.vaadin.flow.component.map.events
- com.vaadin.flow.component.map.serialization - package com.vaadin.flow.component.map.serialization
- Configuration - Class in com.vaadin.flow.component.map.configuration
-
Contains the configuration for the map, such as layers, sources, features.
- Configuration() - Constructor for class com.vaadin.flow.component.map.configuration.Configuration
- Constants - Class in com.vaadin.flow.component.map.configuration
-
Defines constants for OpenLayers types, which are uses by the client-side synchronization mechanism to identify which OL class to construct and synchronize into.
- Constants() - Constructor for class com.vaadin.flow.component.map.configuration.Constants
- Coordinate - Class in com.vaadin.flow.component.map.configuration
-
Represents map coordinates in a specific projection.
- Coordinate() - Constructor for class com.vaadin.flow.component.map.configuration.Coordinate
- Coordinate(double, double) - Constructor for class com.vaadin.flow.component.map.configuration.Coordinate
-
Constructs a new coordinate instance from x and y coordinates.
D
- deepMarkAsDirty() - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Marks this configuration object, as well as all nested objects, as dirty / as changed, so that the full nested hierarchy will be picked up for the next synchronization.
- deepMarkAsDirty() - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
For internal use only.
- defineProjection(String, String) - Static method in class com.vaadin.flow.component.map.Map
-
Defines a custom coordinate projection that can then be used as user projection or view projection.
E
- EPSG_3857 - com.vaadin.flow.component.map.configuration.Projection
- Extent - Class in com.vaadin.flow.component.map.configuration
-
Defines an area within a map using min/max coordinates.
- Extent() - Constructor for class com.vaadin.flow.component.map.configuration.Extent
- Extent(double, double, double, double) - Constructor for class com.vaadin.flow.component.map.configuration.Extent
F
- Feature - Class in com.vaadin.flow.component.map.configuration
-
A geographic feature to be displayed on a map.
- Feature() - Constructor for class com.vaadin.flow.component.map.configuration.Feature
- FeatureEventDetails - Class in com.vaadin.flow.component.map.events
-
Stores information about a
Featurethat is part of an event - FeatureEventDetails(Feature, VectorSource, VectorLayer) - Constructor for class com.vaadin.flow.component.map.events.FeatureEventDetails
- FeatureLayer - Class in com.vaadin.flow.component.map.configuration.layer
-
Layer that allows to conveniently display a number of geographic features.
- FeatureLayer() - Constructor for class com.vaadin.flow.component.map.configuration.layer.FeatureLayer
- Fill - Class in com.vaadin.flow.component.map.configuration.style
- Fill() - Constructor for class com.vaadin.flow.component.map.configuration.style.Fill
- fromLonLat(double, double) - Static method in class com.vaadin.flow.component.map.configuration.Coordinate
-
Deprecated.Since 23.2, the default coordinate system has been changed to EPSG:4326, which allows passing latitude and longitude into the constructor directly. Usages of this method should be replaced with a call to the constructor
Coordinate(double, double).Since the default coordinate system has been changed to EPSG:4326, and the purpose of this method is to return coordinates in EPSG:3857, this method will not return correct results anymore. As a temporary measure, the coordinate system can be changed back to EPSG:3857 using
Map.setUserProjection(String). Long-term, usages of this method should be replaced. - fromLonLat(double, double, Projection) - Static method in class com.vaadin.flow.component.map.configuration.Coordinate
-
Deprecated.Since 23.2, the default coordinate system has been changed to EPSG:4326, which allows passing latitude and longitude into the constructor directly. Usages of this method should be replaced with a call to the constructor
Coordinate(double, double).Since the default coordinate system has been changed to EPSG:4326, and the purpose of this method is to return coordinates in EPSG:3857, this method will not return correct results anymore. As a temporary measure, the coordinate system can be changed back to EPSG:3857 using
Map.setUserProjection(String). Long-term, usages of this method should be replaced.
G
- getAbsoluteX() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- getAbsoluteY() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- getAnchor() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
The anchor position of the image.
- getAnchorOrigin() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
The origin of the
Icon.getAnchor()position. - getAttributions() - Method in class com.vaadin.flow.component.map.configuration.source.Source
-
The attributions to display for the source.
- getBackground() - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
- getBackgroundLayer() - Method in class com.vaadin.flow.component.map.Map
-
Background layer of the map.
- getButton() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- getButtonName() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- getCenter() - Method in class com.vaadin.flow.component.map.configuration.View
-
Gets center coordinates of the view
- getCenter() - Method in class com.vaadin.flow.component.map.events.MapViewMoveEndEvent
-
Gets the
View's updated center coordinates - getCenter() - Method in class com.vaadin.flow.component.map.Map
-
Gets center coordinates of the map's viewport
- getColor() - Method in class com.vaadin.flow.component.map.configuration.style.Fill
- getColor() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
Color to tint the icon's image with.
- getColor() - Method in class com.vaadin.flow.component.map.configuration.style.Stroke
- getConfiguration() - Method in class com.vaadin.flow.component.map.MapBase
- getCoordinate() - Method in class com.vaadin.flow.component.map.events.MapClickEvent
-
Gets the coordinate of the click on viewport.
- getCoordinates() - Method in class com.vaadin.flow.component.map.configuration.feature.PointBasedFeature
-
The coordinates that define where the feature is located on the map.
- getCoordinates() - Method in class com.vaadin.flow.component.map.configuration.geometry.Point
-
The coordinates where the point is located
- getCrossOrigin() - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
-
The
crossOriginattribute for loaded images. - getCrossOrigin() - Method in class com.vaadin.flow.component.map.configuration.source.TileImageSource
-
The
crossOriginattribute for loaded images. - getCrossOrigin() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
The cross-origin attribute value for loaded images.
- getExtent() - Method in class com.vaadin.flow.component.map.configuration.View
-
Gets the extent (or bounding box) of the view's currently visible area.
- getExtent() - Method in class com.vaadin.flow.component.map.events.MapViewMoveEndEvent
-
Gets the updated extent (or bounding box) of the
View's currently visible area. - getFeature() - Method in class com.vaadin.flow.component.map.events.FeatureEventDetails
-
The feature of the event
- getFeature() - Method in class com.vaadin.flow.component.map.events.MapFeatureClickEvent
-
The feature that was clicked
- getFeatureLayer() - Method in class com.vaadin.flow.component.map.Map
-
The feature layer of the map.
- getFeatures() - Method in class com.vaadin.flow.component.map.configuration.layer.FeatureLayer
-
The features managed by this layer.
- getFeatures() - Method in class com.vaadin.flow.component.map.configuration.source.VectorSource
- getFeatures() - Method in class com.vaadin.flow.component.map.events.MapClickEvent
-
List of map features at the clicked position.
- getFileName() - Method in class com.vaadin.flow.component.map.Assets.Asset
- getFill() - Method in class com.vaadin.flow.component.map.configuration.style.Style
- getGeometry() - Method in class com.vaadin.flow.component.map.configuration.Feature
-
The geometry representing the feature, for example a
Pointor a polygon. - getGeometry() - Method in class com.vaadin.flow.component.map.configuration.feature.PointBasedFeature
-
The
Pointgeometry representing this feature. - getGutter() - Method in class com.vaadin.flow.component.map.configuration.source.TileWMSSource
-
Size of the gutter around image tiles to ignore, in pixels.
- getHeight() - Method in class com.vaadin.flow.component.map.Assets.ImageAsset
- getHeight() - Method in class com.vaadin.flow.component.map.configuration.style.Icon.ImageSize
- getIcon() - Method in class com.vaadin.flow.component.map.configuration.feature.MarkerFeature
-
The icon used to visually display the marker feature.
- getId() - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
- getImage() - Method in class com.vaadin.flow.component.map.configuration.style.Style
- getImg() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
The stream resource from which the icon's image should be loaded.
- getImgSize() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
The size of the image in pixels.
- getLayer() - Method in class com.vaadin.flow.component.map.events.FeatureEventDetails
-
The
VectorLayerthat contains the feature - getLayer() - Method in class com.vaadin.flow.component.map.events.MapFeatureClickEvent
-
The layer that contains the feature
- getLayers() - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
The list of layers managed by this map.
- getMaxX() - Method in class com.vaadin.flow.component.map.configuration.Extent
- getMaxY() - Method in class com.vaadin.flow.component.map.configuration.Extent
- getMaxZoom() - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
- getMinX() - Method in class com.vaadin.flow.component.map.configuration.Extent
- getMinY() - Method in class com.vaadin.flow.component.map.configuration.Extent
- getMinZoom() - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
- getMouseDetails() - Method in class com.vaadin.flow.component.map.events.MapClickEvent
-
Gets the click's mouse event details.
- getMouseDetails() - Method in class com.vaadin.flow.component.map.events.MapFeatureClickEvent
-
Gets the click's mouse event details.
- getName() - Method in enum com.vaadin.flow.component.map.events.MouseEventDetails.MouseButton
-
Returns a human readable text representing the button
- getOpacity() - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
- getOpacity() - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
The opacity of the image.
- getParams() - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
-
The WMS request parameters for requesting images from the WMS server.
- getParams() - Method in class com.vaadin.flow.component.map.configuration.source.TileWMSSource
-
The WMS request parameters for requesting images from the WMS server.
- getProjection() - Method in class com.vaadin.flow.component.map.configuration.source.Source
-
The type of coordinate projection to use for this source.
- getProjection() - Method in class com.vaadin.flow.component.map.configuration.View
-
Gets the projection of the view, which defaults to
EPSG:3857/ Web Mercator Sphere projection - getRatio() - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
-
The ratio for the size of requested images compared to the map's viewport.
- getRawConfiguration() - Method in class com.vaadin.flow.component.map.Map
- getResource() - Method in class com.vaadin.flow.component.map.Assets.Asset
- getRotation() - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
The rotation of the image in radians.
- getRotation() - Method in class com.vaadin.flow.component.map.configuration.View
-
Get rotation of the view, defaults to
0 - getRotation() - Method in class com.vaadin.flow.component.map.events.MapViewMoveEndEvent
-
Gets the
View's updated rotation - getScale() - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
The scaling of the image's size.
- getServerType() - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
-
The type of WMS server.
- getServerType() - Method in class com.vaadin.flow.component.map.configuration.source.TileWMSSource
-
The type of WMS server.
- getSource() - Method in class com.vaadin.flow.component.map.configuration.layer.FeatureLayer
-
The source for this layer.
- getSource() - Method in class com.vaadin.flow.component.map.configuration.layer.ImageLayer
- getSource() - Method in class com.vaadin.flow.component.map.configuration.layer.TileLayer
- getSource() - Method in class com.vaadin.flow.component.map.configuration.layer.VectorLayer
- getSource() - Method in class com.vaadin.flow.component.map.events.FeatureEventDetails
-
The
VectorSourcethat contains the feature - getSrc() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
The source URL from which the icon's image should be loaded.
- getStroke() - Method in class com.vaadin.flow.component.map.configuration.style.Style
- getStyle() - Method in class com.vaadin.flow.component.map.configuration.Feature
-
The
Styledefines how the feature should be visually displayed. - getType() - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
The unique type name of this class.
- getType() - Method in class com.vaadin.flow.component.map.configuration.Configuration
- getType() - Method in class com.vaadin.flow.component.map.configuration.Feature
- getType() - Method in class com.vaadin.flow.component.map.configuration.geometry.Point
- getType() - Method in class com.vaadin.flow.component.map.configuration.layer.ImageLayer
- getType() - Method in class com.vaadin.flow.component.map.configuration.layer.TileLayer
- getType() - Method in class com.vaadin.flow.component.map.configuration.layer.VectorLayer
- getType() - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
- getType() - Method in class com.vaadin.flow.component.map.configuration.source.OSMSource
- getType() - Method in class com.vaadin.flow.component.map.configuration.source.TileWMSSource
- getType() - Method in class com.vaadin.flow.component.map.configuration.source.VectorSource
- getType() - Method in class com.vaadin.flow.component.map.configuration.source.XYZSource
- getType() - Method in class com.vaadin.flow.component.map.configuration.style.Fill
- getType() - Method in class com.vaadin.flow.component.map.configuration.style.Icon
- getType() - Method in class com.vaadin.flow.component.map.configuration.style.Stroke
- getType() - Method in class com.vaadin.flow.component.map.configuration.style.Style
- getType() - Method in class com.vaadin.flow.component.map.configuration.View
- getUrl() - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
-
The WMS service URL
- getUrl() - Method in class com.vaadin.flow.component.map.configuration.source.UrlTileSource
- getUrl() - Method in class com.vaadin.flow.component.map.configuration.source.XYZSource
-
The URL template in XYZ format (see also Slippy map tilenames) used to load individual image tiles.
- getVariantName() - Method in enum com.vaadin.flow.component.map.MapVariant
-
Gets the variant name.
- getVectorSource() - Method in class com.vaadin.flow.component.map.events.MapFeatureClickEvent
-
The source that contains the feature
- getView() - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
Gets the view of the map.
- getView() - Method in class com.vaadin.flow.component.map.MapBase
-
Gets the
Viewof the map. - getWidth() - Method in class com.vaadin.flow.component.map.Assets.ImageAsset
- getWidth() - Method in class com.vaadin.flow.component.map.configuration.style.Icon.ImageSize
- getWidth() - Method in class com.vaadin.flow.component.map.configuration.style.Stroke
- getX() - Method in class com.vaadin.flow.component.map.configuration.Coordinate
- getX() - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Anchor
- getY() - Method in class com.vaadin.flow.component.map.configuration.Coordinate
- getY() - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Anchor
- getzIndex() - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
- getZoom() - Method in class com.vaadin.flow.component.map.configuration.View
-
Gets zoom level of the view, defaults to
0 - getZoom() - Method in class com.vaadin.flow.component.map.events.MapViewMoveEndEvent
-
Gets the
View's updated zoom level - getZoom() - Method in class com.vaadin.flow.component.map.Map
-
Gets zoom level of the map's viewport, defaults to
0
I
- Icon - Class in com.vaadin.flow.component.map.configuration.style
-
An icon or image that can be used to visually represent a
Feature, by using it as the feature'sStyle.setImage(ImageStyle) - Icon(Icon.Options) - Constructor for class com.vaadin.flow.component.map.configuration.style.Icon
- Icon.Anchor - Class in com.vaadin.flow.component.map.configuration.style
- Icon.AnchorOrigin - Enum in com.vaadin.flow.component.map.configuration.style
- Icon.ImageSize - Class in com.vaadin.flow.component.map.configuration.style
- Icon.Options - Class in com.vaadin.flow.component.map.configuration.style
- ImageLayer - Class in com.vaadin.flow.component.map.configuration.layer
-
Layer for server-rendered images that are available in arbitrary extents and resolutions.
- ImageLayer() - Constructor for class com.vaadin.flow.component.map.configuration.layer.ImageLayer
- ImageSize(int, int) - Constructor for class com.vaadin.flow.component.map.configuration.style.Icon.ImageSize
- ImageSource - Class in com.vaadin.flow.component.map.configuration.source
-
Abstract base class for all sources providing a single image
- ImageSource(ImageSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.ImageSource
- ImageSource.Options - Class in com.vaadin.flow.component.map.configuration.source
- ImageStyle - Class in com.vaadin.flow.component.map.configuration.style
-
Abstract base class for drawing image-based features
- ImageStyle(ImageStyle.Options) - Constructor for class com.vaadin.flow.component.map.configuration.style.ImageStyle
- ImageStyle.Options - Class in com.vaadin.flow.component.map.configuration.style
- ImageWMSSource - Class in com.vaadin.flow.component.map.configuration.source
-
Source for WMS servers providing single, untiled images
- ImageWMSSource(ImageWMSSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
- ImageWMSSource.Options - Class in com.vaadin.flow.component.map.configuration.source
- isAltKey() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- isAttributionsCollapsible() - Method in class com.vaadin.flow.component.map.configuration.source.OSMSource
-
Determines whether attributions are collapsible.
- isAttributionsCollapsible() - Method in class com.vaadin.flow.component.map.configuration.source.Source
-
Determines whether attributions are collapsible.
- isCtrlKey() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- isMetaKey() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- isOpaque() - Method in class com.vaadin.flow.component.map.configuration.source.TileSource
-
Whether the source has an opaque background or not.
- isRotateWithView() - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
Whether to rotate the image together with the view.
- isShiftKey() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- isVisible() - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
L
- Layer - Class in com.vaadin.flow.component.map.configuration.layer
-
Abstract base class for all map layers
- Layer() - Constructor for class com.vaadin.flow.component.map.configuration.layer.Layer
- LEFT - com.vaadin.flow.component.map.events.MouseEventDetails.MouseButton
M
- Map - Class in com.vaadin.flow.component.map
-
Map is a component for displaying geographic maps from various sources.
- Map() - Constructor for class com.vaadin.flow.component.map.Map
- MapBase - Class in com.vaadin.flow.component.map
-
Base class for the map component.
- MapBase() - Constructor for class com.vaadin.flow.component.map.MapBase
- MapClickEvent - Class in com.vaadin.flow.component.map.events
-
Representing OpenLayers' @code{click} event
- MapClickEvent(Map, boolean, JsonArray, JsonArray, JsonArray, int, int, boolean, boolean, boolean, boolean, int) - Constructor for class com.vaadin.flow.component.map.events.MapClickEvent
- MapFeatureClickEvent - Class in com.vaadin.flow.component.map.events
-
Provides data for click events on geographic features
- MapFeatureClickEvent(Map, boolean, String, String, int, int, boolean, boolean, boolean, boolean, int) - Constructor for class com.vaadin.flow.component.map.events.MapFeatureClickEvent
- MapSerializer - Class in com.vaadin.flow.component.map.serialization
-
Custom JSON serializer for the map component using a Jackson
ObjectMapper - MapSerializer() - Constructor for class com.vaadin.flow.component.map.serialization.MapSerializer
- MapVariant - Enum in com.vaadin.flow.component.map
-
Set of theme variants applicable for the
vaadin-mapcomponent. - MapViewMoveEndEvent - Class in com.vaadin.flow.component.map.events
-
Fired when viewport movement has ended.
- MapViewMoveEndEvent(MapBase, boolean, double, double, JsonArray, JsonArray) - Constructor for class com.vaadin.flow.component.map.events.MapViewMoveEndEvent
- markAsDirty() - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Marks this configuration object as dirty / as changed, so that it will be picked up for the next synchronization.
- MarkerFeature - Class in com.vaadin.flow.component.map.configuration.feature
-
A convenience class for displaying icons or images, such as markers, at a specific location on the map.
- MarkerFeature() - Constructor for class com.vaadin.flow.component.map.configuration.feature.MarkerFeature
-
Creates a new marker feature displaying a default marker icon.
- MarkerFeature(Coordinate) - Constructor for class com.vaadin.flow.component.map.configuration.feature.MarkerFeature
-
Creates a new marker feature located at the specified coordinates, displaying a default marker icon.
- MarkerFeature(Coordinate, Icon) - Constructor for class com.vaadin.flow.component.map.configuration.feature.MarkerFeature
-
Creates a new marker feature located at the specified coordinates, displaying the specified custom icon.
- MIDDLE - com.vaadin.flow.component.map.events.MouseEventDetails.MouseButton
- MouseEventDetails - Class in com.vaadin.flow.component.map.events
-
Helper class to store and transfer mouse event details.
- MouseEventDetails() - Constructor for class com.vaadin.flow.component.map.events.MouseEventDetails
- MouseEventDetails.MouseButton - Enum in com.vaadin.flow.component.map.events
-
Constants for mouse buttons.
N
- notifyChange() - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Notifies observers that this object has changed.
- notifyChange(PropertyChangeEvent) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Same behavior as
AbstractConfigurationObject.notifyChange(), can be used as a shortcut to relay events from nested objects.
O
- of(int) - Static method in enum com.vaadin.flow.component.map.events.MouseEventDetails.MouseButton
- OL_FEATURE - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_GEOMETRY_POINT - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_LAYER_IMAGE - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_LAYER_TILE - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_LAYER_VECTOR - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_MAP - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_SOURCE_IMAGE_WMS - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_SOURCE_OSM - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_SOURCE_TILE_WMS - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_SOURCE_VECTOR - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_SOURCE_XYZ - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_STYLE_FILL - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_STYLE_ICON - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_STYLE_STROKE - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_STYLE_STYLE - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- OL_VIEW - Static variable in class com.vaadin.flow.component.map.configuration.Constants
- onAttach(AttachEvent) - Method in class com.vaadin.flow.component.map.MapBase
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.ImageSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.ImageWMSSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.OSMSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.Source.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.TileImageSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.TileSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.TileWMSSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.UrlTileSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.VectorSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.source.XYZSource.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.style.Icon.Options
- Options() - Constructor for class com.vaadin.flow.component.map.configuration.style.ImageStyle.Options
- OSMSource - Class in com.vaadin.flow.component.map.configuration.source
-
Map source for loading tiled images from an OpenStreetMap service.
- OSMSource() - Constructor for class com.vaadin.flow.component.map.configuration.source.OSMSource
- OSMSource(OSMSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.OSMSource
- OSMSource.Options - Class in com.vaadin.flow.component.map.configuration.source
P
- PIN - Static variable in class com.vaadin.flow.component.map.Assets
- PIN_ICON - Static variable in class com.vaadin.flow.component.map.configuration.feature.MarkerFeature
-
The default icon used for markers, which is a pin pointing at a location on the map
- Point - Class in com.vaadin.flow.component.map.configuration.geometry
-
Geometry that is represented by a single point and coordinate.
- Point(Coordinate) - Constructor for class com.vaadin.flow.component.map.configuration.geometry.Point
-
Creates a new point geometry located at the specified coordinates.
- POINT - Static variable in class com.vaadin.flow.component.map.Assets
- POINT_ICON - Static variable in class com.vaadin.flow.component.map.configuration.feature.MarkerFeature
-
An alternative icon that displays a point
- PointBasedFeature - Class in com.vaadin.flow.component.map.configuration.feature
-
Abstract base class for features that are represented by a single point and a single coordinate.
- PointBasedFeature() - Constructor for class com.vaadin.flow.component.map.configuration.feature.PointBasedFeature
- PointBasedFeature(Coordinate) - Constructor for class com.vaadin.flow.component.map.configuration.feature.PointBasedFeature
- prependLayer(Layer) - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
Adds a layer to the map by prepending it to the list of layers.
- Projection - Enum in com.vaadin.flow.component.map.configuration
-
Defines constants for map coordinate projections.
- propertyChangeSupport - Variable in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
R
- removeChild(AbstractConfigurationObject) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Removes a nested object reference from tracking.
- removeFeature(Feature) - Method in class com.vaadin.flow.component.map.configuration.layer.FeatureLayer
-
Removes a feature from the layer
- removeFeature(Feature) - Method in class com.vaadin.flow.component.map.configuration.source.VectorSource
- removeLayer(Layer) - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
Remove a layer from the map
- removeLayer(Layer) - Method in class com.vaadin.flow.component.map.Map
-
Remove a layer from the map
- removePropertyChangeListener(PropertyChangeListener) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Removes a change listener from the object.
- removeThemeVariants(MapVariant...) - Method in class com.vaadin.flow.component.map.MapBase
-
Removes theme variants from the component.
- RIGHT - com.vaadin.flow.component.map.events.MouseEventDetails.MouseButton
S
- setAbsoluteX(int) - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- setAbsoluteY(int) - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- setAltKey(boolean) - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- setAnchor(Icon.Anchor) - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Options
- setAnchor(Icon.Anchor) - Method in class com.vaadin.flow.component.map.configuration.style.Icon
-
Sets the anchor position of the icon's image
- setAnchorOrigin(Icon.AnchorOrigin) - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Options
- setAttributions(List<String>) - Method in class com.vaadin.flow.component.map.configuration.source.Source.Options
- setAttributions(List<String>) - Method in class com.vaadin.flow.component.map.configuration.source.Source
-
Sets the attributions to display for the source.
- setAttributionsCollapsible(boolean) - Method in class com.vaadin.flow.component.map.configuration.source.OSMSource.Options
- setAttributionsCollapsible(boolean) - Method in class com.vaadin.flow.component.map.configuration.source.Source.Options
- setBackground(String) - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
-
Sets the background color of the layer as CSS color string.
- setBackgroundLayer(Layer) - Method in class com.vaadin.flow.component.map.Map
-
Sets the background layer of the map.
- setButton(MouseEventDetails.MouseButton) - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- setCenter(Coordinate) - Method in class com.vaadin.flow.component.map.configuration.View
-
Sets the center of the map's viewport.
- setCenter(Coordinate) - Method in class com.vaadin.flow.component.map.Map
-
Sets the center of the map's viewport.
- setColor(String) - Method in class com.vaadin.flow.component.map.configuration.style.Fill
- setColor(String) - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Options
- setColor(String) - Method in class com.vaadin.flow.component.map.configuration.style.Stroke
- setCoordinates(Coordinate) - Method in class com.vaadin.flow.component.map.configuration.feature.PointBasedFeature
-
Sets the coordinates that define where the feature is located on the map.
- setCoordinates(Coordinate) - Method in class com.vaadin.flow.component.map.configuration.geometry.Point
-
Sets the coordinates that locate the point.
- setCrossOrigin(String) - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource.Options
- setCrossOrigin(String) - Method in class com.vaadin.flow.component.map.configuration.source.TileImageSource.Options
- setCrossOrigin(String) - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Options
- setCtrlKey(boolean) - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- setFill(Fill) - Method in class com.vaadin.flow.component.map.configuration.style.Style
- setGeometry(SimpleGeometry) - Method in class com.vaadin.flow.component.map.configuration.feature.PointBasedFeature
-
Sets the geometry representing this feature.
- setGeometry(SimpleGeometry) - Method in class com.vaadin.flow.component.map.configuration.Feature
-
Sets the geometry representing the feature.
- setGutter(int) - Method in class com.vaadin.flow.component.map.configuration.source.TileWMSSource.Options
- setIcon(Icon) - Method in class com.vaadin.flow.component.map.configuration.feature.MarkerFeature
-
Sets the icon used to visually display the marker feature.
- setId(String) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
- setImage(ImageStyle) - Method in class com.vaadin.flow.component.map.configuration.style.Style
- setImg(StreamResource) - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Options
- setImgSize(Icon.ImageSize) - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Options
- setMaxZoom(Float) - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
-
Sets the maximum zoom level at which this layer will be visible.
- setMetaKey(boolean) - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- setMinZoom(Float) - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
-
Sets the minimum zoom level at which this layer will be visible.
- setOpacity(float) - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
-
Sets the opacity of the layer.
- setOpacity(float) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle.Options
- setOpacity(float) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
Sets the opacity for the image.
- setOpaque(boolean) - Method in class com.vaadin.flow.component.map.configuration.source.TileSource.Options
- setParams(Map<String, Object>) - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource.Options
- setParams(Map<String, Object>) - Method in class com.vaadin.flow.component.map.configuration.source.TileWMSSource.Options
- setProjection(String) - Method in class com.vaadin.flow.component.map.configuration.source.Source.Options
- setRatio(float) - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource.Options
- setRotateWithView(boolean) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle.Options
- setRotateWithView(boolean) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
Sets whether to rotate the image together with the view.
- setRotation(float) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle.Options
- setRotation(float) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
Sets the rotation of the image in radians.
- setRotation(float) - Method in class com.vaadin.flow.component.map.configuration.View
-
Sets the rotation of the view in radians
- setScale(float) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle.Options
- setScale(float) - Method in class com.vaadin.flow.component.map.configuration.style.ImageStyle
-
Sets the scaling of the image's size.
- setServerType(String) - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource.Options
- setServerType(String) - Method in class com.vaadin.flow.component.map.configuration.source.TileWMSSource.Options
- setShiftKey(boolean) - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
- setSource(ImageSource) - Method in class com.vaadin.flow.component.map.configuration.layer.ImageLayer
-
Sets the source for this layer.
- setSource(UrlTileSource) - Method in class com.vaadin.flow.component.map.configuration.layer.TileLayer
-
Sets the source for this layer.
- setSource(VectorSource) - Method in class com.vaadin.flow.component.map.configuration.layer.VectorLayer
-
Sets the source for this layer.
- setSrc(String) - Method in class com.vaadin.flow.component.map.configuration.style.Icon.Options
- setStroke(Stroke) - Method in class com.vaadin.flow.component.map.configuration.style.Style
- setStyle(Style) - Method in class com.vaadin.flow.component.map.configuration.Feature
-
Sets the style that defines how the feature should be visually displayed.
- setUrl(String) - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource.Options
- setUrl(String) - Method in class com.vaadin.flow.component.map.configuration.source.ImageWMSSource
-
Sets the WMS service URL
- setUrl(String) - Method in class com.vaadin.flow.component.map.configuration.source.UrlTileSource.Options
- setUrl(String) - Method in class com.vaadin.flow.component.map.configuration.source.UrlTileSource
-
Sets the URL from which to load tile data.
- setUrl(String) - Method in class com.vaadin.flow.component.map.configuration.source.XYZSource.Options
- setUrl(String) - Method in class com.vaadin.flow.component.map.configuration.source.XYZSource
-
Sets the URL template in XYZ format.
- setUserProjection(String) - Static method in class com.vaadin.flow.component.map.Map
-
Sets the projection (or coordinate system) to use for all coordinates.
- setView(View) - Method in class com.vaadin.flow.component.map.configuration.Configuration
-
Sets the view of the map.
- setView(View) - Method in class com.vaadin.flow.component.map.MapBase
-
Sets the view of the map.
- setVisible(boolean) - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
-
Sets the visibility of the layer.
- setWidth(float) - Method in class com.vaadin.flow.component.map.configuration.style.Stroke
- setzIndex(Integer) - Method in class com.vaadin.flow.component.map.configuration.layer.Layer
-
Sets the z-index of the layer.
- setZoom(float) - Method in class com.vaadin.flow.component.map.configuration.View
-
Sets the zoom level of the view.
- setZoom(float) - Method in class com.vaadin.flow.component.map.Map
-
Sets the zoom level of the map's viewport.
- SimpleGeometry - Class in com.vaadin.flow.component.map.configuration.geometry
-
Abstract base class for geometries
- SimpleGeometry() - Constructor for class com.vaadin.flow.component.map.configuration.geometry.SimpleGeometry
- Source - Class in com.vaadin.flow.component.map.configuration.source
-
Abstract base class for all map sources
- Source(Source.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.Source
- Source.Options - Class in com.vaadin.flow.component.map.configuration.source
- stringValue() - Method in enum com.vaadin.flow.component.map.configuration.Projection
- Stroke - Class in com.vaadin.flow.component.map.configuration.style
- Stroke() - Constructor for class com.vaadin.flow.component.map.configuration.style.Stroke
- Style - Class in com.vaadin.flow.component.map.configuration.style
-
Defines how to visually represent a
Feature - Style() - Constructor for class com.vaadin.flow.component.map.configuration.style.Style
T
- TileImageSource - Class in com.vaadin.flow.component.map.configuration.source
-
Abstract base class for map sources providing tiled images from a URL
- TileImageSource(TileImageSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.TileImageSource
- TileImageSource.Options - Class in com.vaadin.flow.component.map.configuration.source
- TileLayer - Class in com.vaadin.flow.component.map.configuration.layer
-
Layer for displaying tiled map data
- TileLayer() - Constructor for class com.vaadin.flow.component.map.configuration.layer.TileLayer
- TileSource - Class in com.vaadin.flow.component.map.configuration.source
-
Abstract base class for map sources providing tiled map data
- TileSource(TileSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.TileSource
- TileSource.Options - Class in com.vaadin.flow.component.map.configuration.source
- TileWMSSource - Class in com.vaadin.flow.component.map.configuration.source
-
Source for loading tile data from WMS (Web Map Service) servers
- TileWMSSource(TileWMSSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.TileWMSSource
- TileWMSSource.Options - Class in com.vaadin.flow.component.map.configuration.source
- toJson(Object) - Method in class com.vaadin.flow.component.map.serialization.MapSerializer
-
Serializes a map configuration object to JSON using a Jackson
ObjectMapper, and returns the value as aJsonValueto provide it in a type that is compatible with Flow. - TOP_LEFT - com.vaadin.flow.component.map.configuration.style.Icon.AnchorOrigin
- TOP_RIGHT - com.vaadin.flow.component.map.configuration.style.Icon.AnchorOrigin
- toString() - Method in class com.vaadin.flow.component.map.configuration.Coordinate
- toString() - Method in class com.vaadin.flow.component.map.events.MouseEventDetails
U
- update(Runnable, boolean) - Method in class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject
-
Updates an object using a
Runnablethat executes code for manipulating this object. - updateInternalViewState(Coordinate, float, float, Extent) - Method in class com.vaadin.flow.component.map.configuration.View
-
Updates internal state of view to the latest values received from client.
- UrlTileSource - Class in com.vaadin.flow.component.map.configuration.source
-
Abstract base class for map sources providing tiled map data from a URL
- UrlTileSource(UrlTileSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.UrlTileSource
- UrlTileSource.Options - Class in com.vaadin.flow.component.map.configuration.source
V
- valueOf(String) - Static method in enum com.vaadin.flow.component.map.configuration.Projection
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.vaadin.flow.component.map.configuration.style.Icon.AnchorOrigin
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.vaadin.flow.component.map.events.MouseEventDetails.MouseButton
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.vaadin.flow.component.map.MapVariant
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.vaadin.flow.component.map.configuration.Projection
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.vaadin.flow.component.map.configuration.style.Icon.AnchorOrigin
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.vaadin.flow.component.map.events.MouseEventDetails.MouseButton
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.vaadin.flow.component.map.MapVariant
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VectorLayer - Class in com.vaadin.flow.component.map.configuration.layer
-
Layer for rendering vector data client-side
- VectorLayer() - Constructor for class com.vaadin.flow.component.map.configuration.layer.VectorLayer
- VectorSource - Class in com.vaadin.flow.component.map.configuration.source
- VectorSource() - Constructor for class com.vaadin.flow.component.map.configuration.source.VectorSource
- VectorSource(VectorSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.VectorSource
- VectorSource.Options - Class in com.vaadin.flow.component.map.configuration.source
- View - Class in com.vaadin.flow.component.map.configuration
-
Represents a map's viewport, responsible for changing properties like center and zoom level
- View() - Constructor for class com.vaadin.flow.component.map.configuration.View
-
Constructs a new view using
EPSG:3857/ Web Mercator Sphere coordinate projection by default. - View(String) - Constructor for class com.vaadin.flow.component.map.configuration.View
-
Constructs a new view using a custom coordinate projection.
X
- XYZSource - Class in com.vaadin.flow.component.map.configuration.source
-
Source for loading tiled images from a map service using the Slippy Map tile numbering scheme, also known as XYZ format.
- XYZSource() - Constructor for class com.vaadin.flow.component.map.configuration.source.XYZSource
- XYZSource(XYZSource.Options) - Constructor for class com.vaadin.flow.component.map.configuration.source.XYZSource
- XYZSource.Options - Class in com.vaadin.flow.component.map.configuration.source
All Classes All Packages