Skip to content

PolylineLayer

PolylineLayer #

Bases: MapLayer

A layer to display PolylineMarkers.

culling_margin: ft.Number = 10.0 #

Acceptable extent outside of viewport before culling polyline segments.

Defaults to 10.0.

min_hittable_radius: ft.Number = 10.0 #

The minimum radius of the hittable area around each Polyline in logical pixels.

The entire visible area is always hittable, but if the visible area is smaller than this, then this will be the hittable area.

Defaults to 10.0.

polylines: List[PolylineMarker] #

List polylines to be drawn.

simplify_tolerance: ft.Number = 0.3 #

Defaults to 0.3.

PolylineMarker #

Bases: Control

A marker for the PolylineLayer.

border_color: ft.ColorValue = ft.Colors.YELLOW #

The border's color.

Defaults to ft.Colors.YELLOW.

border_stroke_width: ft.Number = 0.0 #

The width of the stroke with of the line border.

Defaults to 0.0 (disabled).

color: ft.ColorValue = ft.Colors.YELLOW #

The color of the line stroke.

Defaults to ft.Colors.YELLOW.

colors_stop: Optional[List[ft.Number]] = None #

The stops for the gradient_colors.

coordinates: List[MapLatitudeLongitude] #

The list of coordinates for the Polyline.

gradient_colors: Optional[List[ft.ColorValue]] = None #

The List of colors in case a gradient should get used.

stroke_cap: ft.StrokeCap = ft.StrokeCap.ROUND #

Style to use for line endings.

Defaults to ft.StrokeCap.ROUND.

stroke_join: ft.StrokeJoin = ft.StrokeJoin.ROUND #

Style to use for line segment joins.

Defaults to ft.StrokeJoin.ROUND.

stroke_pattern: StrokePattern = field(default_factory=lambda: SolidStrokePattern()) #

Determines whether the line should be solid, dotted, or dashed, and the exact characteristics of each.

Defaults to SolidStrokePattern().

stroke_width: ft.Number = 1.0 #

The width of the stroke.

Defaults to 1.0.

use_stroke_width_in_meter: bool = False #

Whether the stroke's width should have meters as unit.

Defaults to False.