On this page

Type Alias FillExtrusionLayerSpecification

type FillExtrusionLayerSpecification = {
    filter?: FilterSpecification;
    id: string;
    layout?: { visibility?: VisibilitySpecification };
    maxzoom?: number;
    metadata?: unknown;
    minzoom?: number;
    paint?: {
        "fill-extrusion-base"?: DataDrivenPropertyValueSpecification<number>;
        "fill-extrusion-base-transition"?: TransitionSpecification;
        "fill-extrusion-color"?: DataDrivenPropertyValueSpecification<
            ColorSpecification,
        >;
        "fill-extrusion-color-transition"?: TransitionSpecification;
        "fill-extrusion-height"?: DataDrivenPropertyValueSpecification<number>;
        "fill-extrusion-height-transition"?: TransitionSpecification;
        "fill-extrusion-opacity"?: PropertyValueSpecification<number>;
        "fill-extrusion-opacity-transition"?: TransitionSpecification;
        "fill-extrusion-pattern"?: DataDrivenPropertyValueSpecification<
            ResolvedImageSpecification,
        >;
        "fill-extrusion-pattern-transition"?: TransitionSpecification;
        "fill-extrusion-translate"?: PropertyValueSpecification<[number, number]>;
        "fill-extrusion-translate-anchor"?: PropertyValueSpecification<
            "map"
            | "viewport",
        >;
        "fill-extrusion-translate-transition"?: TransitionSpecification;
        "fill-extrusion-vertical-gradient"?: PropertyValueSpecification<boolean>;
    };
    source: string;
    "source-layer"?: string;
    type: "fill-extrusion";
}
Index

Properties

A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions.

id: string

Unique layer name.

layout?: { visibility?: VisibilitySpecification }

Layout properties for the layer.

Type Declaration

maxzoom?: number

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

metadata?: unknown

Arbitrary properties useful to track with the layer, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'maplibre:'.

{"source:comment": "Hydrology FCCODE 460 - Narrow wash"}
minzoom?: number

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

paint?: {
    "fill-extrusion-base"?: DataDrivenPropertyValueSpecification<number>;
    "fill-extrusion-base-transition"?: TransitionSpecification;
    "fill-extrusion-color"?: DataDrivenPropertyValueSpecification<
        ColorSpecification,
    >;
    "fill-extrusion-color-transition"?: TransitionSpecification;
    "fill-extrusion-height"?: DataDrivenPropertyValueSpecification<number>;
    "fill-extrusion-height-transition"?: TransitionSpecification;
    "fill-extrusion-opacity"?: PropertyValueSpecification<number>;
    "fill-extrusion-opacity-transition"?: TransitionSpecification;
    "fill-extrusion-pattern"?: DataDrivenPropertyValueSpecification<
        ResolvedImageSpecification,
    >;
    "fill-extrusion-pattern-transition"?: TransitionSpecification;
    "fill-extrusion-translate"?: PropertyValueSpecification<[number, number]>;
    "fill-extrusion-translate-anchor"?: PropertyValueSpecification<
        "map"
        | "viewport",
    >;
    "fill-extrusion-translate-transition"?: TransitionSpecification;
    "fill-extrusion-vertical-gradient"?: PropertyValueSpecification<boolean>;
}

Default paint properties for this layer.

Type Declaration

  • Optionalfill-extrusion-base?: DataDrivenPropertyValueSpecification<number>

    The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height.

  • Optionalfill-extrusion-base-transition?: TransitionSpecification
  • Optionalfill-extrusion-color?: DataDrivenPropertyValueSpecification<ColorSpecification>

    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 fill-extrusion-opacity to set layer opacity.

    "#000000"
    
  • Optionalfill-extrusion-color-transition?: TransitionSpecification
  • Optionalfill-extrusion-height?: DataDrivenPropertyValueSpecification<number>

    The height with which to extrude this layer.

  • Optionalfill-extrusion-height-transition?: TransitionSpecification
  • Optionalfill-extrusion-opacity?: PropertyValueSpecification<number>

    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.

    1
    
  • Optionalfill-extrusion-opacity-transition?: TransitionSpecification
  • Optionalfill-extrusion-pattern?: DataDrivenPropertyValueSpecification<ResolvedImageSpecification>

    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.

  • Optionalfill-extrusion-pattern-transition?: TransitionSpecification
  • Optionalfill-extrusion-translate?: PropertyValueSpecification<[number, number]>

    The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.

    [0, 0]
    
  • Optionalfill-extrusion-translate-anchor?: PropertyValueSpecification<"map" | "viewport">

    Controls the frame of reference for fill-extrusion-translate.

    "map"
    
  • Optionalfill-extrusion-translate-transition?: TransitionSpecification
  • Optionalfill-extrusion-vertical-gradient?: PropertyValueSpecification<boolean>

    Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.

    true
    
source: string

Name of a source description to be used for this layer. Required for all layer types except background.

"source-layer"?: string

Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

type: "fill-extrusion"
Was this helpful?
SDK JS
Reference
FillExtrusionLayerSpecification