com.mapbox.mapboxsdk.plugins.annotation

Class LineManager

java.lang.Object

com.mapbox.mapboxsdk.plugins.annotation.AnnotationManager<LineLayer,Line,LineOptions,OnLineDragListener,OnLineClickListener,OnLineLongClickListener>

com.mapbox.mapboxsdk.plugins.annotation.LineManager

public class LineManager
extends AnnotationManager<LineLayer,Line,LineOptions,OnLineDragListener,OnLineClickListener,OnLineLongClickListener>

The line manager allows to add lines to a map.

Field Summary

Fields inherited from class com.mapbox.mapboxsdk.plugins.annotation.AnnotationManager

annotations, layer, mapboxMap

Constructor Summary

Constructors

Constructor and Description
LineManager(MapView mapView, MapboxMap mapboxMap, Style style) Create a line manager, used to manage lines.
LineManager(MapView mapView, MapboxMap mapboxMap, Style style, java.lang.String belowLayerId) Create a line manager, used to manage lines.
LineManager(MapView mapView, MapboxMap mapboxMap, Style style, java.lang.String belowLayerId, GeoJsonOptions geoJsonOptions) Create a line manager, used to manage lines.

Method Summary

Modifier and Type	Method and Description
java.util.List<Line>	create(FeatureCollection featureCollection) Create a list of lines on the map.
java.util.List<Line>	create(java.lang.String json) Create a list of lines on the map.
Expression	getFilter() Get filter of the managed lines.
java.lang.String	getLineCap() Get the LineCap property
java.lang.Float[]	getLineDasharray() Get the LineDasharray property
java.lang.Float	getLineMiterLimit() Get the LineMiterLimit property
java.lang.Float	getLineRoundLimit() Get the LineRoundLimit property
java.lang.Float[]	getLineTranslate() Get the LineTranslate property
java.lang.String	getLineTranslateAnchor() Get the LineTranslateAnchor property
protected void	setDataDrivenPropertyIsUsed(java.lang.String property)
void	setFilter(Expression expression) Set filter on the managed lines.
void	setLineCap(java.lang.String value) Set the LineCap property
void	setLineDasharray(java.lang.Float[] value) Set the LineDasharray property
void	setLineMiterLimit(java.lang.Float value) Set the LineMiterLimit property
void	setLineRoundLimit(java.lang.Float value) Set the LineRoundLimit property
void	setLineTranslate(java.lang.Float[] value) Set the LineTranslate property
void	setLineTranslateAnchor(java.lang.String value) Set the LineTranslateAnchor property

Methods inherited from class com.mapbox.mapboxsdk.plugins.annotation.AnnotationManager

addClickListener, addDragListener, addLongClickListener, delete, delete, deleteAll, getAnnotations, getLayerId, onDestroy, removeClickListener, removeDragListener, removeLongClickListener, update, update, updateSource

Methods inherited from class java.lang.Object

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

Constructor Detail

LineManager

public LineManager(MapView mapView,
                   MapboxMap mapboxMap,
                   Style style)

Create a line manager, used to manage lines.

Parameters:

mapboxMap - the map object to add lines to

style - a valid a fully loaded style object

LineManager

public LineManager(MapView mapView,
                   MapboxMap mapboxMap,
                   Style style,
                   java.lang.String belowLayerId)

Create a line manager, used to manage lines.

Parameters:

mapboxMap - the map object to add lines to

style - a valid a fully loaded style object

belowLayerId - the id of the layer above the circle layer

LineManager

public LineManager(MapView mapView,
                   MapboxMap mapboxMap,
                   Style style,
                   java.lang.String belowLayerId,
                   GeoJsonOptions geoJsonOptions)

Create a line manager, used to manage lines.

Parameters:

mapboxMap - the map object to add lines to

style - a valid a fully loaded style object

belowLayerId - the id of the layer above the circle layer

geoJsonOptions - options for the internal source

Method Detail

setDataDrivenPropertyIsUsed

protected void setDataDrivenPropertyIsUsed(java.lang.String property)

Specified by:

setDataDrivenPropertyIsUsed in class AnnotationManager<LineLayer,Line,LineOptions,OnLineDragListener,OnLineClickListener,OnLineLongClickListener>

create

public java.util.List<Line> create(java.lang.String json)

Create a list of lines on the map.

Lines are going to be created only for features with a matching geometry.

All supported properties are:
LineOptions.PROPERTY_LINE_JOIN - String
LineOptions.PROPERTY_LINE_OPACITY - Float
LineOptions.PROPERTY_LINE_COLOR - String
LineOptions.PROPERTY_LINE_WIDTH - Float
LineOptions.PROPERTY_LINE_GAP_WIDTH - Float
LineOptions.PROPERTY_LINE_OFFSET - Float
LineOptions.PROPERTY_LINE_BLUR - Float
LineOptions.PROPERTY_LINE_PATTERN - String
Learn more about above properties in the Style specification.

Out of spec properties:
"is-draggable" - Boolean, true if the line should be draggable, false otherwise

Parameters:

json - the GeoJSON defining the list of lines to build

Returns:

the list of built lines

create

public java.util.List<Line> create(FeatureCollection featureCollection)

Create a list of lines on the map.

Lines are going to be created only for features with a matching geometry.

All supported properties are:
LineOptions.PROPERTY_LINE_JOIN - String
LineOptions.PROPERTY_LINE_OPACITY - Float
LineOptions.PROPERTY_LINE_COLOR - String
LineOptions.PROPERTY_LINE_WIDTH - Float
LineOptions.PROPERTY_LINE_GAP_WIDTH - Float
LineOptions.PROPERTY_LINE_OFFSET - Float
LineOptions.PROPERTY_LINE_BLUR - Float
LineOptions.PROPERTY_LINE_PATTERN - String
Learn more about above properties in the Style specification.

Out of spec properties:
"is-draggable" - Boolean, true if the line should be draggable, false otherwise

Overrides:

create in class AnnotationManager<LineLayer,Line,LineOptions,OnLineDragListener,OnLineClickListener,OnLineLongClickListener>

Parameters:

featureCollection - the featureCollection defining the list of lines to build

Returns:

the list of built lines

getLineCap

public java.lang.String getLineCap()

Get the LineCap property

The display of line endings.

Returns:

property wrapper value around String

setLineCap

public void setLineCap(java.lang.String value)

Set the LineCap property

The display of line endings.

Parameters:

value - property wrapper value around String

getLineMiterLimit

public java.lang.Float getLineMiterLimit()

Get the LineMiterLimit property

Used to automatically convert miter joins to bevel joins for sharp angles.

Returns:

property wrapper value around Float

setLineMiterLimit

public void setLineMiterLimit(java.lang.Float value)

Set the LineMiterLimit property

Used to automatically convert miter joins to bevel joins for sharp angles.

Parameters:

value - property wrapper value around Float

getLineRoundLimit

public java.lang.Float getLineRoundLimit()

Get the LineRoundLimit property

Used to automatically convert round joins to miter joins for shallow angles.

Returns:

property wrapper value around Float

setLineRoundLimit

public void setLineRoundLimit(java.lang.Float value)

Set the LineRoundLimit property

Used to automatically convert round joins to miter joins for shallow angles.

Parameters:

value - property wrapper value around Float

getLineTranslate

public java.lang.Float[] getLineTranslate()

Get the LineTranslate property

The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.

Returns:

property wrapper value around Float[]

setLineTranslate

public void setLineTranslate(java.lang.Float[] value)

Set the LineTranslate property

The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.

Parameters:

value - property wrapper value around Float[]

getLineTranslateAnchor

public java.lang.String getLineTranslateAnchor()

Get the LineTranslateAnchor property

Controls the frame of reference for PropertyFactory#lineTranslate.

Returns:

property wrapper value around String

setLineTranslateAnchor

public void setLineTranslateAnchor(java.lang.String value)

Set the LineTranslateAnchor property

Controls the frame of reference for PropertyFactory#lineTranslate.

Parameters:

value - property wrapper value around String

getLineDasharray

public java.lang.Float[] getLineDasharray()

Get the LineDasharray property

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. Note that GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.

Returns:

property wrapper value around Float[]

setLineDasharray

public void setLineDasharray(java.lang.Float[] value)

Set the LineDasharray property

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. Note that GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.

Parameters:

value - property wrapper value around Float[]

setFilter

public void setFilter(Expression expression)

Set filter on the managed lines.

Parameters:

expression - expression

getFilter

public Expression getFilter()

Get filter of the managed lines.

Returns:

expression