Package-level declarations

The interfaces and enums defining the type system for MapLibre expressions.

Types

Link copied to clipboard

Represents an ExpressionValue that resolves to a list value (corresponds to a JSON array) of alternating types.

Link copied to clipboard

Represents an ExpressionValue that resolves to a true or false value. See const.

Link copied to clipboard

Orientation of circles when the map is pitched.

Link copied to clipboard

Scaling behavior of circles when the map is pitched.

Link copied to clipboard
sealed interface CollatorValue : ExpressionValue

Represents an ExpressionValue that resolves to a collator object for use in locale-dependent comparison operations. See collator.

Link copied to clipboard

Represents an ExpressionValue that resolves to a Color value. See const.

Link copied to clipboard
sealed interface ComparableValue<T> : ExpressionValue

Union type for an Expression that resolves to a value that can be ordered with other values of its type. See gt, lt, gte, and lte.

Link copied to clipboard

Represents an ExpressionValue that resolves to a 2D floating point offset in device-independent pixels (DpOffset). See offset.

Link copied to clipboard
sealed interface DpPaddingValue : VectorValue<Dp>

Represents an ExpressionValue that resolves to an absolute (layout direction unaware) padding applied along the edges inside a box (PaddingValues.Absolute). See const.

Link copied to clipboard
typealias DpValue = NumberValue<Dp>

Represents an ExpressionValue that resolves to device-independent pixels (Dp). See const.

Link copied to clipboard
sealed interface EnumValue<out T> : StringValue

Represents an ExpressionValue that resolves to an enum string. See const.

Link copied to clipboard
sealed interface EquatableValue : ExpressionValue

Represents an Expression that resolves to a value that can be compared for equality. See eq and neq.

Link copied to clipboard

The type of value resolved from an expression, as returned by type.

Link copied to clipboard
sealed interface ExpressionValue

Represents a value that an Expression can resolve to. Many of these types are never actually instantiated at runtime; they're only used as type parameters to hint at the type of an Expression.

Link copied to clipboard

Represents an ExpressionValue that resolves to a 2D floating point offset without a particular unit. (Offset). See offset.

Link copied to clipboard

Represents an ExpressionValue that resolves to a dimensionless quantity. See const.

Link copied to clipboard

Represents and Expression that resolves to a value that can be an input to format.

Link copied to clipboard
sealed interface FormattedValue : ExpressionValue

Represents an ExpressionValue that resolves to a formatted string. See format.

Link copied to clipboard
sealed interface GeoJsonValue : ExpressionValue

Represents an ExpressionValue that resolves to a geometry object.

Link copied to clipboard

Type of a GeoJson feature, as returned by Feature.type.

Link copied to clipboard

Orientation of icon when map is pitched.

Link copied to clipboard

In combination with SymbolPlacement, determines the rotation behavior of icons.

Link copied to clipboard

Scales the icon to fit around the associated text.

Link copied to clipboard

Direction of light source when map is rotated.

Link copied to clipboard

Represents an ExpressionValue that resolves to an image. See image

Link copied to clipboard

Union type for an Expression that resolves to a value that can be interpolated. See interpolate.

Link copied to clipboard

Represents an ExpressionValue that resolves to an interpolation type. See linear, exponential, and cubicBezier.

Link copied to clipboard
sealed interface IntValue : NumberValue<Number>

Represents an ExpressionValue that resolves to an integer dimensionless quantity. See const.

Link copied to clipboard

Display of line endings

Link copied to clipboard

Display of joined lines

Link copied to clipboard
sealed interface ListValue<out T : ExpressionValue> : ExpressionValue

Represents an ExpressionValue that resolves to a list value (corresponds to a JSON array). See const.

Link copied to clipboard
sealed interface MapValue<out T : ExpressionValue> : ExpressionValue

Represents an ExpressionValue that resolves to a map value (corresponds to a JSON object). See const.

Link copied to clipboard
sealed interface MatchableValue : ExpressionValue

Union type for an Expression that resolves to a value that can be matched. See switch.

Link copied to clipboard

Represents an ExpressionValue that resolves to an amount of time with millisecond precision (Duration). See const.

Link copied to clipboard

Represents an ExpressionValue that resolves to a numeric quantity. Corresponds to numbers in the JSON style spec. Use const to create a literal NumberValue.

Link copied to clipboard
sealed interface OffsetValue<U> : VectorValue<U>

Represents an ExpressionValue that reoslves to a 2D vector in some unit.

Link copied to clipboard

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

Link copied to clipboard
Link copied to clipboard

Part of the icon/text placed closest to the anchor.

Link copied to clipboard

Controls whether to show an icon/text when it overlaps other symbols on the map.

Link copied to clipboard

Symbol placement relative to its geometry.

Link copied to clipboard

Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use sortKey.

Link copied to clipboard

Text justification options.

Link copied to clipboard

Orientation of text when map is pitched.

Link copied to clipboard

In combination with SymbolPlacement, determines the rotation behavior of the individual glyphs forming the text.

Link copied to clipboard

Specifies how to capitalize text, similar to the CSS text-transform property.

Link copied to clipboard

Represents an ExpressionValue that resolves to a 2D floating point offset in scalable pixels or em (TextUnit). See offset.

Link copied to clipboard

Represents an ExpressionValue that resolves to scalable pixels or em (TextUnit). See const.

Link copied to clipboard
Link copied to clipboard

How the text will be laid out.

Link copied to clipboard

Frame of reference for offsetting geometry.

Link copied to clipboard

Represents an ExpressionValue that resolves to a list of numbers.