Package com.vaadin.flow.component.map

Class MapBase

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.map.MapBase
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasThemeVariant<MapVariant>, Serializable
Direct Known Subclasses:
Map
public abstract class MapBase extends com.vaadin.flow.component.Component implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.shared.HasThemeVariant<MapVariant>
Base 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
    protected
    MapBase()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addClickEventListener(com.vaadin.flow.component.ComponentEventListener<MapClickEvent> listener)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use addClickListener(ComponentEventListener) instead
    com.vaadin.flow.shared.Registration
    addClickListener(com.vaadin.flow.component.ComponentEventListener<MapClickEvent> listener)
    Adds a click listener for the map.
    com.vaadin.flow.shared.Registration
    addClusterClickListener(com.vaadin.flow.component.ComponentEventListener<MapClusterClickEvent> listener)
    Adds a click listener for clusters of features.
    com.vaadin.flow.shared.Registration
    addFeatureClickListener(com.vaadin.flow.component.ComponentEventListener<MapFeatureClickEvent> listener)
    Adds a click listener for geographical features.
    com.vaadin.flow.shared.Registration
    addFeatureClickListener(VectorLayer layer, com.vaadin.flow.component.ComponentEventListener<MapFeatureClickEvent> listener)
    Adds a click listener for geographical features.
    com.vaadin.flow.shared.Registration
    addFeatureDropListener(com.vaadin.flow.component.ComponentEventListener<MapFeatureDropEvent> listener)
    Adds an event listener for when a feature is dropped after a drag operation.
    com.vaadin.flow.shared.Registration
    addViewMoveEndEventListener(com.vaadin.flow.component.ComponentEventListener<MapViewMoveEndEvent> listener)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use addViewMoveEndListener(ComponentEventListener) instead
    com.vaadin.flow.shared.Registration
    addViewMoveEndListener(com.vaadin.flow.component.ComponentEventListener<MapViewMoveEndEvent> listener)
    Adds an event listener for changes to the map's viewport.
    protected Configuration
    getConfiguration()
     
    View
    getView()
    Gets the View of the map.
    protected void
    onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
     
    void
    setView(View view)
    Sets the view of the map.

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, 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.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

    addThemeVariants, removeThemeVariants, setThemeVariant, setThemeVariants, setThemeVariants

  • Constructor Details

    • MapBase

      protected MapBase()

  • Method Details

    • getConfiguration

      protected Configuration getConfiguration()

    • getView

      public View getView()
      Gets the View of 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(com.vaadin.flow.component.AttachEvent attachEvent)
      Overrides:
      onAttach in class com.vaadin.flow.component.Component

    • addViewMoveEndEventListener

      @Deprecated(since="25.0", forRemoval=true) public com.vaadin.flow.shared.Registration addViewMoveEndEventListener(com.vaadin.flow.component.ComponentEventListener<MapViewMoveEndEvent> listener)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addViewMoveEndListener(ComponentEventListener) instead
      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 - the listener to add
      Returns:
      a registration object for removing the added listener

    • addViewMoveEndListener

      public com.vaadin.flow.shared.Registration addViewMoveEndListener(com.vaadin.flow.component.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 - the listener to add
      Returns:
      a registration object for removing the added listener

    • addClickEventListener

      @Deprecated(since="25.0", forRemoval=true) public com.vaadin.flow.shared.Registration addClickEventListener(com.vaadin.flow.component.ComponentEventListener<MapClickEvent> listener)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use addClickListener(ComponentEventListener) instead
      Adds a click listener for the map.

      Note that the listener will also be invoked when clicking on a Feature. Use MapClickEvent.getFeatures() to distinguish whether a feature exists at the clicked location.

      Parameters:
      listener - the listener to add
      Returns:
      a registration object for removing the added listener

    • addClickListener

      public com.vaadin.flow.shared.Registration addClickListener(com.vaadin.flow.component.ComponentEventListener<MapClickEvent> listener)
      Adds a click listener for the map.

      Note that the listener will also be invoked when clicking on a Feature. Use MapClickEvent.getFeatures() to distinguish whether a feature exists at the clicked location.

      Parameters:
      listener - the listener to add
      Returns:
      a registration object for removing the added listener

    • addFeatureClickListener

      public com.vaadin.flow.shared.Registration addFeatureClickListener(VectorLayer layer, com.vaadin.flow.component.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.

      When clustering is enabled, the listener will only be invoked for clicks on individual features. Use addClusterClickListener(ComponentEventListener) to listen for clicks on clusters.

      Parameters:
      listener - the listener to trigger
      Returns:
      registration for the listener
      See Also:

    • addFeatureClickListener

      public com.vaadin.flow.shared.Registration addFeatureClickListener(com.vaadin.flow.component.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.

      When clustering is enabled, the listener will only be invoked for clicks on individual features. Use addClusterClickListener(ComponentEventListener) to listen for clicks on clusters.

      Parameters:
      listener - the listener to trigger
      Returns:
      registration for the listener
      See Also:

    • addClusterClickListener

      public com.vaadin.flow.shared.Registration addClusterClickListener(com.vaadin.flow.component.ComponentEventListener<MapClusterClickEvent> listener)
      Adds a click listener for clusters of features. The listener will be invoked for a click on any cluster, in any feature layer. Use addFeatureClickListener(ComponentEventListener) to listen for clicks on individual features.
      Parameters:
      listener - the listener to trigger
      Returns:
      registration for the listener

    • addFeatureDropListener

      public com.vaadin.flow.shared.Registration addFeatureDropListener(com.vaadin.flow.component.ComponentEventListener<MapFeatureDropEvent> listener)
      Adds an event listener for when a feature is dropped after a drag operation. Features can be made draggable by setting Feature.setDraggable(boolean).
      Parameters:
      listener - the listener to trigger
      Returns:
      registration for the listener
      See Also: