com.gwidgets.api.leaflet.options

Class PolylineOptions

java.lang.Object

com.gwidgets.api.leaflet.options.PathOptions

com.gwidgets.api.leaflet.options.PolylineOptions

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

The Class PolylineOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.gwidgets.api.leaflet.options.PathOptions

attribution, className, color, dashArray, dashOffset, fill, fillColor, fillOpacity, fillRule, interactive, lineCap, lineJoin, opacity, pane, pointerEvents, renderer, stroke, weight

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
boolean	getNoClip() Gets whether the polyline clipping is disabled.
double	getOpacity_() Gets the Stroke opacity.
String	getPointerEvents_() Gets the pointer-events attribute on the path if SVG backend is used.
double	getSmoothFactor() Gets How much to simplify the polyline on each zoom level.
boolean	getStroke_() Gets Whether to draw stroke along the path.
double	getWeight_() Gets the Stroke width in pixels.

Methods inherited from class com.gwidgets.api.leaflet.options.PathOptions

getAttribution, getClassName, getColor, getDashArray, getDashOffset, getFill, getFillColor, getFillOpacity, getFillRule, getInteractive, getLineCap, getLineJoin, getOpacity, getPane, getPointerEvents, getRenderer, getStroke, getWeight

Methods inherited from class java.lang.Object

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

Method Detail

getSmoothFactor

@JsOverlay
public final double getSmoothFactor()

Gets How much to simplify the polyline on each zoom level. More means better performance and smoother look, and less means more accurate representation.
default 1.0

Returns:

the smooth factor

getNoClip

@JsOverlay
public final boolean getNoClip()

Gets whether the polyline clipping is disabled.
default false

Returns:

the no clip

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