Class LineOptions

Method Details

• withLineJoin

  public LineOptions withLineJoin(String lineJoin)

  Set line-join to initialise the line with.

  The display of lines when joining.

  Parameters:

  lineJoin - the line-join value

  Returns:

  this

• getLineJoin

  public String getLineJoin()

  Get the current configured line-join for the line

  The display of lines when joining.

  Returns:

  lineJoin value

• withLineOpacity

  public 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

  Returns:

  this

• getLineOpacity

  public Float getLineOpacity()

  Get the current configured line-opacity for the line

  The opacity at which the line will be drawn.

  Returns:

  lineOpacity value

• withLineColor

  public 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

  Returns:

  this

• getLineColor

  public String getLineColor()

  Get the current configured line-color for the line

  The color with which the line will be drawn.

  Returns:

  lineColor value

• withLineWidth

  public LineOptions withLineWidth(Float lineWidth)

  Set line-width to initialise the line with.

  Stroke thickness.

  Parameters:

  lineWidth - the line-width value

  Returns:

  this

• getLineWidth

  public Float getLineWidth()

  Get the current configured line-width for the line

  Stroke thickness.

  Returns:

  lineWidth value

• withLineGapWidth

  public 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

  Returns:

  this

• getLineGapWidth

  public 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.

  Returns:

  lineGapWidth value

• withLineOffset

  public 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

  Returns:

  this

• getLineOffset

  public 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.

  Returns:

  lineOffset value

• withLineBlur

  public 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

  Returns:

  this

• getLineBlur

  public Float getLineBlur()

  Get the current configured line-blur for the line

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

  Returns:

  lineBlur value

• withLinePattern

  public 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

  Returns:

  this

• getLinePattern

  public 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.

  Returns:

  linePattern value

• withLatLngs

  public LineOptions withLatLngs(List<com.trimblemaps.mapsdk.geometry.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

  Returns:

  this

• getLatLngs

  public List<com.trimblemaps.mapsdk.geometry.LatLng> getLatLngs()

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

  Returns:

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

• withGeometry

  public LineOptions withGeometry(com.trimblemaps.geojson.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

  Returns:

  this

• getGeometry

  public com.trimblemaps.geojson.LineString getGeometry()

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

  Returns:

  the location of the line

• getDraggable

  public boolean getDraggable()

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

  Returns:

  draggable when touched

• withDraggable

  public 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

  public LineOptions withData(@Nullable com.google.gson.JsonElement jsonElement)

  Set the arbitrary json data of the annotation.

  Parameters:

  jsonElement - the arbitrary json element data

• getData

  @Nullable public com.google.gson.JsonElement getData()

  Get the arbitrary json data of the annotation.

  Returns:

  the arbitrary json object data if set, else null