Class PropertyFactory

java.lang.Object
com.trimblemaps.mapsdk.style.layers.PropertyFactory

public class PropertyFactory extends Object
Constructs paint/layout properties for Layers
  • Constructor Details

    • PropertyFactory

      public PropertyFactory()
  • Method Details

    • visibility

      public static PropertyValue<String> visibility(String value)
      Set the property visibility.
      Parameters:
      value - the visibility value
      Returns:
      property wrapper around visibility
    • fillAntialias

      public static PropertyValue<Boolean> fillAntialias(Boolean value)
      Whether or not the fill should be antialiased.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • fillAntialias

      public static PropertyValue<Expression> fillAntialias(Expression expression)
      Whether or not the fill should be antialiased.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillOpacity

      public static PropertyValue<Float> fillOpacity(Float value)
      The opacity of the entire fill layer. In contrast to the fillColor(int), this value will also affect the 1px stroke around the fill, if the stroke is used.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • fillOpacity

      public static PropertyValue<Expression> fillOpacity(Expression expression)
      The opacity of the entire fill layer. In contrast to the fillColor(int), this value will also affect the 1px stroke around the fill, if the stroke is used.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillColor

      public static PropertyValue<String> fillColor(@ColorInt int value)
      The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • fillColor

      public static PropertyValue<String> fillColor(String value)
      The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • fillColor

      public static PropertyValue<Expression> fillColor(Expression expression)
      The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillOutlineColor

      public static PropertyValue<String> fillOutlineColor(@ColorInt int value)
      The outline color of the fill. Matches the value of fillColor(int) if unspecified.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • fillOutlineColor

      public static PropertyValue<String> fillOutlineColor(String value)
      The outline color of the fill. Matches the value of fillColor(int) if unspecified.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • fillOutlineColor

      public static PropertyValue<Expression> fillOutlineColor(Expression expression)
      The outline color of the fill. Matches the value of fillColor(int) if unspecified.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillTranslate

      public static PropertyValue<Float[]> fillTranslate(Float[] value)
      The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • fillTranslate

      public static PropertyValue<Expression> fillTranslate(Expression expression)
      The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillTranslateAnchor

      public static PropertyValue<String> fillTranslateAnchor(String value)
      Controls the frame of reference for fillTranslate(java.lang.Float[]).
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • fillTranslateAnchor

      public static PropertyValue<Expression> fillTranslateAnchor(Expression expression)
      Controls the frame of reference for fillTranslate(java.lang.Float[]).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillPattern

      public static PropertyValue<String> fillPattern(String value)
      Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • fillPattern

      public static PropertyValue<Expression> fillPattern(Expression expression)
      Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineOpacity

      public static PropertyValue<Float> lineOpacity(Float value)
      The opacity at which the line will be drawn.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineOpacity

      public static PropertyValue<Expression> lineOpacity(Expression expression)
      The opacity at which the line will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineColor

      public static PropertyValue<String> lineColor(@ColorInt int value)
      The color with which the line will be drawn.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • lineColor

      public static PropertyValue<String> lineColor(String value)
      The color with which the line will be drawn.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • lineColor

      public static PropertyValue<Expression> lineColor(Expression expression)
      The color with which the line will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineTranslate

      public static PropertyValue<Float[]> lineTranslate(Float[] value)
      The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • lineTranslate

      public static PropertyValue<Expression> lineTranslate(Expression expression)
      The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineTranslateAnchor

      public static PropertyValue<String> lineTranslateAnchor(String value)
      Controls the frame of reference for lineTranslate(java.lang.Float[]).
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • lineTranslateAnchor

      public static PropertyValue<Expression> lineTranslateAnchor(Expression expression)
      Controls the frame of reference for lineTranslate(java.lang.Float[]).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineWidth

      public static PropertyValue<Float> lineWidth(Float value)
      Stroke thickness.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineWidth

      public static PropertyValue<Expression> lineWidth(Expression expression)
      Stroke thickness.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineGapWidth

      public static PropertyValue<Float> lineGapWidth(Float value)
      Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineGapWidth

      public static PropertyValue<Expression> lineGapWidth(Expression expression)
      Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineOffset

      public static PropertyValue<Float> lineOffset(Float value)
      The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineOffset

      public static PropertyValue<Expression> lineOffset(Expression expression)
      The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineBlur

      public static PropertyValue<Float> lineBlur(Float value)
      Blur applied to the line, in density-independent pixels.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineBlur

      public static PropertyValue<Expression> lineBlur(Expression expression)
      Blur applied to the line, in density-independent pixels.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineDasharray

      public static PropertyValue<Float[]> lineDasharray(Float[] value)
      Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to density-independent pixels, multiply the length by the current line width. Note that GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • lineDasharray

      public static PropertyValue<Expression> lineDasharray(Expression expression)
      Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to density-independent pixels, multiply the length by the current line width. Note that GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • linePattern

      public static PropertyValue<String> linePattern(String value)
      Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • linePattern

      public static PropertyValue<Expression> linePattern(Expression expression)
      Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • lineGradient

      public static PropertyValue<String> lineGradient(@ColorInt int value)
      Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • lineGradient

      public static PropertyValue<String> lineGradient(String value)
      Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • lineGradient

      public static PropertyValue<Expression> lineGradient(Expression expression)
      Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `"lineMetrics": true`.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • iconOpacity

      public static PropertyValue<Float> iconOpacity(Float value)
      The opacity at which the icon will be drawn.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconOpacity

      public static PropertyValue<Expression> iconOpacity(Expression expression)
      The opacity at which the icon will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • iconColor

      public static PropertyValue<String> iconColor(@ColorInt int value)
      The color of the icon. This can only be used with sdf icons.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • iconColor

      public static PropertyValue<String> iconColor(String value)
      The color of the icon. This can only be used with sdf icons.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconColor

      public static PropertyValue<Expression> iconColor(Expression expression)
      The color of the icon. This can only be used with sdf icons.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • iconHaloColor

      public static PropertyValue<String> iconHaloColor(@ColorInt int value)
      The color of the icon's halo. Icon halos can only be used with SDF icons.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • iconHaloColor

      public static PropertyValue<String> iconHaloColor(String value)
      The color of the icon's halo. Icon halos can only be used with SDF icons.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconHaloColor

      public static PropertyValue<Expression> iconHaloColor(Expression expression)
      The color of the icon's halo. Icon halos can only be used with SDF icons.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • iconHaloWidth

      public static PropertyValue<Float> iconHaloWidth(Float value)
      Distance of halo to the icon outline.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconHaloWidth

      public static PropertyValue<Expression> iconHaloWidth(Expression expression)
      Distance of halo to the icon outline.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • iconHaloBlur

      public static PropertyValue<Float> iconHaloBlur(Float value)
      Fade out the halo towards the outside.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconHaloBlur

      public static PropertyValue<Expression> iconHaloBlur(Expression expression)
      Fade out the halo towards the outside.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • iconTranslate

      public static PropertyValue<Float[]> iconTranslate(Float[] value)
      Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • iconTranslate

      public static PropertyValue<Expression> iconTranslate(Expression expression)
      Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • iconTranslateAnchor

      public static PropertyValue<String> iconTranslateAnchor(String value)
      Controls the frame of reference for iconTranslate(java.lang.Float[]).
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconTranslateAnchor

      public static PropertyValue<Expression> iconTranslateAnchor(Expression expression)
      Controls the frame of reference for iconTranslate(java.lang.Float[]).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • textOpacity

      public static PropertyValue<Float> textOpacity(Float value)
      The opacity at which the text will be drawn.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textOpacity

      public static PropertyValue<Expression> textOpacity(Expression expression)
      The opacity at which the text will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • textColor

      public static PropertyValue<String> textColor(@ColorInt int value)
      The color with which the text will be drawn.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • textColor

      public static PropertyValue<String> textColor(String value)
      The color with which the text will be drawn.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textColor

      public static PropertyValue<Expression> textColor(Expression expression)
      The color with which the text will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • textHaloColor

      public static PropertyValue<String> textHaloColor(@ColorInt int value)
      The color of the text's halo, which helps it stand out from backgrounds.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • textHaloColor

      public static PropertyValue<String> textHaloColor(String value)
      The color of the text's halo, which helps it stand out from backgrounds.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textHaloColor

      public static PropertyValue<Expression> textHaloColor(Expression expression)
      The color of the text's halo, which helps it stand out from backgrounds.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • textHaloWidth

      public static PropertyValue<Float> textHaloWidth(Float value)
      Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textHaloWidth

      public static PropertyValue<Expression> textHaloWidth(Expression expression)
      Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • textHaloBlur

      public static PropertyValue<Float> textHaloBlur(Float value)
      The halo's fadeout distance towards the outside.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textHaloBlur

      public static PropertyValue<Expression> textHaloBlur(Expression expression)
      The halo's fadeout distance towards the outside.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • textTranslate

      public static PropertyValue<Float[]> textTranslate(Float[] value)
      Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • textTranslate

      public static PropertyValue<Expression> textTranslate(Expression expression)
      Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • textTranslateAnchor

      public static PropertyValue<String> textTranslateAnchor(String value)
      Controls the frame of reference for textTranslate(java.lang.Float[]).
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textTranslateAnchor

      public static PropertyValue<Expression> textTranslateAnchor(Expression expression)
      Controls the frame of reference for textTranslate(java.lang.Float[]).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleRadius

      public static PropertyValue<Float> circleRadius(Float value)
      Circle radius.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • circleRadius

      public static PropertyValue<Expression> circleRadius(Expression expression)
      Circle radius.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleColor

      public static PropertyValue<String> circleColor(@ColorInt int value)
      The fill color of the circle.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • circleColor

      public static PropertyValue<String> circleColor(String value)
      The fill color of the circle.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • circleColor

      public static PropertyValue<Expression> circleColor(Expression expression)
      The fill color of the circle.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleBlur

      public static PropertyValue<Float> circleBlur(Float value)
      Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • circleBlur

      public static PropertyValue<Expression> circleBlur(Expression expression)
      Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleOpacity

      public static PropertyValue<Float> circleOpacity(Float value)
      The opacity at which the circle will be drawn.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • circleOpacity

      public static PropertyValue<Expression> circleOpacity(Expression expression)
      The opacity at which the circle will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleTranslate

      public static PropertyValue<Float[]> circleTranslate(Float[] value)
      The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • circleTranslate

      public static PropertyValue<Expression> circleTranslate(Expression expression)
      The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleTranslateAnchor

      public static PropertyValue<String> circleTranslateAnchor(String value)
      Controls the frame of reference for circleTranslate(java.lang.Float[]).
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • circleTranslateAnchor

      public static PropertyValue<Expression> circleTranslateAnchor(Expression expression)
      Controls the frame of reference for circleTranslate(java.lang.Float[]).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circlePitchScale

      public static PropertyValue<String> circlePitchScale(String value)
      Controls the scaling behavior of the circle when the map is pitched.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • circlePitchScale

      public static PropertyValue<Expression> circlePitchScale(Expression expression)
      Controls the scaling behavior of the circle when the map is pitched.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circlePitchAlignment

      public static PropertyValue<String> circlePitchAlignment(String value)
      Orientation of circle when map is pitched.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • circlePitchAlignment

      public static PropertyValue<Expression> circlePitchAlignment(Expression expression)
      Orientation of circle when map is pitched.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleStrokeWidth

      public static PropertyValue<Float> circleStrokeWidth(Float value)
      The width of the circle's stroke. Strokes are placed outside of the circleRadius(java.lang.Float).
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • circleStrokeWidth

      public static PropertyValue<Expression> circleStrokeWidth(Expression expression)
      The width of the circle's stroke. Strokes are placed outside of the circleRadius(java.lang.Float).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleStrokeColor

      public static PropertyValue<String> circleStrokeColor(@ColorInt int value)
      The stroke color of the circle.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • circleStrokeColor

      public static PropertyValue<String> circleStrokeColor(String value)
      The stroke color of the circle.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • circleStrokeColor

      public static PropertyValue<Expression> circleStrokeColor(Expression expression)
      The stroke color of the circle.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • circleStrokeOpacity

      public static PropertyValue<Float> circleStrokeOpacity(Float value)
      The opacity of the circle's stroke.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • circleStrokeOpacity

      public static PropertyValue<Expression> circleStrokeOpacity(Expression expression)
      The opacity of the circle's stroke.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • heatmapRadius

      public static PropertyValue<Float> heatmapRadius(Float value)
      Radius of influence of one heatmap point in density-independent pixels. Increasing the value makes the heatmap smoother, but less detailed.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • heatmapRadius

      public static PropertyValue<Expression> heatmapRadius(Expression expression)
      Radius of influence of one heatmap point in density-independent pixels. Increasing the value makes the heatmap smoother, but less detailed.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • heatmapWeight

      public static PropertyValue<Float> heatmapWeight(Float value)
      A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • heatmapWeight

      public static PropertyValue<Expression> heatmapWeight(Expression expression)
      A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • heatmapIntensity

      public static PropertyValue<Float> heatmapIntensity(Float value)
      Similar to heatmapWeight(java.lang.Float) but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • heatmapIntensity

      public static PropertyValue<Expression> heatmapIntensity(Expression expression)
      Similar to heatmapWeight(java.lang.Float) but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • heatmapColor

      public static PropertyValue<String> heatmapColor(@ColorInt int value)
      Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `["heatmap-density"]` as input.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • heatmapColor

      public static PropertyValue<String> heatmapColor(String value)
      Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `["heatmap-density"]` as input.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • heatmapColor

      public static PropertyValue<Expression> heatmapColor(Expression expression)
      Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `["heatmap-density"]` as input.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • heatmapOpacity

      public static PropertyValue<Float> heatmapOpacity(Float value)
      The global opacity at which the heatmap layer will be drawn.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • heatmapOpacity

      public static PropertyValue<Expression> heatmapOpacity(Expression expression)
      The global opacity at which the heatmap layer will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionOpacity

      public static PropertyValue<Float> fillExtrusionOpacity(Float value)
      The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • fillExtrusionOpacity

      public static PropertyValue<Expression> fillExtrusionOpacity(Expression expression)
      The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionColor

      public static PropertyValue<String> fillExtrusionColor(@ColorInt int value)
      The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use fillExtrusionOpacity(java.lang.Float) to set layer opacity.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • fillExtrusionColor

      public static PropertyValue<String> fillExtrusionColor(String value)
      The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use fillExtrusionOpacity(java.lang.Float) to set layer opacity.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • fillExtrusionColor

      public static PropertyValue<Expression> fillExtrusionColor(Expression expression)
      The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use fillExtrusionOpacity(java.lang.Float) to set layer opacity.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionTranslate

      public static PropertyValue<Float[]> fillExtrusionTranslate(Float[] value)
      The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • fillExtrusionTranslate

      public static PropertyValue<Expression> fillExtrusionTranslate(Expression expression)
      The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionTranslateAnchor

      public static PropertyValue<String> fillExtrusionTranslateAnchor(String value)
      Controls the frame of reference for fillExtrusionTranslate(java.lang.Float[]).
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • fillExtrusionTranslateAnchor

      public static PropertyValue<Expression> fillExtrusionTranslateAnchor(Expression expression)
      Controls the frame of reference for fillExtrusionTranslate(java.lang.Float[]).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionPattern

      public static PropertyValue<String> fillExtrusionPattern(String value)
      Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • fillExtrusionPattern

      public static PropertyValue<Expression> fillExtrusionPattern(Expression expression)
      Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionHeight

      public static PropertyValue<Float> fillExtrusionHeight(Float value)
      The height with which to extrude this layer.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • fillExtrusionHeight

      public static PropertyValue<Expression> fillExtrusionHeight(Expression expression)
      The height with which to extrude this layer.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionBase

      public static PropertyValue<Float> fillExtrusionBase(Float value)
      The height with which to extrude the base of this layer. Must be less than or equal to fillExtrusionHeight(java.lang.Float).
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • fillExtrusionBase

      public static PropertyValue<Expression> fillExtrusionBase(Expression expression)
      The height with which to extrude the base of this layer. Must be less than or equal to fillExtrusionHeight(java.lang.Float).
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillExtrusionVerticalGradient

      public static PropertyValue<Boolean> fillExtrusionVerticalGradient(Boolean value)
      Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • fillExtrusionVerticalGradient

      public static PropertyValue<Expression> fillExtrusionVerticalGradient(Expression expression)
      Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterOpacity

      public static PropertyValue<Float> rasterOpacity(Float value)
      The opacity at which the image will be drawn.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • rasterOpacity

      public static PropertyValue<Expression> rasterOpacity(Expression expression)
      The opacity at which the image will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterHueRotate

      public static PropertyValue<Float> rasterHueRotate(Float value)
      Rotates hues around the color wheel.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • rasterHueRotate

      public static PropertyValue<Expression> rasterHueRotate(Expression expression)
      Rotates hues around the color wheel.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterBrightnessMin

      public static PropertyValue<Float> rasterBrightnessMin(Float value)
      Increase or reduce the brightness of the image. The value is the minimum brightness.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • rasterBrightnessMin

      public static PropertyValue<Expression> rasterBrightnessMin(Expression expression)
      Increase or reduce the brightness of the image. The value is the minimum brightness.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterBrightnessMax

      public static PropertyValue<Float> rasterBrightnessMax(Float value)
      Increase or reduce the brightness of the image. The value is the maximum brightness.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • rasterBrightnessMax

      public static PropertyValue<Expression> rasterBrightnessMax(Expression expression)
      Increase or reduce the brightness of the image. The value is the maximum brightness.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterSaturation

      public static PropertyValue<Float> rasterSaturation(Float value)
      Increase or reduce the saturation of the image.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • rasterSaturation

      public static PropertyValue<Expression> rasterSaturation(Expression expression)
      Increase or reduce the saturation of the image.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterContrast

      public static PropertyValue<Float> rasterContrast(Float value)
      Increase or reduce the contrast of the image.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • rasterContrast

      public static PropertyValue<Expression> rasterContrast(Expression expression)
      Increase or reduce the contrast of the image.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterResampling

      public static PropertyValue<String> rasterResampling(String value)
      The resampling/interpolation method to use for overscaling, also known as texture magnification filter
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • rasterResampling

      public static PropertyValue<Expression> rasterResampling(Expression expression)
      The resampling/interpolation method to use for overscaling, also known as texture magnification filter
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • rasterFadeDuration

      public static PropertyValue<Float> rasterFadeDuration(Float value)
      Fade duration when a new tile is added.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • rasterFadeDuration

      public static PropertyValue<Expression> rasterFadeDuration(Expression expression)
      Fade duration when a new tile is added.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • hillshadeIlluminationDirection

      public static PropertyValue<Float> hillshadeIlluminationDirection(Float value)
      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`.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • hillshadeIlluminationDirection

      public static PropertyValue<Expression> hillshadeIlluminationDirection(Expression expression)
      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`.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • hillshadeIlluminationAnchor

      public static PropertyValue<String> hillshadeIlluminationAnchor(String value)
      Direction of light source when map is rotated.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • hillshadeIlluminationAnchor

      public static PropertyValue<Expression> hillshadeIlluminationAnchor(Expression expression)
      Direction of light source when map is rotated.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • hillshadeExaggeration

      public static PropertyValue<Float> hillshadeExaggeration(Float value)
      Intensity of the hillshade
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • hillshadeExaggeration

      public static PropertyValue<Expression> hillshadeExaggeration(Expression expression)
      Intensity of the hillshade
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • hillshadeShadowColor

      public static PropertyValue<String> hillshadeShadowColor(@ColorInt int value)
      The shading color of areas that face away from the light source.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • hillshadeShadowColor

      public static PropertyValue<String> hillshadeShadowColor(String value)
      The shading color of areas that face away from the light source.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • hillshadeShadowColor

      public static PropertyValue<Expression> hillshadeShadowColor(Expression expression)
      The shading color of areas that face away from the light source.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • hillshadeHighlightColor

      public static PropertyValue<String> hillshadeHighlightColor(@ColorInt int value)
      The shading color of areas that faces towards the light source.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • hillshadeHighlightColor

      public static PropertyValue<String> hillshadeHighlightColor(String value)
      The shading color of areas that faces towards the light source.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • hillshadeHighlightColor

      public static PropertyValue<Expression> hillshadeHighlightColor(Expression expression)
      The shading color of areas that faces towards the light source.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • hillshadeAccentColor

      public static PropertyValue<String> hillshadeAccentColor(@ColorInt int value)
      The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • hillshadeAccentColor

      public static PropertyValue<String> hillshadeAccentColor(String value)
      The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • hillshadeAccentColor

      public static PropertyValue<Expression> hillshadeAccentColor(Expression expression)
      The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • backgroundColor

      public static PropertyValue<String> backgroundColor(@ColorInt int value)
      The color with which the background will be drawn.
      Parameters:
      value - a int color value
      Returns:
      property wrapper around String color
    • backgroundColor

      public static PropertyValue<String> backgroundColor(String value)
      The color with which the background will be drawn.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • backgroundColor

      public static PropertyValue<Expression> backgroundColor(Expression expression)
      The color with which the background will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • backgroundPattern

      public static PropertyValue<String> backgroundPattern(String value)
      Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • backgroundPattern

      public static PropertyValue<Expression> backgroundPattern(Expression expression)
      Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • backgroundOpacity

      public static PropertyValue<Float> backgroundOpacity(Float value)
      The opacity at which the background will be drawn.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • backgroundOpacity

      public static PropertyValue<Expression> backgroundOpacity(Expression expression)
      The opacity at which the background will be drawn.
      Parameters:
      expression - an expression statement
      Returns:
      property wrapper around an expression statement
    • fillSortKey

      public static PropertyValue<Float> fillSortKey(Float value)
      Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • fillSortKey

      public static PropertyValue<Expression> fillSortKey(Expression value)
      Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineCap

      public static PropertyValue<String> lineCap(String value)
      The display of line endings.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • lineCap

      public static PropertyValue<Expression> lineCap(Expression value)
      The display of line endings.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • lineJoin

      public static PropertyValue<String> lineJoin(String value)
      The display of lines when joining.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • lineJoin

      public static PropertyValue<Expression> lineJoin(Expression value)
      The display of lines when joining.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • lineMiterLimit

      public static PropertyValue<Float> lineMiterLimit(Float value)
      Used to automatically convert miter joins to bevel joins for sharp angles.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineMiterLimit

      public static PropertyValue<Expression> lineMiterLimit(Expression value)
      Used to automatically convert miter joins to bevel joins for sharp angles.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineRoundLimit

      public static PropertyValue<Float> lineRoundLimit(Float value)
      Used to automatically convert round joins to miter joins for shallow angles.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineRoundLimit

      public static PropertyValue<Expression> lineRoundLimit(Expression value)
      Used to automatically convert round joins to miter joins for shallow angles.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineSortKey

      public static PropertyValue<Float> lineSortKey(Float value)
      Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • lineSortKey

      public static PropertyValue<Expression> lineSortKey(Expression value)
      Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • symbolPlacement

      public static PropertyValue<String> symbolPlacement(String value)
      Label placement relative to its geometry.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • symbolPlacement

      public static PropertyValue<Expression> symbolPlacement(Expression value)
      Label placement relative to its geometry.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • symbolSpacing

      public static PropertyValue<Float> symbolSpacing(Float value)
      Distance between two symbol anchors.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • symbolSpacing

      public static PropertyValue<Expression> symbolSpacing(Expression value)
      Distance between two symbol anchors.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • symbolAvoidEdges

      public static PropertyValue<Boolean> symbolAvoidEdges(Boolean value)
      If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • symbolAvoidEdges

      public static PropertyValue<Expression> symbolAvoidEdges(Expression value)
      If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • symbolSortKey

      public static PropertyValue<Float> symbolSortKey(Float value)
      Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When iconAllowOverlap(java.lang.Boolean) or textAllowOverlap(java.lang.Boolean) is `false`, features with a lower sort key will have priority during placement. When iconAllowOverlap(java.lang.Boolean) or textAllowOverlap(java.lang.Boolean) is set to `true`, features with a higher sort key will overlap over features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • symbolSortKey

      public static PropertyValue<Expression> symbolSortKey(Expression value)
      Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When iconAllowOverlap(java.lang.Boolean) or textAllowOverlap(java.lang.Boolean) is `false`, features with a lower sort key will have priority during placement. When iconAllowOverlap(java.lang.Boolean) or textAllowOverlap(java.lang.Boolean) is set to `true`, features with a higher sort key will overlap over features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • symbolZOrder

      public static PropertyValue<String> symbolZOrder(String value)
      Controls the order in which overlapping symbols in the same layer are rendered
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • symbolZOrder

      public static PropertyValue<Expression> symbolZOrder(Expression value)
      Controls the order in which overlapping symbols in the same layer are rendered
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconAllowOverlap

      public static PropertyValue<Boolean> iconAllowOverlap(Boolean value)
      If true, the icon will be visible even if it collides with other previously drawn symbols.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconAllowOverlap

      public static PropertyValue<Expression> iconAllowOverlap(Expression value)
      If true, the icon will be visible even if it collides with other previously drawn symbols.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconIgnorePlacement

      public static PropertyValue<Boolean> iconIgnorePlacement(Boolean value)
      If true, other symbols can be visible even if they collide with the icon.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconIgnorePlacement

      public static PropertyValue<Expression> iconIgnorePlacement(Expression value)
      If true, other symbols can be visible even if they collide with the icon.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconOptional

      public static PropertyValue<Boolean> iconOptional(Boolean value)
      If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconOptional

      public static PropertyValue<Expression> iconOptional(Expression value)
      If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconRotationAlignment

      public static PropertyValue<String> iconRotationAlignment(String value)
      In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of icons.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconRotationAlignment

      public static PropertyValue<Expression> iconRotationAlignment(Expression value)
      In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of icons.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconSize

      public static PropertyValue<Float> iconSize(Float value)
      Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by iconSize(java.lang.Float). 1 is the original size; 3 triples the size of the image.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconSize

      public static PropertyValue<Expression> iconSize(Expression value)
      Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by iconSize(java.lang.Float). 1 is the original size; 3 triples the size of the image.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconTextFit

      public static PropertyValue<String> iconTextFit(String value)
      Scales the icon to fit around the associated text.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconTextFit

      public static PropertyValue<Expression> iconTextFit(Expression value)
      Scales the icon to fit around the associated text.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconTextFitPadding

      public static PropertyValue<Float[]> iconTextFitPadding(Float[] value)
      Size of the additional area added to dimensions determined by Property.ICON_TEXT_FIT, in clockwise order: top, right, bottom, left.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • iconTextFitPadding

      public static PropertyValue<Expression> iconTextFitPadding(Expression value)
      Size of the additional area added to dimensions determined by Property.ICON_TEXT_FIT, in clockwise order: top, right, bottom, left.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • iconImage

      public static PropertyValue<String> iconImage(String value)
      Name of image in sprite to use for drawing an image background.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconImage

      public static PropertyValue<Expression> iconImage(Expression value)
      Name of image in sprite to use for drawing an image background.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconRotate

      public static PropertyValue<Float> iconRotate(Float value)
      Rotates the icon clockwise.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconRotate

      public static PropertyValue<Expression> iconRotate(Expression value)
      Rotates the icon clockwise.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconPadding

      public static PropertyValue<Float> iconPadding(Float value)
      Size of the additional area around the icon bounding box used for detecting symbol collisions.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconPadding

      public static PropertyValue<Expression> iconPadding(Expression value)
      Size of the additional area around the icon bounding box used for detecting symbol collisions.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • iconKeepUpright

      public static PropertyValue<Boolean> iconKeepUpright(Boolean value)
      If true, the icon may be flipped to prevent it from being rendered upside-down.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconKeepUpright

      public static PropertyValue<Expression> iconKeepUpright(Expression value)
      If true, the icon may be flipped to prevent it from being rendered upside-down.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • iconOffset

      public static PropertyValue<Float[]> iconOffset(Float[] value)
      Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of iconSize(java.lang.Float) to obtain the final offset in density-independent pixels. When combined with iconRotate(java.lang.Float) the offset will be as if the rotated direction was up.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • iconOffset

      public static PropertyValue<Expression> iconOffset(Expression value)
      Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of iconSize(java.lang.Float) to obtain the final offset in density-independent pixels. When combined with iconRotate(java.lang.Float) the offset will be as if the rotated direction was up.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • iconAnchor

      public static PropertyValue<String> iconAnchor(String value)
      Part of the icon placed closest to the anchor.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconAnchor

      public static PropertyValue<Expression> iconAnchor(Expression value)
      Part of the icon placed closest to the anchor.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconPitchAlignment

      public static PropertyValue<String> iconPitchAlignment(String value)
      Orientation of icon when map is pitched.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • iconPitchAlignment

      public static PropertyValue<Expression> iconPitchAlignment(Expression value)
      Orientation of icon when map is pitched.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textPitchAlignment

      public static PropertyValue<String> textPitchAlignment(String value)
      Orientation of text when map is pitched.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textPitchAlignment

      public static PropertyValue<Expression> textPitchAlignment(Expression value)
      Orientation of text when map is pitched.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textRotationAlignment

      public static PropertyValue<String> textRotationAlignment(String value)
      In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of the individual glyphs forming the text.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textRotationAlignment

      public static PropertyValue<Expression> textRotationAlignment(Expression value)
      In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of the individual glyphs forming the text.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textField

      public static PropertyValue<String> textField(String value)
      Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textField

      public static PropertyValue<com.trimblemaps.mapsdk.style.types.Formatted> textField(com.trimblemaps.mapsdk.style.types.Formatted value)
      Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.
      Parameters:
      value - a Formatted value
      Returns:
      property wrapper around Formatted
    • textField

      public static PropertyValue<Expression> textField(Expression value)
      Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.
      Parameters:
      value - a Formatted value
      Returns:
      property wrapper around Formatted
    • textFont

      public static PropertyValue<String[]> textFont(String[] value)
      Font stack to use for displaying text.
      Parameters:
      value - a String[] value
      Returns:
      property wrapper around String[]
    • textFont

      public static PropertyValue<Expression> textFont(Expression value)
      Font stack to use for displaying text.
      Parameters:
      value - a String[] value
      Returns:
      property wrapper around String[]
    • textSize

      public static PropertyValue<Float> textSize(Float value)
      Font size.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textSize

      public static PropertyValue<Expression> textSize(Expression value)
      Font size.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textMaxWidth

      public static PropertyValue<Float> textMaxWidth(Float value)
      The maximum line width for text wrapping.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textMaxWidth

      public static PropertyValue<Expression> textMaxWidth(Expression value)
      The maximum line width for text wrapping.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textLineHeight

      public static PropertyValue<Float> textLineHeight(Float value)
      Text leading value for multi-line text.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textLineHeight

      public static PropertyValue<Expression> textLineHeight(Expression value)
      Text leading value for multi-line text.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textLetterSpacing

      public static PropertyValue<Float> textLetterSpacing(Float value)
      Text tracking amount.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textLetterSpacing

      public static PropertyValue<Expression> textLetterSpacing(Expression value)
      Text tracking amount.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textJustify

      public static PropertyValue<String> textJustify(String value)
      Text justification options.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textJustify

      public static PropertyValue<Expression> textJustify(Expression value)
      Text justification options.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textRadialOffset

      public static PropertyValue<Float> textRadialOffset(Float value)
      Radial offset of text, in the direction of the symbol's anchor. Useful in combination with textVariableAnchor(java.lang.String[]), which defaults to using the two-dimensional textOffset(java.lang.Float[]) if present.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textRadialOffset

      public static PropertyValue<Expression> textRadialOffset(Expression value)
      Radial offset of text, in the direction of the symbol's anchor. Useful in combination with textVariableAnchor(java.lang.String[]), which defaults to using the two-dimensional textOffset(java.lang.Float[]) if present.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textVariableAnchor

      public static PropertyValue<String[]> textVariableAnchor(String[] value)
      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. Use `text-justify: auto` to choose justification based on anchor position. To apply an offset, use the textRadialOffset(java.lang.Float) or the two-dimensional textOffset(java.lang.Float[]).
      Parameters:
      value - a String[] value
      Returns:
      property wrapper around String[]
    • textVariableAnchor

      public static PropertyValue<Expression> textVariableAnchor(Expression value)
      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. Use `text-justify: auto` to choose justification based on anchor position. To apply an offset, use the textRadialOffset(java.lang.Float) or the two-dimensional textOffset(java.lang.Float[]).
      Parameters:
      value - a String[] value
      Returns:
      property wrapper around String[]
    • textAnchor

      public static PropertyValue<String> textAnchor(String value)
      Part of the text placed closest to the anchor.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textAnchor

      public static PropertyValue<Expression> textAnchor(Expression value)
      Part of the text placed closest to the anchor.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textMaxAngle

      public static PropertyValue<Float> textMaxAngle(Float value)
      Maximum angle change between adjacent characters.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textMaxAngle

      public static PropertyValue<Expression> textMaxAngle(Expression value)
      Maximum angle change between adjacent characters.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textWritingMode

      public static PropertyValue<String[]> textWritingMode(String[] value)
      The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.
      Parameters:
      value - a String[] value
      Returns:
      property wrapper around String[]
    • textWritingMode

      public static PropertyValue<Expression> textWritingMode(Expression value)
      The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.
      Parameters:
      value - a String[] value
      Returns:
      property wrapper around String[]
    • textRotate

      public static PropertyValue<Float> textRotate(Float value)
      Rotates the text clockwise.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textRotate

      public static PropertyValue<Expression> textRotate(Expression value)
      Rotates the text clockwise.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textPadding

      public static PropertyValue<Float> textPadding(Float value)
      Size of the additional area around the text bounding box used for detecting symbol collisions.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textPadding

      public static PropertyValue<Expression> textPadding(Expression value)
      Size of the additional area around the text bounding box used for detecting symbol collisions.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • textKeepUpright

      public static PropertyValue<Boolean> textKeepUpright(Boolean value)
      If true, the text may be flipped vertically to prevent it from being rendered upside-down.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • textKeepUpright

      public static PropertyValue<Expression> textKeepUpright(Expression value)
      If true, the text may be flipped vertically to prevent it from being rendered upside-down.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • textTransform

      public static PropertyValue<String> textTransform(String value)
      Specifies how to capitalize text, similar to the CSS textTransform(java.lang.String) property.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textTransform

      public static PropertyValue<Expression> textTransform(Expression value)
      Specifies how to capitalize text, similar to the CSS textTransform(java.lang.String) property.
      Parameters:
      value - a String value
      Returns:
      property wrapper around String
    • textOffset

      public static PropertyValue<Float[]> textOffset(Float[] value)
      Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • textOffset

      public static PropertyValue<Expression> textOffset(Expression value)
      Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.
      Parameters:
      value - a Float[] value
      Returns:
      property wrapper around Float[]
    • textAllowOverlap

      public static PropertyValue<Boolean> textAllowOverlap(Boolean value)
      If true, the text will be visible even if it collides with other previously drawn symbols.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • textAllowOverlap

      public static PropertyValue<Expression> textAllowOverlap(Expression value)
      If true, the text will be visible even if it collides with other previously drawn symbols.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • textIgnorePlacement

      public static PropertyValue<Boolean> textIgnorePlacement(Boolean value)
      If true, other symbols can be visible even if they collide with the text.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • textIgnorePlacement

      public static PropertyValue<Expression> textIgnorePlacement(Expression value)
      If true, other symbols can be visible even if they collide with the text.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • textOptional

      public static PropertyValue<Boolean> textOptional(Boolean value)
      If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • textOptional

      public static PropertyValue<Expression> textOptional(Expression value)
      If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
      Parameters:
      value - a Boolean value
      Returns:
      property wrapper around Boolean
    • circleSortKey

      public static PropertyValue<Float> circleSortKey(Float value)
      Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float
    • circleSortKey

      public static PropertyValue<Expression> circleSortKey(Expression value)
      Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
      Parameters:
      value - a Float value
      Returns:
      property wrapper around Float