mapsglmaps/com.xweather.mapsgl.style/Expression/Companion

Companion

Factory helpers mirroring Mapbox expression operators. Each method returns a new Expression node; nest them or wrap in StyleValue.Expression as needed.

Unless a factory says otherwise, GLES Feature-path evaluation does run the operator for fill/line/symbol/heatmap paint and for vector layer filters.

Properties

geometryType

val geometryType: <Error class: unknown class>

["geometry-type"]. Serializes for Mapbox native layers; GLES Feature-path evaluation does not resolve this operator.

mapTime

val mapTime: <Error class: unknown class>

Active map timeline position as Unix seconds (from the map controller), not wall clock. iOS/JS ["map-time"] parity. Used in vector filters; GLES applies it on the dedicated map-time reveal path rather than the generic paint evaluator.

time

val time: <Error class: unknown class>

Alias for mapTime — ["time"].

zoom

var zoom: <Error class: unknown class>

["zoom"] — current map zoom.

Functions

abs

fun abs(value: Any): Expression

["abs", value].

add

fun add(lhs: Any, rhs: Any): Expression

["+", lhs, rhs].

and

fun and(expressions: List<Any>): Expression

["all", …expressions] — logical AND.

fun at(index: Int, array: Any): Expression

["at", index, array] — element at index.

bind

fun bind(bindings: List<Expression.Variable>, output: Any): Expression

["let", name1, value1, …, output] — bind Variables then evaluate output. Pair with variable inside output. GLES evaluates let / var on the Feature path.

ceil

fun ceil(value: Any): Expression

["ceil", value].

coalesce

fun coalesce(expressions: List<Any>): Expression

["coalesce", …expressions] — first non-null result.

concat

fun concat(parts: List<Any>): Expression

["concat", …parts] — string concatenation (also used to prefix # on hex colors).

contains

fun contains(value: Any, array: List<String>): Expression

Membership test serialized as ["match", value, item1, true, item2, true, …, false] (more widely supported as a Mapbox layer filter than ["in", …]). GLES evaluates match.

divide

fun divide(lhs: Any, rhs: Any): Expression

["/", lhs, rhs].

downcase

fun downcase(input: Any): Expression

["downcase", input].

equals

fun equals(lhs: Any, rhs: Any): Expression

["==", lhs, rhs].

floor

fun floor(value: Any): Expression

["floor", value].

format

fun format(parts: List<Pair<StyleValue<String>, TextFormatOptions>>): Expression

Mapbox ["format", text, options, …] for mixed-style labels. Serializes for Mapbox native symbol layers; GLES Feature-path evaluation does not run this operator.

get

fun get(property: String): Expression

["get", property] for a feature property. Dotted property (e.g. "vals.0") is expanded via getPath into nested get / at nodes.

getPath

fun getPath(path: String): Expression

Nested property access: "a.b" → ["get", "b", ["get", "a"]], and numeric segments such as "vals.0" become ["at", 0, ["get", "vals"]].

greaterThan

fun greaterThan(lhs: Any, rhs: Any): Expression

[">", lhs, rhs].

greaterThanOrEqual

fun greaterThanOrEqual(lhs: Any, rhs: Any): Expression

[">=", lhs, rhs].

has

fun has(property: String, obj: Any? = null): Expression

["has", property] on the feature, or ["has", property, obj] when obj is set. Dotted property is expanded via hasPath.

hasPath

fun hasPath(property: String): Expression

Nested has: "a.b" → ["has", "b", ["get", "a"]].

indexOf

fun indexOf(search: Any, array: Any): Expression

["index-of", search, array]. Serializes for Mapbox native layers; GLES Feature-path evaluation does not run this operator.

interpolate

fun interpolate(input: Any, stops: List<Any>): Expression

Linear ["interpolate", ["linear"], input, …stops]. ColorStop entries expand to value + rgba(...) string. GLES evaluates linear interpolation for color and number paint.

fun interpolate(interpolation: Any, input: Any, stops: List<Any>): Expression

["interpolate", interpolation, input, …stops].

interpolateCubicBezier

fun interpolateCubicBezier(input: Any, controlPoints: List<Double>, stops: List<Any>): Expression

["interpolate", ["cubic-bezier", x1, y1, x2, y2], input, …stops]. controlPoints must be four numbers. GLES evaluates cubic-bezier interpolation.

interpolateExponential

fun interpolateExponential(input: Any, base: Double, stops: List<Any>): Expression

["interpolate", ["exponential", base], input, …stops]. GLES evaluates exponential interpolation for color and number paint.

join

fun join(separator: String, parts: List<Any>): Expression

["join", separator, …parts].

length

fun length(input: Any): Expression

["length", input] — string or array length.

lessThan

fun lessThan(lhs: Any, rhs: Any): Expression

["<", lhs, rhs].

lessThanOrEqual

fun lessThanOrEqual(lhs: Any, rhs: Any): Expression

["<=", lhs, rhs].

literal

fun literal(value: Any): Expression

["literal", value] — wrap a Kotlin value as an expression operand.

match

fun match(input: Any, matches: List<Expression.Step<Any>>, fallback: Any?): Expression

["match", input, label, output, …, fallback]. Each Step.value is a match label and Step.result the output for that label.

max

fun max(vararg values: Any): Expression

["max", …values].

min

fun min(vararg values: Any): Expression

["min", …values].

mod

fun mod(lhs: Any, rhs: Any): Expression

["%", lhs, rhs] (remainder).

multiply

fun multiply(lhs: Any, rhs: Any): Expression

["*", lhs, rhs].

not

fun not(expression: Any): Expression

["!", expression] — logical NOT.

notEquals

fun notEquals(lhs: Any, rhs: Any): Expression

["!=", lhs, rhs].

fun or(expressions: List<Any>): Expression

["any", …expressions] — logical OR.

rgb

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

["rgb", red, green, blue] with channels in 0…255. GLES evaluates this for fill color.

rgba

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

["rgba", red, green, blue, alpha] with RGB in 0…255 and alpha in 0…1. GLES evaluates this for fill color.

round

fun round(value: Any): Expression

["round", value].

slice

fun slice(input: Any, start: Int, end: Int? = null): Expression

["slice", input, start] or ["slice", input, start, end].

step

fun <T : Any> step(input: Any, stops: List<Expression.Step<T>>): Expression

["step", input, output0, stop1, output1, …]. The first Step is the base output (its Step.value is ignored); later stops pair Step.value thresholds with outputs.

subtract

fun subtract(value: Any): Expression

Unary negate: ["-", 0, value].

fun subtract(lhs: Any, rhs: Any): Expression

["-", lhs, rhs].

switchCase

fun switchCase(conditionsAndResults: List<Expression.Case>, fallback: Any): Expression

["case", cond1, out1, …, fallback] (Mapbox case; named switchCase to avoid the Kotlin keyword).

toBoolean

fun toBoolean(value: Any): Expression

["to-boolean", value]. Serializes for Mapbox native layers. GLES Feature-path evaluation does not run this operator except a narrow symbol-color path.

toNumber

fun toNumber(value: Any): Expression

["to-number", value].

toString

fun toString(value: Any): Expression

["to-string", value].

upcase

fun upcase(input: Any): Expression

["upcase", input].

variable

fun variable(name: String): Expression

["var", name] — reference a name bound by bind.