com.mapbox.mapboxsdk.style.functions

Class SourceFunction<I,O>

java.lang.Object

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

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

Type Parameters:

I - the input type

O - the output type

public class SourceFunction<I,O>
extends Function<I,O>

Source functions take Feature property names as input.

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.

See Also:

Function.property(java.lang.String, com.mapbox.mapboxsdk.style.functions.stops.ExponentialStops<I, O>)

Method Summary

Modifier and Type	Method and Description
PropertyValue<O>	getDefaultValue()
java.lang.String	getProperty() INTERNAL USAGE ONLY
java.util.Map<java.lang.String,java.lang.Object>	toValueObject() INTERNAL USAGE ONLY
SourceFunction<I,O>	withDefaultValue(PropertyValue<O> defaultValue) Set the default value

Methods inherited from class com.mapbox.mapboxsdk.style.functions.Function

composite, composite, composite, getStops, getStopsAs, property, property, property, property, toString, zoom, zoom

Methods inherited from class java.lang.Object

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

Method Detail

getProperty

public java.lang.String getProperty()

INTERNAL USAGE ONLY

Returns:

The feature property name

withDefaultValue

public SourceFunction<I,O> withDefaultValue(PropertyValue<O> defaultValue)

Set the default value

Parameters:

defaultValue - the default value to use when no other applies

Returns:

this (for chaining)

getDefaultValue

@Nullable
public PropertyValue<O> getDefaultValue()

Returns:

the defaultValue

toValueObject

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

INTERNAL USAGE ONLY

Overrides:

toValueObject in class Function<I,O>

Returns:

a value object representation for core conversion