net.java.html.leaflet

Class PathOptions

java.lang.Object

net.java.html.leaflet.PathOptions

public final class PathOptions
extends Object

Options for configuring a Path.

Constructor Summary

Constructors

Constructor and Description
PathOptions() Creates a PathOptions object

Method Summary

Modifier and Type	Method and Description
PathOptions	setClassName(String className) Sets className option
PathOptions	setClickable(boolean clickable) Sets clickable option
PathOptions	setColor(String color) Sets color option
PathOptions	setDashArray(String dashArray) Sets dashArray option
PathOptions	setFill(boolean fill) Sets fill option
PathOptions	setFillColor(String fillColor) Sets fillColor option
PathOptions	setFillOpacity(double fillOpacity) Sets fillOpacity option
PathOptions	setLineCap(String lineCap) Sets lineCap option
PathOptions	setLineJoin(String lineJoin) Sets lineJoin option
PathOptions	setOpacity(double opacity) Sets opacity option
PathOptions	setPointerEvents(String pointerEvents) Sets pointerEvents option
PathOptions	setStroke(boolean stroke) Sets stroke option
PathOptions	setWeight(int weight) Sets weight option

Methods inherited from class java.lang.Object

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

Constructor Detail

PathOptions

public PathOptions()

Creates a PathOptions object

Method Detail

setStroke

public PathOptions setStroke(boolean stroke)

Sets stroke option

Parameters:

stroke - Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles.

Returns:

updated options

setColor

public PathOptions setColor(String color)

Sets color option

Parameters:

color - Stroke color.

Returns:

updated options

setWeight

public PathOptions setWeight(int weight)

Sets weight option

Parameters:

weight - Stroke width in pixels.

Returns:

updated options

setOpacity

public PathOptions setOpacity(double opacity)

Sets opacity option

Parameters:

opacity - Stroke opacity.

Returns:

updated options

setFill

public PathOptions setFill(boolean fill)

Sets fill option

Parameters:

fill - Whether to fill the path with color. Set it to false to disable filling on polygons or circles.

Returns:

updated options

setFillColor

public PathOptions setFillColor(String fillColor)

Sets fillColor option

Parameters:

fillColor - Fill color.

Returns:

updated options

setFillOpacity

public PathOptions setFillOpacity(double fillOpacity)

Sets fillOpacity option

Parameters:

fillOpacity - Fill opacity.

Returns:

updated options

setDashArray

public PathOptions setDashArray(String dashArray)

Sets dashArray option

Parameters:

dashArray - A string that defines the stroke dash pattern. Doesn't work on canvas-powered layers (e.g. Android 2).

Returns:

updated options

setLineCap

public PathOptions setLineCap(String lineCap)

Sets lineCap option

Parameters:

lineCap - A string that defines shape to be used at the end of the stroke.

Returns:

updated options

setLineJoin

public PathOptions setLineJoin(String lineJoin)

Sets lineJoin option

Parameters:

lineJoin - A string that defines shape to be used at the corners of the stroke.

Returns:

updated options

setClickable

public PathOptions setClickable(boolean clickable)

Sets clickable option

Parameters:

clickable - If false, the vector will not emit mouse events and will act as a part of the underlying map.

Returns:

updated options

setPointerEvents

public PathOptions setPointerEvents(String pointerEvents)

Sets pointerEvents option

Parameters:

pointerEvents - Sets the pointer-events attribute on the path if SVG backend is used.

Returns:

updated options

setClassName

public PathOptions setClassName(String className)

Sets className option

Parameters:

className - Custom class name set on an element.

Returns:

updated options