package com.mapbox.mapboxsdk.style.expressions; import android.annotation.SuppressLint; import android.support.annotation.ColorInt; import android.support.annotation.NonNull; import android.support.annotation.Nullable; import android.support.annotation.Size; import com.google.gson.Gson; import com.google.gson.JsonArray; import com.google.gson.JsonElement; import com.google.gson.JsonNull; import com.google.gson.JsonObject; import com.google.gson.JsonPrimitive; import com.mapbox.mapboxsdk.style.layers.PropertyFactory; import com.mapbox.mapboxsdk.style.layers.PropertyValue; import java.util.ArrayList; import java.util.Arrays; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import static com.mapbox.mapboxsdk.utils.ColorUtils.colorToRgbaArray; /** * The value for any layout property, paint property, or filter may be specified as an expression. * An expression defines a formula for computing the value of the property using the operators described below. * The set of expression operators provided by Mapbox GL includes: *
* Expressions are represented as JSON arrays. * The first element of an expression array is a string naming the expression operator, * e.g. "*"or "case". Subsequent elements (if any) are the arguments to the expression. * Each argument is either a literal value (a string, number, boolean, or null), or another expression array. *
** Data expression: a data expression is any expression that access feature data -- that is, * any expression that uses one of the data operators:get,has,id,geometry-type, or properties. * Data expressions allow a feature's properties to determine its appearance. * They can be used to differentiate features within the same layer and to create data visualizations. *
** Camera expression: a camera expression is any expression that uses the zoom operator. * Such expressions allow the the appearance of a layer to change with the map's zoom level. * Camera expressions can be used to create the appearance of depth and to control data density. *
** Composition: a single expression may use a mix of data operators, camera operators, and other operators. * Such composite expressions allows a layer's appearance to be determined by * a combination of the zoom level and individual feature properties. *
** Example expression: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( linear(), zoom(), * stop(12, step(get("stroke-width"), * color(Color.BLACK), * stop(1f, color(Color.RED)), * stop(2f, color(Color.WHITE)), * stop(3f, color(Color.BLUE)) * )), * stop(15, step(get("stroke-width"), * color(Color.BLACK), * stop(1f, color(Color.YELLOW)), * stop(2f, color(Color.LTGRAY)), * stop(3f, color(Color.CYAN)) * )), * stop(18, step(get("stroke-width"), * color(Color.BLACK), * stop(1f, color(Color.WHITE)), * stop(2f, color(Color.GRAY)), * stop(3f, color(Color.GREEN)) * )) * ) * ) * ); * } **/ public class Expression { @Nullable private final String operator; @Nullable private final Expression[] arguments; /** * Creates an empty expression for expression literals */ Expression() { operator = null; arguments = null; } /** * Creates an expression from its operator and varargs expressions. * * @param operator the expression operator * @param arguments expressions input */ public Expression(@NonNull String operator, @Nullable Expression... arguments) { this.operator = operator; this.arguments = arguments; } /** * Create a literal number expression. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(literal(10.0f)) * ); * } ** * @param number the number * @return the expression */ public static Expression literal(@NonNull Number number) { return new ExpressionLiteral(number); } /** * Create a literal string expression. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(literal("Text")) * ); * } ** * @param string the string * @return the expression */ public static Expression literal(@NonNull String string) { return new ExpressionLiteral(string); } /** * Create a literal boolean expression. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillAntialias(literal(true)) * ); * } ** * @param bool the boolean * @return the expression */ public static Expression literal(boolean bool) { return new ExpressionLiteral(bool); } /** * Create a literal object expression. * * @param object the object * @return the expression */ public static Expression literal(@NonNull Object object) { if (object.getClass().isArray()) { return literal(toObjectArray(object)); } else if (object instanceof Expression) { throw new RuntimeException("Can't convert an expression to a literal"); } return new ExpressionLiteral(object); } /** * Create a literal array expression * * @param array the array * @return the expression */ public static Expression literal(@NonNull Object[] array) { return new Expression("literal", new ExpressionLiteralArray(array)); } /** * Expression literal utility method to convert a color int to an color expression *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor(color(Color.GREEN)) * ); * } ** * @param color the int color * @return the color expression */ public static Expression color(@ColorInt int color) { float[] rgba = colorToRgbaArray(color); return rgba(rgba[0], rgba[1], rgba[2], rgba[3]); } /** * Creates a color value from red, green, and blue components, which must range between 0 and 255, * and an alpha component of 1. *
* If any component is out of range, the expression is an error. *
** Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * rgb( * literal(255.0f), * literal(255.0f), * literal(255.0f) * ) * ) * ); * } ** * @param red red color expression * @param green green color expression * @param blue blue color expression * @return expression * @see Style specification */ public static Expression rgb(@NonNull Expression red, @NonNull Expression green, @NonNull Expression blue) { return new Expression("rgb", red, green, blue); } /** * Creates a color value from red, green, and blue components, which must range between 0 and 255, * and an alpha component of 1. *
* If any component is out of range, the expression is an error. *
** Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * rgb(255.0f, 255.0f, 255.0f) * ) * ); * } ** * @param red red color value * @param green green color value * @param blue blue color value * @return expression * @see Style specification */ public static Expression rgb(@NonNull Number red, @NonNull Number green, @NonNull Number blue) { return rgb(literal(red), literal(green), literal(blue)); } /** * Creates a color value from red, green, blue components, which must range between 0 and 255, * and an alpha component which must range between 0 and 1. *
* If any component is out of range, the expression is an error. *
** Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * rgba( * literal(255.0f), * literal(255.0f), * literal(255.0f), * literal(1.0f) * ) * ) * ); * } ** * @param red red color value * @param green green color value * @param blue blue color value * @param alpha alpha color value * @return expression * @see Style specification */ public static Expression rgba(@NonNull Expression red, @NonNull Expression green, @NonNull Expression blue, @NonNull Expression alpha) { return new Expression("rgba", red, green, blue, alpha); } /** * Creates a color value from red, green, blue components, which must range between 0 and 255, * and an alpha component which must range between 0 and 1. *
* If any component is out of range, the expression is an error. *
** Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * rgba(255.0f, 255.0f, 255.0f, 1.0f) * ) * ); * } ** * @param red red color value * @param green green color value * @param blue blue color value * @param alpha alpha color value * @return expression * @see Style specification */ public static Expression rgba(@NonNull Number red, @NonNull Number green, @NonNull Number blue, @NonNull Number alpha) { return rgba(literal(red), literal(green), literal(blue), literal(alpha)); } /** * Returns a four-element array containing the input color's red, green, blue, and alpha components, in that order. * * @param expression an expression to convert to a color * @return expression * @see Style specification */ public static Expression toRgba(@NonNull Expression expression) { return new Expression("to-rgba", expression); } /** * Returns true if the input values are equal, false otherwise. * The inputs must be numbers, strings, or booleans, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * eq(get("keyToValue"), get("keyToOtherValue")) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @return expression * @see Style specification */ public static Expression eq(@NonNull Expression compareOne, @NonNull Expression compareTwo) { return new Expression("==", compareOne, compareTwo); } /** * Returns true if the input values are equal, false otherwise. * The inputs must be numbers, strings, or booleans, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * eq(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @param collator the collator expression * @return expression * @see Style specification */ public static Expression eq(@NonNull Expression compareOne, @NonNull Expression compareTwo, @NonNull Expression collator) { return new Expression("==", compareOne, compareTwo, collator); } /** * Returns true if the input values are equal, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * eq(get("keyToValue"), true) * ); * } ** * @param compareOne the first expression * @param compareTwo the second boolean * @return expression * @see Style specification */ public static Expression eq(@NonNull Expression compareOne, boolean compareTwo) { return eq(compareOne, literal(compareTwo)); } /** * Returns true if the input values are equal, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * eq(get("keyToValue"), "value") * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @return expression * @see Style specification */ public static Expression eq(@NonNull Expression compareOne, @NonNull String compareTwo) { return eq(compareOne, literal(compareTwo)); } /** * Returns true if the input values are equal, false otherwise. * The inputs must be numbers, strings, or booleans, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * eq(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second String * @param collator the collator expression * @return expression * @see Style specification */ public static Expression eq(@NonNull Expression compareOne, @NonNull String compareTwo, @NonNull Expression collator) { return eq(compareOne, literal(compareTwo), collator); } /** * Returns true if the input values are equal, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * eq(get("keyToValue"), 2.0f) * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @return expression * @see Style specification */ public static Expression eq(@NonNull Expression compareOne, @NonNull Number compareTwo) { return eq(compareOne, literal(compareTwo)); } /** * Returns true if the input values are not equal, false otherwise. * The inputs must be numbers, strings, or booleans, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * neq(get("keyToValue"), get("keyToOtherValue")) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @return expression * @see Style specification */ public static Expression neq(@NonNull Expression compareOne, @NonNull Expression compareTwo) { return new Expression("!=", compareOne, compareTwo); } /** * Returns true if the input values are not equal, false otherwise. * The inputs must be numbers, strings, or booleans, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * neq(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @param collator the collator expression * @return expression * @see Style specification */ public static Expression neq(@NonNull Expression compareOne, @NonNull Expression compareTwo, @NonNull Expression collator) { return new Expression("!=", compareOne, compareTwo, collator); } /** * Returns true if the input values are equal, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * neq(get("keyToValue"), true) * ); * } ** * @param compareOne the first expression * @param compareTwo the second boolean * @return expression * @see Style specification */ public static Expression neq(Expression compareOne, boolean compareTwo) { return new Expression("!=", compareOne, literal(compareTwo)); } /** * Returns `true` if the input values are not equal, `false` otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * neq(get("keyToValue"), "value") * ); * } ** * @param compareOne the first expression * @param compareTwo the second string * @return expression * @see Style specification */ public static Expression neq(@NonNull Expression compareOne, @NonNull String compareTwo) { return new Expression("!=", compareOne, literal(compareTwo)); } /** * Returns true if the input values are not equal, false otherwise. * The inputs must be numbers, strings, or booleans, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * neq(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second String * @param collator the collator expression * @return expression * @see Style specification */ public static Expression neq(@NonNull Expression compareOne, @NonNull String compareTwo, @NonNull Expression collator) { return new Expression("!=", compareOne, literal(compareTwo), collator); } /** * Returns `true` if the input values are not equal, `false` otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * neq(get("keyToValue"), 2.0f) * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @return expression * @see Style specification */ public static Expression neq(@NonNull Expression compareOne, @NonNull Number compareTwo) { return new Expression("!=", compareOne, literal(compareTwo)); } /** * Returns true if the first input is strictly greater than the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gt(get("keyToValue"), get("keyToOtherValue")) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @return expression * @see Style specification */ public static Expression gt(@NonNull Expression compareOne, @NonNull Expression compareTwo) { return new Expression(">", compareOne, compareTwo); } /** * Returns true if the first input is strictly greater than the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gt(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @param collator the collator expression * @return expression * @see Style specification */ public static Expression gt(@NonNull Expression compareOne, @NonNull Expression compareTwo, @NonNull Expression collator) { return new Expression(">", compareOne, compareTwo, collator); } /** * Returns true if the first input is strictly greater than the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gt(get("keyToValue"), 2.0f) * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @return expression * @see Style specification */ public static Expression gt(@NonNull Expression compareOne, @NonNull Number compareTwo) { return new Expression(">", compareOne, literal(compareTwo)); } /** * Returns true if the first input is strictly greater than the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gt(get("keyToValue"), "value") * ); * } ** * @param compareOne the first expression * @param compareTwo the second string * @return expression * @see Style specification */ public static Expression gt(@NonNull Expression compareOne, @NonNull String compareTwo) { return new Expression(">", compareOne, literal(compareTwo)); } /** * Returns true if the first input is strictly greater than the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gt(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second String * @param collator the collator expression * @return expression * @see Style specification */ public static Expression gt(@NonNull Expression compareOne, @NonNull String compareTwo, @NonNull Expression collator) { return new Expression(">", compareOne, literal(compareTwo), collator); } /** * Returns true if the first input is strictly less than the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lt(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @return expression * @see Style specification */ public static Expression lt(@NonNull Expression compareOne, @NonNull Expression compareTwo) { return new Expression("<", compareOne, compareTwo); } /** * Returns true if the first input is strictly less than the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lt(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @param collator the collator expression * @return expression * @see Style specification */ public static Expression lt(@NonNull Expression compareOne, @NonNull Expression compareTwo, @NonNull Expression collator) { return new Expression("<", compareOne, compareTwo, collator); } /** * Returns true if the first input is strictly less than the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lt(get("keyToValue"), 2.0f) * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @return expression * @see Style specification */ public static Expression lt(@NonNull Expression compareOne, @NonNull Number compareTwo) { return new Expression("<", compareOne, literal(compareTwo)); } /** * Returns true if the first input is strictly less than the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lt(get("keyToValue"), "value") * ); * } ** * @param compareOne the first expression * @param compareTwo the second string * @return expression * @see Style specification */ public static Expression lt(@NonNull Expression compareOne, @NonNull String compareTwo) { return new Expression("<", compareOne, literal(compareTwo)); } /** * Returns true if the first input is strictly less than the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lt(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second String * @param collator the collator expression * @return expression * @see Style specification */ public static Expression lt(@NonNull Expression compareOne, @NonNull String compareTwo, @NonNull Expression collator) { return new Expression("<", compareOne, literal(compareTwo), collator); } /** * Returns true if the first input is greater than or equal to the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gte(get("keyToValue"), get("keyToOtherValue")) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @return expression * @see Style specification */ public static Expression gte(@NonNull Expression compareOne, @NonNull Expression compareTwo) { return new Expression(">=", compareOne, compareTwo); } /** * Returns true if the first input is greater than or equal to the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gte(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @param collator the collator expression * @return expression * @see Style specification */ public static Expression gte(@NonNull Expression compareOne, @NonNull Expression compareTwo, @NonNull Expression collator) { return new Expression(">=", compareOne, compareTwo, collator); } /** * Returns true if the first input is greater than or equal to the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gte(get("keyToValue"), 2.0f) * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @return expression * @see Style specification */ public static Expression gte(@NonNull Expression compareOne, @NonNull Number compareTwo) { return new Expression(">=", compareOne, literal(compareTwo)); } /** * Returns true if the first input is greater than or equal to the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * neq(get("keyToValue"), "value") * ); * } ** * @param compareOne the first expression * @param compareTwo the second string * @return expression * @see Style specification */ public static Expression gte(@NonNull Expression compareOne, @NonNull String compareTwo) { return new Expression(">=", compareOne, literal(compareTwo)); } /** * Returns true if the first input is greater than or equal to the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * gte(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second String * @param collator the collator expression * @return expression * @see Style specification */ public static Expression gte(@NonNull Expression compareOne, @NonNull String compareTwo, @NonNull Expression collator) { return new Expression(">=", compareOne, literal(compareTwo), collator); } /** * Returns true if the first input is less than or equal to the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lte(get("keyToValue"), get("keyToOtherValue")) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @return expression * @see Style specification */ public static Expression lte(@NonNull Expression compareOne, @NonNull Expression compareTwo) { return new Expression("<=", compareOne, compareTwo); } /** * Returns true if the first input is less than or equal to the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lte(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second expression * @param collator the collator expression * @return expression * @see Style specification */ public static Expression lte(@NonNull Expression compareOne, @NonNull Expression compareTwo, @NonNull Expression collator) { return new Expression("<=", compareOne, compareTwo, collator); } /** * Returns true if the first input is less than or equal to the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lte(get("keyToValue"), 2.0f) * ); * } ** * @param compareOne the first expression * @param compareTwo the second number * @return expression * @see Style specification */ public static Expression lte(@NonNull Expression compareOne, @NonNull Number compareTwo) { return new Expression("<=", compareOne, literal(compareTwo)); } /** * Returns true if the first input is less than or equal to the second, false otherwise. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lte(get("keyToValue"), "value") * ); * } ** * @param compareOne the first expression * @param compareTwo the second string * @return expression * @see Style specification */ public static Expression lte(@NonNull Expression compareOne, @NonNull String compareTwo) { return new Expression("<=", compareOne, literal(compareTwo)); } /** * Returns true if the first input is less than or equal to the second, false otherwise. * The inputs must be numbers or strings, and both of the same type. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * lte(get("keyToValue"), get("keyToOtherValue"), collator(true, false)) * ); * } ** * @param compareOne the first expression * @param compareTwo the second String * @param collator the collator expression * @return expression * @see Style specification */ public static Expression lte(@NonNull Expression compareOne, @NonNull String compareTwo, @NonNull Expression collator) { return new Expression("<=", compareOne, literal(compareTwo), collator); } /** * Returns `true` if all the inputs are `true`, `false` otherwise. *
* The inputs are evaluated in order, and evaluation is short-circuiting: * once an input expression evaluates to `false`, * the result is `false` and no further input expressions are evaluated. *
** Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * all(get("keyToValue"), get("keyToOtherValue")) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression all(@NonNull Expression... input) { return new Expression("all", input); } /** * Returns `true` if any of the inputs are `true`, `false` otherwise. *
* The inputs are evaluated in order, and evaluation is short-circuiting: * once an input expression evaluates to `true`, * the result is `true` and no further input expressions are evaluated. *
** Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * any(get("keyToValue"), get("keyToOtherValue")) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression any(@NonNull Expression... input) { return new Expression("any", input); } /** * Logical negation. Returns `true` if the input is `false`, and `false` if the input is `true`. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * not(get("keyToValue")) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression not(@NonNull Expression input) { return new Expression("!", input); } /** * Logical negation. Returns `true` if the input is `false`, and `false` if the input is `true`. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * not(false) * ); * } ** * @param input boolean input * @return expression * @see Style specification */ public static Expression not(boolean input) { return not(literal(input)); } /** * Selects the first output whose corresponding test condition evaluates to true. *
* For each case a condition and an output should be provided. * The last parameter should provide the default output. *
** Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * iconSize( * switchCase( * get(KEY_TO_BOOLEAN), literal(3.0f), * get(KEY_TO_OTHER_BOOLEAN), literal(5.0f), * literal(1.0f) // default value * ) * ) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression switchCase(@NonNull @Size(min = 1) Expression... input) { return new Expression("case", input); } /** * Selects the output whose label value matches the input value, or the fallback value if no match is found. * The `input` can be any string or number expression. * Each label can either be a single literal value or an array of values. * If types of the input and keys don't match, or the input value doesn't exist, * the expresion will fail without falling back to the default value. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textColor( * match(get("keyToValue"), * literal(1), rgba(255, 0, 0, 1.0f), * literal(2), rgba(0, 0, 255.0f, 1.0f), * rgba(0.0f, 255.0f, 0.0f, 1.0f) * ) * ) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression match(@NonNull @Size(min = 2) Expression... input) { return new Expression("match", input); } /** * Selects the output whose label value matches the input value, or the fallback value if no match is found. * The `input` can be any string or number expression. * Each label can either be a single literal value or an array of values. * If types of the input and keys don't match, or the input value doesn't exist, * the expresion will fail without falling back to the default value. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textColor( * match(get("keyToValue"), * literal(1), rgba(255, 0, 0, 1.0f), * literal(2), rgba(0, 0, 255.0f, 1.0f), * rgba(0.0f, 255.0f, 0.0f, 1.0f) * ) * ) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression match(@NonNull Expression input, @NonNull Expression defaultOutput, @NonNull Stop... stops) { return match(join(join(new Expression[] {input}, Stop.toExpressionArray(stops)), new Expression[] {defaultOutput})); } /** * Evaluates each expression in turn until the first non-null value is obtained, and returns that value. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textColor( * coalesce( * get("keyToNullValue"), * get("keyToNonNullValue") * ) * ) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression coalesce(@NonNull Expression... input) { return new Expression("coalesce", input); } /** * Gets the feature properties object. *
* Note that in some cases, it may be more efficient to use {@link #get(Expression)}} instead. *
** Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(get("key-to-value", properties())) * ); * } ** * @return expression * @see Style specification */ public static Expression properties() { return new Expression("properties"); } /** * Gets the feature's geometry type: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(concat(get("key-to-value"), literal(" "), geometryType())) * ); * } ** * @return expression * @see Style specification */ public static Expression geometryType() { return new Expression("geometry-type"); } /** * Gets the feature's id, if it has one. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(id()) * ); * } ** * @return expression * @see Style specification */ public static Expression id() { return new Expression("id"); } /** * Gets the kernel density estimation of a pixel in a heatmap layer, * which is a relative measure of how many data points are crowded around a particular pixel. * Can only be used in the `heatmap-color` property. *
* Example usage: *
** {@code * HeatmapLayer layer = new HeatmapLayer("layer-id", "source-id"); * layer.setProperties( * heatmapColor(interpolate(linear(), heatmapDensity(), * literal(0), rgba(33, 102, 172, 0), * literal(0.2), rgb(103, 169, 207), * literal(0.4), rgb(209, 229, 240), * literal(0.6), rgb(253, 219, 199), * literal(0.8), rgb(239, 138, 98), * literal(1), rgb(178, 24, 43)) * ) * ); * } ** * @return expression * @see Style specification */ public static Expression heatmapDensity() { return new Expression("heatmap-density"); } /** * Gets the progress along a gradient line. Can only be used in the line-gradient property. *
* Example usage: *
** {@code * LineLayer layer = new LineLayer("layer-id", "source-id"); * layer.setProperties( * lineGradient(interpolate( * linear(), lineProgress(), * stop(0f, rgb(0, 0, 255)), * stop(0.5f, rgb(0, 255, 0)), * stop(1f, rgb(255, 0, 0))) * ) * ); * } ** * @return expression * @see Style specification */ public static Expression lineProgress() { return new Expression("line-progress"); } /** * Retrieves an item from an array. * * @param number the index expression * @param expression the array expression * @return expression * @see Style specification */ public static Expression at(@NonNull Expression number, @NonNull Expression expression) { return new Expression("at", number, expression); } /** * Retrieves an item from an array. * * @param number the index expression * @param expression the array expression * @return expression * @see Style specification */ public static Expression at(@NonNull Number number, @NonNull Expression expression) { return at(literal(number), expression); } /** * Retrieves a property value from the current feature's properties, * or from another object if a second argument is provided. * Returns null if the requested property is missing. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(get("key-to-feature")) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression get(@NonNull Expression input) { return new Expression("get", input); } /** * Retrieves a property value from the current feature's properties, * or from another object if a second argument is provided. * Returns null if the requested property is missing. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(get("key-to-feature")) * ); * } ** * @param input string input * @return expression * @see Style specification */ public static Expression get(@NonNull String input) { return get(literal(input)); } /** * Retrieves a property value from another object. * Returns null if the requested property is missing. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(get("key-to-property", get("key-to-object"))) * ); * } ** * @param key a property value key * @param object an expression object * @return expression * @see Style specification */ public static Expression get(@NonNull Expression key, @NonNull Expression object) { return new Expression("get", key, object); } /** * Retrieves a property value from another object. * Returns null if the requested property is missing. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(get("key-to-property", get("key-to-object"))) * ); * } ** * @param key a property value key * @param object an expression object * @return expression * @see Style specification */ public static Expression get(@NonNull String key, @NonNull Expression object) { return get(literal(key), object); } /** * Tests for the presence of an property value in the current feature's properties. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * has(get("keyToValue")) * ); * } ** * @param key the expression property value key * @return expression * @see Style specification */ public static Expression has(@NonNull Expression key) { return new Expression("has", key); } /** * Tests for the presence of an property value in the current feature's properties. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * has("keyToValue") * ); * } ** * @param key the property value key * @return expression * @see Style specification */ public static Expression has(@NonNull String key) { return has(literal(key)); } /** * Tests for the presence of an property value from another object. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * has(get("keyToValue"), get("keyToObject")) * ); * } ** * @param key the expression property value key * @param object an expression object * @return expression * @see Style specification */ public static Expression has(@NonNull Expression key, @NonNull Expression object) { return new Expression("has", key, object); } /** * Tests for the presence of an property value from another object. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setFilter( * has("keyToValue", get("keyToObject")) * ); * } ** * @param key the property value key * @param object an expression object * @return expression * @see Style specification */ public static Expression has(@NonNull String key, @NonNull Expression object) { return has(literal(key), object); } /** * Gets the length of an array or string. * * @param expression an expression object or expression string * @return expression * @see Style specification */ public static Expression length(@NonNull Expression expression) { return new Expression("length", expression); } /** * Gets the length of an array or string. * * @param input a string * @return expression * @see Style specification */ public static Expression length(@NonNull String input) { return length(literal(input)); } /** * Returns mathematical constant ln(2). *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(product(literal(10.0f), ln2())) * ); * } ** * @return expression * @see Style specification */ public static Expression ln2() { return new Expression("ln2"); } /** * Returns the mathematical constant pi. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(product(literal(10.0f), pi())) * ); * } ** * @return expression * @see Style specification */ public static Expression pi() { return new Expression("pi"); } /** * Returns the mathematical constant e. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(product(literal(10.0f), e())) * ); * } ** * @return expression * @see Style specification */ public static Expression e() { return new Expression("e"); } /** * Returns the sum of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(sum(literal(10.0f), ln2(), pi())) * ); * } ** * @param numbers the numbers to calculate the sum for * @return expression * @see Style specification */ public static Expression sum(@Size(min = 2) Expression... numbers) { return new Expression("+", numbers); } /** * Returns the sum of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(sum(10.0f, 5.0f, 3.0f)) * ); * } ** * @param numbers the numbers to calculate the sum for * @return expression * @see Style specification */ @SuppressLint("Range") public static Expression sum(@Size(min = 2) Number... numbers) { Expression[] numberExpression = new Expression[numbers.length]; for (int i = 0; i < numbers.length; i++) { numberExpression[i] = literal(numbers[i]); } return sum(numberExpression); } /** * Returns the product of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(product(literal(10.0f), ln2())) * ); * } ** * @param numbers the numbers to calculate the product for * @return expression * @see Style specification */ public static Expression product(@Size(min = 2) Expression... numbers) { return new Expression("*", numbers); } /** * Returns the product of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(product(10.0f, 2.0f)) * ); * } ** * @param numbers the numbers to calculate the product for * @return expression * @see Style specification */ @SuppressLint("Range") public static Expression product(@Size(min = 2) Number... numbers) { Expression[] numberExpression = new Expression[numbers.length]; for (int i = 0; i < numbers.length; i++) { numberExpression[i] = literal(numbers[i]); } return product(numberExpression); } /** * Returns the result of subtracting a number from 0. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(subtract(pi())) * ); * } ** * @param number the number subtract from 0 * @return expression * @see Style specification */ public static Expression subtract(@NonNull Expression number) { return new Expression("-", number); } /** * Returns the result of subtracting a number from 0. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(subtract(10.0f)) * ); * } ** * @param number the number subtract from 0 * @return expression * @see Style specification */ public static Expression subtract(@NonNull Number number) { return subtract(literal(number)); } /** * Returns the result of subtracting the second input from the first. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(subtract(literal(10.0f), pi())) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression subtract(@NonNull Expression first, @NonNull Expression second) { return new Expression("-", first, second); } /** * Returns the result of subtracting the second input from the first. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(subtract(10.0f, 20.0f)) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression subtract(@NonNull Number first, @NonNull Number second) { return subtract(literal(first), literal(second)); } /** * Returns the result of floating point division of the first input by the second. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(division(literal(10.0f), pi())) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression division(@NonNull Expression first, @NonNull Expression second) { return new Expression("/", first, second); } /** * Returns the result of floating point division of the first input by the second. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(division(10.0f, 20.0f)) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression division(@NonNull Number first, @NonNull Number second) { return division(literal(first), literal(second)); } /** * Returns the remainder after integer division of the first input by the second. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(mod(literal(10.0f), pi())) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression mod(@NonNull Expression first, @NonNull Expression second) { return new Expression("%", first, second); } /** * Returns the remainder after integer division of the first input by the second. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(mod(10.0f, 10.0f)) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression mod(@NonNull Number first, @NonNull Number second) { return mod(literal(first), literal(second)); } /** * Returns the result of raising the first input to the power specified by the second. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(pow(pi(), literal(2.0f))) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression pow(@NonNull Expression first, @NonNull Expression second) { return new Expression("^", first, second); } /** * Returns the result of raising the first input to the power specified by the second. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(pow(5.0f, 2.0f)) * ); * } ** * @param first the first number * @param second the second number * @return expression * @see Style specification */ public static Expression pow(@NonNull Number first, @NonNull Number second) { return pow(literal(first), literal(second)); } /** * Returns the square root of the input *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(sqrt(pi())) * ); * } ** * @param number the number to take the square root from * @return expression * @see Style specification */ public static Expression sqrt(@NonNull Expression number) { return new Expression("sqrt", number); } /** * Returns the square root of the input *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(sqrt(25.0f)) * ); * } ** * @param number the number to take the square root from * @return expression * @see Style specification */ public static Expression sqrt(@NonNull Number number) { return sqrt(literal(number)); } /** * Returns the base-ten logarithm of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(log10(pi())) * ); * } ** * @param number the number to take base-ten logarithm from * @return expression * @see Style specification */ public static Expression log10(@NonNull Expression number) { return new Expression("log10", number); } /** * Returns the base-ten logarithm of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(log10(10)) * ); * } ** * @param number the number to take base-ten logarithm from * @return expression * @see Style specification */ public static Expression log10(@NonNull Number number) { return log10(literal(number)); } /** * Returns the natural logarithm of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(ln(pi())) * ); * } ** * @param number the number to take natural logarithm from * @return expression * @see Style specification */ public static Expression ln(Expression number) { return new Expression("ln", number); } /** * Returns the natural logarithm of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(ln(10)) * ); * } ** * @param number the number to take natural logarithm from * @return expression * @see Style specification */ public static Expression ln(@NonNull Number number) { return ln(literal(number)); } /** * Returns the base-two logarithm of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(log2(pi())) * ); * } ** * @param number the number to take base-two logarithm from * @return expression * @see Style specification */ public static Expression log2(@NonNull Expression number) { return new Expression("log2", number); } /** * Returns the base-two logarithm of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(log2(2)) * ); * } ** * @param number the number to take base-two logarithm from * @return expression * @see Style specification */ public static Expression log2(@NonNull Number number) { return log2(literal(number)); } /** * Returns the sine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(sin(pi())) * ); * } ** * @param number the number to calculate the sine for * @return expression * @see Style specification */ public static Expression sin(@NonNull Expression number) { return new Expression("sin", number); } /** * Returns the sine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(sin(90.0f)) * ); * } ** * @param number the number to calculate the sine for * @return expression * @see Style specification */ public static Expression sin(@NonNull Number number) { return sin(literal(number)); } /** * Returns the cosine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(cos(pi())) * ); * } ** * @param number the number to calculate the cosine for * @return expression * @see Style specification */ public static Expression cos(@NonNull Expression number) { return new Expression("cos", number); } /** * Returns the cosine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(cos(0)) * ); * } ** * @param number the number to calculate the cosine for * @return expression * @see Style specification */ public static Expression cos(@NonNull Number number) { return new Expression("cos", literal(number)); } /** * Returns the tangent of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(tan(pi())) * ); * } ** * @param number the number to calculate the tangent for * @return expression * @see Style specification */ public static Expression tan(@NonNull Expression number) { return new Expression("tan", number); } /** * Returns the tangent of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(tan(45.0f)) * ); * } ** * @param number the number to calculate the tangent for * @return expression * @see Style specification */ public static Expression tan(@NonNull Number number) { return new Expression("tan", literal(number)); } /** * Returns the arcsine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(asin(pi())) * ); * } ** * @param number the number to calculate the arcsine for * @return expression * @see Style specification */ public static Expression asin(@NonNull Expression number) { return new Expression("asin", number); } /** * Returns the arcsine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(asin(90)) * ); * } ** * @param number the number to calculate the arcsine for * @return expression * @see Style specification */ public static Expression asin(@NonNull Number number) { return asin(literal(number)); } /** * Returns the arccosine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(acos(pi())) * ); * } ** * @param number the number to calculate the arccosine for * @return expression * @see Style specification */ public static Expression acos(@NonNull Expression number) { return new Expression("acos", number); } /** * Returns the arccosine of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(acos(0)) * ); * } ** * @param number the number to calculate the arccosine for * @return expression * @see Style specification */ public static Expression acos(@NonNull Number number) { return acos(literal(number)); } /** * Returns the arctangent of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(asin(pi())) * ); * } ** * @param number the number to calculate the arctangent for * @return expression * @see Style specification */ public static Expression atan(@NonNull Expression number) { return new Expression("atan", number); } /** * Returns the arctangent of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(atan(90)) * ); * } ** * @param number the number to calculate the arctangent for * @return expression * @see Style specification */ public static Expression atan(@NonNull Number number) { return atan(literal(number)); } /** * Returns the minimum value of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(min(pi(), literal(3.14f), literal(3.15f))) * ); * } ** * @param numbers varargs of numbers to get the minimum from * @return expression * @see Style specification */ public static Expression min(@Size(min = 1) Expression... numbers) { return new Expression("min", numbers); } /** * Returns the minimum value of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(min(3.141, 3.14f, 3.15f)) * ); * } ** * @param numbers varargs of numbers to get the minimum from * @return expression * @see Style specification */ @SuppressLint("Range") public static Expression min(@Size(min = 1) Number... numbers) { Expression[] numberExpression = new Expression[numbers.length]; for (int i = 0; i < numbers.length; i++) { numberExpression[i] = literal(numbers[i]); } return min(numberExpression); } /** * Returns the maximum value of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(max(pi(), product(pi(), pi()))) * ); * } ** * @param numbers varargs of numbers to get the maximum from * @return expression * @see Style specification */ public static Expression max(@Size(min = 1) Expression... numbers) { return new Expression("max", numbers); } /** * Returns the maximum value of the inputs. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(max(3.141, 3.14f, 3.15f)) * ); * } ** * @param numbers varargs of numbers to get the maximum from * @return expression * @see Style specification */ @SuppressLint("Range") public static Expression max(@Size(min = 1) Number... numbers) { Expression[] numberExpression = new Expression[numbers.length]; for (int i = 0; i < numbers.length; i++) { numberExpression[i] = literal(numbers[i]); } return max(numberExpression); } /** * Rounds the input to the nearest integer. * Halfway values are rounded away from zero. * For example `[\"round\", -1.5]` evaluates to -2. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(round(pi())) * ); * } ** * @param expression number expression to round * @return expression * @see Style specification */ public static Expression round(Expression expression) { return new Expression("round", expression); } /** * Rounds the input to the nearest integer. * Halfway values are rounded away from zero. * For example `[\"round\", -1.5]` evaluates to -2. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(round(3.14159265359f)) * ); * } ** * @param number number to round * @return expression * @see Style specification */ public static Expression round(@NonNull Number number) { return round(literal(number)); } /** * Returns the absolute value of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(abs(subtract(pi()))) * ); * } ** * @param expression number expression to get absolute value from * @return expression * @see Style specification */ public static Expression abs(Expression expression) { return new Expression("abs", expression); } /** * Returns the absolute value of the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(abs(-3.14159265359f)) * ); * } ** * @param number number to get absolute value from * @return expression * @see Style specification */ public static Expression abs(@NonNull Number number) { return abs(literal(number)); } /** * Returns the smallest integer that is greater than or equal to the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(ceil(pi())) * ); * } ** * @param expression number expression to get value from * @return expression * @see Style specification */ public static Expression ceil(Expression expression) { return new Expression("ceil", expression); } /** * Returns the smallest integer that is greater than or equal to the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(ceil(3.14159265359)) * ); * } ** * @param number number to get value from * @return expression * @see Style specification */ public static Expression ceil(@NonNull Number number) { return ceil(literal(number)); } /** * Returns the largest integer that is less than or equal to the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(floor(pi())) * ); * } ** * @param expression number expression to get value from * @return expression * @see Style specification */ public static Expression floor(Expression expression) { return new Expression("floor", expression); } /** * Returns the largest integer that is less than or equal to the input. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(floor(pi())) * ); * } ** * @param number number to get value from * @return expression * @see Style specification */ public static Expression floor(@NonNull Number number) { return floor(literal(number)); } /** * Returns the IETF language tag of the locale being used by the provided collator. * This can be used to determine the default system locale, * or to determine if a requested locale was successfully loaded. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleColor(switchCase( * eq(literal("it"), resolvedLocale(collator(true, true, Locale.ITALY))), literal(ColorUtils.colorToRgbaString(Color.GREEN)), * literal(ColorUtils.colorToRgbaString(Color.RED)))) * ); * } ** * @param collator the collator expression * @return expression * @see Style specification */ public static Expression resolvedLocale(Expression collator) { return new Expression("resolved-locale", collator); } /** * Returns true if the input string is expected to render legibly. * Returns false if the input string contains sections that cannot be rendered without potential loss of meaning * (e.g. Indic scripts that require complex text shaping, * or right-to-left scripts if the the mapbox-gl-rtl-text plugin is not in use in Mapbox GL JS). *
* Example usage: *
** {@code * mapboxMap.getStyle().addLayer(new SymbolLayer("layer-id", "source-id") * .withProperties( * textField( * switchCase( * isSupportedScript(get("name_property")), get("name_property"), * literal("not-compatible") * ) * ) * )); * } ** * @param expression the expression to evaluate * @return expression * @see Style * specification */ public static Expression isSupportedScript(Expression expression) { return new Expression("is-supported-script", expression); } /** * Returns true if the input string is expected to render legibly. * Returns false if the input string contains sections that cannot be rendered without potential loss of meaning * (e.g. Indic scripts that require complex text shaping, * or right-to-left scripts if the the mapbox-gl-rtl-text plugin is not in use in Mapbox GL JS). *
* Example usage: *
** {@code * mapboxMap.getStyle().addLayer(new SymbolLayer("layer-id", "source-id") * .withProperties( * textField( * switchCase( * isSupportedScript("ಗೌರವಾರ್ಥವಾಗಿ"), literal("ಗೌರವಾರ್ಥವಾಗಿ"), * literal("not-compatible")) * ) * ) * ); * } ** * @param string the string to evaluate * @return expression * @see Style * specification */ public static Expression isSupportedScript(@NonNull String string) { return new Expression("is-supported-script", literal(string)); } /** * Returns the input string converted to uppercase. *
* Follows the Unicode Default Case Conversion algorithm * and the locale-insensitive case mappings in the Unicode Character Database. *
** Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(upcase(get("key-to-string-value"))) * ); * } ** * @param string the string to upcase * @return expression * @see Style specification */ public static Expression upcase(@NonNull Expression string) { return new Expression("upcase", string); } /** * Returns the input string converted to uppercase. *
* Follows the Unicode Default Case Conversion algorithm * and the locale-insensitive case mappings in the Unicode Character Database. *
** Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(upcase("text")) * ); * } ** * @param string string to upcase * @return expression * @see Style specification */ public static Expression upcase(@NonNull String string) { return upcase(literal(string)); } /** * Returns the input string converted to lowercase. *
* Follows the Unicode Default Case Conversion algorithm * and the locale-insensitive case mappings in the Unicode Character Database. *
** Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(downcase(get("key-to-string-value"))) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression downcase(@NonNull Expression input) { return new Expression("downcase", input); } /** * Returns the input string converted to lowercase. *
* Follows the Unicode Default Case Conversion algorithm * and the locale-insensitive case mappings in the Unicode Character Database. *
** Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(upcase("key-to-string-value")) * ); * } ** * @param input string to downcase * @return expression * @see Style specification */ public static Expression downcase(@NonNull String input) { return downcase(literal(input)); } /** * Returns a string consisting of the concatenation of the inputs. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(concat(get("key-to-string-value"), literal("other string"))) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression concat(@NonNull Expression... input) { return new Expression("concat", input); } /** * Returns a string consisting of the concatenation of the inputs. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(concat("foo", "bar")) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression concat(@NonNull String... input) { Expression[] stringExpression = new Expression[input.length]; for (int i = 0; i < input.length; i++) { stringExpression[i] = literal(input[i]); } return concat(stringExpression); } /** * Asserts that the input is an array (optionally with a specific item type and length). * If, when the input expression is evaluated, it is not of the asserted type, * then this assertion will cause the whole expression to be aborted. * * @param input expression input * @return expression * @see Style specification */ public static Expression array(@NonNull Expression input) { return new Expression("array", input); } /** * Returns a string describing the type of the given value. * * @param input expression input * @return expression * @see Style specification */ public static Expression typeOf(@NonNull Expression input) { return new Expression("typeof", input); } /** * Asserts that the input value is a string. * If multiple values are provided, each one is evaluated in order until a string value is obtained. * If none of the inputs are strings, the expression is an error. * The asserted input value is returned as result. * * @param input expression input * @return expression * @see Style specification */ public static Expression string(@NonNull Expression... input) { return new Expression("string", input); } /** * Asserts that the input value is a number. * If multiple values are provided, each one is evaluated in order until a number value is obtained. * If none of the inputs are numbers, the expression is an error. * The asserted input value is returned as result. * * @param input expression input * @return expression * @see Style specification */ public static Expression number(@NonNull Expression... input) { return new Expression("number", input); } /** * Asserts that the input value is a boolean. * If multiple values are provided, each one is evaluated in order until a boolean value is obtained. * If none of the inputs are booleans, the expression is an error. * The asserted input value is returned as result. * * @param input expression input * @return expression * @see Style specification */ public static Expression bool(@NonNull Expression... input) { return new Expression("boolean", input); } /** * Returns a collator for use in locale-dependent comparison operations. * The case-sensitive and diacritic-sensitive options default to false. * The locale argument specifies the IETF language tag of the locale to use. * If none is provided, the default locale is used. If the requested locale is not available, * the collator will use a system-defined fallback locale. * Use resolved-locale to test the results of locale fallback behavior. * * @param caseSensitive case sensitive flag * @param diacriticSensitive diacritic sensitive flag * @param locale locale * @return expression * @see Style specification */ public static Expression collator(boolean caseSensitive, boolean diacriticSensitive, Locale locale) { Map
* To build the expression, use {@link #formatEntry(Expression, FormatOption...)}. *
* "format" expression can be used, for example, with the {@link PropertyFactory#textField(Expression)} * and accepts unlimited numbers of formatted sections. *
* Each section consist of the input, the displayed text, and options, like font-scale and text-font. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField( * format( * formatEntry( * get("header_property"), * formatFontScale(2.0), * formatTextFont(new String[] {"DIN Offc Pro Regular", "Arial Unicode MS Regular"}) * ), * formatEntry(concat(literal("\n"), get("description_property")), formatFontScale(1.5)) * ) * ) * ); * } ** * @param formatEntries format entries * @return expression * @see Style specification */ public static Expression format(@NonNull FormatEntry... formatEntries) { // for each entry we are going to build an input and parameters Expression[] mappedExpressions = new Expression[formatEntries.length * 2]; int mappedIndex = 0; for (FormatEntry formatEntry : formatEntries) { // input mappedExpressions[mappedIndex++] = formatEntry.text; // parameters Map
* Text is required to be of a resulting type string. *
* Text is required to be passed; {@link FormatOption}s are optional and will default to the base values defined * for the symbol. * * @param text displayed text * @param formatOptions format options * @return format entry */ public static FormatEntry formatEntry(@NonNull Expression text, @Nullable FormatOption... formatOptions) { return new FormatEntry(text, formatOptions); } /** * Returns a format entry that can be used in {@link #format(FormatEntry...)} to create formatted text fields. *
* Text is required to be of a resulting type string. *
* Text is required to be passed; {@link FormatOption}s are optional and will default to the base values defined * for the symbol. * * @param text displayed text * @return format entry */ public static FormatEntry formatEntry(@NonNull Expression text) { return new FormatEntry(text, null); } /** * Returns a format entry that can be used in {@link #format(FormatEntry...)} to create formatted text fields. *
* Text is required to be of a resulting type string. *
* Text is required to be passed; {@link FormatOption}s are optional and will default to the base values defined * for the symbol. * * @param text displayed text * @param formatOptions format options * @return format entry */ public static FormatEntry formatEntry(@NonNull String text, @Nullable FormatOption... formatOptions) { return new FormatEntry(literal(text), formatOptions); } /** * Returns a format entry that can be used in {@link #format(FormatEntry...)} to create formatted text fields. *
* Text is required to be of a resulting type string. *
* Text is required to be passed; {@link FormatOption}s are optional and will default to the base values defined * for the symbol. * * @param text displayed text * @return format entry */ public static FormatEntry formatEntry(@NonNull String text) { return new FormatEntry(literal(text), null); } /** * Asserts that the input value is an object. If it is not, the expression is an error * The asserted input value is returned as result. * * @param input expression input * @return expression * @see Style specification */ public static Expression object(@NonNull Expression input) { return new Expression("object", input); } /** * Converts the input value to a string. * If the input is null, the result is null. * If the input is a boolean, the result is true or false. * If the input is a number, it is converted to a string by NumberToString in the ECMAScript Language Specification. * If the input is a color, it is converted to a string of the form "rgba(r,g,b,a)", * where `r`, `g`, and `b` are numerals ranging from 0 to 255, and `a` ranges from 0 to 1. * Otherwise, the input is converted to a string in the format specified by the JSON.stringify in the ECMAScript * Language Specification. *
* Example usage: *
** {@code * SymbolLayer symbolLayer = new SymbolLayer("layer-id", "source-id"); * symbolLayer.setProperties( * textField(get("key-to-number-value")) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression toString(@NonNull Expression input) { return new Expression("to-string", input); } /** * Converts the input value to a number, if possible. * If the input is null or false, the result is 0. * If the input is true, the result is 1. * If the input is a string, it is converted to a number as specified by the ECMAScript Language Specification. * If multiple values are provided, each one is evaluated in order until the first successful conversion is obtained. * If none of the inputs can be converted, the expression is an error. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(toNumber(get("key-to-string-value"))) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression toNumber(@NonNull Expression input) { return new Expression("to-number", input); } /** * Converts the input value to a boolean. The result is `false` when then input is an empty string, 0, false, * null, or NaN; otherwise it is true. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius(toBool(get("key-to-value"))) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression toBool(@NonNull Expression input) { return new Expression("to-boolean", input); } /** * Converts the input value to a color. If multiple values are provided, * each one is evaluated in order until the first successful conversion is obtained. * If none of the inputs can be converted, the expression is an error. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor(toColor(get("keyStringValue"))) * ); * } ** * @param input expression input * @return expression * @see Style specification */ public static Expression toColor(@NonNull Expression input) { return new Expression("to-color", input); } /** * Binds input to named variables, * which can then be referenced in the result expression using {@link #var(String)} or {@link #var(Expression)}. * * @param input expression input * @return expression * @see Style specification */ public static Expression let(@Size(min = 1) Expression... input) { return new Expression("let", input); } /** * References variable bound using let. * * @param expression the variable naming expression that was bound with using let * @return expression * @see Style specification */ public static Expression var(@NonNull Expression expression) { return new Expression("var", expression); } /** * References variable bound using let. * * @param variableName the variable naming that was bound with using let * @return expression * @see Style specification */ public static Expression var(@NonNull String variableName) { return var(literal(variableName)); } /** * Gets the current zoom level. *
* Note that in style layout and paint properties, * zoom may only appear as the input to a top-level step or interpolate expression. *
** Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( * exponential(0.5f), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN)) * ) * ) * ); * } ** * @return expression * @see Style specification */ public static Expression zoom() { return new Expression("zoom"); } /** * Produces a stop value. *
* Can be used for {@link #stop(Object, Object)} as part of varargs parameter in * {@link #step(Number, Expression, Stop...)} or {@link #interpolate(Interpolator, Expression, Stop...)}. *
** Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), literal(0.0f), * stop(1.0f, 2.5f), * stop(10.0f, 5.0f)) * ) * ); * } ** * @param stop the stop input * @param value the stop output * @return the stop */ public static Stop stop(@NonNull Object stop, @NonNull Object value) { return new Stop(stop, value); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), literal(0.0f), * literal(1.0f), literal(2.5f), * literal(10.0f), literal(5.0f)) * ) * ); * } ** * @param input the input value * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Number input, @NonNull Expression defaultOutput, Expression... stops) { return step(literal(input), defaultOutput, stops); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), literal(0.0f), * literal(1.0f), literal(2.5f), * literal(10.0f), literal(5.0f)) * ) * ); * } ** * @param input the input expression * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Expression input, @NonNull Expression defaultOutput, @NonNull Expression... stops) { return new Expression("step", join(new Expression[] {input, defaultOutput}, stops)); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), literal(0.0f), * stop(1, 2.5f), * stop(10, 5.0f)) * ) * ); * } ** * @param input the input value * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Number input, @NonNull Expression defaultOutput, Stop... stops) { return step(literal(input), defaultOutput, Stop.toExpressionArray(stops)); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), literal(0.0f), * stop(1, 2.5f), * stop(10, 5.0f)) * ) * ); * } ** * @param input the input value * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Expression input, @NonNull Expression defaultOutput, Stop... stops) { return step(input, defaultOutput, Stop.toExpressionArray(stops)); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(1.0f, 0.0f, * literal(1.0f), literal(2.5f), * literal(10.0f), literal(5.0f)) * ) * ); * } ** * @param input the input value * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Number input, @NonNull Number defaultOutput, Expression... stops) { return step(literal(input), defaultOutput, stops); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), 0.0f, * literal(1.0f), literal(2.5f), * literal(10.0f), literal(5.0f)) * ) * ); * } ** * @param input the input expression * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Expression input, @NonNull Number defaultOutput, Expression... stops) { return step(input, literal(defaultOutput), stops); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), 0.0f, * stop(1, 2.5f), * stop(10, 5.0f)) * ) * ); * } ** * @param input the input value * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Number input, @NonNull Number defaultOutput, Stop... stops) { return step(literal(input), defaultOutput, Stop.toExpressionArray(stops)); } /** * Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of * input and output values (\"stops\"). The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * Returns the output value of the stop just less than the input, * or the first input if the input is less than the first stop. *
* Example usage: *
** {@code * CircleLayer circleLayer = new CircleLayer("layer-id", "source-id"); * circleLayer.setProperties( * circleRadius( * step(zoom(), 0.0f, * stop(1, 2.5f), * stop(10, 5.0f)) * ) * ); * } ** * @param input the input value * @param defaultOutput the default output expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression step(@NonNull Expression input, @NonNull Number defaultOutput, Stop... stops) { return step(input, defaultOutput, Stop.toExpressionArray(stops)); } /** * Produces continuous, smooth results by interpolating between pairs of input and output values (\"stops\"). * The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * The output type must be `number`, `array<number>`, or `color`. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate(exponential(0.5f), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN) * ) * ) * ) * ); * } ** * @param interpolation type of interpolation * @param number the input expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression interpolate(@NonNull Interpolator interpolation, @NonNull Expression number, @NonNull Expression... stops) { return new Expression("interpolate", join(new Expression[] {interpolation, number}, stops)); } /** * Produces continuous, smooth results by interpolating between pairs of input and output values (\"stops\"). * The `input` may be any numeric expression (e.g., `[\"get\", \"population\"]`). * Stop inputs must be numeric literals in strictly ascending order. * The output type must be `number`, `array<number>`, or `color`. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( * exponential(0.5f), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN)) * ) * ) * ); * } ** * @param interpolation type of interpolation * @param number the input expression * @param stops pair of input and output values * @return expression * @see Style specification */ public static Expression interpolate(@NonNull Interpolator interpolation, @NonNull Expression number, Stop... stops) { return interpolate(interpolation, number, Stop.toExpressionArray(stops)); } /** * interpolates linearly between the pair of stops just less than and just greater than the input. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( * linear(), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN)) * ) * ) * ); * } ** * @return expression * @see Style specification */ public static Interpolator linear() { return new Interpolator("linear"); } /** * Interpolates exponentially between the stops just less than and just greater than the input. * `base` controls the rate at which the output increases: * higher values make the output increase more towards the high end of the range. * With values close to 1 the output increases linearly. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( * exponential(0.5f), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN)) * ) * ) * ); * } ** * @param base value controlling the route at which the output increases * @return expression * @see Style specification */ public static Interpolator exponential(@NonNull Number base) { return exponential(literal(base)); } /** * Interpolates exponentially between the stops just less than and just greater than the input. * The parameter controls the rate at which the output increases: * higher values make the output increase more towards the high end of the range. * With values close to 1 the output increases linearly. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( * exponential(get("keyToValue")), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN)) * ) * ) * ); * } ** * @param expression base number expression * @return expression * @see Style specification */ public static Interpolator exponential(@NonNull Expression expression) { return new Interpolator("exponential", expression); } /** * Interpolates using the cubic bezier curve defined by the given control points. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( * cubicBezier(0.42f, 0.0f, 1.0f, 1.0f), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN)) * ) * ) * ); * } ** * @param x1 x value of the first point of a cubic bezier, ranges from 0 to 1 * @param y1 y value of the first point of a cubic bezier, ranges from 0 to 1 * @param x2 x value of the second point of a cubic bezier, ranges from 0 to 1 * @param y2 y value fo the second point of a cubic bezier, ranges from 0 to 1 * @return expression * @see Style specification */ public static Interpolator cubicBezier(@NonNull Expression x1, @NonNull Expression y1, @NonNull Expression x2, @NonNull Expression y2) { return new Interpolator("cubic-bezier", x1, y1, x2, y2); } /** * Interpolates using the cubic bezier curve defined by the given control points. *
* Example usage: *
** {@code * FillLayer fillLayer = new FillLayer("layer-id", "source-id"); * fillLayer.setProperties( * fillColor( * interpolate( * cubicBezier(0.42f, 0.0f, 1.0f, 1.0f), zoom(), * stop(1.0f, color(Color.RED)), * stop(5.0f, color(Color.BLUE)), * stop(10.0f, color(Color.GREEN)) * ) * ) * ); * } ** * @param x1 x value of the first point of a cubic bezier, ranges from 0 to 1 * @param y1 y value of the first point of a cubic bezier, ranges from 0 to 1 * @param x2 x value of the second point of a cubic bezier, ranges from 0 to 1 * @param y2 y value fo the second point of a cubic bezier, ranges from 0 to 1 * @return expression * @see Style specification */ public static Interpolator cubicBezier(@NonNull Number x1, @NonNull Number y1, @NonNull Number x2, @NonNull Number y2) { return cubicBezier(literal(x1), literal(y1), literal(x2), literal(y2)); } /** * Joins two expressions arrays. *
* This flattens the object array output of an expression from a nested expression hierarchy. *
* * @param left the left part of an expression * @param right the right part of an expression * @return the joined expression */ @NonNull private static Expression[] join(Expression[] left, Expression[] right) { Expression[] output = new Expression[left.length + right.length]; System.arraycopy(left, 0, output, 0, left.length); System.arraycopy(right, 0, output, left.length, right.length); return output; } /** * Converts the expression to Object array representation. ** The output will later be converted to a JSON Object array. *
* * @return the converted object array expression */ @NonNull public Object[] toArray() { List