Package com.vaadin.componentfactory.maps

Class Map

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.componentfactory.maps.Map
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, Serializable
@Tag("vcf-map") @NpmPackage(value="highcharts", version="9.2.2") @JsModule("./vaadin-map.js") public class Map extends com.vaadin.flow.component.Component implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle

Map class.

Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Map()
    Constructor for Map.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addCheckBoxClickListener(com.vaadin.flow.component.ComponentEventListener<SeriesCheckboxClickEvent> listener)
    Adds checkbox click listener, which will be notified when user has clicked a checkbox in the legend
    com.vaadin.flow.shared.Registration
    addDrilldownListener(com.vaadin.flow.component.ComponentEventListener<DrilldownEvent> listener)
    Sets the Map drilldown handler that's responsible for returning the drilldown series for each drilldown callback when doing async drilldown
    com.vaadin.flow.shared.Registration
    addMapAddSeriesListener(com.vaadin.flow.component.ComponentEventListener<MapAddSeriesEvent> listener)
    Adds a map add series listener, which will be notified after a new series is added to the map
    com.vaadin.flow.shared.Registration
    addMapAfterPrintListener(com.vaadin.flow.component.ComponentEventListener<MapAfterPrintEvent> listener)
    Adds a map after print listener, which will be notified after the map is printed using the print menu
    com.vaadin.flow.shared.Registration
    addMapBeforePrintListener(com.vaadin.flow.component.ComponentEventListener<MapBeforePrintEvent> listener)
    Adds a map before print listener, which will be notified before the map is printed using the print menu
    com.vaadin.flow.shared.Registration
    addMapClickListener(com.vaadin.flow.component.ComponentEventListener<MapClickEvent> listener)
    Adds map click listener, which will be notified of clicks on the map area
    com.vaadin.flow.shared.Registration
    addMapDrillupAllListener(com.vaadin.flow.component.ComponentEventListener<MapDrillupAllEvent> listener)
    Adds map drillupall listener, which will be notified after all the series have been drilled up in a map with multiple drilldown series.
    com.vaadin.flow.shared.Registration
    addMapDrillupListener(com.vaadin.flow.component.ComponentEventListener<MapDrillupEvent> listener)
    Adds map drillup listener, which will be notified of clicks on the 'Back to previous series' button.
    com.vaadin.flow.shared.Registration
    addMapLoadListener(com.vaadin.flow.component.ComponentEventListener<MapLoadEvent> listener)
    Adds a map load listener, which will be notified after a map is loaded
    com.vaadin.flow.shared.Registration
    addMapRedrawListener(com.vaadin.flow.component.ComponentEventListener<MapRedrawEvent> listener)
    Adds a map redraw listener, which will be notified after a map is redrawn
    com.vaadin.flow.shared.Registration
    addMapSelectionListener(com.vaadin.flow.component.ComponentEventListener<MapSelectionEvent> listener)
    Adds a map selection listener
    com.vaadin.flow.shared.Registration
    addPointClickListener(com.vaadin.flow.component.ComponentEventListener<PointClickEvent> listener)
    Adds a point click listener, which will be notified of clicks on the points, bars or columns in the map
    com.vaadin.flow.shared.Registration
    addPointLegendItemClickListener(com.vaadin.flow.component.ComponentEventListener<PointLegendItemClickEvent> listener)
    Adds a point legend item click listener, which will be notified of clicks on the legend's items corresponding to a Point
    com.vaadin.flow.shared.Registration
    addPointMouseOutListener(com.vaadin.flow.component.ComponentEventListener<PointMouseOutEvent> listener)
    Adds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a data point
    com.vaadin.flow.shared.Registration
    addPointMouseOverListener(com.vaadin.flow.component.ComponentEventListener<PointMouseOverEvent> listener)
    Adds a point mouse over listener, which will be notified when the mouse enters the neighborhood of a data point
    com.vaadin.flow.shared.Registration
    addPointRemoveListener(com.vaadin.flow.component.ComponentEventListener<PointRemoveEvent> listener)
    Adds a point remove listener, which will be notified when a data point is removed.
    com.vaadin.flow.shared.Registration
    addPointSelectListener(com.vaadin.flow.component.ComponentEventListener<PointSelectEvent> listener)
    Adds a point select listener, which will be notified when a data point is selected.
    com.vaadin.flow.shared.Registration
    addPointUnselectListener(com.vaadin.flow.component.ComponentEventListener<PointUnselectEvent> listener)
    Adds a point unselect listener, which will be notified when a data point is unselected.
    com.vaadin.flow.shared.Registration
    addPointUpdateListener(com.vaadin.flow.component.ComponentEventListener<PointUpdateEvent> listener)
    Adds a point update listener, which will be notified when a data point is updated.
    com.vaadin.flow.shared.Registration
    addSeriesAfterAnimateListener(com.vaadin.flow.component.ComponentEventListener<SeriesAfterAnimateEvent> listener)
    Adds a series after animate listener, which will be notified after a series is animated
    void
    addSeriesAsDrilldown(String pointId, MapDataSeries series)
    addSeriesAsDrilldown.
    com.vaadin.flow.shared.Registration
    addSeriesClickListener(com.vaadin.flow.component.ComponentEventListener<SeriesClickEvent> listener)
    Adds a series click listener, which will be notified of clicks on the series in the map
    com.vaadin.flow.shared.Registration
    addSeriesHideListener(com.vaadin.flow.component.ComponentEventListener<SeriesHideEvent> listener)
    Adds a series hide listener, which will be notified when a series is hidden
    com.vaadin.flow.shared.Registration
    addSeriesLegendItemClickListener(com.vaadin.flow.component.ComponentEventListener<SeriesLegendItemClickEvent> listener)
    Adds a series legend item click listener, which will be notified of clicks on the legend's items corresponding to a Series
    com.vaadin.flow.shared.Registration
    addSeriesMouseOutListener(com.vaadin.flow.component.ComponentEventListener<SeriesMouseOutEvent> listener)
    Adds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a series
    com.vaadin.flow.shared.Registration
    addSeriesMouseOverListener(com.vaadin.flow.component.ComponentEventListener<SeriesMouseOverEvent> listener)
    Adds a point mouse out listener, which will be notified when the mouse enters the neighborhood of a series
    com.vaadin.flow.shared.Registration
    addSeriesShowListener(com.vaadin.flow.component.ComponentEventListener<SeriesShowEvent> listener)
    Adds a series show listener, which will be notified when a series is shown
    com.vaadin.flow.shared.Registration
    addXAxesExtremesSetListener(com.vaadin.flow.component.ComponentEventListener<XAxesExtremesSetEvent> listener)
    Adds a x axes extremes set listener, which will be notified when an x axis extremes are set
    com.vaadin.flow.shared.Registration
    addYAxesExtremesSetListener(com.vaadin.flow.component.ComponentEventListener<YAxesExtremesSetEvent> listener)
    Adds a y axes extremes set listener, which will be notified when an y axis extremes are set
    void
    drawMap(boolean resetConfiguration)
    drawMap.
    Configuration
    getConfiguration()
    Getter for the field configuration.
    protected void
    onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
    void
    setVisibilityTogglingDisabled(boolean disabled)
    The series or point visibility is toggled by default if user clicks the legend item that corresponds to the series or point.

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

    addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, 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

    bindHeight, bindWidth, 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, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Constructor Details

    • Map

      public Map()

      Constructor for Map.

  • Method Details

    • onAttach

      protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
      Overrides:
      onAttach in class com.vaadin.flow.component.Component

    • drawMap

      public void drawMap(boolean resetConfiguration)

      drawMap.

      Parameters:
      resetConfiguration - a boolean.

    • setVisibilityTogglingDisabled

      public void setVisibilityTogglingDisabled(boolean disabled)
      The series or point visibility is toggled by default if user clicks the legend item that corresponds to the series or point. Calling setVisibilityTogglingDisabled( true) will disable this behavior.
      Parameters:
      disabled - a boolean.

    • getConfiguration

      public Configuration getConfiguration()

      Getter for the field configuration.

      Returns:
      the map configuration that is used for this map

    • addMapAddSeriesListener

      public com.vaadin.flow.shared.Registration addMapAddSeriesListener(com.vaadin.flow.component.ComponentEventListener<MapAddSeriesEvent> listener)
      Adds a map add series listener, which will be notified after a new series is added to the map
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addMapAfterPrintListener

      public com.vaadin.flow.shared.Registration addMapAfterPrintListener(com.vaadin.flow.component.ComponentEventListener<MapAfterPrintEvent> listener)
      Adds a map after print listener, which will be notified after the map is printed using the print menu
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addMapBeforePrintListener

      public com.vaadin.flow.shared.Registration addMapBeforePrintListener(com.vaadin.flow.component.ComponentEventListener<MapBeforePrintEvent> listener)
      Adds a map before print listener, which will be notified before the map is printed using the print menu
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addMapClickListener

      public com.vaadin.flow.shared.Registration addMapClickListener(com.vaadin.flow.component.ComponentEventListener<MapClickEvent> listener)
      Adds map click listener, which will be notified of clicks on the map area
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addMapDrillupListener

      public com.vaadin.flow.shared.Registration addMapDrillupListener(com.vaadin.flow.component.ComponentEventListener<MapDrillupEvent> listener)
      Adds map drillup listener, which will be notified of clicks on the 'Back to previous series' button.
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addMapDrillupAllListener

      public com.vaadin.flow.shared.Registration addMapDrillupAllListener(com.vaadin.flow.component.ComponentEventListener<MapDrillupAllEvent> listener)
      Adds map drillupall listener, which will be notified after all the series have been drilled up in a map with multiple drilldown series.
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addMapLoadListener

      public com.vaadin.flow.shared.Registration addMapLoadListener(com.vaadin.flow.component.ComponentEventListener<MapLoadEvent> listener)
      Adds a map load listener, which will be notified after a map is loaded
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addMapRedrawListener

      public com.vaadin.flow.shared.Registration addMapRedrawListener(com.vaadin.flow.component.ComponentEventListener<MapRedrawEvent> listener)
      Adds a map redraw listener, which will be notified after a map is redrawn
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addCheckBoxClickListener

      public com.vaadin.flow.shared.Registration addCheckBoxClickListener(com.vaadin.flow.component.ComponentEventListener<SeriesCheckboxClickEvent> listener)
      Adds checkbox click listener, which will be notified when user has clicked a checkbox in the legend
      Parameters:
      listener - event listener
      Returns:
      a Registration object.

    • addDrilldownListener

      public com.vaadin.flow.shared.Registration addDrilldownListener(com.vaadin.flow.component.ComponentEventListener<DrilldownEvent> listener)
      Sets the Map drilldown handler that's responsible for returning the drilldown series for each drilldown callback when doing async drilldown
      Parameters:
      listener - event listener
      Returns:
      a Registration object.
      See Also:

    • addMapSelectionListener

      public com.vaadin.flow.shared.Registration addMapSelectionListener(com.vaadin.flow.component.ComponentEventListener<MapSelectionEvent> listener)
      Adds a map selection listener

      Note that if a map selection listener is set, default action for selection is prevented. Most commonly this means that client side zoom doesn't work and you are responsible for setting the zoom, etc in the listener implementation.

      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addSeriesLegendItemClickListener

      public com.vaadin.flow.shared.Registration addSeriesLegendItemClickListener(com.vaadin.flow.component.ComponentEventListener<SeriesLegendItemClickEvent> listener)
      Adds a series legend item click listener, which will be notified of clicks on the legend's items corresponding to a Series

      Note that by default, clicking on a legend item toggles the visibility of its associated series. To disable this behavior call setVisibilityTogglingDisabled(true)

      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.
      See Also:

    • addPointLegendItemClickListener

      public com.vaadin.flow.shared.Registration addPointLegendItemClickListener(com.vaadin.flow.component.ComponentEventListener<PointLegendItemClickEvent> listener)
      Adds a point legend item click listener, which will be notified of clicks on the legend's items corresponding to a Point

      Note that by default, clicking on a legend item toggles the visibility of its associated point. To disable this behavior call setVisibilityTogglingDisabled(true)

      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.
      See Also:

    • addSeriesAfterAnimateListener

      public com.vaadin.flow.shared.Registration addSeriesAfterAnimateListener(com.vaadin.flow.component.ComponentEventListener<SeriesAfterAnimateEvent> listener)
      Adds a series after animate listener, which will be notified after a series is animated
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addSeriesClickListener

      public com.vaadin.flow.shared.Registration addSeriesClickListener(com.vaadin.flow.component.ComponentEventListener<SeriesClickEvent> listener)
      Adds a series click listener, which will be notified of clicks on the series in the map
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addSeriesHideListener

      public com.vaadin.flow.shared.Registration addSeriesHideListener(com.vaadin.flow.component.ComponentEventListener<SeriesHideEvent> listener)
      Adds a series hide listener, which will be notified when a series is hidden
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addSeriesMouseOutListener

      public com.vaadin.flow.shared.Registration addSeriesMouseOutListener(com.vaadin.flow.component.ComponentEventListener<SeriesMouseOutEvent> listener)
      Adds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a series
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addSeriesMouseOverListener

      public com.vaadin.flow.shared.Registration addSeriesMouseOverListener(com.vaadin.flow.component.ComponentEventListener<SeriesMouseOverEvent> listener)
      Adds a point mouse out listener, which will be notified when the mouse enters the neighborhood of a series
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addSeriesShowListener

      public com.vaadin.flow.shared.Registration addSeriesShowListener(com.vaadin.flow.component.ComponentEventListener<SeriesShowEvent> listener)
      Adds a series show listener, which will be notified when a series is shown
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addPointClickListener

      public com.vaadin.flow.shared.Registration addPointClickListener(com.vaadin.flow.component.ComponentEventListener<PointClickEvent> listener)
      Adds a point click listener, which will be notified of clicks on the points, bars or columns in the map
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addPointMouseOutListener

      public com.vaadin.flow.shared.Registration addPointMouseOutListener(com.vaadin.flow.component.ComponentEventListener<PointMouseOutEvent> listener)
      Adds a point mouse out listener, which will be notified when the mouse exits the neighborhood of a data point
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addPointMouseOverListener

      public com.vaadin.flow.shared.Registration addPointMouseOverListener(com.vaadin.flow.component.ComponentEventListener<PointMouseOverEvent> listener)
      Adds a point mouse over listener, which will be notified when the mouse enters the neighborhood of a data point
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addPointRemoveListener

      public com.vaadin.flow.shared.Registration addPointRemoveListener(com.vaadin.flow.component.ComponentEventListener<PointRemoveEvent> listener)
      Adds a point remove listener, which will be notified when a data point is removed.
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addPointSelectListener

      public com.vaadin.flow.shared.Registration addPointSelectListener(com.vaadin.flow.component.ComponentEventListener<PointSelectEvent> listener)
      Adds a point select listener, which will be notified when a data point is selected.
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addPointUnselectListener

      public com.vaadin.flow.shared.Registration addPointUnselectListener(com.vaadin.flow.component.ComponentEventListener<PointUnselectEvent> listener)
      Adds a point unselect listener, which will be notified when a data point is unselected.
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addPointUpdateListener

      public com.vaadin.flow.shared.Registration addPointUpdateListener(com.vaadin.flow.component.ComponentEventListener<PointUpdateEvent> listener)
      Adds a point update listener, which will be notified when a data point is updated.
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addXAxesExtremesSetListener

      public com.vaadin.flow.shared.Registration addXAxesExtremesSetListener(com.vaadin.flow.component.ComponentEventListener<XAxesExtremesSetEvent> listener)
      Adds a x axes extremes set listener, which will be notified when an x axis extremes are set
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addYAxesExtremesSetListener

      public com.vaadin.flow.shared.Registration addYAxesExtremesSetListener(com.vaadin.flow.component.ComponentEventListener<YAxesExtremesSetEvent> listener)
      Adds a y axes extremes set listener, which will be notified when an y axis extremes are set
      Parameters:
      listener - a ComponentEventListener object.
      Returns:
      a Registration object.

    • addSeriesAsDrilldown

      public void addSeriesAsDrilldown(String pointId, MapDataSeries series)

      addSeriesAsDrilldown.

      Parameters:
      pointId - a String object.
      series - a MapDataSeries object.