InterpolatorBuilder

class InterpolatorBuilder(operator: String) : Expression.ExpressionBuilder

Builder for Interpolate Expression.

Parameters

operator

compulsory operator field for the builder

Constructors

InterpolatorBuilder
Link copied to clipboard
fun InterpolatorBuilder(operator: String)
compulsory operator field for the builder

Functions

abs
Link copied to clipboard
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
Link copied to clipboard
fun accumulated()
Gets the value of a cluster property accumulated so far.
acos
Link copied to clipboard
fun acos(value: Double)
Returns the arccosine of the input.
fun acos(block: Expression.ExpressionBuilder.() -> Unit)
Returns the arccosine of the input.
addArgument
Link copied to clipboard
fun addArgument(expression: Expression): Expression.ExpressionBuilder
Add an Expression to the builder.
all
Link copied to clipboard
fun all(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if all the inputs are true, false otherwise.
any
Link copied to clipboard
fun any(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if any of the inputs are true, false otherwise.
array
Link copied to clipboard
fun array(block: Expression.ExpressionBuilder.() -> Unit)
Asserts that the input is an array (optionally with a specific item type and length).
asin
Link copied to clipboard
fun asin(value: Double)
Returns the arcsine of the input.
fun asin(block: Expression.ExpressionBuilder.() -> Unit)
Returns the arcsine of the input.
at
Link copied to clipboard
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
Link copied to clipboard
fun atan(value: Double)
Returns the arctangent of the input.
fun atan(block: Expression.ExpressionBuilder.() -> Unit)
Returns the arctangent of the input.
boolean
Link copied to clipboard
fun boolean(block: Expression.ExpressionBuilder.() -> Unit)
Asserts that the input value is a boolean.
build
Link copied to clipboard
open fun build(): Expression
Build the Expression with the settings.
ceil
Link copied to clipboard
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
Link copied to clipboard
fun coalesce(block: Expression.ExpressionBuilder.() -> Unit)
Evaluates each expression in turn until the first non-null value is obtained, and returns that value.
collator
Link copied to clipboard
fun collator(block: Expression.CollatorBuilder.() -> Unit)
Returns a collator for use in locale-dependent comparison operations.
color
Link copied to clipboard
fun color(@ColorInt() intColor: Int)
Add a color expression to the current expression builder.
concat
Link copied to clipboard
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
Link copied to clipboard
fun cos(value: Double)
Returns the cosine of the input.
fun cos(block: Expression.ExpressionBuilder.() -> Unit)
Returns the cosine of the input.
cubicBezier
Link copied to clipboard
fun cubicBezier(block: Expression.ExpressionBuilder.() -> Unit)
Interpolates using the cubic bezier curve defined by the given control points.
distance
Link copied to clipboard
fun distance(geojson: GeoJson)
Returns the shortest distance in meters between the evaluated feature and the input geometry.
division
Link copied to clipboard
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
Link copied to clipboard
fun downcase(block: Expression.ExpressionBuilder.() -> Unit)
Returns the input string converted to lowercase.
fun downcase(value: String)
Returns the input string converted to lowercase.
e
Link copied to clipboard
fun e()
Returns the mathematical constant e.
eq
Link copied to clipboard
fun eq(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if the input values are equal, false otherwise.
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
exponential
Link copied to clipboard
fun exponential(block: Expression.ExpressionBuilder.() -> Unit)
Interpolates exponentially between the stops just less than and just greater than the input.
featureState
Link copied to clipboard
fun featureState(block: Expression.ExpressionBuilder.() -> Unit)
Retrieves a property value from the current feature's state.
floor
Link copied to clipboard
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
Link copied to clipboard
fun format(block: Expression.FormatBuilder.() -> Unit)
Returns a formatted string for displaying mixed-format text in the text-field property.
geometryType
Link copied to clipboard
fun geometryType()
Gets the feature's geometry type: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon.
get
Link copied to clipboard
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.
gt
Link copied to clipboard
fun gt(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if the first input is strictly greater than the second, false otherwise.
gte
Link copied to clipboard
fun gte(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if the first input is greater than or equal to the second, false otherwise.
has
Link copied to clipboard
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.
hashCode
Link copied to clipboard
open fun hashCode(): Int
heatmapDensity
Link copied to clipboard
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.
id
Link copied to clipboard
fun id()
Gets the feature's id, if it has one.
image
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
fun interpolate(block: Expression.InterpolatorBuilder.() -> Unit)
Produces continuous, smooth results by interpolating between pairs of input and output values ("stops").
isSupportedScript
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
fun linear()
Interpolates linearly between the pair of stops just less than and just greater than the input.
lineProgress
Link copied to clipboard
fun lineProgress()
Gets the progress along a gradient line.
literal
Link copied to clipboard
fun literal(value: HashMap<String, Any>)
Provides a literal array or object value.
fun literal(value: Boolean)
Provides a literal array or object value.
fun literal(value: Double)
Provides a literal array or object value.
fun literal(value: Long)
Provides a literal array or object value.
fun literal(value: String)
Provides a literal array or object value.
fun literal(value: List<Any>)
Provides a literal array or object value.
ln
Link copied to clipboard
fun ln(value: Double)
Returns the natural logarithm of the input.
fun ln(block: Expression.ExpressionBuilder.() -> Unit)
Returns the natural logarithm of the input.
ln2
Link copied to clipboard
fun ln2()
Returns mathematical constant ln(2).
log10
Link copied to clipboard
fun log10(value: Double)
Returns the base-ten logarithm of the input.
fun log10(block: Expression.ExpressionBuilder.() -> Unit)
Returns the base-ten logarithm of the input.
log2
Link copied to clipboard
fun log2(value: Double)
Returns the base-two logarithm of the input.
fun log2(block: Expression.ExpressionBuilder.() -> Unit)
Returns the base-two logarithm of the input.
lt
Link copied to clipboard
fun lt(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if the first input is strictly less than the second, false otherwise.
lte
Link copied to clipboard
fun lte(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if the first input is less than or equal to the second, false otherwise.
match
Link copied to clipboard
fun match(block: Expression.ExpressionBuilder.() -> Unit)
Selects the output whose label value matches the input value, or the fallback value if no match is found.
max
Link copied to clipboard
fun max(vararg values: Double)
Returns the maximum value of the inputs.
fun max(block: Expression.ExpressionBuilder.() -> Unit)
Returns the maximum value of the inputs.
min
Link copied to clipboard
fun min(vararg values: Double)
Returns the minimum value of the inputs.
fun min(block: Expression.ExpressionBuilder.() -> Unit)
Returns the minimum value of the inputs.
mod
Link copied to clipboard
fun mod(block: Expression.ExpressionBuilder.() -> Unit)
Returns the remainder after integer division of the first input by the second.
fun mod(first: Double, second: Double)
Returns the remainder after integer division of the first input by the second.
neq
Link copied to clipboard
fun neq(block: Expression.ExpressionBuilder.() -> Unit)
Returns true if the input values are not equal, false otherwise.
not
Link copied to clipboard
fun not(bool: Boolean)
Logical negation.
fun not(block: Expression.ExpressionBuilder.() -> Unit)
Logical negation.
number
Link copied to clipboard
fun number(block: Expression.ExpressionBuilder.() -> Unit)
Asserts that the input value is a number.
numberFormat
Link copied to clipboard
fun numberFormat(input: Expression, block: Expression.NumberFormatBuilder.() -> Unit)
Converts the input number into a string representation using the providing formatting rules.
fun numberFormat(value: Double, block: Expression.NumberFormatBuilder.() -> Unit)
Converts the input number into a string representation using the providing formatting rules.
objectExpression
Link copied to clipboard
fun objectExpression(block: Expression.ExpressionBuilder.() -> Unit)
Asserts that the input value is an object.
pi
Link copied to clipboard
fun pi()
Returns the mathematical constant pi.
pow
Link copied to clipboard
fun pow(block: Expression.ExpressionBuilder.() -> Unit)
Returns the result of raising the first input to the power specified by the second.
fun pow(first: Double, second: Double)
Returns the result of raising the first input to the power specified by the second.
product
Link copied to clipboard
fun product(vararg double: Double)
Returns the product of the inputs.
fun product(block: Expression.ExpressionBuilder.() -> Unit)
Returns the product of the inputs.
properties
Link copied to clipboard
fun properties()
Gets the feature properties object.
resolvedLocale
Link copied to clipboard
fun resolvedLocale(block: Expression.ExpressionBuilder.() -> Unit)
Returns the IETF language tag of the locale being used by the provided collator.
rgb
Link copied to clipboard
fun rgb(block: Expression.ExpressionBuilder.() -> Unit)
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(red: Double, green: Double, blue: Double)
Add a RGB color expression from numbers to the current expression builder.
rgba
Link copied to clipboard
fun rgba(block: Expression.ExpressionBuilder.() -> Unit)
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(red: Double, green: Double, blue: Double, alpha: Double)
Add a RGBA color expression from numbers to the current expression builder.
round
Link copied to clipboard
fun round(value: Double)
Rounds the input to the nearest integer.
fun round(block: Expression.ExpressionBuilder.() -> Unit)
Rounds the input to the nearest integer.
sin
Link copied to clipboard
fun sin(value: Double)
Returns the sine of the input.
fun sin(block: Expression.ExpressionBuilder.() -> Unit)
Returns the sine of the input.
skyRadialProgress
Link copied to clipboard
fun skyRadialProgress()
Gets the distance of a point on the sky from the sun position.
slice
Link copied to clipboard
fun slice(block: Expression.ExpressionBuilder.() -> Unit)
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.
sqrt
Link copied to clipboard
fun sqrt(value: Double)
Returns the square root of the input.
fun sqrt(block: Expression.ExpressionBuilder.() -> Unit)
Returns the square root of the input.
step
Link copied to clipboard
fun step(block: Expression.ExpressionBuilder.() -> Unit)
Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of input and output values ("stops").
stop
Link copied to clipboard
fun stop(block: Expression.ExpressionBuilder.() -> Unit)
Add a pair of input and output values.
fun stop(key: Double, block: Expression.ExpressionBuilder.() -> Unit)
Add a pair of input and output values.
string
Link copied to clipboard
fun string(block: Expression.ExpressionBuilder.() -> Unit)
Asserts that the input value is a string.
subtract
Link copied to clipboard
fun subtract(value: Double)
Returns the result of subtracting it from 0.
fun subtract(block: Expression.ExpressionBuilder.() -> Unit)
For two inputs, returns the result of subtracting the second input from the first.
fun subtract(first: Double, second: Double)
Returns the result of subtracting the second input from the first.
sum
Link copied to clipboard
fun sum(vararg double: Double)
Returns the sum of the inputs.
fun sum(block: Expression.ExpressionBuilder.() -> Unit)
Returns the sum of the inputs.
switchCase
Link copied to clipboard
fun switchCase(block: Expression.ExpressionBuilder.() -> Unit)
Selects the first output whose corresponding test condition evaluates to true, or the fallback value otherwise.
tan
Link copied to clipboard
fun tan(value: Double)
Returns the tangent of the input.
fun tan(block: Expression.ExpressionBuilder.() -> Unit)
Returns the tangent of the input.
toBoolean
Link copied to clipboard
fun toBoolean(block: Expression.ExpressionBuilder.() -> Unit)
Converts the input value to a boolean.
toColor
Link copied to clipboard
fun toColor(block: Expression.ExpressionBuilder.() -> Unit)
Converts the input value to a color.
toNumber
Link copied to clipboard
fun toNumber(block: Expression.ExpressionBuilder.() -> Unit)
Converts the input value to a number, if possible.
toRgba
Link copied to clipboard
fun toRgba(block: Expression.ExpressionBuilder.() -> Unit)
Returns a four-element array containing the input color's red, green, blue, and alpha components, in that order.
toString
Link copied to clipboard
open fun toString(): String
fun toString(block: Expression.ExpressionBuilder.() -> Unit)
Converts the input value to a string.
typeofExpression
Link copied to clipboard
fun typeofExpression(block: Expression.ExpressionBuilder.() -> Unit)
Returns a string describing the type of the given value.
upcase
Link copied to clipboard
fun upcase(block: Expression.ExpressionBuilder.() -> Unit)
Returns the input string converted to uppercase.
fun upcase(value: String)
Returns the input string converted to uppercase.
varExpression
Link copied to clipboard
fun varExpression(block: Expression.ExpressionBuilder.() -> Unit)
References variable bound using "let".
fun varExpression(value: String)
References variable bound using "let".
within
Link copied to clipboard
fun within(geometry: Geometry)
Returns true if the evaluated feature is fully contained inside a boundary of the input geometry, false otherwise.
zoom
Link copied to clipboard
fun zoom()
Gets the current zoom level.