We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.map.
Class MapBase
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.map.MapBase
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasElement,HasSize,HasTheme,SerializableDirect Known Subclasses:
public abstract class MapBase extends Component implements HasSize, HasThemeBase class for the map component. Contains all base functionality for the map component, but does not provide any defaults. This component should not be used directly, instead use
Map, which also provides some out-of-the-box conveniences such as a pre-configured background layer, and a feature layer.See Also:
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedMapBase()
-
Method Summary
All Methods Modifier and Type Method Description RegistrationaddClickEventListener(ComponentEventListener<MapClickEvent> listener)Adds a click listener for the map.
RegistrationaddFeatureClickListener(ComponentEventListener<MapFeatureClickEvent> listener)Adds a click listener for geographical features.
RegistrationaddFeatureClickListener(VectorLayer layer, ComponentEventListener<MapFeatureClickEvent> listener)Adds a click listener for geographical features.
voidaddThemeVariants(MapVariant... variants)Adds theme variants to the component.
RegistrationaddViewMoveEndEventListener(ComponentEventListener<MapViewMoveEndEvent> listener)Adds an event listener for changes to the map's viewport.
protected ConfigurationgetConfiguration()protected FeatureFlagsgetFeatureFlags()Gets the feature flags for the current UI.
ViewgetView()Gets the
Viewof the map.protected voidonAttach(AttachEvent attachEvent)Called when the component is attached to a UI.
voidremoveThemeVariants(MapVariant... variants)Removes theme variants from the component.
voidsetView(View view)Sets the view of the map.
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
-
Methods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName
-
-
-
-
Method Detail
-
getConfiguration
protected Configuration getConfiguration()
-
getView
public View getView()Gets the
Viewof the map. The view allows controlling properties of the map's viewport, such as center, zoom level and rotation.Returns:
the map's view
-
setView
public void setView(View view)Sets the view of the map. This is only necessary when dealing with map services that use custom coordinate projection, in which case a view with a matching projection needs to be created and used.
Parameters:
view- the new view
-
onAttach
protected void onAttach(AttachEvent attachEvent)Description copied from class:
ComponentCalled when the component is attached to a UI.
The default implementation does nothing.
This method is invoked before the
AttachEventis fired for the component.
-
addViewMoveEndEventListener
public Registration addViewMoveEndEventListener(ComponentEventListener<MapViewMoveEndEvent> listener)Adds an event listener for changes to the map's viewport. The event will only be triggered after the user has finished manipulating the viewport, for example after letting go of the mouse button after a mouse drag interaction.
Parameters:
listener-Returns:
a registration object for removing the added listener
-
addClickEventListener
public Registration addClickEventListener(ComponentEventListener<MapClickEvent> listener)Adds a click listener for the map.
Note that the listener will also be invoked when clicking on a
Feature. UseMapClickEvent.getFeatures()to distinguish whether a feature exists at the clicked location.Parameters:
listener-Returns:
a registration object for removing the added listener
-
addFeatureClickListener
public Registration addFeatureClickListener(VectorLayer layer, ComponentEventListener<MapFeatureClickEvent> listener)Adds a click listener for geographical features. The listener will be invoked for a click on any feature in the specified layer. For clicks on overlapping features, the listener will be invoked only for the top-level feature at that location.
Parameters:
listener- the listener to triggerReturns:
registration for the listener
See Also:
-
addFeatureClickListener
public Registration addFeatureClickListener(ComponentEventListener<MapFeatureClickEvent> listener)Adds a click listener for geographical features. The listener will be invoked for a click on any feature, in any layer. To listen for feature clicks in a specific layer, see
addFeatureClickListener(VectorLayer, ComponentEventListener). For clicks on overlapping features, the listener will be invoked only for the top-level feature at that location.Parameters:
listener- the listener to triggerReturns:
registration for the listener
See Also:
-
getFeatureFlags
protected FeatureFlags getFeatureFlags()Gets the feature flags for the current UI.
Extracted with protected visibility to support mocking
Returns:
the current set of feature flags
-
addThemeVariants
public void addThemeVariants(MapVariant... variants)Adds theme variants to the component.
Parameters:
variants- theme variants to add
-
removeThemeVariants
public void removeThemeVariants(MapVariant... variants)Removes theme variants from the component.
Parameters:
variants- theme variants to remove
-
-