On this page
Properties

Type Alias CircleLayerSpecification

type CircleLayerSpecification = {
    filter?: FilterSpecification;
    id: string;
    layout?: {
        "circle-sort-key"?: DataDrivenPropertyValueSpecification<number>;
        visibility?: VisibilitySpecification;
    };
    maxzoom?: number;
    metadata?: unknown;
    minzoom?: number;
    paint?: {
        "circle-blur"?: DataDrivenPropertyValueSpecification<number>;
        "circle-blur-transition"?: TransitionSpecification;
        "circle-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
        "circle-color-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<
            ColorSpecification,
        >;
        "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;
    };
    source: string;
    "source-layer"?: string;
    type: "circle";
}
Index

Properties

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

Properties

filter?: FilterSpecification

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?: {
    "circle-sort-key"?: DataDrivenPropertyValueSpecification<number>;
    visibility?: VisibilitySpecification;
}

Layout properties for the layer.

Type Declaration

  • Optionalcircle-sort-key?: DataDrivenPropertyValueSpecification<number>

    Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

  • Optionalvisibility?: VisibilitySpecification

    Whether this layer is displayed.

    "visible"
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?: {
    "circle-blur"?: DataDrivenPropertyValueSpecification<number>;
    "circle-blur-transition"?: TransitionSpecification;
    "circle-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
    "circle-color-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<
        ColorSpecification,
    >;
    "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;
}

Default paint properties for this layer.

Type Declaration

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: "circle"
Was this helpful?
SDK JS
Reference
CircleLayerSpecification