Interface MarkSymbolizer

MarkSymbolizer describes the style representation of POINT data, if styled as with a regular geometry.

interface MarkSymbolizer {
    avoidEdges?: boolean | GeoStylerBooleanFunction;
    blur?: number | GeoStylerNumberFunction;
    color?: string | GeoStylerStringFunction;
    fillOpacity?: number | GeoStylerNumberFunction;
    kind: "Mark";
    offset?: [number | GeoStylerNumberFunction, number | GeoStylerNumberFunction];
    offsetAnchor?: "map" | GeoStylerStringFunction | "viewport";
    opacity?: number | GeoStylerNumberFunction;
    pitchAlignment?: "map" | GeoStylerStringFunction | "viewport";
    pitchScale?: "map" | GeoStylerStringFunction | "viewport";
    radius?: number | GeoStylerNumberFunction;
    radiusUnit?: DistanceUnit;
    rotate?: number | GeoStylerNumberFunction;
    strokeColor?: string | GeoStylerStringFunction;
    strokeOpacity?: number | GeoStylerNumberFunction;
    strokeWidth?: number | GeoStylerNumberFunction;
    strokeWidthUnit?: DistanceUnit;
    visibility?: boolean | GeoStylerBooleanFunction;
    wellKnownName: WellKnownName;
}

Hierarchy (view full)

Properties

avoidEdges? blur? color? fillOpacity? kind offset? offsetAnchor? opacity? pitchAlignment? pitchScale? radius? radiusUnit? rotate? strokeColor? strokeOpacity? strokeWidth? strokeWidthUnit? visibility? wellKnownName

Properties

Optional avoidEdges

avoidEdges?: boolean | GeoStylerBooleanFunction

This is a property relevant if using tiled datasets. If true, the symbols will not cross tile edges to avoid mutual collisions.

Optional blur

blur?: number | GeoStylerNumberFunction

Amount to blur the Symbolizer. 1 blurs the Symbolizer such that only the centerpoint has full opacity. Mostly relevant for circles.

Optional color

color?: string | GeoStylerStringFunction

A color defined as a hex-color string.

Optional fillOpacity

fillOpacity?: number | GeoStylerNumberFunction

The opacity of the fill. A value between 0 and 1. 0 is none opaque and 1 is full opaque.

kind

kind: "Mark"

Describes the type of the kind of the Symbolizer.

Optional offset

offset?: [number | GeoStylerNumberFunction, number | GeoStylerNumberFunction]

The offset of the Symbolizer as [x, y] coordinates. Positive values indicate right and down, while negative values indicate left and up.

Optional offsetAnchor

offsetAnchor?: "map" | GeoStylerStringFunction | "viewport"

Property relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#paint-symbol-icon-translate-anchor

Optional opacity

opacity?: number | GeoStylerNumberFunction

Determines the total opacity for the Symbolizer. A value between 0 and 1. 0 is none opaque and 1 is full opaque.

Optional pitchAlignment

pitchAlignment?: "map" | GeoStylerStringFunction | "viewport"

Property relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#paint-circle-circle-pitch-alignment

Optional pitchScale

pitchScale?: "map" | GeoStylerStringFunction | "viewport"

Property relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#paint-circle-circle-pitch-scale

Optional radius

radius?: number | GeoStylerNumberFunction

The radius of the Symbolizer. Values describing the full size of the Symbolizer have to be divided by two (pixels if radiusUnit is not defined).

Optional radiusUnit

radiusUnit?: DistanceUnit

Unit to use for the radius.

Optional rotate

rotate?: number | GeoStylerNumberFunction

The rotation of the Symbolizer in degrees. Value should be between 0 and 360.

Optional strokeColor

strokeColor?: string | GeoStylerStringFunction

The color of the stroke represented as a hex-color string.

Optional strokeOpacity

strokeOpacity?: number | GeoStylerNumberFunction

The opacity of the stroke. A value between 0 and 1. 0 is none opaque and 1 is full opaque.

Optional strokeWidth

strokeWidth?: number | GeoStylerNumberFunction

The width of the stroke (pixels if strokeWidthUnit is not defined).

Optional strokeWidthUnit

strokeWidthUnit?: DistanceUnit

Unit to use for the strokeWidth.

Optional visibility

visibility?: boolean | GeoStylerBooleanFunction

Defines whether the Symbolizer should be visibile or not.

wellKnownName

wellKnownName: WellKnownName

The WellKnownName of the MarkSymbolizer.

Settings

Member Visibility

Theme

On This Page

avoidEdgesblurcolorfillOpacitykindoffsetoffsetAnchoropacitypitchAlignmentpitchScaleradiusradiusUnitrotatestrokeColorstrokeOpacitystrokeWidthstrokeWidthUnitvisibilitywellKnownName