Package io.jmix.mapsflowui.kit.component.model.style.image

Class CircleStyle

java.lang.Object

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

io.jmix.mapsflowui.kit.component.model.style.image.ImageStyle

io.jmix.mapsflowui.kit.component.model.style.image.AbstractRegularShape

io.jmix.mapsflowui.kit.component.model.style.image.CircleStyle

All Implemented Interfaces:

Serializable

public class CircleStyle
extends AbstractRegularShape

Circle style for vector features.

For more details see: CircleStyle 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 inherited from class io.jmix.mapsflowui.kit.component.model.style.image.AbstractRegularShape

angle, fill, firstRadius, points, radius, secondRadius, stroke

Fields inherited from class io.jmix.mapsflowui.kit.component.model.style.image.ImageStyle

declutterMode, displacement, opacity, rotateWithView, rotation, scale, scaleSize

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

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

Constructor Summary

Constructors

Constructor	Description
CircleStyle()

Method Summary

Modifier and Type	Method	Description
DeclutterMode	getDeclutterMode()
Displacement	getDisplacement()
Fill	getFill()
Integer	getRadius()
Boolean	getRotateWithView()
Double	getRotation()
Double	getScale()
Size	getScaleSize()
Stroke	getStroke()
protected String	getType()
void	setDeclutterMode(DeclutterMode declutterMode)	Sets declutter mode.
void	setDisplacement(Displacement displacement)	Sets the displacement.
void	setFill(Fill fill)	Sets fill object that describes which color should be used for filling shape.
void	setRadius(Integer radius)	Sets the circle radius.
void	setRotateWithView(Boolean rotateWithView)	Sets whether to rotate the shape with the map view (meaningful only when used in conjunction with a two-dimensional scale).
void	setRotation(Double rotation)	Sets rotation in radians (positive rotation clockwise, meaningful only when used in conjunction with a two-dimensional scale).
void	setScale(Double scale)	Sets the scale.
void	setScaleSize(Size scaleSize)	Sets the scale size.
void	setStroke(Stroke stroke)	Sets stroke style for regular shape.
CircleStyle	withDeclutterMode(DeclutterMode declutterMode)	See setDeclutterMode(DeclutterMode).
CircleStyle	withDisplacement(Displacement displacement)
CircleStyle	withFill(Fill fill)	See setFill(Fill).
CircleStyle	withRadius(Integer radius)	See setRadius(Integer).
CircleStyle	withRotateWithView(Boolean rotateWithView)	See setRotateWithView(Boolean).
CircleStyle	withRotation(Double rotation)	See setRotation(Double).
CircleStyle	withScale(Double scale)	See setScale(Double).
CircleStyle	withScaleSize(Size scaleSize)	See setScaleSize(Size).
CircleStyle	withStroke(Stroke stroke)	See setStroke(Stroke).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.style.image.AbstractRegularShape

getAngle, getFirstRadius, getPoints, getSecondRadius, setAngle, setFirstRadius, setPoints, setSecondRadius

Methods inherited from class io.jmix.mapsflowui.kit.component.model.style.image.ImageStyle

getOpacity, setOpacity

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, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Constructor Details

CircleStyle

public CircleStyle()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getFill

public Fill getFill()

Overrides:

getFill in class AbstractRegularShape

Returns:

fill style or null if not set

setFill

public void setFill(Fill fill)

Sets fill object that describes which color should be used for filling shape.

For more details see: setFill() docs

Overrides:

setFill in class AbstractRegularShape

Parameters:

fill - fill to set

withFill

public CircleStyle withFill(Fill fill)

See setFill(Fill).

Parameters:

fill - fill to set

Returns:

current instance

getRadius

public Integer getRadius()

Overrides:

getRadius in class AbstractRegularShape

Returns:

circle radius or null if not set

setRadius

public void setRadius(Integer radius)

Sets the circle radius.

For more details see: setRadius() docs

Overrides:

setRadius in class AbstractRegularShape

Parameters:

radius - radius value

withRadius

public CircleStyle withRadius(Integer radius)

See setRadius(Integer).

Parameters:

radius - radius value

Returns:

current instance

getStroke

public Stroke getStroke()

Overrides:

getStroke in class AbstractRegularShape

Returns:

stroke style or null if not set

setStroke

public void setStroke(Stroke stroke)

Sets stroke style for regular shape. It describes line styling: width, color, dash, etc.

For more details see: setStroke() docs

Overrides:

setStroke in class AbstractRegularShape

Parameters:

stroke - stroke style

withStroke

public CircleStyle withStroke(Stroke stroke)

See setStroke(Stroke).

Parameters:

stroke - stroke style

Returns:

current instance

getRotateWithView

public Boolean getRotateWithView()

Overrides:

getRotateWithView in class ImageStyle

Returns:

whether the image should get rotated with the map view or null if not set

setRotateWithView

public void setRotateWithView(Boolean rotateWithView)

Sets whether to rotate the shape with the map view (meaningful only when used in conjunction with a two-dimensional scale). The default value is false.

For more details see: setRotateWithView() docs

Overrides:

setRotateWithView in class ImageStyle

Parameters:

rotateWithView - whether the shape should be rotated

withRotateWithView

public CircleStyle withRotateWithView(Boolean rotateWithView)

See setRotateWithView(Boolean).

Parameters:

rotateWithView - whether the shape should be rotated

Returns:

current instance

getRotation

public Double getRotation()

Overrides:

getRotation in class ImageStyle

Returns:

rotation value or null if not set

setRotation

public void setRotation(Double rotation)

Sets rotation in radians (positive rotation clockwise, meaningful only when used in conjunction with a two-dimensional scale). The default value is 0.

For more details see: setRotation() docs

Overrides:

setRotation in class ImageStyle

Parameters:

rotation - rotation value

withRotation

public CircleStyle withRotation(Double rotation)

See setRotation(Double).

Parameters:

rotation - rotation value

Returns:

current instance

getScale

public Double getScale()

Overrides:

getScale in class ImageStyle

Returns:

scale value or null if not set

setScale

public void setScale(Double scale)

Sets the scale. A two-dimensional scale will produce an ellipse. Unless two-dimensional scaling is required a better result may be obtained with an appropriate setting for setRadius(Integer). The default value is 1. Note, if setScaleSize(Size) is set, it will take precedence over the scale.

For more details see: setScale() docs

Overrides:

setScale in class ImageStyle

Parameters:

scale - scale value

withScale

public CircleStyle withScale(Double scale)

See setScale(Double).

Parameters:

scale - scale value

Returns:

current instance

getScaleSize

public Size getScaleSize()

Overrides:

getScaleSize in class ImageStyle

Returns:

scale size or null if not set

setScaleSize

public void setScaleSize(Size scaleSize)

Sets the scale size. Note, it takes precedence over the ImageStyle.setScale(Double).

For more details see: setScale() docs

Overrides:

setScaleSize in class ImageStyle

Parameters:

scaleSize - scale size

withScaleSize

public CircleStyle withScaleSize(Size scaleSize)

See setScaleSize(Size).

Parameters:

scaleSize - scale size

Returns:

current instance

getDisplacement

public Displacement getDisplacement()

Overrides:

getDisplacement in class ImageStyle

Returns:

displacement value or null if not set

setDisplacement

public void setDisplacement(Displacement displacement)

Sets the displacement.

For more details see: setDisplacement() docs

Overrides:

setDisplacement in class ImageStyle

Parameters:

displacement - displacement value

withDisplacement

public CircleStyle withDisplacement(Displacement displacement)

Parameters:

displacement -

Returns:

current instance

getDeclutterMode

public DeclutterMode getDeclutterMode()

Overrides:

getDeclutterMode in class ImageStyle

Returns:

declutter mode or null if not set

setDeclutterMode

public void setDeclutterMode(DeclutterMode declutterMode)

Sets declutter mode.

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

For more details see: ImageStyle docs

Overrides:

setDeclutterMode in class ImageStyle

Parameters:

declutterMode - declutter mode value

withDeclutterMode

public CircleStyle withDeclutterMode(DeclutterMode declutterMode)

See setDeclutterMode(DeclutterMode).

Parameters:

declutterMode - declutter mode value

Returns:

current instance