InterpolatorBuilder

class InterpolatorBuilder(operator: String) : Expression.ExpressionBuilder

Builder for Interpolate Expression.

Parameters

operator

compulsory operator field for the builder

Constructors

InterpolatorBuilder

fun InterpolatorBuilder(operator: String)

compulsory operator field for the builder

Functions

abs

fun abs(value: Double)

Returns the absolute value of the input.

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

Returns the absolute value of the input.

accumulated

fun accumulated()

Gets the value of a cluster property accumulated so far.

acos

fun acos(value: Double)

Returns the arccosine of the input.

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

Returns the arccosine of the input.

addArgument

fun addArgument(expression: Expression): Expression.ExpressionBuilder

Add an Expression to the builder.

all

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

Returns true if all the inputs are true, false otherwise.

any

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

Returns true if any of the inputs are true, false otherwise.

array

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

Asserts that the input is an array (optionally with a specific item type and length).

asin

fun asin(value: Double)

Returns the arcsine of the input.

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

Returns the arcsine of the input.

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

Retrieves an item from an array.

fun at(index: Double, array: Expression)

Retrieves an item from an array.

atan

fun atan(value: Double)

Returns the arctangent of the input.

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

Returns the arctangent of the input.

boolean

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

Asserts that the input value is a boolean.

build

open fun build(): Expression

Build the Expression with the settings.

ceil

fun ceil(value: Double)

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

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

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

coalesce

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

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

collator

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

Returns a collator for use in locale-dependent comparison operations.

color

fun color(@ColorInt() intColor: Int)

Add a color expression to the current expression builder.

concat

fun concat(vararg values: String)

Returns a string consisting of the concatenation of the inputs.

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

Returns a string consisting of the concatenation of the inputs.

cos

fun cos(value: Double)

Returns the cosine of the input.

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

Returns the cosine of the input.

cubicBezier

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

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

distance

fun distance(geojson: GeoJson)

Returns the shortest distance in meters between the evaluated feature and the input geometry.

division

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

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

fun division(first: Double, second: Double)

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

downcase

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

Returns the input string converted to lowercase.

fun downcase(value: String)

Returns the input string converted to lowercase.

fun e()

Returns the mathematical constant e.

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

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

exponential

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

Interpolates exponentially between the stops just less than and just greater than the input.

featureState

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

Retrieves a property value from the current feature's state.

floor

fun floor(value: Double)

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

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

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

format

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

Returns a formatted string for displaying mixed-format text in the text-field property.

geometryType

fun geometryType()

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

get

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

Retrieves a property value from the current feature's properties, or from another object if a second argument is provided.

fun get(key: String)

Retrieves a property value from the current feature's properties.

fun get(key: String, expression: Expression)

Retrieves a property value from the current feature's properties, or from another object if a second argument is provided.

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

Returns true if the first input is strictly greater than the second, false otherwise.

gte

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

Returns true if the first input is greater than or equal to the second, false otherwise.

has

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

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(string: String)

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

fun has(string: String, 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.

heatmapDensity

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

fun id()

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

image

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

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

indexOf

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

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.

inExpression

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

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

fun inExpression(needle: Double, haystack: Expression)

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

fun inExpression(needle: String, haystack: Expression)

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

interpolate

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

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

isSupportedScript

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

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

fun isSupportedScript(script: String)

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

length

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

Gets the length of an array or string.

fun length(string: String)

Gets the length of an string.

letExpression

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

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

linear

fun linear()

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

lineProgress

fun lineProgress()

Gets the progress along a gradient line.

literal

fun literal(value: HashMap<String, Any>)