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

Class Feature

java.lang.Object

io.jmix.mapsflowui.kit.component.model.MapObservableObject

io.jmix.mapsflowui.kit.component.model.feature.Feature

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LineStringFeature, MarkerFeature, MultiLineStringFeature, MultiMarkerFeature, MultiPointFeature, MultiPolygonFeature, PointFeature, PolygonFeature

public abstract class Feature
extends MapObservableObject

Abstract class for vector object for geographic features with a geometry.

For more details see: Feature docs

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

MapObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected SimpleGeometry<?>	geometry
protected Map<String,Object>	properties
protected List<Style>	styles

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
Feature(SimpleGeometry<?> geometry)

Method Summary

Modifier and Type	Method	Description
void	addStyles(Style... styles)	Adds style to the feature.
SimpleGeometry	getGeometry()
Map<String,Object>	getProperties()
List<Style>	getStyles()
protected String	getType()
void	removeAllProperties()	Removes all properties from the feature.
void	removeAllStyles()	Removes all added styles from feature.
void	removeProperty(String name)	Removes property from the feature.
void	removeStyles(Style... styles)	Removes styles from feature.
Feature	withProperties(Map<String,Object> properties)	Sets the properties that will be associated with the feature.
Feature	withProperty(String name, Object value)	Sets the property that will be associated with the feature.
Feature	withStyles(Style... styles)	See addStyles(Style...).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

addChild, addListener, clearRemovedChildren, clearRemovedChildrenInDepth, equals, fireChangeEvent, getChildren, getEventBus, getMetaProperties, getRemovedChildren, getSyncId, hashCode, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setMapObjectChangeListener, setMetaProperty, setParent, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

geometry

protected SimpleGeometry<?> geometry

styles

protected List<Style> styles

properties

protected Map<String,Object> properties

Constructor Details

Feature

public Feature(SimpleGeometry<?> geometry)

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getGeometry

public SimpleGeometry getGeometry()

Returns:

feature's geometry

getStyles

public List<Style> getStyles()

Returns:

list of added styles or empty list if no styles added

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.

Parameters:

styles - styles to add

withStyles

public Feature withStyles(Style... styles)

See addStyles(Style...).

Parameters:

styles - styles to add

Returns:

current instance

removeStyles

public void removeStyles(Style... styles)

Removes styles from feature.

Parameters:

styles - styles to remove

removeAllStyles

public void removeAllStyles()

Removes all added styles from feature.

getProperties

public Map<String,Object> getProperties()

withProperties

public Feature withProperties(Map<String,Object> properties)

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);
 });
 

Parameters:

properties - properties to set

Returns:

current instance

withProperty

public Feature withProperty(String name,
 Object value)

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);
 });
 

Parameters:

name - property name

value - value

Returns:

current instance

removeProperty

public void removeProperty(String name)

Removes property from the feature.

Parameters:

name - property name to remove

removeAllProperties

public void removeAllProperties()

Removes all properties from the feature.