com.gwidgets.api.leaflet.options

Class PolylineOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.PolylineOptions.Builder

Enclosing class:

PolylineOptions

public static class PolylineOptions.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PolylineOptions.Builder	attribution(String attribution)
PolylineOptions	build() Builds the PolylineOptions new instance
PolylineOptions.Builder	className(String className) Custom class name set on an element.
PolylineOptions.Builder	color(String color) Stroke color.
PolylineOptions.Builder	dashArray(String dashArray) A string that defines the stroke dash pattern.
PolylineOptions.Builder	dashOffset(String dashOffset)
PolylineOptions.Builder	fill(Boolean fill) Whether to fill the path with color.
PolylineOptions.Builder	fillColor(String fillColor) Fill color.
PolylineOptions.Builder	fillOpacity(Double fillOpacity) Fill opacity.
PolylineOptions.Builder	fillRule(String fillRule) A string that defines how the inside of a shape is determined.
PolylineOptions.Builder	interactive(Boolean interactive)
PolylineOptions.Builder	lineCap(String lineCap) A string that defines shape to be used at the end of the stroke.
PolylineOptions.Builder	lineJoin(String lineJoin) A string that defines shape to be used at the corners of the stroke.
PolylineOptions.Builder	noClip(Boolean noClip) Disabled polyline clipping.
PolylineOptions.Builder	opacity(Double opacity) Stroke opacity.
PolylineOptions.Builder	pane(String pane)
PolylineOptions.Builder	pointerEvents(String pointerEvents) Sets the pointer-events attribute on the path if SVG backend is used.
PolylineOptions.Builder	renderer(Renderer renderer)
PolylineOptions.Builder	smoothFactor(Double smoothFactor) How much to simplify the polyline on each zoom level.
PolylineOptions.Builder	stroke(Boolean stroke) Whether to draw stroke along the path.
PolylineOptions.Builder	weight(Double weight) Stroke width in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

smoothFactor

public PolylineOptions.Builder smoothFactor(Double smoothFactor)

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

Parameters:

smoothFactor - the smooth factor

Returns:

the builder

noClip

public PolylineOptions.Builder noClip(Boolean noClip)

Disabled polyline clipping.
default false

Parameters:

noClip - the no clip

Returns:

the builder

stroke

public PolylineOptions.Builder stroke(Boolean stroke)

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

Parameters:

stroke - the stroke

Returns:

the builder

color

public PolylineOptions.Builder color(String color)

Stroke color.
default "#03f"

Parameters:

color - the color

Returns:

the builder

weight

public PolylineOptions.Builder weight(Double weight)

Stroke width in pixels.
default 5

Parameters:

weight - the weight

Returns:

the builder

opacity

public PolylineOptions.Builder opacity(Double opacity)

Stroke opacity.
default 0.5

Parameters:

opacity - the opacity

Returns:

the builder

fill

public PolylineOptions.Builder fill(Boolean fill)

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

Parameters:

fill - the fill

Returns:

the builder

fillColor

public PolylineOptions.Builder fillColor(String fillColor)

Fill color.
default "#03f"

Parameters:

fillColor - the fill color

Returns:

the builder

fillOpacity

public PolylineOptions.Builder fillOpacity(Double fillOpacity)

Fill opacity.
default 0.2

Parameters:

fillOpacity - the fill opacity

Returns:

the builder

fillRule

public PolylineOptions.Builder fillRule(String fillRule)

A string that defines how the inside of a shape is determined. See docs for more info

Parameters:

fillRule - the fill rule

Returns:

the builder

dashArray

public PolylineOptions.Builder dashArray(String dashArray)

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

Parameters:

dashArray - the dash array

Returns:

the builder

lineCap

public PolylineOptions.Builder lineCap(String lineCap)

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

Parameters:

lineCap - the line cap

Returns:

the builder

lineJoin

public PolylineOptions.Builder lineJoin(String lineJoin)

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

Parameters:

lineJoin - the line join

Returns:

the builder

pointerEvents

public PolylineOptions.Builder pointerEvents(String pointerEvents)

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

Parameters:

pointerEvents - the pointer events

Returns:

the builder

className

public PolylineOptions.Builder className(String className)

Custom class name set on an element.
default empty string

Parameters:

className - the class name

Returns:

the builder

dashOffset

public PolylineOptions.Builder dashOffset(String dashOffset)

renderer

public PolylineOptions.Builder renderer(Renderer renderer)

attribution

public PolylineOptions.Builder attribution(String attribution)

pane

public PolylineOptions.Builder pane(String pane)

interactive

public PolylineOptions.Builder interactive(Boolean interactive)

build

public PolylineOptions build()

Builds the PolylineOptions new instance

Returns:

the polyline options