Interface SymbolIconLayer

A layer that displays one or more symbols at geographic points on the map.

See

Mapbox symbol layer

interface SymbolIconLayer {
    iconImageUrl: string;
    id: string;
    type: "symbol";
    filter?: any[];
    imageOptions?: {
        pixelRatio?: number;
        sdf?: boolean;
    };
    interactive?: boolean;
    layout?: SymbolLayout;
    maxzoom?: number;
    metadata?: any;
    minzoom?: number;
    paint?: SymbolPaint;
    ref?: string;
    source?: string | AnySourceData;
    source-layer?: string;
}

Hierarchy

  • SymbolLayer
    • SymbolIconLayer

Properties

iconImageUrl id type filter? imageOptions? interactive? layout? maxzoom? metadata? minzoom? paint? ref? source? source-layer?

Properties

iconImageUrl

iconImageUrl: string

A URL to an image resource to be displayed as the symbol for the coordinates in the layer.

id

id: string

type

type: "symbol"

Optional filter

filter?: any[]

Optional imageOptions

imageOptions?: {
    pixelRatio?: number;
    sdf?: boolean;
}

Options for the image resource.

Type declaration

  • Optional pixelRatio?: number
  • Optional sdf?: boolean

See

Mapbox addLayer method

Optional interactive

interactive?: boolean

Optional layout

layout?: SymbolLayout

Optional maxzoom

maxzoom?: number

Optional metadata

metadata?: any

Optional minzoom

minzoom?: number

Optional paint

paint?: SymbolPaint

Optional ref

ref?: string

Optional source

source?: string | AnySourceData

Optional source-layer

source-layer?: string

Settings

Member Visibility

Theme

On This Page

iconImageUrlidtypefilterimageOptionsinteractivelayoutmaxzoommetadataminzoompaintrefsourcesource-layer