Companion

object Companion

Static variables and methods.

Functions

Link copied to clipboard
fun abs(vararg expressions: Expression): Expression

Returns the absolute value of the input.

DSL function for "abs".

Link copied to clipboard

Returns the value of a cluster property accumulated so far. Can only be used in the clusterProperties option of a clustered GeoJSON source.

Link copied to clipboard
fun acos(vararg expressions: Expression): Expression

Returns the arccosine of the input.

DSL function for "acos".

Link copied to clipboard

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.

Link copied to clipboard
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.

DSL function for "all".

Link copied to clipboard
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.

DSL function for "any".

Link copied to clipboard
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.

DSL function for "array".

Link copied to clipboard
fun asin(vararg expressions: Expression): Expression

Returns the arcsine of the input.

DSL function for "asin".

Link copied to clipboard
fun at(vararg expressions: Expression): Expression
fun at(index: Double, array: Expression): Expression

Retrieves an item from an array.

DSL function for "at".

Link copied to clipboard
fun atan(vararg expressions: Expression): Expression

Returns the arctangent of the input.

DSL function for "atan".

Link copied to clipboard
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.

DSL function for "boolean".

Link copied to clipboard
fun ceil(vararg expressions: Expression): Expression

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

DSL function for "ceil".

Link copied to clipboard
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.

DSL function for "coalesce".

Link copied to clipboard

Dsl function for "collator".

fun collator(caseSensitive: Expression, diacriticSensitive: Expression, locale: Expression): Expression
fun collator(caseSensitive: Boolean = false, diacriticSensitive: Boolean = false, locale: Locale): Expression
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.

Link copied to clipboard

Convert a color int to the rgba expression.

Link copied to clipboard
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.

fun concat(vararg values: String): Expression

Returns a string consisting of the concatenation of the inputs.

DSL function for "concat".

Link copied to clipboard
fun config(vararg expressions: Expression): Expression

Retrieves the configuration value for the given option.

DSL function for "config".

Link copied to clipboard
fun cos(vararg expressions: Expression): Expression

Returns the cosine of the input.

DSL function for "cos".

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
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.

Link copied to clipboard

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.

Link copied to clipboard
fun division(vararg expressions: Expression): Expression
fun division(first: Double, second: Double): Expression

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

DSL function for "/".

Link copied to clipboard
fun downcase(vararg expressions: Expression): 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.

DSL function for "downcase".

Link copied to clipboard

Returns the mathematical constant e.

Link copied to clipboard
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.

DSL function for "==".

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
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.

DSL function for "feature-state".

Link copied to clipboard
fun floor(vararg expressions: Expression): Expression

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

DSL function for "floor".

Link copied to clipboard
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:

DSL function for "format".

Link copied to clipboard

Construct Expression from a raw string.

Link copied to clipboard

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

Link copied to clipboard
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.

DSL function for "get".

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

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.

Link copied to clipboard
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.

DSL function for ">".

Link copied to clipboard
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.

DSL function for ">=".

Link copied to clipboard
fun has(vararg expressions: Expression): Expression
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.

DSL function for "has".

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

Link copied to clipboard

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.

Link copied to clipboard
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.

DSL function for "hsl".

Link copied to clipboard
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.

DSL function for "hsla".

Link copied to clipboard

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

Link copied to clipboard
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.

DSL function for "image".

Link copied to clipboard
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.

DSL function for "index-of".

Link copied to clipboard
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.

DSL function for "in".

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

Link copied to clipboard
fun interpolate(vararg expressions: 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.

DSL function for "interpolate".

Link copied to clipboard

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

DSL function for "is-supported-script".

Link copied to clipboard
fun length(vararg expressions: Expression): Expression

Returns the length of an array or string.

DSL function for "length".

Gets the length of an string.

Link copied to clipboard
fun letExpression(vararg expressions: Expression): Expression

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

DSL function for "let".

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Provides a literal array or object value.

Link copied to clipboard
fun ln(vararg expressions: Expression): Expression

Returns the natural logarithm of the input.

DSL function for "ln".

Link copied to clipboard

Returns mathematical constant ln(2).

Link copied to clipboard
fun log10(vararg expressions: Expression): Expression

Returns the base-ten logarithm of the input.

DSL function for "log10".

Link copied to clipboard
fun log2(vararg expressions: Expression): Expression

Returns the base-two logarithm of the input.

DSL function for "log2".

Link copied to clipboard
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.

DSL function for "<".

Link copied to clipboard
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.

DSL function for "<=".

Link copied to clipboard
fun match(vararg expressions: Expression): Expression
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:

DSL function for "match".

Link copied to clipboard
fun max(vararg expressions: Expression): Expression
fun max(vararg values: Double): Expression

Returns the maximum value of the inputs.

DSL function for "max".

Link copied to clipboard
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.

DSL function for "measure-light".

Link copied to clipboard
fun min(vararg expressions: Expression): Expression
fun min(vararg values: Double): Expression

Returns the minimum value of the inputs.

DSL function for "min".

Link copied to clipboard
fun mod(vararg expressions: Expression): Expression
fun mod(first: Double, second: Double): Expression

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

DSL function for "%".

Link copied to clipboard
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.

DSL function for "!=".

Link copied to clipboard
fun not(vararg expressions: Expression): Expression

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

DSL function for "!".

Link copied to clipboard
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.

DSL function for "number".

Link copied to clipboard

DSL function for "number-format".

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.

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.

Link copied to clipboard

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.

DSL function for "object".

Link copied to clipboard

Returns the mathematical constant pi.

Link copied to clipboard

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

Link copied to clipboard
fun pow(vararg expressions: Expression): Expression
fun pow(first: Double, second: Double): Expression

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

DSL function for "^".

Link copied to clipboard
fun product(vararg expressions: Expression): Expression
fun product(vararg double: Double): Expression

Returns the product of the inputs.

DSL function for "*".

Link copied to clipboard

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

Link copied to clipboard
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.

DSL function for "random".

Link copied to clipboard

Returns the length of the particle velocity vector. Can only be used in the raster-particle-color property.

Link copied to clipboard

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

Link copied to clipboard
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.

DSL function for "resolved-locale".

Link copied to clipboard
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.

DSL function for "rgb".

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

Construct a RGB color expression from numbers.

Link copied to clipboard
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.

DSL function for "rgba".

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

Construct a RGBA color expression from numbers.

Link copied to clipboard
fun round(vararg expressions: Expression): Expression

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

DSL function for "round".

Link copied to clipboard
fun sin(vararg expressions: Expression): Expression

Returns the sine of the input.

DSL function for "sin".

Link copied to clipboard

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.

Link copied to clipboard
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.

DSL function for "slice".

Link copied to clipboard
fun sqrt(vararg expressions: Expression): Expression

Returns the square root of the input.

DSL function for "sqrt".

Link copied to clipboard
fun step(vararg expressions: Expression): Expression
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.

DSL function for "step".

Link copied to clipboard
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.

DSL function for "string".

Link copied to clipboard
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.

Returns the result of subtracting it from 0.

DSL function for "-".

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

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

Link copied to clipboard
fun sum(vararg expressions: Expression): Expression
fun sum(vararg double: Double): Expression

Returns the sum of the inputs.

DSL function for "+".

Link copied to clipboard
fun switchCase(vararg expressions: Expression): Expression

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

DSL function for "case".

Link copied to clipboard
fun tan(vararg expressions: Expression): Expression

Returns the tangent of the input.

DSL function for "tan".

Link copied to clipboard
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.

DSL function for "to-boolean".

Link copied to clipboard
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.

DSL function for "to-color".

Link copied to clipboard
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.

DSL function for "to-number".

Link copied to clipboard
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.

DSL function for "to-rgba".

Link copied to clipboard
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.

DSL function for "to-string".

Link copied to clipboard

Returns a string describing the type of the given value.

DSL function for "typeof".

Link copied to clipboard
fun upcase(vararg expressions: Expression): 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.

DSL function for "upcase".

Link copied to clipboard
fun varExpression(vararg expressions: Expression): Expression

References variable bound using "let".

DSL function for "var".

Link copied to clipboard
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:

Link copied to clipboard

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.