Method Detail

• getData

  @Nullable() JsonElement getData()

  Get the arbitrary json data of the annotation.

• getGeometry

   LineString getGeometry()

  Get the geometry of the line, which represents the location of the line on the map

• getLineJoin

   String getLineJoin()

  Get the current configured line-join for the line

  The display of lines when joining.

• getLineSortKey

   Float getLineSortKey()

  Get the current configured line-sort-key for the line

  Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

• getLineOpacity

   Float getLineOpacity()

  Get the current configured line-opacity for the line

  The opacity at which the line will be drawn.

• getLineColor

   String getLineColor()

  Get the current configured line-color for the line

  The color with which the line will be drawn.

• getLineWidth

   Float getLineWidth()

  Get the current configured line-width for the line

  Stroke thickness.

• getLineGapWidth

   Float getLineGapWidth()

  Get the current configured line-gap-width for the line

  Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.

• getLineOffset

   Float getLineOffset()

  Get the current configured line-offset for the line

  The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

• getLineBlur

   Float getLineBlur()

  Get the current configured line-blur for the line

  Blur applied to the line, in density-independent pixels.

• getLineDasharray

   Array<Float> getLineDasharray()

  Get the current configured line-dasharray for the line

  Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to density-independent pixels, multiply the length by the current line width. GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Zoom-dependent expressions will be evaluated only at integer zoom levels. The only way to create an array value is using `["literal", [...]]`; arrays cannot be read from or derived from feature properties.

• getLinePattern

   String getLinePattern()

  Get the current configured line-pattern for the line

  Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

• withLineJoin

   LineOptions withLineJoin(String lineJoin)

  Set line-join to initialise the line with.

  The display of lines when joining.

  Parameters:

  lineJoin - the line-join value

• withLineSortKey

   LineOptions withLineSortKey(Float lineSortKey)

  Set line-sort-key to initialise the line with.

  Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

  Parameters:

  lineSortKey - the line-sort-key value

• withLineOpacity

   LineOptions withLineOpacity(Float lineOpacity)

  Set line-opacity to initialise the line with.

  The opacity at which the line will be drawn.

  Parameters:

  lineOpacity - the line-opacity value

• withLineColor

   LineOptions withLineColor(String lineColor)

  Set line-color to initialise the line with.

  The color with which the line will be drawn.

  Parameters:

  lineColor - the line-color value

• withLineWidth

   LineOptions withLineWidth(Float lineWidth)

  Set line-width to initialise the line with.

  Stroke thickness.

  Parameters:

  lineWidth - the line-width value

• withLineGapWidth

   LineOptions withLineGapWidth(Float lineGapWidth)

  Set line-gap-width to initialise the line with.

  Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.

  Parameters:

  lineGapWidth - the line-gap-width value

• withLineOffset

   LineOptions withLineOffset(Float lineOffset)

  Set line-offset to initialise the line with.

  The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

  Parameters:

  lineOffset - the line-offset value

• withLineBlur

   LineOptions withLineBlur(Float lineBlur)

  Set line-blur to initialise the line with.

  Blur applied to the line, in density-independent pixels.

  Parameters:

  lineBlur - the line-blur value

• withLineDasharray

   LineOptions withLineDasharray(Array<Float> lineDasharray)

  Set line-dasharray to initialise the line with.

  Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to density-independent pixels, multiply the length by the current line width. GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Zoom-dependent expressions will be evaluated only at integer zoom levels. The only way to create an array value is using `["literal", [...]]`; arrays cannot be read from or derived from feature properties.

  Parameters:

  lineDasharray - the line-dasharray value

• withLinePattern

   LineOptions withLinePattern(String linePattern)

  Set line-pattern to initialise the line with.

  Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

  Parameters:

  linePattern - the line-pattern value

• withLatLngs

   LineOptions withLatLngs(List<LatLng> latLngs)

  Set a list of LatLng for the line, which represents the locations of the line on the map

  Parameters:

  latLngs - a list of the locations of the line in a longitude and latitude pairs

• getLatLngs

   List<LatLng> getLatLngs()

  Get a list of LatLng for the line, which represents the locations of the line on the map

• withGeometry

   LineOptions withGeometry(LineString geometry)

  Set the geometry of the line, which represents the location of the line on the map

  Parameters:

  geometry - the location of the line

• getDraggable

   boolean getDraggable()

  Returns whether this line is draggable, meaning it can be dragged across the screen when touched and moved.

• withDraggable

   LineOptions withDraggable(boolean draggable)

  Set whether this line should be draggable,meaning it can be dragged across the screen when touched and moved.

  Parameters:

  draggable - should be draggable

• withData

   LineOptions withData(@Nullable() JsonElement jsonElement)

  Set the arbitrary json data of the annotation.

  Parameters:

  jsonElement - the arbitrary json element data