com.gwidgets.api.leaflet.options

Class PathOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.PathOptions.Builder

Enclosing class:

PathOptions

public static class PathOptions.Builder
extends java.lang.Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder() Instantiates a new builder.

Method Summary

Modifier and Type	Method and Description
PathOptions	build() Builds the PathOptions new instance
PathOptions.Builder	className(java.lang.String className) Custom class name set on an element.
PathOptions.Builder	clickable(java.lang.Boolean clickable) If false, the vector will not emit mouse events and will act as a part of the underlying map.
PathOptions.Builder	color(java.lang.String color) Stroke color.
PathOptions.Builder	dashArray(java.lang.String dashArray) A string that defines the stroke dash pattern.
PathOptions.Builder	fill(java.lang.Boolean fill) Whether to fill the path with color.
PathOptions.Builder	fillColor(java.lang.String fillColor) Fill color.
PathOptions.Builder	fillOpacity(java.lang.Number fillOpacity) Fill opacity.
PathOptions.Builder	fillRule(java.lang.String fillRule) A string that defines how the inside of a shape is determined.
PathOptions.Builder	lineCap(java.lang.String lineCap) A string that defines shape to be used at the end of the stroke.
PathOptions.Builder	lineJoin(java.lang.String lineJoin) A string that defines shape to be used at the corners of the stroke.
PathOptions.Builder	opacity(java.lang.Number opacity) Stroke opacity.
PathOptions.Builder	pointerEvents(java.lang.String pointerEvents) Sets the pointer-events attribute on the path if SVG backend is used.
PathOptions.Builder	stroke(java.lang.Boolean stroke) Whether to draw stroke along the path.
PathOptions.Builder	weight(java.lang.Number weight) Stroke width in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Instantiates a new builder.

Method Detail

stroke

public PathOptions.Builder stroke(java.lang.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 PathOptions.Builder color(java.lang.String color)

Stroke color.
default "#03f"

Parameters:

color - the color

Returns:

the builder

weight

public PathOptions.Builder weight(java.lang.Number weight)

Stroke width in pixels.
default 5

Parameters:

weight - the weight

Returns:

the builder

opacity

public PathOptions.Builder opacity(java.lang.Number opacity)

Stroke opacity.
default 0.5

Parameters:

opacity - the opacity

Returns:

the builder

fill

public PathOptions.Builder fill(java.lang.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 PathOptions.Builder fillColor(java.lang.String fillColor)

Fill color.
default "#03f"

Parameters:

fillColor - the fill color

Returns:

the builder

fillOpacity

public PathOptions.Builder fillOpacity(java.lang.Number fillOpacity)

Fill opacity.
default 0.2

Parameters:

fillOpacity - the fill opacity

Returns:

the builder

fillRule

public PathOptions.Builder fillRule(java.lang.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 PathOptions.Builder dashArray(java.lang.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 PathOptions.Builder lineCap(java.lang.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 PathOptions.Builder lineJoin(java.lang.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

clickable

public PathOptions.Builder clickable(java.lang.Boolean clickable)

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

Parameters:

clickable - the clickable

Returns:

the builder

pointerEvents

public PathOptions.Builder pointerEvents(java.lang.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 PathOptions.Builder className(java.lang.String className)

Custom class name set on an element.
default empty string

Parameters:

className - the class name

Returns:

the builder

build

public PathOptions build()

Builds the PathOptions new instance

Returns:

the path options