com.gwidgets.api.leaflet.options

Class PathOptions

java.lang.Object

com.gwidgets.api.leaflet.options.PathOptions

Direct Known Subclasses:

PolylineOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class PathOptions
extends java.lang.Object

The Class PathOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathOptions.Builder The Class Builder.

Constructor Summary

Constructors

Constructor and Description
PathOptions()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName() Gets the custom class name set on an element.
java.lang.Boolean	getClickable() Gets whether the the vector will not emit mouse events and will act as a part of the underlying map.
java.lang.String	getColor() Gets the Stroke color.
java.lang.String	getDashArray() Gets the string that defines the stroke dash pattern.
java.lang.Boolean	getFill() Gets Whether to fill the path with color.
java.lang.String	getFillColor() Gets the fill color.
java.lang.Number	getFillOpacity() Gets the fill opacity.
java.lang.String	getFillRule() Gets the string that defines how the inside of a shape is determined.
java.lang.String	getLineCap() Gets the string that defines shape to be used at the end of the stroke.
java.lang.String	getLineJoin() Gets the string that defines shape to be used at the corners of the stroke.
java.lang.Number	getOpacity() Gets the Stroke opacity.
java.lang.String	getPointerEvents() Gets the pointer-events attribute on the path if SVG backend is used.
java.lang.Boolean	getStroke() Gets Whether to draw stroke along the path.
java.lang.Number	getWeight() Gets the Stroke width in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathOptions

public PathOptions()

Method Detail

getStroke

@JsOverlay
public final java.lang.Boolean getStroke()

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

Returns:

the stroke

getColor

@JsOverlay
public final java.lang.String getColor()

Gets the Stroke color.
default "#03f"

Returns:

the color

getWeight

@JsOverlay
public final java.lang.Number getWeight()

Gets the Stroke width in pixels.
default 5

Returns:

the weight

getOpacity

@JsOverlay
public final java.lang.Number getOpacity()

Gets the Stroke opacity.
default 0.5

Returns:

the opacity

getFill

@JsOverlay
public final java.lang.Boolean getFill()

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

Returns:

the fill

getFillColor

@JsOverlay
public final java.lang.String getFillColor()

Gets the fill color.
default "#03f"

Returns:

the fill color

getFillOpacity

@JsOverlay
public final java.lang.Number getFillOpacity()

Gets the fill opacity.
default 0.2

Returns:

the fill opacity

getFillRule

@JsOverlay
public final java.lang.String getFillRule()

Gets the string that defines how the inside of a shape is determined. See docs for more info
default "evenodd"

Returns:

the fill rule

getDashArray

@JsOverlay
public final java.lang.String getDashArray()

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

Returns:

the dash array

getLineCap

@JsOverlay
public final java.lang.String getLineCap()

Gets the string that defines shape to be used at the end of the stroke.
default null

Returns:

the line cap

getLineJoin

@JsOverlay
public final java.lang.String getLineJoin()

Gets the string that defines shape to be used at the corners of the stroke.
default null

Returns:

the line join

getClickable

@JsOverlay
public final java.lang.Boolean getClickable()

Gets whether the the vector will not emit mouse events and will act as a part of the underlying map.
default true

Returns:

the clickable

getPointerEvents

@JsOverlay
public final java.lang.String getPointerEvents()

Gets the pointer-events attribute on the path if SVG backend is used.
default null

Returns:

the pointer events

getClassName

@JsOverlay
public final java.lang.String getClassName()

Gets the custom class name set on an element.
default empty string

Returns:

the class name