PolygonMarker

Inherits: Control

A marker for the PolygonLayer.

Properties

• border_color(ColorValue) –

  The color of the border outline.

• border_stroke_width(Number) –

  The width of the border outline.

• color(ColorValue) –

  The color of the polygon.

• coordinates(list[MapLatitudeLongitude]) –

  The points for the outline of this polygon.

• disable_holes_border(bool) –

  Whether holes should have borders.

• label(str | None) –

  An optional label for this polygon.

• label_text_style(TextStyle | None) –

  The text style for the label.

• rotate_label(bool) –

  Whether to rotate the label counter to the camera's rotation,

• stroke_cap(StrokeCap) –

  Style to use for line endings.

• stroke_join(StrokeJoin) –

  Style to use for line segment joins.

Properties

border_color class-attribute instance-attribute

border_color: ColorValue = GREEN

The color of the border outline.

border_stroke_width class-attribute instance-attribute

border_stroke_width: Number = 0.0

The width of the border outline.

Raises:

• ValueError –

  If it is less than 0.0.

color class-attribute instance-attribute

color: ColorValue = GREEN

The color of the polygon.

coordinates instance-attribute

coordinates: list[MapLatitudeLongitude]

The points for the outline of this polygon.

disable_holes_border class-attribute instance-attribute

disable_holes_border: bool = False

Whether holes should have borders.

label class-attribute instance-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.

label_text_style class-attribute instance-attribute

label_text_style: TextStyle | None = None

The text style for the label.

rotate_label class-attribute instance-attribute

rotate_label: bool = False

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

stroke_cap class-attribute instance-attribute

stroke_cap: StrokeCap = ROUND

Style to use for line endings.

stroke_join class-attribute instance-attribute

stroke_join: StrokeJoin = ROUND

Style to use for line segment joins.