Interface MapLayer

interface MapLayer {
    filter?: FilterSpecification;
    id: string;
    layout?:
        | {
            line-cap?: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">;
            line-join?: DataDrivenPropertyValueSpecification<
                | "none"
                | "round"
                | "bevel"
                | "miter">;
            line-miter-limit?: PropertyValueSpecification<number>;
            line-round-limit?: PropertyValueSpecification<number>;
            line-sort-key?: DataDrivenPropertyValueSpecification<number>;
            line-z-offset?: DataDrivenPropertyValueSpecification<number>;
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            icon-allow-overlap?: PropertyValueSpecification<boolean>;
            icon-anchor?: DataDrivenPropertyValueSpecification<
                | "top-left"
                | "top"
                | "top-right"
                | "right"
                | "bottom-right"
                | "bottom"
                | "bottom-left"
                | "left"
                | "center">;
            icon-ignore-placement?: PropertyValueSpecification<boolean>;
            icon-image?: DataDrivenPropertyValueSpecification<string>;
            icon-keep-upright?: PropertyValueSpecification<boolean>;
            icon-offset?: DataDrivenPropertyValueSpecification<[number, number]>;
            icon-optional?: PropertyValueSpecification<boolean>;
            icon-padding?: PropertyValueSpecification<number>;
            icon-pitch-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
            icon-rotate?: DataDrivenPropertyValueSpecification<number>;
            icon-rotation-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
            icon-size?: DataDrivenPropertyValueSpecification<number>;
            icon-text-fit?: DataDrivenPropertyValueSpecification<
                | "width"
                | "height"
                | "none"
                | "both">;
            icon-text-fit-padding?: DataDrivenPropertyValueSpecification<[number, number, number, number]>;
            symbol-avoid-edges?: PropertyValueSpecification<boolean>;
            symbol-placement?: PropertyValueSpecification<"line" | "point" | "line-center">;
            symbol-sort-key?: DataDrivenPropertyValueSpecification<number>;
            symbol-spacing?: PropertyValueSpecification<number>;
            symbol-z-elevate?: PropertyValueSpecification<boolean>;
            symbol-z-order?: PropertyValueSpecification<"source" | "auto" | "viewport-y">;
            text-allow-overlap?: PropertyValueSpecification<boolean>;
            text-anchor?: DataDrivenPropertyValueSpecification<
                | "top-left"
                | "top"
                | "top-right"
                | "right"
                | "bottom-right"
                | "bottom"
                | "bottom-left"
                | "left"
                | "center">;
            text-field?: DataDrivenPropertyValueSpecification<string>;
            text-font?: DataDrivenPropertyValueSpecification<string[]>;
            text-ignore-placement?: PropertyValueSpecification<boolean>;
            text-justify?: DataDrivenPropertyValueSpecification<
                | "right"
                | "left"
                | "center"
                | "auto">;
            text-keep-upright?: PropertyValueSpecification<boolean>;
            text-letter-spacing?: DataDrivenPropertyValueSpecification<number>;
            text-line-height?: DataDrivenPropertyValueSpecification<number>;
            text-max-angle?: PropertyValueSpecification<number>;
            text-max-width?: DataDrivenPropertyValueSpecification<number>;
            text-offset?: DataDrivenPropertyValueSpecification<[number, number]>;
            text-optional?: PropertyValueSpecification<boolean>;
            text-padding?: PropertyValueSpecification<number>;
            text-pitch-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
            text-radial-offset?: DataDrivenPropertyValueSpecification<number>;
            text-rotate?: DataDrivenPropertyValueSpecification<number>;
            text-rotation-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
            text-size?: DataDrivenPropertyValueSpecification<number>;
            text-transform?: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">;
            text-variable-anchor?: PropertyValueSpecification<(
                | "top-left"
                | "top"
                | "top-right"
                | "right"
                | "bottom-right"
                | "bottom"
                | "bottom-left"
                | "left"
                | "center")[]>;
            text-writing-mode?: PropertyValueSpecification<("horizontal" | "vertical")[]>;
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            fill-sort-key?: DataDrivenPropertyValueSpecification<number>;
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            circle-sort-key?: DataDrivenPropertyValueSpecification<number>;
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            fill-extrusion-edge-radius?: ExpressionSpecification;
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            model-id?: DataDrivenPropertyValueSpecification<string>;
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            visibility?: ExpressionSpecification | "visible" | "none";
        }
        | {
            clip-layer-scope?: ExpressionSpecification;
            clip-layer-types?: ExpressionSpecification;
        };
    maxzoom?: number;
    metadata?: unknown;
    minzoom?: number;
    paint?:
        | {
            fill-antialias?: PropertyValueSpecification<boolean>;
            fill-color?: DataDrivenPropertyValueSpecification<string>;
            fill-color-transition?: TransitionSpecification;
            fill-emissive-strength?: PropertyValueSpecification<number>;
            fill-emissive-strength-transition?: TransitionSpecification;
            fill-opacity?: DataDrivenPropertyValueSpecification<number>;
            fill-opacity-transition?: TransitionSpecification;
            fill-outline-color?: DataDrivenPropertyValueSpecification<string>;
            fill-outline-color-transition?: TransitionSpecification;
            fill-pattern?: DataDrivenPropertyValueSpecification<string>;
            fill-translate?: PropertyValueSpecification<[number, number]>;
            fill-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
            fill-translate-transition?: TransitionSpecification;
            fill-z-offset?: DataDrivenPropertyValueSpecification<number>;
            fill-z-offset-transition?: TransitionSpecification;
        }
        | {
            line-blur?: DataDrivenPropertyValueSpecification<number>;
            line-blur-transition?: TransitionSpecification;
            line-border-color?: DataDrivenPropertyValueSpecification<string>;
            line-border-color-transition?: TransitionSpecification;
            line-border-width?: DataDrivenPropertyValueSpecification<number>;
            line-border-width-transition?: TransitionSpecification;
            line-color?: DataDrivenPropertyValueSpecification<string>;
            line-color-transition?: TransitionSpecification;
            line-dasharray?: DataDrivenPropertyValueSpecification<number[]>;
            line-emissive-strength?: PropertyValueSpecification<number>;
            line-emissive-strength-transition?: TransitionSpecification;
            line-gap-width?: DataDrivenPropertyValueSpecification<number>;
            line-gap-width-transition?: TransitionSpecification;
            line-gradient?: ExpressionSpecification;
            line-occlusion-opacity?: PropertyValueSpecification<number>;
            line-occlusion-opacity-transition?: TransitionSpecification;
            line-offset?: DataDrivenPropertyValueSpecification<number>;
            line-offset-transition?: TransitionSpecification;
            line-opacity?: DataDrivenPropertyValueSpecification<number>;
            line-opacity-transition?: TransitionSpecification;
            line-pattern?: DataDrivenPropertyValueSpecification<string>;
            line-translate?: PropertyValueSpecification<[number, number]>;
            line-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
            line-translate-transition?: TransitionSpecification;
            line-trim-color?: PropertyValueSpecification<string>;
            line-trim-color-transition?: TransitionSpecification;
            line-trim-fade-range?: PropertyValueSpecification<[number, number]>;
            line-trim-offset?: [number, number];
            line-width?: DataDrivenPropertyValueSpecification<number>;
            line-width-transition?: TransitionSpecification;
        }
        | {
            icon-color?: DataDrivenPropertyValueSpecification<string>;
            icon-color-brightness-max?: ExpressionSpecification;
            icon-color-brightness-min?: ExpressionSpecification;
            icon-color-contrast?: ExpressionSpecification;
            icon-color-saturation?: ExpressionSpecification;
            icon-color-transition?: TransitionSpecification;
            icon-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
            icon-emissive-strength-transition?: TransitionSpecification;
            icon-halo-blur?: DataDrivenPropertyValueSpecification<number>;
            icon-halo-blur-transition?: TransitionSpecification;
            icon-halo-color?: DataDrivenPropertyValueSpecification<string>;
            icon-halo-color-transition?: TransitionSpecification;
            icon-halo-width?: DataDrivenPropertyValueSpecification<number>;
            icon-halo-width-transition?: TransitionSpecification;
            icon-image-cross-fade?: DataDrivenPropertyValueSpecification<number>;
            icon-image-cross-fade-transition?: TransitionSpecification;
            icon-occlusion-opacity?: DataDrivenPropertyValueSpecification<number>;
            icon-occlusion-opacity-transition?: TransitionSpecification;
            icon-opacity?: DataDrivenPropertyValueSpecification<number>;
            icon-opacity-transition?: TransitionSpecification;
            icon-translate?: PropertyValueSpecification<[number, number]>;
            icon-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
            icon-translate-transition?: TransitionSpecification;
            symbol-elevation-reference?: PropertyValueSpecification<"sea" | "ground">;
            symbol-z-offset?: DataDrivenPropertyValueSpecification<number>;
            symbol-z-offset-transition?: TransitionSpecification;
            text-color?: DataDrivenPropertyValueSpecification<string>;
            text-color-transition?: TransitionSpecification;
            text-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
            text-emissive-strength-transition?: TransitionSpecification;
            text-halo-blur?: DataDrivenPropertyValueSpecification<number>;
            text-halo-blur-transition?: TransitionSpecification;
            text-halo-color?: DataDrivenPropertyValueSpecification<string>;
            text-halo-color-transition?: TransitionSpecification;
            text-halo-width?: DataDrivenPropertyValueSpecification<number>;
            text-halo-width-transition?: TransitionSpecification;
            text-occlusion-opacity?: DataDrivenPropertyValueSpecification<number>;
            text-occlusion-opacity-transition?: TransitionSpecification;
            text-opacity?: DataDrivenPropertyValueSpecification<number>;
            text-opacity-transition?: TransitionSpecification;
            text-translate?: PropertyValueSpecification<[number, number]>;
            text-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
            text-translate-transition?: TransitionSpecification;
        }
        | {
            circle-blur?: DataDrivenPropertyValueSpecification<number>;
            circle-blur-transition?: TransitionSpecification;
            circle-color?: DataDrivenPropertyValueSpecification<string>;
            circle-color-transition?: TransitionSpecification;
            circle-emissive-strength?: PropertyValueSpecification<number>;
            circle-emissive-strength-transition?: TransitionSpecification;
            circle-opacity?: DataDrivenPropertyValueSpecification<number>;
            circle-opacity-transition?: TransitionSpecification;
            circle-pitch-alignment?: PropertyValueSpecification<"map" | "viewport">;
            circle-pitch-scale?: PropertyValueSpecification<"map" | "viewport">;
            circle-radius?: DataDrivenPropertyValueSpecification<number>;
            circle-radius-transition?: TransitionSpecification;
            circle-stroke-color?: DataDrivenPropertyValueSpecification<string>;
            circle-stroke-color-transition?: TransitionSpecification;
            circle-stroke-opacity?: DataDrivenPropertyValueSpecification<number>;
            circle-stroke-opacity-transition?: TransitionSpecification;
            circle-stroke-width?: DataDrivenPropertyValueSpecification<number>;
            circle-stroke-width-transition?: TransitionSpecification;
            circle-translate?: PropertyValueSpecification<[number, number]>;
            circle-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
            circle-translate-transition?: TransitionSpecification;
        }
        | {
            heatmap-color?: ExpressionSpecification;
            heatmap-intensity?: PropertyValueSpecification<number>;
            heatmap-intensity-transition?: TransitionSpecification;
            heatmap-opacity?: PropertyValueSpecification<number>;
            heatmap-opacity-transition?: TransitionSpecification;
            heatmap-radius?: DataDrivenPropertyValueSpecification<number>;
            heatmap-radius-transition?: TransitionSpecification;
            heatmap-weight?: DataDrivenPropertyValueSpecification<number>;
        }
        | {
            fill-extrusion-ambient-occlusion-ground-attenuation?: PropertyValueSpecification<number>;
            fill-extrusion-ambient-occlusion-ground-attenuation-transition?: TransitionSpecification;
            fill-extrusion-ambient-occlusion-ground-radius?: PropertyValueSpecification<number>;
            fill-extrusion-ambient-occlusion-ground-radius-transition?: TransitionSpecification;
            fill-extrusion-ambient-occlusion-intensity?: PropertyValueSpecification<number>;
            fill-extrusion-ambient-occlusion-intensity-transition?: TransitionSpecification;
            fill-extrusion-ambient-occlusion-radius?: PropertyValueSpecification<number>;
            fill-extrusion-ambient-occlusion-radius-transition?: TransitionSpecification;
            fill-extrusion-ambient-occlusion-wall-radius?: PropertyValueSpecification<number>;
            fill-extrusion-ambient-occlusion-wall-radius-transition?: TransitionSpecification;
            fill-extrusion-base?: DataDrivenPropertyValueSpecification<number>;
            fill-extrusion-base-transition?: TransitionSpecification;
            fill-extrusion-cast-shadows?: boolean;
            fill-extrusion-color?: DataDrivenPropertyValueSpecification<string>;
            fill-extrusion-color-transition?: TransitionSpecification;
            fill-extrusion-cutoff-fade-range?: ExpressionSpecification;
            fill-extrusion-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
            fill-extrusion-emissive-strength-transition?: TransitionSpecification;
            fill-extrusion-flood-light-color?: PropertyValueSpecification<string>;
            fill-extrusion-flood-light-color-transition?: TransitionSpecification;
            fill-extrusion-flood-light-ground-attenuation?: PropertyValueSpecification<number>;
            fill-extrusion-flood-light-ground-attenuation-transition?: TransitionSpecification;
            fill-extrusion-flood-light-ground-radius?: DataDrivenPropertyValueSpecification<number>;
            fill-extrusion-flood-light-ground-radius-transition?: TransitionSpecification;
            fill-extrusion-flood-light-intensity?: PropertyValueSpecification<number>;
            fill-extrusion-flood-light-intensity-transition?: TransitionSpecification;
            fill-extrusion-flood-light-wall-radius?: DataDrivenPropertyValueSpecification<number>;
            fill-extrusion-flood-light-wall-radius-transition?: TransitionSpecification;
            fill-extrusion-height?: DataDrivenPropertyValueSpecification<number>;
            fill-extrusion-height-transition?: TransitionSpecification;
            fill-extrusion-line-width?: DataDrivenPropertyValueSpecification<number>;
            fill-extrusion-line-width-transition?: TransitionSpecification;
            fill-extrusion-opacity?: PropertyValueSpecification<number>;
            fill-extrusion-opacity-transition?: TransitionSpecification;
            fill-extrusion-pattern?: DataDrivenPropertyValueSpecification<string>;
            fill-extrusion-rounded-roof?: PropertyValueSpecification<boolean>;
            fill-extrusion-translate?: PropertyValueSpecification<[number, number]>;
            fill-extrusion-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
            fill-extrusion-translate-transition?: TransitionSpecification;
            fill-extrusion-vertical-gradient?: PropertyValueSpecification<boolean>;
            fill-extrusion-vertical-scale?: PropertyValueSpecification<number>;
            fill-extrusion-vertical-scale-transition?: TransitionSpecification;
        }
        | {
            raster-array-band?: string;
            raster-brightness-max?: PropertyValueSpecification<number>;
            raster-brightness-max-transition?: TransitionSpecification;
            raster-brightness-min?: PropertyValueSpecification<number>;
            raster-brightness-min-transition?: TransitionSpecification;
            raster-color?: ExpressionSpecification;
            raster-color-mix?: PropertyValueSpecification<[number, number, number, number]>;
            raster-color-mix-transition?: TransitionSpecification;
            raster-color-range?: PropertyValueSpecification<[number, number]>;
            raster-color-range-transition?: TransitionSpecification;
            raster-contrast?: PropertyValueSpecification<number>;
            raster-contrast-transition?: TransitionSpecification;
            raster-elevation?: PropertyValueSpecification<number>;
            raster-elevation-transition?: TransitionSpecification;
            raster-emissive-strength?: PropertyValueSpecification<number>;
            raster-emissive-strength-transition?: TransitionSpecification;
            raster-fade-duration?: PropertyValueSpecification<number>;
            raster-hue-rotate?: PropertyValueSpecification<number>;
            raster-hue-rotate-transition?: TransitionSpecification;
            raster-opacity?: PropertyValueSpecification<number>;
            raster-opacity-transition?: TransitionSpecification;
            raster-resampling?: PropertyValueSpecification<"linear" | "nearest">;
            raster-saturation?: PropertyValueSpecification<number>;
            raster-saturation-transition?: TransitionSpecification;
        }
        | {
            raster-particle-array-band?: string;
            raster-particle-color?: ExpressionSpecification;
            raster-particle-count?: number;
            raster-particle-elevation?: PropertyValueSpecification<number>;
            raster-particle-elevation-transition?: TransitionSpecification;
            raster-particle-fade-opacity-factor?: PropertyValueSpecification<number>;
            raster-particle-fade-opacity-factor-transition?: TransitionSpecification;
            raster-particle-max-speed?: number;
            raster-particle-reset-rate-factor?: number;
            raster-particle-speed-factor?: PropertyValueSpecification<number>;
            raster-particle-speed-factor-transition?: TransitionSpecification;
        }
        | {
            hillshade-accent-color?: PropertyValueSpecification<string>;
            hillshade-accent-color-transition?: TransitionSpecification;
            hillshade-emissive-strength?: PropertyValueSpecification<number>;
            hillshade-emissive-strength-transition?: TransitionSpecification;
            hillshade-exaggeration?: PropertyValueSpecification<number>;
            hillshade-exaggeration-transition?: TransitionSpecification;
            hillshade-highlight-color?: PropertyValueSpecification<string>;
            hillshade-highlight-color-transition?: TransitionSpecification;
            hillshade-illumination-anchor?: PropertyValueSpecification<"map" | "viewport">;
            hillshade-illumination-direction?: PropertyValueSpecification<number>;
            hillshade-shadow-color?: PropertyValueSpecification<string>;
            hillshade-shadow-color-transition?: TransitionSpecification;
        }
        | {
            model-ambient-occlusion-intensity?: PropertyValueSpecification<number>;
            model-ambient-occlusion-intensity-transition?: TransitionSpecification;
            model-cast-shadows?: boolean;
            model-color?: DataDrivenPropertyValueSpecification<string>;
            model-color-mix-intensity?: DataDrivenPropertyValueSpecification<number>;
            model-color-mix-intensity-transition?: TransitionSpecification;
            model-color-transition?: TransitionSpecification;
            model-cutoff-fade-range?: ExpressionSpecification;
            model-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
            model-emissive-strength-transition?: TransitionSpecification;
            model-front-cutoff?: PropertyValueSpecification<[number, number, number]>;
            model-height-based-emissive-strength-multiplier?: DataDrivenPropertyValueSpecification<[number, number, number, number, number]>;
            model-height-based-emissive-strength-multiplier-transition?: TransitionSpecification;
            model-opacity?: PropertyValueSpecification<number>;
            model-opacity-transition?: TransitionSpecification;
            model-receive-shadows?: boolean;
            model-rotation?: DataDrivenPropertyValueSpecification<[number, number, number]>;
            model-rotation-transition?: TransitionSpecification;
            model-roughness?: DataDrivenPropertyValueSpecification<number>;
            model-roughness-transition?: TransitionSpecification;
            model-scale?: DataDrivenPropertyValueSpecification<[number, number, number]>;
            model-scale-transition?: TransitionSpecification;
            model-translation?: DataDrivenPropertyValueSpecification<[number, number, number]>;
            model-translation-transition?: TransitionSpecification;
            model-type?: "common-3d" | "location-indicator";
        }
        | {
            background-color?: PropertyValueSpecification<string>;
            background-color-transition?: TransitionSpecification;
            background-emissive-strength?: PropertyValueSpecification<number>;
            background-emissive-strength-transition?: TransitionSpecification;
            background-opacity?: PropertyValueSpecification<number>;
            background-opacity-transition?: TransitionSpecification;
            background-pattern?: PropertyValueSpecification<string>;
            background-pitch-alignment?: "map" | ExpressionSpecification | "viewport";
        }
        | {
            sky-atmosphere-color?: string;
            sky-atmosphere-halo-color?: string;
            sky-atmosphere-sun?: PropertyValueSpecification<[number, number]>;
            sky-atmosphere-sun-intensity?: number;
            sky-gradient?: ExpressionSpecification;
            sky-gradient-center?: PropertyValueSpecification<[number, number]>;
            sky-gradient-radius?: PropertyValueSpecification<number>;
            sky-opacity?: PropertyValueSpecification<number>;
            sky-opacity-transition?: TransitionSpecification;
            sky-type?: PropertyValueSpecification<"gradient" | "atmosphere">;
        };
    slot?: string;
    source?: string;
    source-layer?: string;
    type:
        | "symbol"
        | "fill"
        | "slot"
        | "line"
        | "circle"
        | "heatmap"
        | "fill-extrusion"
        | "raster"
        | "raster-particle"
        | "hillshade"
        | "model"
        | "background"
        | "sky"
        | "clip";
    update: ((map: Map$1, show?: boolean) => void);
}

Hierarchy

  • Layer
    • MapLayer

Properties

filter? id layout? maxzoom? metadata? minzoom? paint? slot? source? source-layer? type update

Properties

Optionalfilter

filter?: FilterSpecification

id

id: string

Optionallayout

layout?:
    | {
        line-cap?: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">;
        line-join?: DataDrivenPropertyValueSpecification<
            | "none"
            | "round"
            | "bevel"
            | "miter">;
        line-miter-limit?: PropertyValueSpecification<number>;
        line-round-limit?: PropertyValueSpecification<number>;
        line-sort-key?: DataDrivenPropertyValueSpecification<number>;
        line-z-offset?: DataDrivenPropertyValueSpecification<number>;
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        icon-allow-overlap?: PropertyValueSpecification<boolean>;
        icon-anchor?: DataDrivenPropertyValueSpecification<
            | "top-left"
            | "top"
            | "top-right"
            | "right"
            | "bottom-right"
            | "bottom"
            | "bottom-left"
            | "left"
            | "center">;
        icon-ignore-placement?: PropertyValueSpecification<boolean>;
        icon-image?: DataDrivenPropertyValueSpecification<string>;
        icon-keep-upright?: PropertyValueSpecification<boolean>;
        icon-offset?: DataDrivenPropertyValueSpecification<[number, number]>;
        icon-optional?: PropertyValueSpecification<boolean>;
        icon-padding?: PropertyValueSpecification<number>;
        icon-pitch-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
        icon-rotate?: DataDrivenPropertyValueSpecification<number>;
        icon-rotation-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
        icon-size?: DataDrivenPropertyValueSpecification<number>;
        icon-text-fit?: DataDrivenPropertyValueSpecification<
            | "width"
            | "height"
            | "none"
            | "both">;
        icon-text-fit-padding?: DataDrivenPropertyValueSpecification<[number, number, number, number]>;
        symbol-avoid-edges?: PropertyValueSpecification<boolean>;
        symbol-placement?: PropertyValueSpecification<"line" | "point" | "line-center">;
        symbol-sort-key?: DataDrivenPropertyValueSpecification<number>;
        symbol-spacing?: PropertyValueSpecification<number>;
        symbol-z-elevate?: PropertyValueSpecification<boolean>;
        symbol-z-order?: PropertyValueSpecification<"source" | "auto" | "viewport-y">;
        text-allow-overlap?: PropertyValueSpecification<boolean>;
        text-anchor?: DataDrivenPropertyValueSpecification<
            | "top-left"
            | "top"
            | "top-right"
            | "right"
            | "bottom-right"
            | "bottom"
            | "bottom-left"
            | "left"
            | "center">;
        text-field?: DataDrivenPropertyValueSpecification<string>;
        text-font?: DataDrivenPropertyValueSpecification<string[]>;
        text-ignore-placement?: PropertyValueSpecification<boolean>;
        text-justify?: DataDrivenPropertyValueSpecification<
            | "right"
            | "left"
            | "center"
            | "auto">;
        text-keep-upright?: PropertyValueSpecification<boolean>;
        text-letter-spacing?: DataDrivenPropertyValueSpecification<number>;
        text-line-height?: DataDrivenPropertyValueSpecification<number>;
        text-max-angle?: PropertyValueSpecification<number>;
        text-max-width?: DataDrivenPropertyValueSpecification<number>;
        text-offset?: DataDrivenPropertyValueSpecification<[number, number]>;
        text-optional?: PropertyValueSpecification<boolean>;
        text-padding?: PropertyValueSpecification<number>;
        text-pitch-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
        text-radial-offset?: DataDrivenPropertyValueSpecification<number>;
        text-rotate?: DataDrivenPropertyValueSpecification<number>;
        text-rotation-alignment?: PropertyValueSpecification<"map" | "viewport" | "auto">;
        text-size?: DataDrivenPropertyValueSpecification<number>;
        text-transform?: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">;
        text-variable-anchor?: PropertyValueSpecification<(
            | "top-left"
            | "top"
            | "top-right"
            | "right"
            | "bottom-right"
            | "bottom"
            | "bottom-left"
            | "left"
            | "center")[]>;
        text-writing-mode?: PropertyValueSpecification<("horizontal" | "vertical")[]>;
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        fill-sort-key?: DataDrivenPropertyValueSpecification<number>;
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        circle-sort-key?: DataDrivenPropertyValueSpecification<number>;
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        fill-extrusion-edge-radius?: ExpressionSpecification;
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        model-id?: DataDrivenPropertyValueSpecification<string>;
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        visibility?: ExpressionSpecification | "visible" | "none";
    }
    | {
        clip-layer-scope?: ExpressionSpecification;
        clip-layer-types?: ExpressionSpecification;
    }

Type declaration

  • Optionalline-cap?: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">
  • Optionalline-join?: DataDrivenPropertyValueSpecification<
        | "none"
        | "round"
        | "bevel"
        | "miter">
  • Optionalline-miter-limit?: PropertyValueSpecification<number>
  • Optionalline-round-limit?: PropertyValueSpecification<number>
  • Optionalline-sort-key?: DataDrivenPropertyValueSpecification<number>
  • Optional Experimentalline-z-offset?: DataDrivenPropertyValueSpecification<number>

    This property is experimental and subject to change in future versions.

  • Optionalvisibility?: ExpressionSpecification | "visible" | "none"

Type declaration

  • Optional Experimentalfill-extrusion-edge-radius?: ExpressionSpecification

    This property is experimental and subject to change in future versions.

  • Optionalvisibility?: ExpressionSpecification | "visible" | "none"

Type declaration

  • Optional Experimentalclip-layer-scope?: ExpressionSpecification

    This property is experimental and subject to change in future versions.

  • Optional Experimentalclip-layer-types?: ExpressionSpecification

    This property is experimental and subject to change in future versions.

Optionalmaxzoom

maxzoom?: number

Optionalmetadata

metadata?: unknown

Optionalminzoom

minzoom?: number

Optionalpaint

paint?:
    | {
        fill-antialias?: PropertyValueSpecification<boolean>;
        fill-color?: DataDrivenPropertyValueSpecification<string>;
        fill-color-transition?: TransitionSpecification;
        fill-emissive-strength?: PropertyValueSpecification<number>;
        fill-emissive-strength-transition?: TransitionSpecification;
        fill-opacity?: DataDrivenPropertyValueSpecification<number>;
        fill-opacity-transition?: TransitionSpecification;
        fill-outline-color?: DataDrivenPropertyValueSpecification<string>;
        fill-outline-color-transition?: TransitionSpecification;
        fill-pattern?: DataDrivenPropertyValueSpecification<string>;
        fill-translate?: PropertyValueSpecification<[number, number]>;
        fill-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
        fill-translate-transition?: TransitionSpecification;
        fill-z-offset?: DataDrivenPropertyValueSpecification<number>;
        fill-z-offset-transition?: TransitionSpecification;
    }
    | {
        line-blur?: DataDrivenPropertyValueSpecification<number>;
        line-blur-transition?: TransitionSpecification;
        line-border-color?: DataDrivenPropertyValueSpecification<string>;
        line-border-color-transition?: TransitionSpecification;
        line-border-width?: DataDrivenPropertyValueSpecification<number>;
        line-border-width-transition?: TransitionSpecification;
        line-color?: DataDrivenPropertyValueSpecification<string>;
        line-color-transition?: TransitionSpecification;
        line-dasharray?: DataDrivenPropertyValueSpecification<number[]>;
        line-emissive-strength?: PropertyValueSpecification<number>;
        line-emissive-strength-transition?: TransitionSpecification;
        line-gap-width?: DataDrivenPropertyValueSpecification<number>;
        line-gap-width-transition?: TransitionSpecification;
        line-gradient?: ExpressionSpecification;
        line-occlusion-opacity?: PropertyValueSpecification<number>;
        line-occlusion-opacity-transition?: TransitionSpecification;
        line-offset?: DataDrivenPropertyValueSpecification<number>;
        line-offset-transition?: TransitionSpecification;
        line-opacity?: DataDrivenPropertyValueSpecification<number>;
        line-opacity-transition?: TransitionSpecification;
        line-pattern?: DataDrivenPropertyValueSpecification<string>;
        line-translate?: PropertyValueSpecification<[number, number]>;
        line-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
        line-translate-transition?: TransitionSpecification;
        line-trim-color?: PropertyValueSpecification<string>;
        line-trim-color-transition?: TransitionSpecification;
        line-trim-fade-range?: PropertyValueSpecification<[number, number]>;
        line-trim-offset?: [number, number];
        line-width?: DataDrivenPropertyValueSpecification<number>;
        line-width-transition?: TransitionSpecification;
    }
    | {
        icon-color?: DataDrivenPropertyValueSpecification<string>;
        icon-color-brightness-max?: ExpressionSpecification;
        icon-color-brightness-min?: ExpressionSpecification;
        icon-color-contrast?: ExpressionSpecification;
        icon-color-saturation?: ExpressionSpecification;
        icon-color-transition?: TransitionSpecification;
        icon-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
        icon-emissive-strength-transition?: TransitionSpecification;
        icon-halo-blur?: DataDrivenPropertyValueSpecification<number>;
        icon-halo-blur-transition?: TransitionSpecification;
        icon-halo-color?: DataDrivenPropertyValueSpecification<string>;
        icon-halo-color-transition?: TransitionSpecification;
        icon-halo-width?: DataDrivenPropertyValueSpecification<number>;
        icon-halo-width-transition?: TransitionSpecification;
        icon-image-cross-fade?: DataDrivenPropertyValueSpecification<number>;
        icon-image-cross-fade-transition?: TransitionSpecification;
        icon-occlusion-opacity?: DataDrivenPropertyValueSpecification<number>;
        icon-occlusion-opacity-transition?: TransitionSpecification;
        icon-opacity?: DataDrivenPropertyValueSpecification<number>;
        icon-opacity-transition?: TransitionSpecification;
        icon-translate?: PropertyValueSpecification<[number, number]>;
        icon-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
        icon-translate-transition?: TransitionSpecification;
        symbol-elevation-reference?: PropertyValueSpecification<"sea" | "ground">;
        symbol-z-offset?: DataDrivenPropertyValueSpecification<number>;
        symbol-z-offset-transition?: TransitionSpecification;
        text-color?: DataDrivenPropertyValueSpecification<string>;
        text-color-transition?: TransitionSpecification;
        text-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
        text-emissive-strength-transition?: TransitionSpecification;
        text-halo-blur?: DataDrivenPropertyValueSpecification<number>;
        text-halo-blur-transition?: TransitionSpecification;
        text-halo-color?: DataDrivenPropertyValueSpecification<string>;
        text-halo-color-transition?: TransitionSpecification;
        text-halo-width?: DataDrivenPropertyValueSpecification<number>;
        text-halo-width-transition?: TransitionSpecification;
        text-occlusion-opacity?: DataDrivenPropertyValueSpecification<number>;
        text-occlusion-opacity-transition?: TransitionSpecification;
        text-opacity?: DataDrivenPropertyValueSpecification<number>;
        text-opacity-transition?: TransitionSpecification;
        text-translate?: PropertyValueSpecification<[number, number]>;
        text-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
        text-translate-transition?: TransitionSpecification;
    }
    | {
        circle-blur?: DataDrivenPropertyValueSpecification<number>;
        circle-blur-transition?: TransitionSpecification;
        circle-color?: DataDrivenPropertyValueSpecification<string>;
        circle-color-transition?: TransitionSpecification;
        circle-emissive-strength?: PropertyValueSpecification<number>;
        circle-emissive-strength-transition?: TransitionSpecification;
        circle-opacity?: DataDrivenPropertyValueSpecification<number>;
        circle-opacity-transition?: TransitionSpecification;
        circle-pitch-alignment?: PropertyValueSpecification<"map" | "viewport">;
        circle-pitch-scale?: PropertyValueSpecification<"map" | "viewport">;
        circle-radius?: DataDrivenPropertyValueSpecification<number>;
        circle-radius-transition?: TransitionSpecification;
        circle-stroke-color?: DataDrivenPropertyValueSpecification<string>;
        circle-stroke-color-transition?: TransitionSpecification;
        circle-stroke-opacity?: DataDrivenPropertyValueSpecification<number>;
        circle-stroke-opacity-transition?: TransitionSpecification;
        circle-stroke-width?: DataDrivenPropertyValueSpecification<number>;
        circle-stroke-width-transition?: TransitionSpecification;
        circle-translate?: PropertyValueSpecification<[number, number]>;
        circle-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
        circle-translate-transition?: TransitionSpecification;
    }
    | {
        heatmap-color?: ExpressionSpecification;
        heatmap-intensity?: PropertyValueSpecification<number>;
        heatmap-intensity-transition?: TransitionSpecification;
        heatmap-opacity?: PropertyValueSpecification<number>;
        heatmap-opacity-transition?: TransitionSpecification;
        heatmap-radius?: DataDrivenPropertyValueSpecification<number>;
        heatmap-radius-transition?: TransitionSpecification;
        heatmap-weight?: DataDrivenPropertyValueSpecification<number>;
    }
    | {
        fill-extrusion-ambient-occlusion-ground-attenuation?: PropertyValueSpecification<number>;
        fill-extrusion-ambient-occlusion-ground-attenuation-transition?: TransitionSpecification;
        fill-extrusion-ambient-occlusion-ground-radius?: PropertyValueSpecification<number>;
        fill-extrusion-ambient-occlusion-ground-radius-transition?: TransitionSpecification;
        fill-extrusion-ambient-occlusion-intensity?: PropertyValueSpecification<number>;
        fill-extrusion-ambient-occlusion-intensity-transition?: TransitionSpecification;
        fill-extrusion-ambient-occlusion-radius?: PropertyValueSpecification<number>;
        fill-extrusion-ambient-occlusion-radius-transition?: TransitionSpecification;
        fill-extrusion-ambient-occlusion-wall-radius?: PropertyValueSpecification<number>;
        fill-extrusion-ambient-occlusion-wall-radius-transition?: TransitionSpecification;
        fill-extrusion-base?: DataDrivenPropertyValueSpecification<number>;
        fill-extrusion-base-transition?: TransitionSpecification;
        fill-extrusion-cast-shadows?: boolean;
        fill-extrusion-color?: DataDrivenPropertyValueSpecification<string>;
        fill-extrusion-color-transition?: TransitionSpecification;
        fill-extrusion-cutoff-fade-range?: ExpressionSpecification;
        fill-extrusion-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
        fill-extrusion-emissive-strength-transition?: TransitionSpecification;
        fill-extrusion-flood-light-color?: PropertyValueSpecification<string>;
        fill-extrusion-flood-light-color-transition?: TransitionSpecification;
        fill-extrusion-flood-light-ground-attenuation?: PropertyValueSpecification<number>;
        fill-extrusion-flood-light-ground-attenuation-transition?: TransitionSpecification;
        fill-extrusion-flood-light-ground-radius?: DataDrivenPropertyValueSpecification<number>;
        fill-extrusion-flood-light-ground-radius-transition?: TransitionSpecification;
        fill-extrusion-flood-light-intensity?: PropertyValueSpecification<number>;
        fill-extrusion-flood-light-intensity-transition?: TransitionSpecification;
        fill-extrusion-flood-light-wall-radius?: DataDrivenPropertyValueSpecification<number>;
        fill-extrusion-flood-light-wall-radius-transition?: TransitionSpecification;
        fill-extrusion-height?: DataDrivenPropertyValueSpecification<number>;
        fill-extrusion-height-transition?: TransitionSpecification;
        fill-extrusion-line-width?: DataDrivenPropertyValueSpecification<number>;
        fill-extrusion-line-width-transition?: TransitionSpecification;
        fill-extrusion-opacity?: PropertyValueSpecification<number>;
        fill-extrusion-opacity-transition?: TransitionSpecification;
        fill-extrusion-pattern?: DataDrivenPropertyValueSpecification<string>;
        fill-extrusion-rounded-roof?: PropertyValueSpecification<boolean>;
        fill-extrusion-translate?: PropertyValueSpecification<[number, number]>;
        fill-extrusion-translate-anchor?: PropertyValueSpecification<"map" | "viewport">;
        fill-extrusion-translate-transition?: TransitionSpecification;
        fill-extrusion-vertical-gradient?: PropertyValueSpecification<boolean>;
        fill-extrusion-vertical-scale?: PropertyValueSpecification<number>;
        fill-extrusion-vertical-scale-transition?: TransitionSpecification;
    }
    | {
        raster-array-band?: string;
        raster-brightness-max?: PropertyValueSpecification<number>;
        raster-brightness-max-transition?: TransitionSpecification;
        raster-brightness-min?: PropertyValueSpecification<number>;
        raster-brightness-min-transition?: TransitionSpecification;
        raster-color?: ExpressionSpecification;
        raster-color-mix?: PropertyValueSpecification<[number, number, number, number]>;
        raster-color-mix-transition?: TransitionSpecification;
        raster-color-range?: PropertyValueSpecification<[number, number]>;
        raster-color-range-transition?: TransitionSpecification;
        raster-contrast?: PropertyValueSpecification<number>;
        raster-contrast-transition?: TransitionSpecification;
        raster-elevation?: PropertyValueSpecification<number>;
        raster-elevation-transition?: TransitionSpecification;
        raster-emissive-strength?: PropertyValueSpecification<number>;
        raster-emissive-strength-transition?: TransitionSpecification;
        raster-fade-duration?: PropertyValueSpecification<number>;
        raster-hue-rotate?: PropertyValueSpecification<number>;
        raster-hue-rotate-transition?: TransitionSpecification;
        raster-opacity?: PropertyValueSpecification<number>;
        raster-opacity-transition?: TransitionSpecification;
        raster-resampling?: PropertyValueSpecification<"linear" | "nearest">;
        raster-saturation?: PropertyValueSpecification<number>;
        raster-saturation-transition?: TransitionSpecification;
    }
    | {
        raster-particle-array-band?: string;
        raster-particle-color?: ExpressionSpecification;
        raster-particle-count?: number;
        raster-particle-elevation?: PropertyValueSpecification<number>;
        raster-particle-elevation-transition?: TransitionSpecification;
        raster-particle-fade-opacity-factor?: PropertyValueSpecification<number>;
        raster-particle-fade-opacity-factor-transition?: TransitionSpecification;
        raster-particle-max-speed?: number;
        raster-particle-reset-rate-factor?: number;
        raster-particle-speed-factor?: PropertyValueSpecification<number>;
        raster-particle-speed-factor-transition?: TransitionSpecification;
    }
    | {
        hillshade-accent-color?: PropertyValueSpecification<string>;
        hillshade-accent-color-transition?: TransitionSpecification;
        hillshade-emissive-strength?: PropertyValueSpecification<number>;
        hillshade-emissive-strength-transition?: TransitionSpecification;
        hillshade-exaggeration?: PropertyValueSpecification<number>;
        hillshade-exaggeration-transition?: TransitionSpecification;
        hillshade-highlight-color?: PropertyValueSpecification<string>;
        hillshade-highlight-color-transition?: TransitionSpecification;
        hillshade-illumination-anchor?: PropertyValueSpecification<"map" | "viewport">;
        hillshade-illumination-direction?: PropertyValueSpecification<number>;
        hillshade-shadow-color?: PropertyValueSpecification<string>;
        hillshade-shadow-color-transition?: TransitionSpecification;
    }
    | {
        model-ambient-occlusion-intensity?: PropertyValueSpecification<number>;
        model-ambient-occlusion-intensity-transition?: TransitionSpecification;
        model-cast-shadows?: boolean;
        model-color?: DataDrivenPropertyValueSpecification<string>;
        model-color-mix-intensity?: DataDrivenPropertyValueSpecification<number>;
        model-color-mix-intensity-transition?: TransitionSpecification;
        model-color-transition?: TransitionSpecification;
        model-cutoff-fade-range?: ExpressionSpecification;
        model-emissive-strength?: DataDrivenPropertyValueSpecification<number>;
        model-emissive-strength-transition?: TransitionSpecification;
        model-front-cutoff?: PropertyValueSpecification<[number, number, number]>;
        model-height-based-emissive-strength-multiplier?: DataDrivenPropertyValueSpecification<[number, number, number, number, number]>;
        model-height-based-emissive-strength-multiplier-transition?: TransitionSpecification;
        model-opacity?: PropertyValueSpecification<number>;
        model-opacity-transition?: TransitionSpecification;
        model-receive-shadows?: boolean;
        model-rotation?: DataDrivenPropertyValueSpecification<[number, number, number]>;
        model-rotation-transition?: TransitionSpecification;
        model-roughness?: DataDrivenPropertyValueSpecification<number>;
        model-roughness-transition?: TransitionSpecification;
        model-scale?: DataDrivenPropertyValueSpecification<[number, number, number]>;
        model-scale-transition?: TransitionSpecification;
        model-translation?: DataDrivenPropertyValueSpecification<[number, number, number]>;
        model-translation-transition?: TransitionSpecification;
        model-type?: "common-3d" | "location-indicator";
    }
    | {
        background-color?: PropertyValueSpecification<string>;
        background-color-transition?: TransitionSpecification;
        background-emissive-strength?: PropertyValueSpecification<number>;
        background-emissive-strength-transition?: TransitionSpecification;
        background-opacity?: PropertyValueSpecification<number>;
        background-opacity-transition?: TransitionSpecification;
        background-pattern?: PropertyValueSpecification<string>;
        background-pitch-alignment?: "map" | ExpressionSpecification | "viewport";
    }
    | {
        sky-atmosphere-color?: string;
        sky-atmosphere-halo-color?: string;
        sky-atmosphere-sun?: PropertyValueSpecification<[number, number]>;
        sky-atmosphere-sun-intensity?: number;
        sky-gradient?: ExpressionSpecification;
        sky-gradient-center?: PropertyValueSpecification<[number, number]>;
        sky-gradient-radius?: PropertyValueSpecification<number>;
        sky-opacity?: PropertyValueSpecification<number>;
        sky-opacity-transition?: TransitionSpecification;
        sky-type?: PropertyValueSpecification<"gradient" | "atmosphere">;
    }

Type declaration

  • Optionalline-blur?: DataDrivenPropertyValueSpecification<number>
  • Optionalline-blur-transition?: TransitionSpecification
  • Optionalline-border-color?: DataDrivenPropertyValueSpecification<string>
  • Optionalline-border-color-transition?: TransitionSpecification
  • Optionalline-border-width?: DataDrivenPropertyValueSpecification<number>
  • Optionalline-border-width-transition?: TransitionSpecification
  • Optionalline-color?: DataDrivenPropertyValueSpecification<string>
  • Optionalline-color-transition?: TransitionSpecification
  • Optionalline-dasharray?: DataDrivenPropertyValueSpecification<number[]>
  • Optionalline-emissive-strength?: PropertyValueSpecification<number>
  • Optionalline-emissive-strength-transition?: TransitionSpecification
  • Optionalline-gap-width?: DataDrivenPropertyValueSpecification<number>
  • Optionalline-gap-width-transition?: TransitionSpecification
  • Optionalline-gradient?: ExpressionSpecification
  • Optionalline-occlusion-opacity?: PropertyValueSpecification<number>
  • Optionalline-occlusion-opacity-transition?: TransitionSpecification
  • Optionalline-offset?: DataDrivenPropertyValueSpecification<number>
  • Optionalline-offset-transition?: TransitionSpecification
  • Optionalline-opacity?: DataDrivenPropertyValueSpecification<number>
  • Optionalline-opacity-transition?: TransitionSpecification
  • Optionalline-pattern?: DataDrivenPropertyValueSpecification<string>
  • Optionalline-translate?: PropertyValueSpecification<[number, number]>
  • Optionalline-translate-anchor?: PropertyValueSpecification<"map" | "viewport">
  • Optionalline-translate-transition?: TransitionSpecification
  • Optionalline-trim-color?: PropertyValueSpecification<string>
  • Optionalline-trim-color-transition?: TransitionSpecification
  • Optional Experimentalline-trim-fade-range?: PropertyValueSpecification<[number, number]>

    This property is experimental and subject to change in future versions.

  • Optionalline-trim-offset?: [number, number]
  • Optionalline-width?: DataDrivenPropertyValueSpecification<number>
  • Optionalline-width-transition?: TransitionSpecification

Type declaration

  • Optionalicon-color?: DataDrivenPropertyValueSpecification<string>
  • Optionalicon-color-brightness-max?: ExpressionSpecification
  • Optionalicon-color-brightness-min?: ExpressionSpecification
  • Optionalicon-color-contrast?: ExpressionSpecification
  • Optionalicon-color-saturation?: ExpressionSpecification
  • Optionalicon-color-transition?: TransitionSpecification
  • Optionalicon-emissive-strength?: DataDrivenPropertyValueSpecification<number>
  • Optionalicon-emissive-strength-transition?: TransitionSpecification
  • Optionalicon-halo-blur?: DataDrivenPropertyValueSpecification<number>
  • Optionalicon-halo-blur-transition?: TransitionSpecification
  • Optionalicon-halo-color?: DataDrivenPropertyValueSpecification<string>
  • Optionalicon-halo-color-transition?: TransitionSpecification
  • Optionalicon-halo-width?: DataDrivenPropertyValueSpecification<number>
  • Optionalicon-halo-width-transition?: TransitionSpecification
  • Optionalicon-image-cross-fade?: DataDrivenPropertyValueSpecification<number>
  • Optionalicon-image-cross-fade-transition?: TransitionSpecification
  • Optionalicon-occlusion-opacity?: DataDrivenPropertyValueSpecification<number>
  • Optionalicon-occlusion-opacity-transition?: TransitionSpecification
  • Optionalicon-opacity?: DataDrivenPropertyValueSpecification<number>
  • Optionalicon-opacity-transition?: TransitionSpecification
  • Optionalicon-translate?: PropertyValueSpecification<[number, number]>
  • Optionalicon-translate-anchor?: PropertyValueSpecification<"map" | "viewport">
  • Optionalicon-translate-transition?: TransitionSpecification
  • Optional Experimentalsymbol-elevation-reference?: PropertyValueSpecification<"sea" | "ground">

    This property is experimental and subject to change in future versions.

  • Optionalsymbol-z-offset?: DataDrivenPropertyValueSpecification<number>
  • Optionalsymbol-z-offset-transition?: TransitionSpecification
  • Optionaltext-color?: DataDrivenPropertyValueSpecification<string>
  • Optionaltext-color-transition?: TransitionSpecification
  • Optionaltext-emissive-strength?: DataDrivenPropertyValueSpecification<number>
  • Optionaltext-emissive-strength-transition?: TransitionSpecification
  • Optionaltext-halo-blur?: DataDrivenPropertyValueSpecification<number>
  • Optionaltext-halo-blur-transition?: TransitionSpecification
  • Optionaltext-halo-color?: DataDrivenPropertyValueSpecification<string>
  • Optionaltext-halo-color-transition?: TransitionSpecification
  • Optionaltext-halo-width?: DataDrivenPropertyValueSpecification<number>
  • Optionaltext-halo-width-transition?: TransitionSpecification
  • Optionaltext-occlusion-opacity?: DataDrivenPropertyValueSpecification<number>
  • Optionaltext-occlusion-opacity-transition?: TransitionSpecification
  • Optionaltext-opacity?: DataDrivenPropertyValueSpecification<number>
  • Optionaltext-opacity-transition?: TransitionSpecification
  • Optionaltext-translate?: PropertyValueSpecification<[number, number]>
  • Optionaltext-translate-anchor?: PropertyValueSpecification<"map" | "viewport">
  • Optionaltext-translate-transition?: TransitionSpecification

Type declaration

  • Optionalfill-extrusion-ambient-occlusion-ground-attenuation?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-ambient-occlusion-ground-attenuation-transition?: TransitionSpecification
  • Optionalfill-extrusion-ambient-occlusion-ground-radius?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-ambient-occlusion-ground-radius-transition?: TransitionSpecification
  • Optionalfill-extrusion-ambient-occlusion-intensity?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-ambient-occlusion-intensity-transition?: TransitionSpecification
  • Optionalfill-extrusion-ambient-occlusion-radius?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-ambient-occlusion-radius-transition?: TransitionSpecification
  • Optionalfill-extrusion-ambient-occlusion-wall-radius?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-ambient-occlusion-wall-radius-transition?: TransitionSpecification
  • Optionalfill-extrusion-base?: DataDrivenPropertyValueSpecification<number>
  • Optionalfill-extrusion-base-transition?: TransitionSpecification
  • Optionalfill-extrusion-cast-shadows?: boolean
  • Optionalfill-extrusion-color?: DataDrivenPropertyValueSpecification<string>
  • Optionalfill-extrusion-color-transition?: TransitionSpecification
  • Optionalfill-extrusion-cutoff-fade-range?: ExpressionSpecification
  • Optionalfill-extrusion-emissive-strength?: DataDrivenPropertyValueSpecification<number>
  • Optionalfill-extrusion-emissive-strength-transition?: TransitionSpecification
  • Optionalfill-extrusion-flood-light-color?: PropertyValueSpecification<string>
  • Optionalfill-extrusion-flood-light-color-transition?: TransitionSpecification
  • Optionalfill-extrusion-flood-light-ground-attenuation?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-flood-light-ground-attenuation-transition?: TransitionSpecification
  • Optionalfill-extrusion-flood-light-ground-radius?: DataDrivenPropertyValueSpecification<number>
  • Optionalfill-extrusion-flood-light-ground-radius-transition?: TransitionSpecification
  • Optionalfill-extrusion-flood-light-intensity?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-flood-light-intensity-transition?: TransitionSpecification
  • Optionalfill-extrusion-flood-light-wall-radius?: DataDrivenPropertyValueSpecification<number>
  • Optionalfill-extrusion-flood-light-wall-radius-transition?: TransitionSpecification
  • Optionalfill-extrusion-height?: DataDrivenPropertyValueSpecification<number>
  • Optionalfill-extrusion-height-transition?: TransitionSpecification
  • Optionalfill-extrusion-line-width?: DataDrivenPropertyValueSpecification<number>
  • Optionalfill-extrusion-line-width-transition?: TransitionSpecification
  • Optionalfill-extrusion-opacity?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-opacity-transition?: TransitionSpecification
  • Optionalfill-extrusion-pattern?: DataDrivenPropertyValueSpecification<string>
  • Optional Experimentalfill-extrusion-rounded-roof?: PropertyValueSpecification<boolean>

    This property is experimental and subject to change in future versions.

  • Optionalfill-extrusion-translate?: PropertyValueSpecification<[number, number]>
  • Optionalfill-extrusion-translate-anchor?: PropertyValueSpecification<"map" | "viewport">
  • Optionalfill-extrusion-translate-transition?: TransitionSpecification
  • Optionalfill-extrusion-vertical-gradient?: PropertyValueSpecification<boolean>
  • Optionalfill-extrusion-vertical-scale?: PropertyValueSpecification<number>
  • Optionalfill-extrusion-vertical-scale-transition?: TransitionSpecification

Type declaration

  • Optional Experimentalraster-array-band?: string

    This property is experimental and subject to change in future versions.

  • Optionalraster-brightness-max?: PropertyValueSpecification<number>
  • Optionalraster-brightness-max-transition?: TransitionSpecification
  • Optionalraster-brightness-min?: PropertyValueSpecification<number>
  • Optionalraster-brightness-min-transition?: TransitionSpecification
  • Optionalraster-color?: ExpressionSpecification
  • Optionalraster-color-mix?: PropertyValueSpecification<[number, number, number, number]>
  • Optionalraster-color-mix-transition?: TransitionSpecification
  • Optionalraster-color-range?: PropertyValueSpecification<[number, number]>
  • Optionalraster-color-range-transition?: TransitionSpecification
  • Optionalraster-contrast?: PropertyValueSpecification<number>
  • Optionalraster-contrast-transition?: TransitionSpecification
  • Optionalraster-elevation?: PropertyValueSpecification<number>
  • Optionalraster-elevation-transition?: TransitionSpecification
  • Optionalraster-emissive-strength?: PropertyValueSpecification<number>
  • Optionalraster-emissive-strength-transition?: TransitionSpecification
  • Optionalraster-fade-duration?: PropertyValueSpecification<number>
  • Optionalraster-hue-rotate?: PropertyValueSpecification<number>
  • Optionalraster-hue-rotate-transition?: TransitionSpecification
  • Optionalraster-opacity?: PropertyValueSpecification<number>
  • Optionalraster-opacity-transition?: TransitionSpecification
  • Optionalraster-resampling?: PropertyValueSpecification<"linear" | "nearest">
  • Optionalraster-saturation?: PropertyValueSpecification<number>
  • Optionalraster-saturation-transition?: TransitionSpecification

Optionalslot

slot?: string

Optionalsource

source?: string

Optionalsource-layer

source-layer?: string

type

type:
    | "symbol"
    | "fill"
    | "slot"
    | "line"
    | "circle"
    | "heatmap"
    | "fill-extrusion"
    | "raster"
    | "raster-particle"
    | "hillshade"
    | "model"
    | "background"
    | "sky"
    | "clip"

update

update: ((map: Map$1, show?: boolean) => void)

Settings

Member Visibility

On This Page

Properties