PolygonMarker

A marker for the PolygonLayer.

Inherits: BaseControl

Properties

• border_color - The color of the border outline.
• border_stroke_width - The width of the border outline.
• color - The color of the polygon.
• coordinates - The points for the outline of this polygon.
• disable_holes_border - Whether holes should have borders.
• label - An optional label for this polygon.
• label_text_style - The text style for the label.
• rotate_label - Whether to rotate the label counter to the camera's rotation, to ensure it remains upright.
• stroke_cap - Style to use for line endings.
• stroke_join - Style to use for line segment joins.
• visible - Whether this marker is rendered on the map.

Properties

buildborder_colorclass-attributeinstance-attribute

border_color: ColorValue = Colors.GREEN

The color of the border outline.

buildborder_stroke_widthclass-attributeinstance-attribute

border_stroke_width: Number = 0.0

The width of the border outline.

Raises:

• ValueError - If it is less than 0.0.

buildcolorclass-attributeinstance-attribute

color: ColorValue = Colors.GREEN

The color of the polygon.

buildcoordinatesinstance-attribute

coordinates: list[MapLatitudeLongitude]

The points for the outline of this polygon.

builddisable_holes_borderclass-attributeinstance-attribute

disable_holes_border: bool = False

Whether holes should have borders.

buildlabelclass-attributeinstance-attribute

label: str | None = None

An optional label for this polygon.

Note

Specifying a label will reduce performance, as the internal canvas must be drawn to and 'saved' more frequently to ensure the proper stacking order is maintained. This can be avoided, potentially at the expense of appearance, by setting PolygonLayer.draw_labels_last.

buildlabel_text_styleclass-attributeinstance-attribute

label_text_style: TextStyle | None = None

The text style for the label.

buildrotate_labelclass-attributeinstance-attribute

rotate_label: bool = False

Whether to rotate the label counter to the camera's rotation, to ensure it remains upright.

buildstroke_capclass-attributeinstance-attribute

stroke_cap: StrokeCap = StrokeCap.ROUND

Style to use for line endings.

buildstroke_joinclass-attributeinstance-attribute

stroke_join: StrokeJoin = StrokeJoin.ROUND

Style to use for line segment joins.

buildvisibleclass-attributeinstance-attribute

visible: bool = True

Whether this marker is rendered on the map.