Returns a string which matches one of the values specified in the text-anchor layout property, depending on the best-fit anchor for the symbol during rendering. Using this expression the content of the layer can be dynamically configured for the specific anchor type.

all

@JvmStatic

fun all(vararg expressions: Expression): Expression

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.

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

DSL function for "all".

any

@JvmStatic

fun any(vararg expressions: Expression): Expression

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.

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

DSL function for "any".

array

@JvmStatic

fun array(vararg expressions: Expression): Expression

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.

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

DSL function for "array".

asin

@JvmStatic

fun asin(vararg expressions: Expression): Expression

@JvmStatic

fun asin(value: Double): Expression

Returns the arcsine of the input.

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

DSL function for "asin".

@JvmStatic

fun at(vararg expressions: Expression): Expression

@JvmStatic

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

Retrieves an item from an array.

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

DSL function for "at".

atan

@JvmStatic

fun atan(vararg expressions: Expression): Expression

@JvmStatic

fun atan(value: Double): Expression

Returns the arctangent of the input.

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

DSL function for "atan".

boolean

@JvmStatic

fun boolean(vararg expressions: Expression): Expression

Asserts that the input value is a boolean. If multiple values are provided, each one is evaluated in order until a boolean is obtained. If none of the inputs are booleans, the expression is an error.

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

DSL function for "boolean".

ceil

@JvmStatic

fun ceil(vararg expressions: Expression): Expression

@JvmStatic

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

DSL function for "ceil".

coalesce

@JvmStatic

fun coalesce(vararg expressions: Expression): Expression

Evaluates each expression in turn until the first valid value is obtained. Invalid values are null and #types-image expressions that are unavailable in the style. If all values are invalid, coalesce returns the first value listed.

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

DSL function for "coalesce".

collator

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

Dsl function for "collator".

@JvmStatic

fun collator(caseSensitive: Expression, diacriticSensitive: Expression, locale: Expression): Expression

@JvmStatic

fun collator(caseSensitive: Boolean = false, diacriticSensitive: Boolean = false, locale: Locale): Expression

@JvmStatic

fun collator(caseSensitive: Boolean = false, diacriticSensitive: Boolean = false, locale: String): Expression

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.

color

@JvmStatic

fun color(@ColorInt intColor: Int): Expression

Convert a color int to the rgba expression.

concat

@JvmStatic

fun concat(vararg expressions: Expression): Expression

Returns a string consisting of the concatenation of the inputs. Each input is converted to a string as if by to-string.

@JvmStatic

fun concat(vararg values: String): Expression

Returns a string consisting of the concatenation of the inputs.

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

DSL function for "concat".

config

@JvmStatic

fun config(vararg expressions: Expression): Expression

Retrieves the configuration value for the given option.

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

DSL function for "config".

cos

@JvmStatic

fun cos(vararg expressions: Expression): Expression

@JvmStatic

fun cos(value: Double): Expression

Returns the cosine of the input.

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

DSL function for "cos".

cubicBezier

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

@JvmStatic

fun cubicBezier(x1: Expression, x2: Expression, x3: Expression, x4: Expression): Expression

@JvmStatic

fun cubicBezier(x1: Double, x2: Double, x3: Double, x4: Double): Expression

Interpolates using the cubic bezier curve defined by the given control points.

cubicBezierInterpolator

@JvmStatic

fun cubicBezierInterpolator(x1: Expression, y1: Expression, x2: Expression, y2: Expression, input: Expression, vararg stops: Pair<Expression, Expression>): Expression

@JvmStatic

fun cubicBezierInterpolator(x1: Double, y1: Double, x2: Double, y2: Double, input: Expression, vararg stops: Pair<Expression, Expression>): Expression

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.

distance

@JvmStatic

fun distance(geojson: GeoJson): Expression

Returns the shortest distance in meters between the evaluated feature and the input geometry. The input value can be a valid GeoJSON of type Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, Feature, or FeatureCollection. Distance values returned may vary in precision due to loss in precision from encoding geometries, particularly below zoom level 13.

distanceFromCenter

@JvmStatic

fun distanceFromCenter(): Expression

Returns the distance of a symbol instance from the center of the map. The distance is measured in pixels divided by the height of the map container. It measures 0 at the center, decreases towards the camera and increase away from the camera. For example, if the height of the map is 1000px, a value of -1 means 1000px away from the center towards the camera, and a value of 1 means a distance of 1000px away from the camera from the center. ["distance-from-center"] may only be used in the filter expression for a symbol layer.

division

@JvmStatic

fun division(vararg expressions: Expression): Expression

@JvmStatic

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

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

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

DSL function for "/".

downcase

@JvmStatic

fun downcase(vararg expressions: Expression): Expression

@JvmStatic

fun downcase(value: String): Expression

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.

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

DSL function for "downcase".

@JvmStatic

fun e(): Expression

Returns the mathematical constant e.

@JvmStatic

fun eq(vararg expressions: Expression): Expression

Returns true if the input values are equal, false otherwise. The comparison is strictly typed: values of different runtime types are always considered unequal. Cases where the types are known to be different at parse time are considered invalid and will produce a parse error. Accepts an optional collator argument to control locale-dependent string comparisons.

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

DSL function for "==".

exponential

@JvmStatic

fun exponential(expression: Expression): Expression

@JvmStatic

fun exponential(value: Double): Expression

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

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.

exponentialInterpolator

@JvmStatic

fun exponentialInterpolator(base: Expression, input: Expression, vararg stops: Pair<Expression, Expression>): Expression

@JvmStatic

fun exponentialInterpolator(base: Double, input: Expression, vararg stops: Pair<Expression, Expression>): Expression

featureState

@JvmStatic

fun featureState(vararg expressions: Expression): Expression

Retrieves a property value from the current feature's state. Returns null if the requested property is not present on the feature's state. A feature's state is not part of the GeoJSON or vector tile data, and must be set programmatically on each feature. Features are identified by their id attribute, which must be an integer or a string that can be cast to an integer. Note that "feature-state" can only be used with paint properties that support data-driven styling.

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

DSL function for "feature-state".

floor

@JvmStatic

fun floor(vararg expressions: Expression): Expression

@JvmStatic

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

DSL function for "floor".

format

@JvmStatic

fun format(vararg formatSections: FormatSection): Expression

Returns a formatted string for displaying mixed-format text in the text-field property. The input may contain a string literal or expression, including an #types-image expression. Strings may be followed by a style override object that supports the following properties:

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

DSL function for "format".

fromRaw

@JvmStatic

fun fromRaw(expression: String): Expression

Construct Expression from a raw string.

geometryType

@JvmStatic

fun geometryType(): Expression

Returns the feature's geometry type: Point, LineString or Polygon. Multi- feature types return the singular forms.

get

@JvmStatic

fun get(vararg expressions: Expression): 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.

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

DSL function for "get".

@JvmStatic

fun get(key: String): Expression

Retrieves a property value from the current feature's properties. Returns null if the requested property is missing.

@JvmStatic

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. Returns null if the requested property is missing.

@JvmStatic

fun gt(vararg expressions: Expression): Expression

Returns true if the first input is strictly greater than the second, false otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional collator argument to control locale-dependent string comparisons.

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

DSL function for ">".

gte

@JvmStatic

fun gte(vararg expressions: Expression): Expression

Returns true if the first input is greater than or equal to the second, false otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional collator argument to control locale-dependent string comparisons.

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

DSL function for ">=".

has

@JvmStatic

fun has(vararg expressions: Expression): Expression

@JvmStatic

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.

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

DSL function for "has".

@JvmStatic

fun has(string: String): Expression

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

heatmapDensity

@JvmStatic

fun heatmapDensity(): Expression

Returns 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.

hsl

@JvmStatic

fun hsl(vararg expressions: Expression): Expression

Creates a color value from hue (range 0-360), saturation and lightness components (range 0-100), and an alpha component of 1. If any component is out of range, the expression is an error.

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

DSL function for "hsl".

hsla

@JvmStatic

fun hsla(vararg expressions: Expression): Expression

Creates a color value from hue (range 0-360), saturation and lightness components (range 0-100), and an alpha component (range 0-1). If any component is out of range, the expression is an error.

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

DSL function for "hsla".

@JvmStatic

fun id(): Expression

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

image

@JvmStatic

fun image(vararg expressions: Expression): Expression

Returns a /mapbox-gl-js/style-spec/types/#resolvedimage for use in /mapbox-gl-js/style-spec/layers/#layout-symbol-icon-image, --pattern entries, and as a section in the #types-format expression. A #coalesce expression containing image expressions will evaluate to the first listed image that is currently in the style. This validation process is synchronous and requires the image to have been added to the style before requesting it in the 'image' argument.

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

DSL function for "image".

indexOf

@JvmStatic

fun indexOf(vararg expressions: Expression): 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. Accepts an optional index from where to begin the search.

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

DSL function for "index-of".

inExpression

@JvmStatic

fun inExpression(vararg expressions: Expression): Expression

Determines whether an item exists in an array or a substring exists in a string. In the specific case when the second and third arguments are string literals, you must wrap at least one of them in a #types-literal expression to hint correct interpretation to the #type-system.

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

DSL function for "in".

@JvmStatic

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

@JvmStatic

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

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

interpolate

@JvmStatic

fun interpolate(vararg expressions: Expression): Expression

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

DSL function for "interpolate".

isSupportedScript

@JvmStatic

fun isSupportedScript(vararg expressions: Expression): Expression

@JvmStatic

fun isSupportedScript(script: String): 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).

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

DSL function for "is-supported-script".

length

@JvmStatic

fun length(vararg expressions: Expression): Expression

Returns the length of an array or string.

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

DSL function for "length".

@JvmStatic

fun length(string: String): Expression

Gets the length of an string.

letExpression

@JvmStatic

fun letExpression(vararg expressions: Expression): Expression

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

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

DSL function for "let".

linear

@JvmStatic

fun linear(): Expression

Interpolates linearly between the pair of stops just less than and just greater than the input.

linearInterpolator

@JvmStatic

fun linearInterpolator(input: Expression, vararg stops: Pair<Expression, Expression>): Expression

lineProgress

@JvmStatic

fun lineProgress(): Expression

Returns the progress along a gradient line. Can only be used in the line-gradient property.

literal

@JvmStatic

fun literal(value: Boolean): Expression

@JvmStatic

fun literal(value: Double): Expression

@JvmStatic

fun literal(value: Long): Expression

@JvmStatic

fun literal(value: String): Expression

Provides a literal array or object value.

@JvmStatic

fun ln(vararg expressions: Expression): Expression

@JvmStatic

fun ln(value: Double): Expression

Returns the natural logarithm of the input.

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

DSL function for "ln".

ln2

@JvmStatic

fun ln2(): Expression

Returns mathematical constant ln(2).

log10

@JvmStatic

fun log10(vararg expressions: Expression): Expression

@JvmStatic

fun log10(value: Double): Expression

Returns the base-ten logarithm of the input.

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

DSL function for "log10".

log2

@JvmStatic

fun log2(vararg expressions: Expression): Expression

@JvmStatic

fun log2(value: Double): Expression

Returns the base-two logarithm of the input.

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

DSL function for "log2".

@JvmStatic

fun lt(vararg expressions: Expression): Expression

Returns true if the first input is strictly less than the second, false otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional collator argument to control locale-dependent string comparisons.

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

DSL function for "<".

lte

@JvmStatic

fun lte(vararg expressions: Expression): Expression

Returns true if the first input is less than or equal to the second, false otherwise. The arguments are required to be either both strings or both numbers; if during evaluation they are not, expression evaluation produces an error. Cases where this constraint is known not to hold at parse time are considered in valid and will produce a parse error. Accepts an optional collator argument to control locale-dependent string comparisons.

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

DSL function for "<=".

match

@JvmStatic

fun match(vararg expressions: Expression): Expression

@JvmStatic

fun match(input: Expression, vararg stops: Pair<Expression, Expression>, fallback: Expression): Expression

Selects the output for which the label value matches the input value, or the fallback value if no match is found. The input can be any expression (for example, ["get", "building_type"]). Each label must be unique, and must be either:

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

DSL function for "match".

max

@JvmStatic

fun max(vararg expressions: Expression): Expression

@JvmStatic

fun max(vararg values: Double): Expression

Returns the maximum value of the inputs.

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

DSL function for "max".

measureLight

@JvmStatic

fun measureLight(vararg expressions: Expression): Expression

Returns a requested property of the light configuration based on the supplied options. Currently the only supported option is brightness which returns the global brightness value of the lights on a scale of 0 to 1, where 0 means total darkness and 1 means full brightness. This expression works only with 3D light, i.e. when lights root property is defined.

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

DSL function for "measure-light".

min

@JvmStatic

fun min(vararg expressions: Expression): Expression

@JvmStatic

fun min(vararg values: Double): Expression

Returns the minimum value of the inputs.

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

DSL function for "min".

mod

@JvmStatic

fun mod(vararg expressions: Expression): Expression

@JvmStatic

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

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

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

DSL function for "%".

neq

@JvmStatic

fun neq(vararg expressions: Expression): Expression

Returns true if the input values are not equal, false otherwise. The comparison is strictly typed: values of different runtime types are always considered unequal. Cases where the types are known to be different at parse time are considered invalid and will produce a parse error. Accepts an optional collator argument to control locale-dependent string comparisons.

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

DSL function for "!=".

not

@JvmStatic

fun not(vararg expressions: Expression): Expression

@JvmStatic

fun not(bool: Boolean): Expression

Logical negation. Returns true if the input is false, and false if the input is true.

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

DSL function for "!".

number

@JvmStatic

fun number(vararg expressions: Expression): Expression

Asserts that the input value is a number. If multiple values are provided, each one is evaluated in order until a number is obtained. If none of the inputs are numbers, the expression is an error.

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

DSL function for "number".

numberFormat

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

DSL function for "number-format".

@JvmStatic

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

Converts the input number into a string representation using the providing formatting rules. If set, the locale argument specifies the locale to use, as a BCP 47 language tag. If set, the currency argument specifies an ISO 4217 code to use for currency-style formatting. If set, the min-fraction-digits and max-fraction-digits arguments specify the minimum and maximum number of fractional digits to include.

@JvmStatic

fun numberFormat(number: Expression, locale: Expression? = null, currency: Expression? = null, minFractionDigits: Expression? = null, maxFractionDigits: Expression? = null): Expression

Converts the input number into a string representation using the providing formatting rules. If set, the locale argument specifies the locale to use, as a BCP 47 language tag. If set, the currency argument specifies an ISO 4217 code to use for currency-style formatting. If set, the unit argument specifies a simple ECMAScript unit to use for unit-style formatting. If set, the min-fraction-digits and max-fraction-digits arguments specify the minimum and maximum number of fractional digits to include.

objectExpression

@JvmStatic

fun objectExpression(vararg expressions: Expression): Expression

Asserts that the input value is an object. If multiple values are provided, each one is evaluated in order until an object is obtained. If none of the inputs are objects, the expression is an error.

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

DSL function for "object".

@JvmStatic

fun pi(): Expression

Returns the mathematical constant pi.

pitch

@JvmStatic

fun pitch(): Expression

Returns the current pitch in degrees. ["pitch"] may only be used in the filter expression for a symbol layer.

pow

@JvmStatic

fun pow(vararg expressions: Expression): Expression

@JvmStatic

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

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

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

DSL function for "^".

product

@JvmStatic

fun product(vararg expressions: Expression): Expression

@JvmStatic

fun product(vararg double: Double): Expression

Returns the product of the inputs.

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

DSL function for "*".

properties

@JvmStatic

fun properties(): Expression

Returns the feature properties object. Note that in some cases, it may be more efficient to use ["get", "property_name"] directly.

random

@JvmStatic

fun random(vararg expressions: Expression): Expression

Returns a random value in the specified range (first two input numbers) based on a supplied seed (third input). The seed can be an expression or a constant number or string value.

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

DSL function for "random".

rasterValue

@JvmStatic

fun rasterValue(): Expression

Returns the raster value of a pixel computed via raster-color-mix. Can only be used in the raster-color property.

resolvedLocale

@JvmStatic

fun resolvedLocale(vararg expressions: Expression): Expression

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.

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

DSL function for "resolved-locale".

rgb

@JvmStatic

fun rgb(vararg expressions: Expression): Expression

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.

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

DSL function for "rgb".

@JvmStatic

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

Construct a RGB color expression from numbers.

rgba

@JvmStatic

fun rgba(vararg expressions: Expression): 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. If any component is out of range, the expression is an error.

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

DSL function for "rgba".

@JvmStatic

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

Construct a RGBA color expression from numbers.

round

@JvmStatic

fun round(vararg expressions: Expression): Expression

@JvmStatic

fun round(value: Double): Expression

Rounds the input to the nearest integer. Halfway values are rounded away from zero. For example, ["round", -1.5] evaluates to -2.

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

DSL function for "round".

sin

@JvmStatic

fun sin(vararg expressions: Expression): Expression

@JvmStatic

fun sin(value: Double): Expression

Returns the sine of the input.

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

DSL function for "sin".

skyRadialProgress

@JvmStatic

fun skyRadialProgress(): Expression

Returns the distance of a point on the sky from the sun position. Returns 0 at sun position and 1 when the distance reaches sky-gradient-radius. Can only be used in the sky-gradient property.

slice

@JvmStatic

fun slice(vararg expressions: Expression): 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. The return value is inclusive of the start index but not of the end index.

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

DSL function for "slice".

sqrt

@JvmStatic

fun sqrt(vararg expressions: Expression): Expression

@JvmStatic

fun sqrt(value: Double): Expression

Returns the square root of the input.

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

DSL function for "sqrt".

step

@JvmStatic

fun step(vararg expressions: Expression): Expression

@JvmStatic

fun step(input: Expression, output: Expression, vararg stops: Pair<Expression, Expression>): Expression

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 output if the input is less than the first stop.

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

DSL function for "step".

string

@JvmStatic

fun string(vararg expressions: Expression): Expression

Asserts that the input value is a string. If multiple values are provided, each one is evaluated in order until a string is obtained. If none of the inputs are strings, the expression is an error.

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

DSL function for "string".

subtract

@JvmStatic

fun subtract(vararg expressions: Expression): Expression

For two inputs, returns the result of subtracting the second input from the first. For a single input, returns the result of subtracting it from 0.

@JvmStatic

fun subtract(value: Double): Expression

Returns the result of subtracting it from 0.

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

DSL function for "-".

@JvmStatic

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

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

sum

@JvmStatic

fun sum(vararg expressions: Expression): Expression

@JvmStatic

fun sum(vararg double: Double): Expression

Returns the sum of the inputs.

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

DSL function for "+".

switchCase

@JvmStatic

fun switchCase(vararg expressions: Expression): Expression

@JvmStatic

fun switchCase(vararg stops: Pair<Expression, Expression>, fallback: Expression): Expression

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

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

DSL function for "case".

tan

@JvmStatic

fun tan(vararg expressions: Expression): Expression

@JvmStatic

fun tan(value: Double): Expression

Returns the tangent of the input.

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

DSL function for "tan".

toBoolean

@JvmStatic

fun toBoolean(vararg expressions: Expression): Expression

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.

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

DSL function for "to-boolean".

toColor

@JvmStatic

fun toColor(vararg expressions: Expression): Expression

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.

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

DSL function for "to-color".

toNumber

@JvmStatic

fun toNumber(vararg expressions: Expression): Expression

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 "ToNumber Applied to * the String Type" algorithm of 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.

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

DSL function for "to-number".

toRgba

@JvmStatic

fun toRgba(vararg expressions: Expression): Expression

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

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

DSL function for "to-rgba".

toString

@JvmStatic

fun toString(vararg expressions: Expression): Expression

Converts the input value to a string. If the input is null, the result is "". If the input is a #types-boolean, the result is "true" or "false". If the input is a number, it is converted to a string as specified by the "NumberToString" algorithm of 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. If the input is an #types-image expression, 'to-string' returns the image name. Otherwise, the input is converted to a string in the format specified by the JSON.stringify function of the ECMAScript Language Specification.

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

DSL function for "to-string".

typeofExpression

@JvmStatic

fun typeofExpression(vararg expressions: Expression): Expression

Returns a string describing the type of the given value.

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

DSL function for "typeof".

upcase

@JvmStatic

fun upcase(vararg expressions: Expression): Expression

@JvmStatic

fun upcase(value: String): Expression

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.

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

DSL function for "upcase".

varExpression

@JvmStatic

fun varExpression(vararg expressions: Expression): Expression

@JvmStatic

fun varExpression(value: String): Expression

References variable bound using "let".

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

DSL function for "var".

within

@JvmStatic

fun within(geometry: Geometry): Expression

Returns true if the evaluated feature is fully contained inside a boundary of the input geometry, false otherwise. The input value can be a valid GeoJSON of type Polygon, MultiPolygon, Feature, or FeatureCollection. Supported features for evaluation:

zoom

@JvmStatic

fun zoom(): Expression

Returns 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.