mapbox-maps-android/com.mapbox.maps.extension.style.expressions.dsl.generated

Package com.mapbox.maps.extension.style.expressions.dsl.generated

Functions

abs

fun abs(value: Double): Expression

Returns the absolute value of the input.

fun abs(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the absolute value of the input.

accumulated

fun accumulated(): Expression

Gets the value of a cluster property accumulated so far.

acos

fun acos(value: Double): Expression

Returns the arccosine of the input.

fun acos(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the arccosine of the input.

all

fun all(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if all the inputs are true, false otherwise.

any

fun any(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if any of the inputs are true, false otherwise.

array

fun array(block: Expression.ExpressionBuilder.() -> Unit): Expression

Asserts that the input is an array (optionally with a specific item type and length).

asin

fun asin(value: Double): Expression

Returns the arcsine of the input.

fun asin(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the arcsine of the input.

at

fun at(block: Expression.ExpressionBuilder.() -> Unit): Expression

Retrieves an item from an array.

fun at(index: Double, array: Expression): Expression

Retrieves an item from an array.

atan

fun atan(value: Double): Expression

Returns the arctangent of the input.

fun atan(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the arctangent of the input.

boolean

fun boolean(block: Expression.ExpressionBuilder.() -> Unit): Expression

Asserts that the input value is a boolean.

ceil

fun ceil(value: Double): Expression

Returns the smallest integer that is greater than or equal to the input.

fun ceil(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the smallest integer that is greater than or equal to the input.

coalesce

fun coalesce(block: Expression.ExpressionBuilder.() -> Unit): Expression

Evaluates each expression in turn until the first non-null value is obtained, and returns that value.

collator

fun collator(block: Expression.CollatorBuilder.() -> Unit): Expression

Returns a collator for use in locale-dependent comparison operations.

color

fun color(@ColorInt() intColor: Int): Expression

Convert a color int to the rgba expression.

concat

fun concat(vararg values: String): Expression

Returns a string consisting of the concatenation of the inputs.

fun concat(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns a string consisting of the concatenation of the inputs.

cos

fun cos(value: Double): Expression

Returns the cosine of the input.

fun cos(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the cosine of the input.

distance

fun distance(geojson: GeoJson): Expression

Returns the shortest distance in meters between the evaluated feature and the input geometry.

division

fun division(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the result of floating point division of the first input by the second.

fun division(first: Double, second: Double): Expression

Returns the result of floating point division of the first input by the second.

downcase

fun downcase(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the input string converted to lowercase.

fun downcase(value: String): Expression

Returns the input string converted to lowercase.

e

fun e(): Expression

Returns the mathematical constant e.

eq

fun eq(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if the input values are equal, false otherwise.

featureState

fun featureState(block: Expression.ExpressionBuilder.() -> Unit): Expression

Retrieves a property value from the current feature's state.

floor

fun floor(value: Double): Expression

Returns the largest integer that is less than or equal to the input.

fun floor(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the largest integer that is less than or equal to the input.

format

fun format(block: Expression.FormatBuilder.() -> Unit): Expression

Returns a formatted string for displaying mixed-format text in the text-field property.

geometryType

fun geometryType(): Expression

Gets the feature's geometry type: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon.

get

fun get(block: Expression.ExpressionBuilder.() -> Unit): Expression

Retrieves a property value from the current feature's properties, or from another object if a second argument is provided.

fun get(key: String): Expression

Retrieves a property value from the current feature's properties.

fun get(key: String, expression: Expression): Expression

Retrieves a property value from the current feature's properties, or from another object if a second argument is provided.

gt

fun gt(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if the first input is strictly greater than the second, false otherwise.

gte

fun gte(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if the first input is greater than or equal to the second, false otherwise.

has

fun has(block: Expression.ExpressionBuilder.() -> Unit): Expression

Tests for the presence of an property value in the current feature's properties, or from another object if a second argument is provided.

fun has(string: String): Expression

Tests for the presence of an property value in the current feature's properties

fun has(string: String, expression: Expression): Expression

Tests for the presence of an property value in the current feature's properties, or from another object if a second argument is provided.

heatmapDensity

fun heatmapDensity(): Expression

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.

id

fun id(): Expression

Gets the feature's id, if it has one.

image

fun image(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns an image type for use in icon-image, *-pattern entries and as a section in the format expression.

indexOf

fun indexOf(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the first position at which an item can be found in an array or a substring can be found in a string, or -1 if the input cannot be found.

inExpression

fun inExpression(block: Expression.ExpressionBuilder.() -> Unit): Expression

Determines whether an item exists in an array or a substring exists in a string.

fun inExpression(needle: Double, haystack: Expression): Expression

Determines whether an item exists in an array or a substring exists in a string.

fun inExpression(needle: String, haystack: Expression): Expression

Determines whether an item exists in an array or a substring exists in a string.

interpolate

fun interpolate(block: Expression.InterpolatorBuilder.() -> Unit): Expression

Produces continuous, smooth results by interpolating between pairs of input and output values ("stops").

isSupportedScript

fun isSupportedScript(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if the input string is expected to render legibly.

fun isSupportedScript(script: String): Expression

Returns true if the input string is expected to render legibly.

length

fun length(block: Expression.ExpressionBuilder.() -> Unit): Expression

Gets the length of an array or string.

fun length(string: String): Expression

Gets the length of an string.

letExpression

fun letExpression(block: Expression.ExpressionBuilder.() -> Unit): Expression

Binds expressions to named variables, which can then be referenced in the result expression using "var", "variable_name".

lineProgress

fun lineProgress(): Expression

Gets the progress along a gradient line.

literal

fun literal(value: HashMap<String, Any>): Expression

Provides a literal array or object value.

fun literal(value: Boolean): Expression

Provides a literal array or object value.

fun literal(value: Double): Expression

Provides a literal array or object value.

fun literal(value: Long): Expression

Provides a literal array or object value.

fun literal(value: String): Expression

Provides a literal array or object value.

fun literal(value: List<Any>): Expression

Provides a literal array or object value.

ln

fun ln(value: Double): Expression

Returns the natural logarithm of the input.

fun ln(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the natural logarithm of the input.

ln2

fun ln2(): Expression

Returns mathematical constant ln(2).

log10

fun log10(value: Double): Expression

Returns the base-ten logarithm of the input.

fun log10(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the base-ten logarithm of the input.

log2

fun log2(value: Double): Expression

Returns the base-two logarithm of the input.

fun log2(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the base-two logarithm of the input.

lt

fun lt(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if the first input is strictly less than the second, false otherwise.

lte

fun lte(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if the first input is less than or equal to the second, false otherwise.

match

fun match(block: Expression.ExpressionBuilder.() -> Unit): Expression

Selects the output whose label value matches the input value, or the fallback value if no match is found.

max

fun max(vararg values: Double): Expression

Returns the maximum value of the inputs.

fun max(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the maximum value of the inputs.

min

fun min(vararg values: Double): Expression

Returns the minimum value of the inputs.

fun min(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the minimum value of the inputs.

mod

fun mod(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the remainder after integer division of the first input by the second.

fun mod(first: Double, second: Double): Expression

Returns the remainder after integer division of the first input by the second.

neq

fun neq(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns true if the input values are not equal, false otherwise.

not

fun not(bool: Boolean): Expression

Logical negation.

fun not(block: Expression.ExpressionBuilder.() -> Unit): Expression

Logical negation.

number

fun number(block: Expression.ExpressionBuilder.() -> Unit): Expression

Asserts that the input value is a number.

numberFormat

fun numberFormat(input: Expression, block: Expression.NumberFormatBuilder.() -> Unit): Expression

Converts the input number into a string representation using the providing formatting rules.

objectExpression

fun objectExpression(block: Expression.ExpressionBuilder.() -> Unit): Expression

Asserts that the input value is an object.

pi

fun pi(): Expression

Returns the mathematical constant pi.

pow

fun pow(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the result of raising the first input to the power specified by the second.

fun pow(first: Double, second: Double): Expression

Returns the result of raising the first input to the power specified by the second.

product

fun product(vararg double: Double): Expression

Returns the product of the inputs.

fun product(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the product of the inputs.

properties

fun properties(): Expression

Gets the feature properties object.

resolvedLocale

fun resolvedLocale(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the IETF language tag of the locale being used by the provided collator.

rgb

fun rgb(block: Expression.ExpressionBuilder.() -> Unit): Expression

Creates a color value from red, green, and blue components, which must range between 0 and 255, and an alpha component of 1.

fun rgb(red: Double, green: Double, blue: Double): Expression

Construct a RGB color expression from numbers.

rgba

fun rgba(block: Expression.ExpressionBuilder.() -> Unit): Expression

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.

fun rgba(red: Double, green: Double, blue: Double, alpha: Double): Expression

Construct a RGBA color expression from numbers.

round

fun round(value: Double): Expression

Rounds the input to the nearest integer.

fun round(block: Expression.ExpressionBuilder.() -> Unit): Expression

Rounds the input to the nearest integer.

sin

fun sin(value: Double): Expression

Returns the sine of the input.

fun sin(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the sine of the input.

skyRadialProgress

fun skyRadialProgress(): Expression

Gets the distance of a point on the sky from the sun position.

slice

fun slice(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns an item from an array or a substring from a string from a specified start index, or between a start index and an end index if set.

sqrt

fun sqrt(value: Double): Expression

Returns the square root of the input.

fun sqrt(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the square root of the input.

step

fun step(block: Expression.ExpressionBuilder.() -> Unit): Expression

Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of input and output values ("stops").

string

fun string(block: Expression.ExpressionBuilder.() -> Unit): Expression

Asserts that the input value is a string.

subtract

fun subtract(value: Double): Expression

Returns the result of subtracting it from 0.

fun subtract(block: Expression.ExpressionBuilder.() -> Unit): Expression

For two inputs, returns the result of subtracting the second input from the first.

fun subtract(first: Double, second: Double): Expression

Returns the result of subtracting the second input from the first.

sum

fun sum(vararg double: Double): Expression

Returns the sum of the inputs.

fun sum(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the sum of the inputs.

switchCase

fun switchCase(block: Expression.ExpressionBuilder.() -> Unit): Expression

Selects the first output whose corresponding test condition evaluates to true, or the fallback value otherwise.

tan

fun tan(value: Double): Expression

Returns the tangent of the input.

fun tan(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the tangent of the input.

toBoolean

fun toBoolean(block: Expression.ExpressionBuilder.() -> Unit): Expression

Converts the input value to a boolean.

toColor

fun toColor(block: Expression.ExpressionBuilder.() -> Unit): Expression

Converts the input value to a color.

toNumber

fun toNumber(block: Expression.ExpressionBuilder.() -> Unit): Expression

Converts the input value to a number, if possible.

toRgba

fun toRgba(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns a four-element array containing the input color's red, green, blue, and alpha components, in that order.

toString

fun toString(block: Expression.ExpressionBuilder.() -> Unit): Expression

Converts the input value to a string.

typeofExpression

fun typeofExpression(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns a string describing the type of the given value.

upcase

fun upcase(block: Expression.ExpressionBuilder.() -> Unit): Expression

Returns the input string converted to uppercase.

fun upcase(value: String): Expression

Returns the input string converted to uppercase.

varExpression

fun varExpression(block: Expression.ExpressionBuilder.() -> Unit): Expression

References variable bound using "let".

fun varExpression(value: String): Expression

References variable bound using "let".

within

fun within(geometry: Geometry): Expression

Returns true if the evaluated feature is fully contained inside a boundary of the input geometry, false otherwise.

zoom

fun zoom(): Expression

Gets the current zoom level.