com.mapbox.mapboxsdk.style.layers

Class LineLayer

java.lang.Object

com.mapbox.mapboxsdk.style.layers.Layer

com.mapbox.mapboxsdk.style.layers.LineLayer

@UiThread
public class LineLayer
extends Layer

A stroked line.

See Also:

The online documentation

Constructor Summary

Constructors

Constructor and Description
LineLayer(java.lang.String layerId, java.lang.String sourceId) Creates a LineLayer.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
Expression	getFilter() Get a single expression filter.
PropertyValue<java.lang.Float>	getLineBlur() Get the LineBlur property
TransitionOptions	getLineBlurTransition() Get the LineBlur property transition options
PropertyValue<java.lang.String>	getLineCap() Get the LineCap property
PropertyValue<java.lang.String>	getLineColor() Get the LineColor property
int	getLineColorAsInt() The color with which the line will be drawn.
TransitionOptions	getLineColorTransition() Get the LineColor property transition options
PropertyValue<java.lang.Float[]>	getLineDasharray() Get the LineDasharray property
TransitionOptions	getLineDasharrayTransition() Get the LineDasharray property transition options
PropertyValue<java.lang.Float>	getLineGapWidth() Get the LineGapWidth property
TransitionOptions	getLineGapWidthTransition() Get the LineGapWidth property transition options
PropertyValue<java.lang.String>	getLineGradient() Get the LineGradient property
int	getLineGradientAsInt() Defines a gradient with which to color a line feature.
PropertyValue<java.lang.String>	getLineJoin() Get the LineJoin property
PropertyValue<java.lang.Float>	getLineMiterLimit() Get the LineMiterLimit property
PropertyValue<java.lang.Float>	getLineOffset() Get the LineOffset property
TransitionOptions	getLineOffsetTransition() Get the LineOffset property transition options
PropertyValue<java.lang.Float>	getLineOpacity() Get the LineOpacity property
TransitionOptions	getLineOpacityTransition() Get the LineOpacity property transition options
PropertyValue<java.lang.String>	getLinePattern() Get the LinePattern property
TransitionOptions	getLinePatternTransition() Get the LinePattern property transition options
PropertyValue<java.lang.Float>	getLineRoundLimit() Get the LineRoundLimit property
PropertyValue<java.lang.Float>	getLineSortKey() Get the LineSortKey property
PropertyValue<java.lang.Float[]>	getLineTranslate() Get the LineTranslate property
PropertyValue<java.lang.String>	getLineTranslateAnchor() Get the LineTranslateAnchor property
TransitionOptions	getLineTranslateTransition() Get the LineTranslate property transition options
PropertyValue<java.lang.Float>	getLineWidth() Get the LineWidth property
TransitionOptions	getLineWidthTransition() Get the LineWidth property transition options
java.lang.String	getSourceId() Get the source id.
java.lang.String	getSourceLayer() Get the source layer.
protected void	initialize(java.lang.String layerId, java.lang.String sourceId)
void	setFilter(Expression filter) Set a single expression filter.
void	setLineBlurTransition(TransitionOptions options) Set the LineBlur property transition options
void	setLineColorTransition(TransitionOptions options) Set the LineColor property transition options
void	setLineDasharrayTransition(TransitionOptions options) Set the LineDasharray property transition options
void	setLineGapWidthTransition(TransitionOptions options) Set the LineGapWidth property transition options
void	setLineOffsetTransition(TransitionOptions options) Set the LineOffset property transition options
void	setLineOpacityTransition(TransitionOptions options) Set the LineOpacity property transition options
void	setLinePatternTransition(TransitionOptions options) Set the LinePattern property transition options
void	setLineTranslateTransition(TransitionOptions options) Set the LineTranslate property transition options
void	setLineWidthTransition(TransitionOptions options) Set the LineWidth property transition options
void	setSourceLayer(java.lang.String sourceLayer) Set the source layer.
LineLayer	withFilter(Expression filter) Set a single expression filter.
LineLayer	withProperties(PropertyValue<?>... properties) Set a property or properties.
LineLayer	withSourceLayer(java.lang.String sourceLayer) Set the source Layer.

Methods inherited from class com.mapbox.mapboxsdk.style.layers.Layer

checkThread, getId, getMaxZoom, getMinZoom, getNativePtr, getVisibility, isDetached, nativeGetFilter, nativeGetId, nativeGetMaxZoom, nativeGetMinZoom, nativeGetSourceId, nativeGetSourceLayer, nativeGetVisibility, nativeSetFilter, nativeSetLayoutProperty, nativeSetMaxZoom, nativeSetMinZoom, nativeSetPaintProperty, nativeSetSourceLayer, setDetached, setMaxZoom, setMinZoom, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

LineLayer

public LineLayer(java.lang.String layerId,
                 java.lang.String sourceId)

Creates a LineLayer.

Parameters:

layerId - the id of the layer

sourceId - the id of the source

Method Detail

initialize

protected void initialize(java.lang.String layerId,
                          java.lang.String sourceId)

setSourceLayer

public void setSourceLayer(java.lang.String sourceLayer)

Set the source layer.

Parameters:

sourceLayer - the source layer to set

withSourceLayer

@NonNull
public LineLayer withSourceLayer(java.lang.String sourceLayer)

Set the source Layer.

Parameters:

sourceLayer - the source layer to set

Returns:

This

getSourceId

@NonNull
public java.lang.String getSourceId()

Get the source id.

Returns:

id of the source

getSourceLayer

@NonNull
public java.lang.String getSourceLayer()

Get the source layer.

Returns:

sourceLayer the source layer to get

setFilter

public void setFilter(@NonNull
                      Expression filter)

Set a single expression filter.

Parameters:

filter - the expression filter to set

withFilter

@NonNull
public LineLayer withFilter(@NonNull
                                     Expression filter)

Set a single expression filter.

Parameters:

filter - the expression filter to set

Returns:

This

getFilter

@Nullable
public Expression getFilter()

Get a single expression filter.

Returns:

the expression filter to get

withProperties

@NonNull
public LineLayer withProperties(@NonNull
                                         PropertyValue<?>... properties)

Set a property or properties.

Parameters:

properties - the var-args properties

Returns:

This

getLineCap

@NonNull
public PropertyValue<java.lang.String> getLineCap()

Get the LineCap property

Returns:

property wrapper value around String

getLineJoin

@NonNull
public PropertyValue<java.lang.String> getLineJoin()

Get the LineJoin property

Returns:

property wrapper value around String

getLineMiterLimit

@NonNull
public PropertyValue<java.lang.Float> getLineMiterLimit()

Get the LineMiterLimit property

Returns:

property wrapper value around Float

getLineRoundLimit

@NonNull
public PropertyValue<java.lang.Float> getLineRoundLimit()

Get the LineRoundLimit property

Returns:

property wrapper value around Float

getLineSortKey

@NonNull
public PropertyValue<java.lang.Float> getLineSortKey()

Get the LineSortKey property

Returns:

property wrapper value around Float

getLineOpacity

@NonNull
public PropertyValue<java.lang.Float> getLineOpacity()

Get the LineOpacity property

Returns:

property wrapper value around Float

getLineOpacityTransition

@NonNull
public TransitionOptions getLineOpacityTransition()

Get the LineOpacity property transition options

Returns:

transition options for Float

setLineOpacityTransition

public void setLineOpacityTransition(@NonNull
                                     TransitionOptions options)

Set the LineOpacity property transition options

Parameters:

options - transition options for Float

getLineColor

@NonNull
public PropertyValue<java.lang.String> getLineColor()

Get the LineColor property

Returns:

property wrapper value around String

getLineColorAsInt

public int getLineColorAsInt()

The color with which the line will be drawn.

Returns:

int representation of a rgba string color

Throws:

java.lang.RuntimeException - thrown if property isn't a value

getLineColorTransition

@NonNull
public TransitionOptions getLineColorTransition()

Get the LineColor property transition options

Returns:

transition options for String

setLineColorTransition

public void setLineColorTransition(@NonNull
                                   TransitionOptions options)

Set the LineColor property transition options

Parameters:

options - transition options for String

getLineTranslate

@NonNull
public PropertyValue<java.lang.Float[]> getLineTranslate()

Get the LineTranslate property

Returns:

property wrapper value around Float[]

getLineTranslateTransition

@NonNull
public TransitionOptions getLineTranslateTransition()

Get the LineTranslate property transition options

Returns:

transition options for Float[]

setLineTranslateTransition

public void setLineTranslateTransition(@NonNull
                                       TransitionOptions options)

Set the LineTranslate property transition options

Parameters:

options - transition options for Float[]

getLineTranslateAnchor

@NonNull
public PropertyValue<java.lang.String> getLineTranslateAnchor()

Get the LineTranslateAnchor property

Returns:

property wrapper value around String

getLineWidth

@NonNull
public PropertyValue<java.lang.Float> getLineWidth()

Get the LineWidth property

Returns:

property wrapper value around Float

getLineWidthTransition

@NonNull
public TransitionOptions getLineWidthTransition()

Get the LineWidth property transition options

Returns:

transition options for Float

setLineWidthTransition

public void setLineWidthTransition(@NonNull
                                   TransitionOptions options)

Set the LineWidth property transition options

Parameters:

options - transition options for Float

getLineGapWidth

@NonNull
public PropertyValue<java.lang.Float> getLineGapWidth()

Get the LineGapWidth property

Returns:

property wrapper value around Float

getLineGapWidthTransition

@NonNull
public TransitionOptions getLineGapWidthTransition()

Get the LineGapWidth property transition options

Returns:

transition options for Float

setLineGapWidthTransition

public void setLineGapWidthTransition(@NonNull
                                      TransitionOptions options)

Set the LineGapWidth property transition options

Parameters:

options - transition options for Float

getLineOffset

@NonNull
public PropertyValue<java.lang.Float> getLineOffset()

Get the LineOffset property

Returns:

property wrapper value around Float

getLineOffsetTransition

@NonNull
public TransitionOptions getLineOffsetTransition()

Get the LineOffset property transition options

Returns:

transition options for Float

setLineOffsetTransition

public void setLineOffsetTransition(@NonNull
                                    TransitionOptions options)

Set the LineOffset property transition options

Parameters:

options - transition options for Float

getLineBlur

@NonNull
public PropertyValue<java.lang.Float> getLineBlur()

Get the LineBlur property

Returns:

property wrapper value around Float

getLineBlurTransition

@NonNull
public TransitionOptions getLineBlurTransition()

Get the LineBlur property transition options

Returns:

transition options for Float

setLineBlurTransition

public void setLineBlurTransition(@NonNull
                                  TransitionOptions options)

Set the LineBlur property transition options

Parameters:

options - transition options for Float

getLineDasharray

@NonNull
public PropertyValue<java.lang.Float[]> getLineDasharray()

Get the LineDasharray property

Returns:

property wrapper value around Float[]

getLineDasharrayTransition

@NonNull
public TransitionOptions getLineDasharrayTransition()

Get the LineDasharray property transition options

Returns:

transition options for Float[]

setLineDasharrayTransition

public void setLineDasharrayTransition(@NonNull
                                       TransitionOptions options)

Set the LineDasharray property transition options

Parameters:

options - transition options for Float[]

getLinePattern

@NonNull
public PropertyValue<java.lang.String> getLinePattern()

Get the LinePattern property

Returns:

property wrapper value around String

getLinePatternTransition

@NonNull
public TransitionOptions getLinePatternTransition()

Get the LinePattern property transition options

Returns:

transition options for String

setLinePatternTransition

public void setLinePatternTransition(@NonNull
                                     TransitionOptions options)

Set the LinePattern property transition options

Parameters:

options - transition options for String

getLineGradient

@NonNull
public PropertyValue<java.lang.String> getLineGradient()

Get the LineGradient property

Returns:

property wrapper value around String

getLineGradientAsInt

public int getLineGradientAsInt()

Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.

Returns:

int representation of a rgba string color

Throws:

java.lang.RuntimeException - thrown if property isn't a value

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class Layer

Throws:

java.lang.Throwable