com.gwidgets.api.leaflet.options

Class PathOptions

java.lang.Object

com.gwidgets.api.leaflet.options.PathOptions

Direct Known Subclasses:

CircleOptions, PolylineOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class PathOptions
extends 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attribution
protected String	className
protected String	color
protected String	dashArray
protected String	dashOffset
protected boolean	fill
protected String	fillColor
protected double	fillOpacity
protected String	fillRule
protected boolean	interactive
protected String	lineCap
protected String	lineJoin
protected double	opacity
protected String	pane
protected String	pointerEvents
protected Renderer	renderer
protected boolean	stroke
protected double	weight

Constructor Summary

Constructors

Constructor and Description
PathOptions()

Method Summary

Modifier and Type	Method and Description
String	getAttribution()
String	getClassName() Gets the custom class name set on an element.
String	getColor() Gets the Stroke color.
String	getDashArray() Gets the string that defines the stroke dash pattern.
String	getDashOffset()
boolean	getFill() Gets Whether to fill the path with color.
String	getFillColor() Gets the fill color.
double	getFillOpacity() Gets the fill opacity.
String	getFillRule() Gets the string that defines how the inside of a shape is determined.
boolean	getInteractive()
String	getLineCap() Gets the string that defines shape to be used at the end of the stroke.
String	getLineJoin() Gets the string that defines shape to be used at the corners of the stroke.
double	getOpacity() Gets the Stroke opacity.
String	getPane()
String	getPointerEvents() Gets the pointer-events attribute on the path if SVG backend is used.
Renderer	getRenderer()
boolean	getStroke() Gets Whether to draw stroke along the path.
double	getWeight() Gets the Stroke width in pixels.

Methods inherited from class java.lang.Object

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

Field Detail

stroke

@JsProperty
protected boolean stroke

color

@JsProperty
protected String color

weight

@JsProperty
protected double weight

opacity

@JsProperty
protected double opacity

fill

@JsProperty
protected boolean fill

fillColor

@JsProperty
protected String fillColor

fillOpacity

@JsProperty
protected double fillOpacity

fillRule

@JsProperty
protected String fillRule

dashArray

@JsProperty
protected String dashArray

lineCap

@JsProperty
protected String lineCap

lineJoin

@JsProperty
protected String lineJoin

pointerEvents

@JsProperty
protected String pointerEvents

className

@JsProperty
protected String className

dashOffset

@JsProperty
protected String dashOffset

renderer

@JsProperty
protected Renderer renderer

pane

@JsProperty
protected String pane

attribution

@JsProperty
protected String attribution

interactive

@JsProperty
protected boolean interactive

Constructor Detail

PathOptions

public PathOptions()

Method Detail

getStroke

@JsOverlay
public final 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 String getColor()

Gets the Stroke color.
default "#03f"

Returns:

the color

getWeight

@JsOverlay
public final double getWeight()

Gets the Stroke width in pixels.
default 5

Returns:

the weight

getOpacity

@JsOverlay
public final double getOpacity()

Gets the Stroke opacity.
default 0.5

Returns:

the opacity

getFill

@JsOverlay
public final 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 String getFillColor()

Gets the fill color.
default "#03f"

Returns:

the fill color

getFillOpacity

@JsOverlay
public final double getFillOpacity()

Gets the fill opacity.
default 0.2

Returns:

the fill opacity

getFillRule

@JsOverlay
public final 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 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 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 String getLineJoin()

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

Returns:

the line join

getPointerEvents

@JsOverlay
public final 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 String getClassName()

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

Returns:

the class name

getDashOffset

@JsOverlay
public final String getDashOffset()

getRenderer

@JsOverlay
public final Renderer getRenderer()

getPane

@JsOverlay
public final String getPane()

getAttribution

@JsOverlay
public final String getAttribution()

getInteractive

@JsOverlay
public final boolean getInteractive()