Package journeymap.api.v2.server.overlay

Class OverlayShapeProps

java.lang.Object

journeymap.api.v2.server.overlay.OverlayShapeProps

public final class OverlayShapeProps
extends Object

Style and visibility properties applied to every polygon in a single ServerPolygon. Mirrors the subset of Overlay fields that are meaningful for server-pushed overlays. Interactive listeners are not supported in v1 and are therefore not represented here.

Constructor Summary

Constructors

Constructor	Description
OverlayShapeProps(int fillColor, float fillOpacity, int strokeColor, float strokeWidth, float strokeOpacity, int displayOrder, int minZoom, int maxZoom, Set<Context.UI> activeUIs, Set<Context.MapType> activeMapTypes, @Nullable String label, @Nullable String title)

Method Summary

Modifier and Type	Method	Description
Set<Context.MapType>	activeMapTypes()
Set<Context.UI>	activeUIs()
int	displayOrder()
boolean	equals(Object o)
int	fillColor()
float	fillOpacity()
int	hashCode()
@Nullable String	label()
int	maxZoom()
int	minZoom()
int	strokeColor()
float	strokeOpacity()
float	strokeWidth()
@Nullable String	title()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

OverlayShapeProps

public OverlayShapeProps(int fillColor,
 float fillOpacity,
 int strokeColor,
 float strokeWidth,
 float strokeOpacity,
 int displayOrder,
 int minZoom,
 int maxZoom,
 Set<Context.UI> activeUIs,
 Set<Context.MapType> activeMapTypes,
 @Nullable
 @Nullable String label,
 @Nullable
 @Nullable String title)

Parameters:

fillColor - 0xRRGGBB; alpha is supplied separately as fillOpacity

fillOpacity - 0.0 (transparent) to 1.0 (opaque)

strokeColor - 0xRRGGBB

strokeWidth - pixels; 0 disables the stroke

strokeOpacity - 0.0 to 1.0

displayOrder - z-order among overlays; higher draws in front (default 1000)

minZoom - minimum fullscreen zoom at which the overlay is visible

maxZoom - maximum fullscreen zoom at which the overlay is visible

activeUIs - which UIs (Fullscreen, Minimap, Webmap) the overlay is visible in

activeMapTypes - which map types (Day, Night, etc.) the overlay is visible in

label - static label rendered with the polygon, or null for none

title - hover tooltip text, or null for none

Method Details

fillColor

public int fillColor()

fillOpacity

public float fillOpacity()

strokeColor

public int strokeColor()

strokeWidth

public float strokeWidth()

strokeOpacity

public float strokeOpacity()

displayOrder

public int displayOrder()

minZoom

public int minZoom()

maxZoom

public int maxZoom()

activeUIs

public Set<Context.UI> activeUIs()

activeMapTypes

public Set<Context.MapType> activeMapTypes()

label

@Nullable
public @Nullable String label()

title

@Nullable
public @Nullable String title()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object