BlueMapWrapper

Back to README.md

Markers

BaseMarker

class BlueMapWrapper.BaseMarker

The Base class of all other Markers

Attributes

Attributes

key (str)

The key of the Marker

label (str)

The given name for a Marker

position (Position)

The position of a marker


ExtrudeMarker(BaseMarker)

class BlueMapWrapper.ExtrudeMarker

A Marker with a 3D shape

Attributes

Attributes

shape (list[Position])

A list of coordinates that traces the shape on the x and z axis

shape_min_y (int)

The lowest point of the shape

shape_max_y (int)

The tallest point of the shape

detail (Optional[Union[str, None]])

HTML information of the Marker


HTMLMarker(BaseMarker)

class BlueMapWrapper.HTMLMarker

A Marker that displays HTML code

Attributes

Attributes

html (str)

HTML information of the Marker

classes (Optional[Union[list[str], None])

a list of CSS classes to be applied to html


LineMarker(BaseMarker)

class BlueMapWrapper.LineMarker

A Marker that displays a line connecting several points

Attributes

Attributes

line (list[Position])

A list of Position Objects that forms the line

detail (str)

HTML information of the Marker


POIMarker(BaseMarker)

class BlueMapWrapper.POIMarker

A Marker that displays a line connecting several points

Attributes

Attributes

line (list[Position])

A list of Position Objects that forms the line

detail (str)

HTML information of the Marker


ShapeMarker(BaseMarker)

class BlueMapWrapper.ShapeMarker

A Marker that displays a 2D shape on the x and z axis

Attributes

Attributes

shape (list[Position])

A list of Position Objects that traces and forms the shape

shape_y (int)

Where the y level of the shape will be placed at

detail (str)

HTML information of the Marker