Package io.jmix.mapsflowui.component.model.source

Class VectorSource

java.lang.Object

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

io.jmix.mapsflowui.kit.component.model.source.Source

io.jmix.mapsflowui.kit.component.model.source.AbstractVectorSource

io.jmix.mapsflowui.kit.component.model.source.AbstractFeatureSource

io.jmix.mapsflowui.component.model.source.VectorSource

All Implemented Interfaces:

SourceFeatureClickNotifier, AbstractVectorSource.HasOverlaps, AbstractVectorSource.HasUseSpatialIndex, AbstractVectorSource.HasVectorSourceOptions, Source.HasAttributions, Source.HasWrapX, Serializable

public class VectorSource
extends AbstractFeatureSource
implements AbstractVectorSource.HasVectorSourceOptions, Source.HasAttributions, Source.HasWrapX, SourceFeatureClickNotifier

Source for working with features. It can be used in VectorLayer.

For more details see: VectorSource docs

See Also:

• VectorLayer
• Serialized Form

Nested Class Summary

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

AbstractVectorSource.HasOverlaps, AbstractVectorSource.HasUseSpatialIndex, AbstractVectorSource.HasVectorSourceOptions

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

Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX

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

MapObservableObject.ObjectChangeEvent

Nested classes/interfaces inherited from interface io.jmix.mapsflowui.component.model.source.SourceFeatureClickNotifier

SourceFeatureClickNotifier.AbstractFeatureClickEvent, SourceFeatureClickNotifier.SourceFeatureClickEvent, SourceFeatureClickNotifier.SourceFeatureDoubleClickEvent, SourceFeatureClickNotifier.SourceFeatureSingleClickEvent

Field Summary

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractFeatureSource

features

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractVectorSource

overlaps, useSpatialIndex

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

attributions, attributionsCollapsible, id, projection, wrapX

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

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

Constructor Summary

Constructors

Constructor	Description
VectorSource()

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addSourceFeatureClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureClickEvent> listener)	Adds feature click listener.
com.vaadin.flow.shared.Registration	addSourceFeatureDoubleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureDoubleClickEvent> listener)	Adds feature double click listener.
com.vaadin.flow.shared.Registration	addSourceFeatureSingleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureSingleClickEvent> listener)	Adds feature single click listener.
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
Boolean	getOverlaps()
protected String	getType()
Boolean	getUseSpatialIndex()
Boolean	getWrapX()	Source.HasWrapX.getWrapX()
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setOverlaps(Boolean overlaps)	Sets whether source may have overlapping geometries.
void	setUseSpatialIndex(Boolean useSpatialIndex)	Sets whether to use spatial index.
void	setWrapX(Boolean wrapX)	Sets whether the source should be looped along the X coordinate.
VectorSource	withAttributions(List<String> attributions)	See setAttributions(List).
VectorSource	withOverlaps(Boolean overlaps)	See setOverlaps(Boolean).
VectorSource	withUseSpatialIndex(Boolean useSpatialIndex)	See setUseSpatialIndex(Boolean).
VectorSource	withWrapX(Boolean wrapX)	See setWrapX(Boolean).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractFeatureSource

addAllFeatures, addFeature, getFeatures, removeAllFeatures, removeFeature

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

getAttributionsCollapsible, getId, getProjection, setAttributionsCollapsible, setId, setProjection

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

Constructor Details

VectorSource

public VectorSource()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getAttributions

public List<String> getAttributions()

Source.HasAttributions.getAttributions()

Specified by:

getAttributions in interface Source.HasAttributions

Overrides:

getAttributions in class Source

Returns:

the attributions of the source or null if not set

setAttributions

public void setAttributions(List<String> attributions)

Source.HasAttributions.setAttributions(List)

Specified by:

setAttributions in interface Source.HasAttributions

Overrides:

setAttributions in class Source

Parameters:

attributions - info about copyrights and licences

withAttributions

public VectorSource withAttributions(List<String> attributions)

See setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

getWrapX

public Boolean getWrapX()

Source.HasWrapX.getWrapX()

Specified by:

getWrapX in interface Source.HasWrapX

Overrides:

getWrapX in class Source

Returns:

whether the source should be looped along the X coordinate or null if not set

setWrapX

public void setWrapX(Boolean wrapX)

Sets whether the source should be looped along the X coordinate. The default value for Source is true.

Note, wrapX attribute is set only at creation time and cannot be changed at runtime. For more details see: VectorSource docs

Specified by:

setWrapX in interface Source.HasWrapX

Overrides:

setWrapX in class Source

Parameters:

wrapX - whether the source should be looped along the X coordinate

withWrapX

public VectorSource withWrapX(Boolean wrapX)

See setWrapX(Boolean).

Parameters:

wrapX - whether the source should be looped along the X coordinate

Returns:

current instance

getOverlaps

public Boolean getOverlaps()

Specified by:

getOverlaps in interface AbstractVectorSource.HasOverlaps

Overrides:

getOverlaps in class AbstractVectorSource

Returns:

overlaps value or null if not set

setOverlaps

public void setOverlaps(Boolean overlaps)

Sets whether source may have overlapping geometries. The default value is true.

Setting this to false (e.g. for sources with polygons that represent administrative boundaries) allows the renderer to optimise fill and stroke operations.

Note, overlaps attribute is set only at creation time and cannot be changed at runtime.

Specified by:

setOverlaps in interface AbstractVectorSource.HasOverlaps

Overrides:

setOverlaps in class AbstractVectorSource

Parameters:

overlaps - overlaps option

withOverlaps

public VectorSource withOverlaps(Boolean overlaps)

See setOverlaps(Boolean).

Parameters:

overlaps - overlaps option

Returns:

current instance

getUseSpatialIndex

public Boolean getUseSpatialIndex()

Specified by:

getUseSpatialIndex in interface AbstractVectorSource.HasUseSpatialIndex

Overrides:

getUseSpatialIndex in class AbstractVectorSource

Returns:

useSpatialIndex value or null if not set

setUseSpatialIndex

public void setUseSpatialIndex(Boolean useSpatialIndex)

Sets whether to use spatial index. When features are removed and added frequently, and the total number of features is low, setting this to false may improve performance. The default value is true.

Specified by:

setUseSpatialIndex in interface AbstractVectorSource.HasUseSpatialIndex

Overrides:

setUseSpatialIndex in class AbstractVectorSource

Parameters:

useSpatialIndex - whether to use spatial index

withUseSpatialIndex

public VectorSource withUseSpatialIndex(Boolean useSpatialIndex)

See setUseSpatialIndex(Boolean).

Parameters:

useSpatialIndex - whether to use spatial index

Returns:

current instance

addSourceFeatureClickListener

public com.vaadin.flow.shared.Registration addSourceFeatureClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureClickEvent> listener)

Adds feature click listener. Note, if the user makes double click on a feature, the SourceFeatureClickNotifier.SourceFeatureClickEvent will be fired twice.

Specified by:

addSourceFeatureClickListener in interface SourceFeatureClickNotifier

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureSingleClickListener

public com.vaadin.flow.shared.Registration addSourceFeatureSingleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureSingleClickEvent> listener)

Adds feature single click listener. Single click means that an event won't be fired if the user makes double click.

Specified by:

addSourceFeatureSingleClickListener in interface SourceFeatureClickNotifier

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureDoubleClickListener

public com.vaadin.flow.shared.Registration addSourceFeatureDoubleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureDoubleClickEvent> listener)

Adds feature double click listener.

Specified by:

addSourceFeatureDoubleClickListener in interface SourceFeatureClickNotifier

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener