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

Class NoOpClusterSource

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.AbstractClusterSource

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

All Implemented Interfaces:

AbstractClusterSource.HasClusterSourceOptions, AbstractClusterSource.HasDisableAtZoom, AbstractClusterSource.HasDistance, AbstractClusterSource.HasMinDistance, AbstractClusterSource.HasPointStyle, AbstractClusterSource.HasPointTextStyle, AbstractClusterSource.HasShowSinglePointAsCluster, AbstractClusterSource.HasVectorSource, AbstractClusterSource.HasWeightProperty, Source.HasAttributions, Source.HasWrapX, Serializable

public class NoOpClusterSource
extends AbstractClusterSource
implements AbstractClusterSource.HasClusterSourceOptions, Source.HasAttributions, Source.HasWrapX

INTERNAL.

Stub implementation, do not use in application. Used by Jmix Studio for showing preview.

See Also:

• Serialized Form

Nested Class Summary

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

AbstractClusterSource.HasClusterSourceOptions, AbstractClusterSource.HasDisableAtZoom, AbstractClusterSource.HasDistance, AbstractClusterSource.HasMinDistance, AbstractClusterSource.HasPointStyle, AbstractClusterSource.HasPointTextStyle, AbstractClusterSource.HasShowSinglePointAsCluster, AbstractClusterSource.HasVectorSource, AbstractClusterSource.HasWeightProperty

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

Field Summary

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

disableAtZoom, distance, minDistance, pointStyles, pointTextStyle, showSinglePointAsCluster, vectorSource, weightProperty

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
NoOpClusterSource()

Method Summary

Modifier and Type	Method	Description
void	addPointStyles(Style... styles)	Adds cluster point style.
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
Double	getDisableAtZoom()
Integer	getDistance()
Integer	getMinDistance()
List<Style>	getPointStyles()
Style	getPointTextStyle()
Boolean	getShowSinglePointAsCluster()
<T extends AbstractVectorSource> T	getVectorSource()
String	getWeightProperty()
Boolean	getWrapX()	Source.HasWrapX.getWrapX()
void	removeAllPointStyles()	Removes all added cluster point styles.
void	removePointStyles(Style... styles)	Removes cluster point styles.
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setDisableAtZoom(Double disableAtZoom)	Sets zoom level from which clustering will be disabled.
void	setDistance(Integer distance)	Sets the distance within which features will be clustered together.
void	setMinDistance(Integer minDistance)	Sets the minimum distance in pixels between clusters that will be capped at the configured distance.
void	setPointTextStyle(Style pointTextStyle)	Sets the text style of cluster marker.
void	setShowSinglePointAsCluster(Boolean showSinglePointAsCluster)	Enables to show not clustered feature (single point, marker, etc.) as a cluster marker of 1 size.
void	setVectorSource(AbstractVectorSource vectorSource)	Sets vector source.
void	setWeightProperty(String weightProperty)	Sets weight property that is defined in a feature or in an entity.
void	setWrapX(Boolean wrapX)	Source.HasWrapX.setWrapX(Boolean)

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

createDefaultPointStyles, createDefaultPointTextStyle, getType

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

getOverlaps, getUseSpatialIndex, setOverlaps, setUseSpatialIndex

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

NoOpClusterSource

public NoOpClusterSource()

Method Details

getDistance

public Integer getDistance()

Specified by:

getDistance in interface AbstractClusterSource.HasDistance

Overrides:

getDistance in class AbstractClusterSource

Returns:

the distance or null if not set

setDistance

public void setDistance(Integer distance)

Description copied from interface: AbstractClusterSource.HasDistance

Sets the distance within which features will be clustered together. If not defined distance with 20 pixels will be used.

For more details see: setDistance() docs

Specified by:

setDistance in interface AbstractClusterSource.HasDistance

Overrides:

setDistance in class AbstractClusterSource

Parameters:

distance - distance in pixels

getMinDistance

public Integer getMinDistance()

Specified by:

getMinDistance in interface AbstractClusterSource.HasMinDistance

Overrides:

getMinDistance in class AbstractClusterSource

Returns:

the minimum distance in pixels or null if not set

setMinDistance

public void setMinDistance(Integer minDistance)

Description copied from interface: AbstractClusterSource.HasMinDistance

Sets the minimum distance in pixels between clusters that will be capped at the configured distance. By default, no minimum distance is guaranteed. This config can be used to avoid overlapping icons. As a tradeoff, the cluster feature's position will no longer be the center of all its features.

For more details see: setMinDistance() docs

Specified by:

setMinDistance in interface AbstractClusterSource.HasMinDistance

Overrides:

setMinDistance in class AbstractClusterSource

Parameters:

minDistance - minimum distance in pixels between clusters

getVectorSource

public <T extends AbstractVectorSource> T getVectorSource()

Specified by:

getVectorSource in interface AbstractClusterSource.HasVectorSource

Overrides:

getVectorSource in class AbstractClusterSource

Type Parameters:

T - vector source type

Returns:

vector source or null if not set

setVectorSource

public void setVectorSource(AbstractVectorSource vectorSource)

Description copied from interface: AbstractClusterSource.HasVectorSource

Sets vector source.

Specified by:

setVectorSource in interface AbstractClusterSource.HasVectorSource

Overrides:

setVectorSource in class AbstractClusterSource

Parameters:

vectorSource - vector source to set

getAttributions

public List<String> getAttributions()

Description copied from class: Source

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)

Description copied from class: Source

Source.HasAttributions.setAttributions(List)

Specified by:

setAttributions in interface Source.HasAttributions

Overrides:

setAttributions in class Source

Parameters:

attributions - info about copyrights and licences

getWrapX

public Boolean getWrapX()

Description copied from class: Source

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)

Description copied from class: Source

Source.HasWrapX.setWrapX(Boolean)

Specified by:

setWrapX in interface Source.HasWrapX

Overrides:

setWrapX in class Source

Parameters:

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

getPointTextStyle

public Style getPointTextStyle()

Specified by:

getPointTextStyle in interface AbstractClusterSource.HasPointTextStyle

Overrides:

getPointTextStyle in class AbstractClusterSource

Returns:

the text style of cluster marker

setPointTextStyle

public void setPointTextStyle(Style pointTextStyle)

Description copied from interface: AbstractClusterSource.HasPointTextStyle

Sets the text style of cluster marker. For instance, default text style is defined by the following:

 clusterSource.setPointTextStyle(
     new Style()
             .withText(new TextStyle()
                     .withFont("12px sans-serif")
                     .withOffsetY(1)
                     .withFill(new Fill("#fff"))));
 

Specified by:

setPointTextStyle in interface AbstractClusterSource.HasPointTextStyle

Overrides:

setPointTextStyle in class AbstractClusterSource

Parameters:

pointTextStyle - text style to set

getPointStyles

public List<Style> getPointStyles()

Specified by:

getPointStyles in interface AbstractClusterSource.HasPointStyle

Overrides:

getPointStyles in class AbstractClusterSource

Returns:

list of added cluster point styles or empty list if no styles added

addPointStyles

public void addPointStyles(Style... styles)

Description copied from class: AbstractClusterSource

Adds cluster point style. The Cluster generates points that includes features in this cluster. Styles will be applied only for generated points, other features will be styled according to their rules.

Specified by:

addPointStyles in interface AbstractClusterSource.HasPointStyle

Overrides:

addPointStyles in class AbstractClusterSource

Parameters:

styles - cluster point styles to add

removePointStyles

public void removePointStyles(Style... styles)

Description copied from class: AbstractClusterSource

Removes cluster point styles.

Specified by:

removePointStyles in interface AbstractClusterSource.HasPointStyle

Overrides:

removePointStyles in class AbstractClusterSource

Parameters:

styles - styles to remove

removeAllPointStyles

public void removeAllPointStyles()

Description copied from class: AbstractClusterSource

Removes all added cluster point styles.

Specified by:

removeAllPointStyles in interface AbstractClusterSource.HasPointStyle

Overrides:

removeAllPointStyles in class AbstractClusterSource

getWeightProperty

public String getWeightProperty()

Specified by:

getWeightProperty in interface AbstractClusterSource.HasWeightProperty

Overrides:

getWeightProperty in class AbstractClusterSource

Returns:

weight property or null if not set

setWeightProperty

public void setWeightProperty(String weightProperty)

Description copied from interface: AbstractClusterSource.HasWeightProperty

Sets weight property that is defined in a feature or in an entity. This property should contain value that will be used when calculating the summed up value of the cluster (by default, the number of points is used).

Specified by:

setWeightProperty in interface AbstractClusterSource.HasWeightProperty

Overrides:

setWeightProperty in class AbstractClusterSource

Parameters:

weightProperty - property in a feature or in an entity

getShowSinglePointAsCluster

public Boolean getShowSinglePointAsCluster()

Specified by:

getShowSinglePointAsCluster in interface AbstractClusterSource.HasShowSinglePointAsCluster

Overrides:

getShowSinglePointAsCluster in class AbstractClusterSource

Returns:

true if feature is shown as a cluster marker of 1 size or null if not set

setShowSinglePointAsCluster

public void setShowSinglePointAsCluster(Boolean showSinglePointAsCluster)

Description copied from interface: AbstractClusterSource.HasShowSinglePointAsCluster

Enables to show not clustered feature (single point, marker, etc.) as a cluster marker of 1 size. Default value is false.

Specified by:

setShowSinglePointAsCluster in interface AbstractClusterSource.HasShowSinglePointAsCluster

Overrides:

setShowSinglePointAsCluster in class AbstractClusterSource

Parameters:

showSinglePointAsCluster - whether to show feature as a cluster marker of 1 size

getDisableAtZoom

public Double getDisableAtZoom()

Specified by:

getDisableAtZoom in interface AbstractClusterSource.HasDisableAtZoom

Overrides:

getDisableAtZoom in class AbstractClusterSource

Returns:

zoom level or null if not set

setDisableAtZoom

public void setDisableAtZoom(Double disableAtZoom)

Description copied from interface: AbstractClusterSource.HasDisableAtZoom

Sets zoom level from which clustering will be disabled.

Specified by:

setDisableAtZoom in interface AbstractClusterSource.HasDisableAtZoom

Overrides:

setDisableAtZoom in class AbstractClusterSource

Parameters:

disableAtZoom - zoom level from which clustering will be disabled