com.mapbox.mapboxsdk.style.functions

Class Function<I,O>

java.lang.Object

com.mapbox.mapboxsdk.style.functions.Function<I,O>

Type Parameters:

I - the function's input type

O - the target property's value type. Make sure it matches.

Direct Known Subclasses:

CameraFunction, CompositeFunction, SourceFunction

public class Function<I,O>
extends java.lang.Object

Functions are used to change properties in relation to the state of the map.

The value for any layout or paint property may be specified as a function. Functions allow you to make the appearance of a map feature change with the current zoom level and/or the feature's properties.

See Also:

The style specification

Method Summary

Modifier and Type	Method and Description
static <Z extends java.lang.Number,I,O> CompositeFunction<Z,I,O>	composite(java.lang.String property, CategoricalStops<Stop.CompositeValue<Z,I>,O> stops) Create a composite, categorical function.
static <Z extends java.lang.Number,I,O> CompositeFunction<Z,I,O>	composite(java.lang.String property, ExponentialStops<Stop.CompositeValue<Z,I>,O> stops) Create a composite, exponential function.
static <Z extends java.lang.Number,I,O> CompositeFunction<Z,I,O>	composite(java.lang.String property, IntervalStops<Stop.CompositeValue<Z,I>,O> stops) Create a composite, interval function.
Stops	getStops()
<S extends Stops> S	getStopsAs() Convenience method
static <I,O> SourceFunction<I,O>	property(java.lang.String property, CategoricalStops<I,O> stops) Create an categorical SourceFunction
static <I,O> SourceFunction<I,O>	property(java.lang.String property, ExponentialStops<I,O> stops) Create an exponential SourceFunction
static <T> SourceFunction<T,T>	property(java.lang.String property, IdentityStops<T> stops) Create an identity SourceFunction
static <I,O> SourceFunction<I,O>	property(java.lang.String property, IntervalStops<I,O> stops) Create an interval SourceFunction
java.lang.String	toString()
java.util.Map<java.lang.String,java.lang.Object>	toValueObject() INTERNAL USAGE ONLY
static <Z extends java.lang.Number,O> CameraFunction<Z,O>	zoom(ExponentialStops<Z,O> stops) Create an exponential CameraFunction
static <Z extends java.lang.Number,O> CameraFunction<Z,O>	zoom(IntervalStops<Z,O> stops) Create an interval CameraFunction

Methods inherited from class java.lang.Object

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

Method Detail

zoom

public static <Z extends java.lang.Number,O> CameraFunction<Z,O> zoom(@NonNull
                                                                      ExponentialStops<Z,O> stops)

Create an exponential CameraFunction

Zoom functions allow the appearance of a map feature to change with map’s zoom. Zoom functions can be used to create the illusion of depth and control data density. Each stop is an array with two elements, the first is a zoom and the second is a function output value.

Type Parameters:

Z - the zoom level type (Float, Integer)

O - the property type

Parameters:

stops - the stops implementation that define the function. @see Stops.exponential(Stop[])

Returns:

the CameraFunction

See Also:

CameraFunction, ExponentialStops, Stops.exponential(Stop[]), Stops.exponential(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

zoom

public static <Z extends java.lang.Number,O> CameraFunction<Z,O> zoom(@NonNull
                                                                      IntervalStops<Z,O> stops)

Create an interval CameraFunction

Zoom functions allow the appearance of a map feature to change with map’s zoom. Zoom functions can be used to create the illusion of depth and control data density. Each stop is an array with two elements, the first is a zoom and the second is a function output value.

Type Parameters:

Z - the zoom level type (Float, Integer)

O - the property type

Parameters:

stops - the stops implementation that define the function. @see Stops.interval(Stop[])

Returns:

the CameraFunction

See Also:

CameraFunction, IntervalStops, Stops.interval(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

property

public static <I,O> SourceFunction<I,O> property(@NonNull
                                                 java.lang.String property,
                                                 @NonNull
                                                 ExponentialStops<I,O> stops)

Create an exponential SourceFunction

Source functions allow the appearance of a map feature to change with its properties. Source functions can be used to visually differentiate types of features within the same layer or create data visualizations. Each stop is an array with two elements, the first is a property input value and the second is a function output value. Note that support for property functions is not available across all properties and platforms at this time.

Type Parameters:

I - the function input type

O - the function output type

Parameters:

property - the feature property name

stops - the stops

Returns:

the SourceFunction

See Also:

SourceFunction, ExponentialStops, Stops.exponential(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

property

public static <T> SourceFunction<T,T> property(@NonNull
                                               java.lang.String property,
                                               @NonNull
                                               IdentityStops<T> stops)

Create an identity SourceFunction

Source functions allow the appearance of a map feature to change with its properties. Source functions can be used to visually differentiate types of features within the same layer or create data visualizations. Each stop is an array with two elements, the first is a property input value and the second is a function output value. Note that support for property functions is not available across all properties and platforms at this time.

Type Parameters:

T - the function input/output type

Parameters:

property - the feature property name

stops - the stops

Returns:

the SourceFunction

See Also:

SourceFunction, IdentityStops, Stops.identity(), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

property

public static <I,O> SourceFunction<I,O> property(@NonNull
                                                 java.lang.String property,
                                                 @NonNull
                                                 IntervalStops<I,O> stops)

Create an interval SourceFunction

Source functions allow the appearance of a map feature to change with its properties. Source functions can be used to visually differentiate types of features within the same layer or create data visualizations. Each stop is an array with two elements, the first is a property input value and the second is a function output value. Note that support for property functions is not available across all properties and platforms at this time.

Type Parameters:

I - the function input type

O - the function output type

Parameters:

property - the feature property name

stops - the stops

Returns:

the SourceFunction

See Also:

SourceFunction, IntervalStops, Stops.interval(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

property

public static <I,O> SourceFunction<I,O> property(@NonNull
                                                 java.lang.String property,
                                                 @NonNull
                                                 CategoricalStops<I,O> stops)

Create an categorical SourceFunction

Source functions allow the appearance of a map feature to change with its properties. Source functions can be used to visually differentiate types of features within the same layer or create data visualizations. Each stop is an array with two elements, the first is a property input value and the second is a function output value. Note that support for property functions is not available across all properties and platforms at this time.

Type Parameters:

I - the function input type

O - the function output type

Parameters:

property - the feature property name

stops - the stops

Returns:

the SourceFunction

See Also:

SourceFunction, CategoricalStops, Stops.categorical(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

composite

public static <Z extends java.lang.Number,I,O> CompositeFunction<Z,I,O> composite(@NonNull
                                                                                  java.lang.String property,
                                                                                  @NonNull
                                                                                  CategoricalStops<Stop.CompositeValue<Z,I>,O> stops)

Create a composite, categorical function.

Composite functions allow the appearance of a map feature to change with both its properties and zoom. Each stop is an array with two elements, the first is an object with a property input value and a zoom, and the second is a function output value. Note that support for property functions is not yet complete.

Type Parameters:

Z - the zoom function input type (Float usually)

I - the function input type for the source part of the function

O - the function output type

Parameters:

property - the feature property name for the source part of the function

stops - the stops

Returns:

the CompositeFunction

See Also:

CompositeFunction, CategoricalStops, Stops.categorical(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

composite

public static <Z extends java.lang.Number,I,O> CompositeFunction<Z,I,O> composite(@NonNull
                                                                                  java.lang.String property,
                                                                                  @NonNull
                                                                                  ExponentialStops<Stop.CompositeValue<Z,I>,O> stops)

Create a composite, exponential function.

Composite functions allow the appearance of a map feature to change with both its properties and zoom. Each stop is an array with two elements, the first is an object with a property input value and a zoom, and the second is a function output value. Note that support for property functions is not yet complete.

Type Parameters:

Z - the zoom function input type (Float usually)

I - the function input type for the source part of the function

O - the function output type

Parameters:

property - the feature property name for the source part of the function

stops - the stops

Returns:

the CompositeFunction

See Also:

CompositeFunction, ExponentialStops, Stops.exponential(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

composite

public static <Z extends java.lang.Number,I,O> CompositeFunction<Z,I,O> composite(@NonNull
                                                                                  java.lang.String property,
                                                                                  @NonNull
                                                                                  IntervalStops<Stop.CompositeValue<Z,I>,O> stops)

Create a composite, interval function.

Composite functions allow the appearance of a map feature to change with both its properties and zoom. Each stop is an array with two elements, the first is an object with a property input value and a zoom, and the second is a function output value. Note that support for property functions is not yet complete.

Type Parameters:

Z - the zoom function input type (Float usually)

I - the function input type for the source part of the function

O - the function output type

Parameters:

property - the feature property name for the source part of the function

stops - the stops

Returns:

the CompositeFunction

See Also:

CompositeFunction, IntervalStops, Stops.interval(Stop[]), Stop.stop(I, com.mapbox.mapboxsdk.style.layers.PropertyValue<O>)

getStops

public Stops getStops()

Returns:

the stops in this function

getStopsAs

@Nullable
public <S extends Stops> S getStopsAs()

Convenience method

Type Parameters:

S - the Stops implementation type

Returns:

the Stops implementation or null when the wrong type is specified

toValueObject

public java.util.Map<java.lang.String,java.lang.Object> toValueObject()

INTERNAL USAGE ONLY

Returns:

a value object representation for core conversion

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object