Package com.vaadin.flow.component.map.configuration.style

Class Icon

java.lang.Object

com.vaadin.flow.component.map.configuration.AbstractConfigurationObject

com.vaadin.flow.component.map.configuration.style.ImageStyle

com.vaadin.flow.component.map.configuration.style.Icon

All Implemented Interfaces:

Serializable

public class Icon
extends ImageStyle

An icon or image that can be used to visually represent a Feature, by using it as the feature's Style.setImage(ImageStyle)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Icon.Anchor
static class	Icon.AnchorOrigin
static class	Icon.ImageSize
static class	Icon.Options

Field Summary

Fields inherited from class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
Icon(Icon.Options options)

Method Summary

Modifier and Type	Method	Description
Icon.Anchor	getAnchor()	The anchor position of the image.
Icon.AnchorOrigin	getAnchorOrigin()	The origin of the getAnchor() position.
String	getColor()	Color to tint the icon's image with.
String	getCrossOrigin()	The cross-origin attribute value for loaded images.
StreamResource	getImg()	The stream resource from which the icon's image should be loaded.
Icon.ImageSize	getImgSize()	The size of the image in pixels.
String	getSrc()	The source URL from which the icon's image should be loaded.
String	getType()	The unique type name of this class.
void	setAnchor(Icon.Anchor anchor)	Sets the anchor position of the icon's image

Methods inherited from class com.vaadin.flow.component.map.configuration.style.ImageStyle

getOpacity, getRotation, getScale, isRotateWithView, setOpacity, setRotateWithView, setRotation, setScale

Methods inherited from class com.vaadin.flow.component.map.configuration.AbstractConfigurationObject

addChild, addPropertyChangeListener, collectChanges, deepMarkAsDirty, getId, markAsDirty, notifyChange, notifyChange, removeChild, removePropertyChangeListener, setId, update

Methods inherited from class java.lang.Object

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

Constructor Detail

Icon

public Icon(Icon.Options options)

Method Detail

getType

public String getType()

Description copied from class: AbstractConfigurationObject

The unique type name of this class. Used by the client-side synchronization mechanism to determine which OpenLayers class to synchronize into.

Specified by:

getType in class AbstractConfigurationObject

getAnchor

public Icon.Anchor getAnchor()

The anchor position of the image. This defines how the image should be aligned from the getAnchorOrigin(). The anchor position is specified in relative units, based on the size of the image. Valid values range from 0 to 1, where 1 moves the image by its full width or height from the anchor origin. Default value is {x: 0.5, y: 0.5}, which centers the image.

Returns:

the current anchor

setAnchor

public void setAnchor(Icon.Anchor anchor)

Sets the anchor position of the icon's image

Parameters:

anchor - the new anchor

getAnchorOrigin

public Icon.AnchorOrigin getAnchorOrigin()

The origin of the getAnchor() position. Defaults to Icon.AnchorOrigin.TOP_LEFT.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the current anchor origin

getColor

public String getColor()

Color to tint the icon's image with. If not specified, the image will not be modified.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the current color tint

getCrossOrigin

public String getCrossOrigin()

The cross-origin attribute value for loaded images.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the cross-origin attribute value

getSrc

public String getSrc()

The source URL from which the icon's image should be loaded. Either this or getImg() must be specified in the options for the icon, and only one of the two options must be provided.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the source URL for the icon's image

getImg

public StreamResource getImg()

The stream resource from which the icon's image should be loaded. Either this or getSrc() must be specified in the options for the icon, and only one of the two options must be provided.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the stream resource containing the icon's image

getImgSize

public Icon.ImageSize getImgSize()

The size of the image in pixels.

This value can not be changed after constructing an instance, it can only be set initially by passing an options object to the constructor.

Returns:

the size of the image