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.

@JvmStatic()

fun all(vararg expressions: Array<out Expression>): Expression

DSL function for "all".

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

any

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.

@JvmStatic()

fun any(vararg expressions: Array<out Expression>): Expression

DSL function for "any".

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

array

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.

@JvmStatic()

fun array(vararg expressions: Array<out Expression>): Expression

DSL function for "array".

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

asin

Returns the arcsine of the input.

@JvmStatic()

fun asin(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun asin(value: Double): Expression

DSL function for "asin".

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

Retrieves an item from an array.

@JvmStatic()

fun at(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

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

DSL function for "at".

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

atan

Returns the arctangent of the input.

@JvmStatic()

fun atan(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun atan(value: Double): Expression

DSL function for "atan".

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

boolean

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.

@JvmStatic()

fun boolean(vararg expressions: Array<out Expression>): Expression

DSL function for "boolean".

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

ceil

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

@JvmStatic()

fun ceil(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun ceil(value: Double): Expression

DSL function for "ceil".

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

coalesce

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

@JvmStatic()

fun coalesce(vararg expressions: Array<out Expression>): Expression

DSL function for "coalesce".

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

collator

Dsl function for "collator".

fun collator(block: Expression.CollatorBuilder.() -> Unit): 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.

@JvmStatic()

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

@JvmStatic()

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

@JvmStatic()

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

color

Convert a color int to the rgba expression.

@JvmStatic()

fun color(intColor: Int): Expression

concat

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 expressions: Array<out Expression>): Expression

Returns a string consisting of the concatenation of the inputs.

@JvmStatic()

fun concat(vararg values: Array<out String>): Expression

DSL function for "concat".

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

cos

Returns the cosine of the input.

@JvmStatic()

fun cos(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun cos(value: Double): Expression

DSL function for "cos".

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

cubicBezier

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

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

@JvmStatic()

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

distance

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.

@JvmStatic()

fun distance(geojson: GeoJson): Expression

division

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

@JvmStatic()

fun division(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

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

DSL function for "/".

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

downcase

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.

@JvmStatic()

fun downcase(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun downcase(value: String): Expression

DSL function for "downcase".

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

Returns the mathematical constant e.

@JvmStatic()

fun e(): 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.

@JvmStatic()

fun eq(vararg expressions: Array<out Expression>): Expression

DSL function for "==".

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

equals

open operator override fun equals(other: Any?): Boolean

exponential

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.

@JvmStatic()

fun exponential(expression: Expression): Expression

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

featureState

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.

@JvmStatic()

fun featureState(vararg expressions: Array<out Expression>): Expression

DSL function for "feature-state".

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

floor

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

@JvmStatic()

fun floor(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun floor(value: Double): Expression

DSL function for "floor".

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

format

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:

"text-font": Overrides the font stack specified by the root layout property.
"text-color": Overrides the color specified by the root paint property.
"font-scale": Applies a scaling factor on text-size as specified by the root layout property.

@JvmStatic()

fun format(vararg formatSections: Array<out FormatSection>): Expression

DSL function for "format".

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

fromRaw

Construct Expression from a raw string.

@JvmStatic()

fun fromRaw(expression: String): Expression

geometryType

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

@JvmStatic()

fun geometryType(): Expression

get

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 get(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

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

DSL function for "get".

fun get(block: Expression.ExpressionBuilder.() -> Unit): 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

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.

@JvmStatic()

fun gt(vararg expressions: Array<out Expression>): Expression

DSL function for ">".

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

gte

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.

@JvmStatic()

fun gte(vararg expressions: Array<out Expression>): Expression

DSL function for ">=".

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

has

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

@JvmStatic()

fun has(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

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

DSL function for "has".

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

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

@JvmStatic()

fun has(string: String): Expression

hashCode

open override fun hashCode(): Int

heatmapDensity

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.

@JvmStatic()

fun heatmapDensity(): Expression

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

@JvmStatic()

fun id(): Expression

image

Returns an image type for use in icon-image, --pattern entries and as a section in the format expression. If set, the image argument will check that the requested image exists in the style and will return either the resolved image name or null, depending on whether or not the image 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.

@JvmStatic()

fun image(vararg expressions: Array<out Expression>): Expression

DSL function for "image".

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

inExpression

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

@JvmStatic()

fun inExpression(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

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

@JvmStatic()

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

DSL function for "in".

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

interpolate

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.

Interpolation types:

["linear"]: Interpolates linearly between the pair of stops just less than and just greater than the input.
["exponential", base]: 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.
["cubic-bezier", x1, y1, x2, y2]: Interpolates using the cubic bezier curve defined by the given control points.

@JvmStatic()

fun interpolate(vararg expressions: Array<out Expression>): Expression

DSL function for "interpolate".

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

isSupportedScript

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

@JvmStatic()

fun isSupportedScript(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun isSupportedScript(script: String): Expression

DSL function for "is-supported-script".

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

length

Gets the length of an array or string.

@JvmStatic()

fun length(vararg expressions: Array<out Expression>): Expression

DSL function for "length".

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

Gets the length of an string.

@JvmStatic()

fun length(string: String): Expression

letExpression

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

@JvmStatic()

fun letExpression(vararg expressions: Array<out Expression>): Expression

DSL function for "let".

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

linear

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

@JvmStatic()

fun linear(): Expression

lineProgress

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

@JvmStatic()

fun lineProgress(): Expression

literal

Provides a literal array or object value.

@JvmStatic()

fun literal(value: Boolean): Expression

@JvmStatic()

fun literal(value: Double): Expression

@JvmStatic()

fun literal(value: Long): Expression

@JvmStatic()

fun literal(value: String): Expression

Returns the natural logarithm of the input.

@JvmStatic()

fun ln(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun ln(value: Double): Expression

DSL function for "ln".

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

ln2

Returns mathematical constant ln(2).

@JvmStatic()

fun ln2(): Expression

log10

Returns the base-ten logarithm of the input.

@JvmStatic()

fun log10(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun log10(value: Double): Expression

DSL function for "log10".

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

log2

Returns the base-two logarithm of the input.

@JvmStatic()

fun log2(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun log2(value: Double): Expression

DSL function for "log2".

fun log2(block: Expression.ExpressionBuilder.() -> Unit): 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.

@JvmStatic()

fun lt(vararg expressions: Array<out Expression>): Expression

DSL function for "<".

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

lte

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.

@JvmStatic()

fun lte(vararg expressions: Array<out Expression>): Expression

DSL function for "<=".

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

match

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

a single literal value; or
an array of literal values, whose values must be all strings or all numbers (e.g. [100, 101] or ["c", "b"]). The input matches if any of the values in the array matches, similar to the "in" operator. Each label must be unique. If the input type does not match the type of the labels, the result will be the fallback value.

@JvmStatic()

fun match(vararg expressions: Array<out Expression>): Expression

DSL function for "match".

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

max

Returns the maximum value of the inputs.

@JvmStatic()

fun max(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun max(vararg values: DoubleArray): Expression

DSL function for "max".

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

min

Returns the minimum value of the inputs.

@JvmStatic()

fun min(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun min(vararg values: DoubleArray): Expression

DSL function for "min".

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

mod

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

@JvmStatic()

fun mod(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

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

DSL function for "%".

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

neq

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.

@JvmStatic()

fun neq(vararg expressions: Array<out Expression>): Expression

DSL function for "!=".

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

not

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

@JvmStatic()

fun not(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun not(bool: Boolean): Expression

DSL function for "!".

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

number

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.

@JvmStatic()

fun number(vararg expressions: Array<out Expression>): Expression

DSL function for "number".

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

numberFormat

DSL function for "number-format".

fun numberFormat(number: Expression, 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(value: Double, block: Expression.NumberFormatBuilder.() -> Unit): Expression

@JvmStatic()

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

objectExpression

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.

@JvmStatic()

fun objectExpression(vararg expressions: Array<out Expression>): Expression

DSL function for "object".

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

Returns the mathematical constant pi.

@JvmStatic()

fun pi(): Expression

pow

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

@JvmStatic()

fun pow(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

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

DSL function for "^".

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

product

Returns the product of the inputs.

@JvmStatic()

fun product(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun product(vararg double: DoubleArray): Expression

DSL function for "*".

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

properties

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

@JvmStatic()

fun properties(): Expression

resolvedLocale

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.

@JvmStatic()

fun resolvedLocale(vararg expressions: Array<out Expression>): Expression

DSL function for "resolved-locale".

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

rgb

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.

@JvmStatic()

fun rgb(vararg expressions: Array<out Expression>): Expression

DSL function for "rgb".

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

Construct a RGB color expression from numbers.

@JvmStatic()

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

rgba

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.

@JvmStatic()

fun rgba(vararg expressions: Array<out Expression>): Expression

DSL function for "rgba".

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

Construct a RGBA color expression from numbers.

@JvmStatic()

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

round

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

@JvmStatic()

fun round(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun round(value: Double): Expression

DSL function for "round".

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

sin

Returns the sine of the input.

@JvmStatic()

fun sin(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun sin(value: Double): Expression

DSL function for "sin".

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

skyRadialProgress

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

@JvmStatic()

fun skyRadialProgress(): Expression

sqrt

Returns the square root of the input.

@JvmStatic()

fun sqrt(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun sqrt(value: Double): Expression

DSL function for "sqrt".

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

step

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.

@JvmStatic()

fun step(vararg expressions: Array<out Expression>): Expression

DSL function for "step".

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

string

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.

@JvmStatic()

fun string(vararg expressions: Array<out Expression>): Expression

DSL function for "string".

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

subtract

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(vararg expressions: Array<out Expression>): Expression

Returns the result of subtracting it from 0.

@JvmStatic()

fun subtract(value: Double): Expression

DSL function for "-".

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

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

@JvmStatic()

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

sum

Returns the sum of the inputs.

@JvmStatic()

fun sum(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun sum(vararg double: DoubleArray): Expression

DSL function for "+".

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

switchCase

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

@JvmStatic()

fun switchCase(vararg expressions: Array<out Expression>): Expression

DSL function for "case".

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

tan

Returns the tangent of the input.

@JvmStatic()

fun tan(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun tan(value: Double): Expression

DSL function for "tan".

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

toBoolean

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.

@JvmStatic()

fun toBoolean(vararg expressions: Array<out Expression>): Expression

DSL function for "to-boolean".

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

toColor

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.

@JvmStatic()

fun toColor(vararg expressions: Array<out Expression>): Expression

DSL function for "to-color".

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

toNumber

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.

@JvmStatic()

fun toNumber(vararg expressions: Array<out Expression>): Expression

DSL function for "to-number".

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

toRgba

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

@JvmStatic()

fun toRgba(vararg expressions: Array<out Expression>): Expression

DSL function for "to-rgba".

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

toString

open override fun toString(): String

Converts the input value to a string. If the input is null, the result is "". If the input is a 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. Otherwise, the input is converted to a string in the format specified by the JSON.stringify function of the ECMAScript Language Specification.

@JvmStatic()

fun toString(vararg expressions: Array<out Expression>): Expression

DSL function for "to-string".

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

typeofExpression

Returns a string describing the type of the given value.

@JvmStatic()

fun typeofExpression(vararg expressions: Array<out Expression>): Expression

DSL function for "typeof".

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

upcase

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.

@JvmStatic()

fun upcase(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun upcase(value: String): Expression

DSL function for "upcase".

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

varExpression

References variable bound using "let".

@JvmStatic()

fun varExpression(vararg expressions: Array<out Expression>): Expression

@JvmStatic()

fun varExpression(value: String): Expression

DSL function for "var".

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

within

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:

Point: Returns false if a point is on the boundary or falls outside the boundary.
LineString: Returns false if any part of a line falls outside the boundary, the line intersects the boundary, or a line's endpoint is on the boundary.

@JvmStatic()

fun within(geometry: Geometry): Expression

zoom

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.

@JvmStatic()

fun zoom(): Expression