Contains options and constants shared between vector overlays (Polygon, Polyline, Circle, CircleMarker, and Rectangle). Parameters ---------- stroke: Bool, True Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles.
(
line: bool = False, radius: Optional[float] = None, **kwargs: TypePathOptions
)
| 21 | |
| 22 | |
| 23 | def path_options( |
| 24 | line: bool = False, radius: Optional[float] = None, **kwargs: TypePathOptions |
| 25 | ): |
| 26 | """ |
| 27 | Contains options and constants shared between vector overlays |
| 28 | (Polygon, Polyline, Circle, CircleMarker, and Rectangle). |
| 29 | |
| 30 | Parameters |
| 31 | ---------- |
| 32 | stroke: Bool, True |
| 33 | Whether to draw stroke along the path. |
| 34 | Set it to false to disable borders on polygons or circles. |
| 35 | color: str, '#3388ff' |
| 36 | Stroke color. |
| 37 | weight: int, 3 |
| 38 | Stroke width in pixels. |
| 39 | opacity: float, 1.0 |
| 40 | Stroke opacity. |
| 41 | line_cap: str, 'round' (lineCap) |
| 42 | A string that defines shape to be used at the end of the stroke. |
| 43 | https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap |
| 44 | line_join: str, 'round' (lineJoin) |
| 45 | A string that defines shape to be used at the corners of the stroke. |
| 46 | https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin |
| 47 | dash_array: str, None (dashArray) |
| 48 | A string that defines the stroke dash pattern. |
| 49 | Doesn't work on Canvas-powered layers in some old browsers. |
| 50 | https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray |
| 51 | dash_offset:, str, None (dashOffset) |
| 52 | A string that defines the distance into the dash pattern to start the dash. |
| 53 | Doesn't work on Canvas-powered layers in some old browsers. |
| 54 | https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset |
| 55 | fill: Bool, False |
| 56 | Whether to fill the path with color. |
| 57 | Set it to false to disable filling on polygons or circles. |
| 58 | fill_color: str, default to `color` (fillColor) |
| 59 | Fill color. Defaults to the value of the color option. |
| 60 | fill_opacity: float, 0.2 (fillOpacity) |
| 61 | Fill opacity. |
| 62 | fill_rule: str, 'evenodd' (fillRule) |
| 63 | A string that defines how the inside of a shape is determined. |
| 64 | https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule |
| 65 | bubbling_mouse_events: Bool, True (bubblingMouseEvents) |
| 66 | When true a mouse event on this path will trigger the same event on the |
| 67 | map (unless L.DomEvent.stopPropagation is used). |
| 68 | gradient: bool, default None |
| 69 | When a gradient on the stroke and fill is available, |
| 70 | allows turning it on or off. |
| 71 | |
| 72 | Note that the presence of `fill_color` will override `fill=False`. |
| 73 | |
| 74 | This function accepts both snake_case and lowerCamelCase equivalents. |
| 75 | |
| 76 | See https://leafletjs.com/reference.html#path |
| 77 | |
| 78 | """ |
| 79 | |
| 80 | kwargs = {camelize(key): value for key, value in kwargs.items()} |