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.

@JvmStatic()

fun id(): Expression

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

image

@JvmStatic()

fun image(vararg expressions: Expression): Expression

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

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.

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.

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

DSL function for "in".

@JvmStatic()

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

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

@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

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

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

DSL function for "interpolate".

isSupportedScript

@JvmStatic()

fun isSupportedScript(vararg expressions: Expression): Expression

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

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

DSL function for "is-supported-script".

@JvmStatic()

fun isSupportedScript(script: String): Expression

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

length

@JvmStatic()

fun length(vararg expressions: Expression): Expression

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

lineProgress

@JvmStatic()

fun lineProgress(): Expression

Gets the progress along a gradient line.

literal

@JvmStatic()

fun literal(value: Boolean): Expression

Provides a literal array or object value.

@JvmStatic()

fun literal(value: Double): Expression

Provides a literal array or object value.

@JvmStatic()

fun literal(value: Long): Expression

Provides a literal array or object value.

@JvmStatic()

fun literal(value: String): Expression

Provides a literal array or object value.

@JvmStatic()

fun ln(vararg expressions: Expression): Expression

Returns the natural logarithm of the input.

@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

Returns the base-ten logarithm of the input.

@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

Returns the base-two logarithm of the input.

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

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.

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

DSL function for "<=".

match

@JvmStatic()

fun match(vararg expressions: Expression): Expression

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

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

DSL function for "match".

max

@JvmStatic()

fun max(vararg expressions: Expression): Expression

Returns the maximum value of the inputs.

@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".

min

@JvmStatic()

fun min(vararg expressions: Expression): Expression

Returns the minimum value of the inputs.

@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

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

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

DSL function for "%".

@JvmStatic()

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

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

neq

@JvmStatic()

fun neq(vararg expressions: Expression): Expression

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

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

DSL function for "!=".

not

@JvmStatic()

fun not(vararg expressions: Expression): Expression

Logical negation.

@JvmStatic()

fun not(bool: Boolean): Expression

Logical negation.

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.

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.

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

objectExpression

@JvmStatic()

fun objectExpression(vararg expressions: Expression): Expression

Asserts that the input value is an object.

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

DSL function for "object".

@JvmStatic()

fun pi(): Expression

Returns the mathematical constant pi.

pow

@JvmStatic()

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

@JvmStatic()

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

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

product

@JvmStatic()

fun product(vararg expressions: Expression): Expression

Returns the product of the inputs.

@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

Gets the feature properties object.

resolvedLocale

@JvmStatic()

fun resolvedLocale(vararg expressions: Expression): Expression

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

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.

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.

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

Rounds the input to the nearest integer.

@JvmStatic()

fun round(value: Double): Expression

Rounds the input to the nearest integer.

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

DSL function for "round".

sin

@JvmStatic()

fun sin(vararg expressions: Expression): Expression

Returns the sine of the input.

@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

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

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.

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

DSL function for "slice".

sqrt

@JvmStatic()

fun sqrt(vararg expressions: Expression): Expression

Returns the square root of the input.

@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

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

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.

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.

@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

Returns the sum of the inputs.

@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

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

Returns the tangent of the input.

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

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.

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.

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

open fun toString(): String

@JvmStatic()

fun toString(vararg expressions: Expression): Expression

Converts the input value to a string.

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

Returns the input string converted to uppercase.

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

DSL function for "upcase".

@JvmStatic()

fun upcase(value: String): Expression

Returns the input string converted to uppercase.

varExpression

@JvmStatic()

fun varExpression(vararg expressions: Expression): Expression

References variable bound using "let".

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

DSL function for "var".

@JvmStatic()

fun varExpression(value: String): Expression

References variable bound using "let".

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.

zoom

@JvmStatic()

fun zoom(): Expression

Gets the current zoom level.