Package io.jmix.mapsflowui.component.model.feature

Class MarkerFeature

java.lang.Object
io.jmix.mapsflowui.kit.component.model.MapObservableObject
io.jmix.mapsflowui.kit.component.model.feature.Feature
io.jmix.mapsflowui.component.model.feature.MarkerFeature
All Implemented Interfaces:
FeatureClickNotifier<MarkerFeature>, Serializable
public class MarkerFeature extends Feature implements FeatureClickNotifier<MarkerFeature>
Marker feature with predefined PointGeometry. It is displayed with marker icon in a map component.

Usage example: 

 protected void addMarker(VectorSource source) {
     Point point = GeometryUtils.createPoint(-0.12081, 51.51592);
     source.addFeature(new MarkerFeature(point));
 }
See Also:

  • Constructor Details

    • MarkerFeature

      public MarkerFeature(org.locationtech.jts.geom.Point point)

  • Method Details

    • getGeometry

      public PointGeometry getGeometry()
      Overrides:
      getGeometry in class Feature
      Returns:
      feature's geometry

    • getPoint

      public org.locationtech.jts.geom.Point getPoint()
      Returns:
      point from feature's geometry getGeometry()

    • setPoint

      public void setPoint(org.locationtech.jts.geom.Point point)
      Sets point to the feature's geometry.
      Parameters:
      point - point to set

    • addStyles

      public void addStyles(Style... styles)
      Adds style to the feature. Note, if the feature contains custom styles, the default styles or added ones to the layer won't be applied to this feature. And you have to provide fully described style to the specific feature.

      MarkerFeature by default contains icon style. If you want to change icon, at first remove default style using Feature.removeAllStyles() and then add new one.

      If it is need to apply additional style, just add a new one. For instance: 

       new MarkerFeature(GeometryUtils.createPoint(13.511928527176917, 52.36486800974413))
         .withStyles(new MarkerStyle()
                 .withText(new TextStyle()
                         .withText("Departure")
                         .withOffsetY(10))
                  .build());
      Overrides:
      addStyles in class Feature
      Parameters:
      styles - styles to add

    • withStyles

      public MarkerFeature withStyles(Style... styles)
      See addStyles(Style...).
      Overrides:
      withStyles in class Feature
      Parameters:
      styles - styles to add
      Returns:
      current instance

    • withProperties

      public MarkerFeature withProperties(Map<String,Object> properties)
      Description copied from class: Feature
      Sets the properties that will be associated with the feature.

      For instance, if cluster specified weight property it will try to get it from the feature's properties. The same with heatmap when it is specified its weight property.

      Another example of using feature's properties is listening click events in source. For instance: 

       vectorSource.addSourceFeatureClickListener(event -> {
     Feature feature = event.getFeature();
     String description = (String) feature.getProperties().get("description");
     notifications.show(description);
 });
      Overrides:
      withProperties in class Feature
      Parameters:
      properties - properties to set
      Returns:
      current instance

    • withProperty

      public MarkerFeature withProperty(String name, Object value)
      Description copied from class: Feature
      Sets the property that will be associated with the feature.

      For instance, if cluster specified weight property it will try to get it from the feature's properties. The same with heatmap when it is specified its weight property.

      Another example of using feature's properties is listening click events in source. For instance: 

       vectorSource.addSourceFeatureClickListener(event -> {
     Feature feature = event.getFeature();
     String description = (String) feature.getProperties().get("description");
     notifications.show(description);
 });
      Overrides:
      withProperty in class Feature
      Parameters:
      name - property name
      value - value
      Returns:
      current instance

    • addClickListener

      public com.vaadin.flow.shared.Registration addClickListener(Consumer<FeatureClickNotifier.FeatureClickEvent<MarkerFeature>> listener)
      Description copied from interface: FeatureClickNotifier
      Adds feature click listener. Note, if the user makes double click on a feature, the FeatureClickNotifier.FeatureClickEvent will be fired twice.
      Specified by:
      addClickListener in interface FeatureClickNotifier<MarkerFeature>
      Parameters:
      listener - listener to add
      Returns:
      a registration object for removing an event listener

    • addSingleClickListener

      public com.vaadin.flow.shared.Registration addSingleClickListener(Consumer<FeatureClickNotifier.FeatureSingleClickEvent<MarkerFeature>> listener)
      Description copied from interface: FeatureClickNotifier
      Adds feature single click listener. Single click means that an event won't be fired if the user makes double click.
      Specified by:
      addSingleClickListener in interface FeatureClickNotifier<MarkerFeature>
      Parameters:
      listener - listener to add
      Returns:
      a registration object for removing an event listener

    • addDoubleClickListener

      public com.vaadin.flow.shared.Registration addDoubleClickListener(Consumer<FeatureClickNotifier.FeatureDoubleClickEvent<MarkerFeature>> listener)
      Description copied from interface: FeatureClickNotifier
      Adds feature double click listener.
      Specified by:
      addDoubleClickListener in interface FeatureClickNotifier<MarkerFeature>
      Parameters:
      listener - listener to add
      Returns:
      a registration object for removing an event listener