Package xyz.jpenilla.squaremap.api.marker

Class MarkerOptions

java.lang.Object

xyz.jpenilla.squaremap.api.marker.MarkerOptions

public final class MarkerOptions
extends Object

Class holding options for map markers

Note that not all options are applicable to all marker types

Many of these options mirror those found in the leaflet path options, see the link below for reference

See Also:

• https://leafletjs.com/reference-1.7.1.html#path

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MarkerOptions.Builder	Builder for MarkerOptions
static enum	MarkerOptions.FillRule	Fill modes enum

Method Summary

Modifier and Type	Method	Description
@NonNull MarkerOptions.Builder	asBuilder()	Create a new MarkerOptions.Builder from this MarkerOptions instance
static @NonNull MarkerOptions.Builder	builder()	Get a new MarkerOptions.Builder
@Nullable String	clickTooltip()	Get the click tooltip
static @NonNull MarkerOptions	defaultOptions()	Get the default marker options instance
boolean	equals(@Nullable Object o)
boolean	fill()	Get whether to fill the inside of the marker
@Nullable Color	fillColor()	Get the fill color
double	fillOpacity()	Get the fill opacity
@NonNull MarkerOptions.FillRule	fillRule()	Get the fill rule
int	hashCode()
@Nullable String	hoverTooltip()	Get the hover tooltip
boolean	stroke()	Get whether to render the line stroke
@NonNull Color	strokeColor()	Get the stroke color
double	strokeOpacity()	Get the line stroke opacity
int	strokeWeight()	Get the line stroke weight

Methods inherited from class java.lang.Object

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

Method Details

defaultOptions

public static @NonNull MarkerOptions defaultOptions()

Get the default marker options instance

Returns:

default options

stroke

public boolean stroke()

Get whether to render the line stroke

Returns:

stroke

strokeColor

public @NonNull Color strokeColor()

Get the stroke color

Returns:

color

strokeWeight

public int strokeWeight()

Get the line stroke weight

Returns:

stroke weight

strokeOpacity

public double strokeOpacity()

Get the line stroke opacity

Returns:

stroke opacity

fill

public boolean fill()

Get whether to fill the inside of the marker

Returns:

fill

fillColor

public @Nullable Color fillColor()

Get the fill color

Returns:

color

fillOpacity

public double fillOpacity()

Get the fill opacity

Returns:

fill opacity

fillRule

public @NonNull MarkerOptions.FillRule fillRule()

Get the fill rule

Returns:

fill mode

clickTooltip

public @Nullable String clickTooltip()

Get the click tooltip

Will be null if not set

Returns:

tooltip

hoverTooltip

public @Nullable String hoverTooltip()

Get the hover tooltip

Will be null if not set

Returns:

tooltip

asBuilder

public @NonNull MarkerOptions.Builder asBuilder()

Create a new MarkerOptions.Builder from this MarkerOptions instance

Returns:

new builder

builder

public static @NonNull MarkerOptions.Builder builder()

Get a new MarkerOptions.Builder

Returns:

new builder

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object