Optional allowIf true, the icon will be visible even if it collides with other previously drawn symbols.
Optional anchorPart of the icon placed closest to the anchor. This may conflict with a set offset.
Optional avoidThis is a property relevant if using tiled datasets. If true, the symbols will not cross tile edges to avoid mutual collisions.
Optional colorA color defined as a hex-color string.
Optional formatAn optional configuration for the image format as MIME type. This might be needed if the image(path) has no filending specified. e.g. http://myserver/getImage
Optional haloThe halo's fadeout distance towards the outside.
Optional haloThe color of the icons halo, which helps it stand out from backgrounds represented as a hex-color string.
Optional haloThe opacity of the halo. A value between 0 and 1. 0 means no opacity (i.e. transparent) and 1 is fully opaque.
Optional haloDistance of halo to the icons outline (pixels if haloWidthUnit is not defined).
Optional haloUnit to use for the haloWidth.
Optional imageA path/URL to the icon image file or a Sprite configuration.
Optional keepIf true, the icon will be kept upright.
Describes the type of the kind of the Symbolizer.
Optional offsetThe offset of the Symbolizer as [x, y] coordinates. Positive values indicate right and down, while negative values indicate left and up.
Optional offsetProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#paint-symbol-icon-translate-anchor
Optional opacityDetermines the total opacity for the Symbolizer. A value between 0 and 1. 0 is none opaque and 1 is full opaque.
Optional optionalProperty relevant for mapbox-styles. If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
Optional paddingSize of the additional area around the icon used for detecting symbol collisions.
Optional pitchProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-icon-pitch-alignment
Optional rotateThe rotation of the Symbolizer in degrees. Value should be between 0 and 360.
Optional rotationProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-icon-rotation-alignment
Optional sizeThe Symbolizer size (pixels if sizeUnit is not defined).
Optional sizeUnit to use for the size.
Optional textProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-icon-text-fit
Optional textProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-icon-text-fit-padding
Optional visibilityDefines whether the Symbolizer should be visibile or not.
Generated using TypeDoc
An IconSymbolizer describes the style representation of POINT data if styled with a specific icon.