PropertyFactory

open class PropertyFactory

Constructs paint/layout properties for Layers

See also

<a href="https://maplibre.org/maplibre-style-spec/#layers">Layer style documentation</a>

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
The color with which the background will be drawn.
Link copied to clipboard
The opacity at which the background will be drawn.
Link copied to clipboard
Name of image in sprite to use for drawing an image background.
Link copied to clipboard
open fun circleBlur(value: Float): PropertyValue<Float>
Amount to blur the circle.
Link copied to clipboard
The fill color of the circle.
Link copied to clipboard
The opacity at which the circle will be drawn.
Link copied to clipboard
Orientation of circle when map is pitched.
Link copied to clipboard
Controls the scaling behavior of the circle when the map is pitched.
Link copied to clipboard
Circle radius.
Link copied to clipboard
Sorts features in ascending order based on this value.
Link copied to clipboard
The stroke color of the circle.
Link copied to clipboard
The opacity of the circle's stroke.
Link copied to clipboard
The width of the circle's stroke.
Link copied to clipboard
The geometry's offset.
Link copied to clipboard
Controls the frame of reference for circleTranslate.
Link copied to clipboard
Whether or not the fill should be antialiased.
Link copied to clipboard
The color of the filled part of this layer.
Link copied to clipboard
The height with which to extrude the base of this layer.
Link copied to clipboard
The base color of the extruded fill.
Link copied to clipboard
The height with which to extrude this layer.
Link copied to clipboard
The opacity of the entire fill extrusion layer.
Link copied to clipboard
Name of image in sprite to use for drawing images on extruded fills.
Link copied to clipboard
The geometry's offset.
Link copied to clipboard
Controls the frame of reference for fillExtrusionTranslate.
Link copied to clipboard
Whether to apply a vertical gradient to the sides of a fill-extrusion layer.
Link copied to clipboard
The opacity of the entire fill layer.
Link copied to clipboard
The outline color of the fill.
Link copied to clipboard
Name of image in sprite to use for drawing image fills.
Link copied to clipboard
Sorts features in ascending order based on this value.
Link copied to clipboard
The geometry's offset.
Link copied to clipboard
Controls the frame of reference for fillTranslate.
Link copied to clipboard
Defines the color of each pixel based on its density value in a heatmap.
Link copied to clipboard
Similar to heatmapWeight but controls the intensity of the heatmap globally.
Link copied to clipboard
The global opacity at which the heatmap layer will be drawn.
Link copied to clipboard
Radius of influence of one heatmap point in density-independent pixels.
Link copied to clipboard
A measure of how much an individual point contributes to the heatmap.
Link copied to clipboard
The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
Link copied to clipboard
Intensity of the hillshade
Link copied to clipboard
The shading color of areas that faces towards the light source.
Link copied to clipboard
Direction of light source when map is rotated.
Link copied to clipboard
The direction of the light source used to generate the hillshading with 0 as the top of the viewport if Property.HILLSHADE_ILLUMINATION_ANCHOR is set to `viewport` and due north if Property.HILLSHADE_ILLUMINATION_ANCHOR is set to `map`.
Link copied to clipboard
The shading color of areas that face away from the light source.
Link copied to clipboard
If true, the icon will be visible even if it collides with other previously drawn symbols.
Link copied to clipboard
Part of the icon placed closest to the anchor.
Link copied to clipboard
The color of the icon.
Link copied to clipboard
Fade out the halo towards the outside.
Link copied to clipboard
The color of the icon's halo.
Link copied to clipboard
Distance of halo to the icon outline.
Link copied to clipboard
If true, other symbols can be visible even if they collide with the icon.
Link copied to clipboard
Name of image in sprite to use for drawing an image background.
Link copied to clipboard
If true, the icon may be flipped to prevent it from being rendered upside-down.
Link copied to clipboard
Offset distance of icon from its anchor.
Link copied to clipboard
The opacity at which the icon will be drawn.
Link copied to clipboard
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
Link copied to clipboard
Size of additional area round the icon bounding box used for detecting symbol collisions.
Link copied to clipboard
Orientation of icon when map is pitched.
Link copied to clipboard
open fun iconRotate(value: Float): PropertyValue<Float>
Rotates the icon clockwise.
Link copied to clipboard
In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of icons.
Link copied to clipboard
open fun iconSize(value: Float): PropertyValue<Float>
Scales the original size of the icon by the provided factor.
Link copied to clipboard
Scales the icon to fit around the associated text.
Link copied to clipboard
Size of the additional area added to dimensions determined by Property.ICON_TEXT_FIT, in clockwise order: top, right, bottom, left.
Link copied to clipboard
Distance that the icon's anchor is moved from its original placement.
Link copied to clipboard
Controls the frame of reference for iconTranslate.
Link copied to clipboard
open fun lineBlur(value: Float): PropertyValue<Float>
Blur applied to the line, in density-independent pixels.
Link copied to clipboard
open fun lineCap(value: String): PropertyValue<String>
The display of line endings.
Link copied to clipboard
The color with which the line will be drawn.
Link copied to clipboard
Specifies the lengths of the alternating dashes and gaps that form the dash pattern.
Link copied to clipboard
Draws a line casing outside of a line's actual path.
Link copied to clipboard
Defines a gradient with which to color a line feature.
Link copied to clipboard
open fun lineJoin(value: String): PropertyValue<String>
The display of lines when joining.
Link copied to clipboard
Used to automatically convert miter joins to bevel joins for sharp angles.
Link copied to clipboard
open fun lineOffset(value: Float): PropertyValue<Float>
The line's offset.
Link copied to clipboard
The opacity at which the line will be drawn.
Link copied to clipboard
Name of image in sprite to use for drawing image lines.
Link copied to clipboard
Used to automatically convert round joins to miter joins for shallow angles.
Link copied to clipboard
Sorts features in ascending order based on this value.
Link copied to clipboard
The geometry's offset.
Link copied to clipboard
Controls the frame of reference for lineTranslate.
Link copied to clipboard
open fun lineWidth(value: Float): PropertyValue<Float>
Stroke thickness.
Link copied to clipboard
Increase or reduce the brightness of the image.
Link copied to clipboard
Increase or reduce the brightness of the image.
Link copied to clipboard
Increase or reduce the contrast of the image.
Link copied to clipboard
Fade duration when a new tile is added, or when a video is started or its coordinates are updated.
Link copied to clipboard
Rotates hues around the color wheel.
Link copied to clipboard
The opacity at which the image will be drawn.
Link copied to clipboard
The resampling/interpolation method to use for overscaling, also known as texture magnification filter
Link copied to clipboard
Increase or reduce the saturation of the image.
Link copied to clipboard
If true, the symbols will not cross tile edges to avoid mutual collisions.
Link copied to clipboard
Label placement relative to its geometry.
Link copied to clipboard
Sorts features in ascending order based on this value.
Link copied to clipboard
Distance between two symbol anchors.
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.
Link copied to clipboard
If true, the text will be visible even if it collides with other previously drawn symbols.
Link copied to clipboard
Part of the text placed closest to the anchor.
Link copied to clipboard
The color with which the text will be drawn.
Link copied to clipboard
Value to use for a text label.
Link copied to clipboard
Font stack to use for displaying text.
Link copied to clipboard
The halo's fadeout distance towards the outside.
Link copied to clipboard
The color of the text's halo, which helps it stand out from backgrounds.
Link copied to clipboard
Distance of halo to the font outline.
Link copied to clipboard
If true, other symbols can be visible even if they collide with the text.
Link copied to clipboard
Text justification options.
Link copied to clipboard
If true, the text may be flipped vertically to prevent it from being rendered upside-down.
Link copied to clipboard
Text tracking amount.
Link copied to clipboard
Text leading value for multi-line text.
Link copied to clipboard
Maximum angle change between adjacent characters.
Link copied to clipboard
The maximum line width for text wrapping.
Link copied to clipboard
Offset distance of text from its anchor.
Link copied to clipboard
The opacity at which the text will be drawn.
Link copied to clipboard
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
Link copied to clipboard
Size of the additional area around the text bounding box used for detecting symbol collisions.
Link copied to clipboard
Orientation of text when map is pitched.
Link copied to clipboard
Radial offset of text, in the direction of the symbol's anchor.
Link copied to clipboard
open fun textRotate(value: Float): PropertyValue<Float>
Rotates the text clockwise.
Link copied to clipboard
In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of the individual glyphs forming the text.
Link copied to clipboard
open fun textSize(value: Float): PropertyValue<Float>
Font size.
Link copied to clipboard
Specifies how to capitalize text, similar to the CSS textTransform property.
Link copied to clipboard
Distance that the text's anchor is moved from its original placement.
Link copied to clipboard
Controls the frame of reference for textTranslate.
Link copied to clipboard
To increase the chance of placing high-priority labels on the map, you can provide an array of Property.TEXT_ANCHOR locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label.
Link copied to clipboard
To increase the chance of placing high-priority labels on the map, you can provide an array of Property.TEXT_ANCHOR locations, each paired with an offset value.
Link copied to clipboard
The property allows control over a symbol's orientation.
Link copied to clipboard
Set the property visibility.