Skip to main content

Reference

Road network format​

Dash Sylvereye's road-network data model is straightforward: nodes and edges are supplied as two separate lists of dictionaries.

Each dictionary in nodes_data represents a node, and each dictionary in edges_data represents an edge.

Markers follow the same pattern: they are supplied as a separate list, markers_data, where each dictionary represents a marker.

Nodes data format​

Every node dictionary in nodes_data must include the node's latitude and longitude under the lat and lon keys.

For visualization purposes, nodes can also include the following keys: size, color, alpha, and visible.

Nodes can optionally hold arbitrary data under the data key.

Example of a node dictionary:

{
    'lon': 20.5858171,
    'lat': -100.3888608,            
    'visible': True,
    'alpha': 1.0,
    'size': 0.005,
    'color': 0xa10000,
    'data': { 
        'foo1': 'bar', 
        'foo2': 'baz' 
    }
}

Dictionary keys​

lon​

Kind: Node dictionary key
Type: float

Node's longitude. This key is mandatory.

lat​

Kind: Node dictionary key
Type: float

Node's latitude. This key is mandatory.

visible​

Kind: Node dictionary key
Type: bool

If False, the node is hidden under the NodeVisibilityMethod.CUSTOM visibility method. This key is mandatory when that visibility method is used.

alpha​

Kind: Node dictionary key
Type: float

Node's alpha (transparency) value. Must be a number between 0 and 1, inclusive. Mandatory when using the NodeAlphaMethod.CUSTOM alpha method.

size​

Kind: Node dictionary key
Type: float

Node's size. Must be either 0 or a positive float. Mandatory when using the NodeSizeMethod.CUSTOM size method.

color​

Kind: Node dictionary key
Type: int

Node's color in hex format. Must be a hex integer between 0x000000 and 0xffffff, inclusive. Mandatory when using the NodeColorMethod.CUSTOM color method.

data​

Kind: Node dictionary key
Type: dict

Optional. Use it to store arbitrary data inside the node.

Edges data format​

Every edge dictionary in edges_data must include the polyline's list of coordinates under the coords key.

For visualization purposes, edges can also include the following keys: width, color, alpha, and visible.

Edges can optionally hold arbitrary data under the data key.

Example of an edge dictionary:

{
    'coords': [[20.6377171, -100.4298833], [20.6362819, -100.4329804], [20.6360693, -100.4334094], [20.6348112, -100.4360734]],
    'visible': True,
    'alpha': 1.0,
    'width': 0.25,
    'color': 0x06696,
    'data': { 
        'foo1': 'bar', 
        'foo2': 'baz' 
    }
}

Dictionary keys​

coords​

Kind: Edge dictionary key
Type: list of list

List of coordinate pairs [lat, lon]. Each pair is a vertex of the edge polyline. This key is mandatory.

visible​

Kind: Edge dictionary key
Type: bool

If False, the edge is hidden under the EdgeVisibilityMethod.CUSTOM visibility method. This key is mandatory when that visibility method is used.

alpha​

Kind: Edge dictionary key
Type: float

Edge's alpha (transparency) value. Must be a number between 0 and 1, inclusive. Mandatory when using the EdgeAlphaMethod.CUSTOM alpha method.

width​

Kind: Edge dictionary key
Type: float

Edge's width. Must be either 0 or a positive float. Mandatory when using the EdgeWidthMethod.CUSTOM width method.

color​

Kind: Edge dictionary key
Type: int

Edge's color in hex format. Must be a hex integer between 0x000000 and 0xffffff, inclusive. Mandatory when using the EdgeColorMethod.CUSTOM color method.

data​

Kind: Edge dictionary key
Type: dict

Optional. Use it to store arbitrary data inside the edge.

Markers data format​

Every marker dictionary in markers_data must include the marker's latitude and longitude under the lat and lon keys.

For visualization purposes, markers can also include the following keys: size, color, alpha, size_scale_min, size_scale_max, and visible.

A marker can also carry a custom icon (under the icon_id and icon_image keys) and a tooltip (under the tooltip key).

Markers can optionally hold arbitrary data under the data key.

Example of a marker dictionary:

{
    'icon_id': 'sample_marker',
    'icon_image': '<svg height="100" width="100"><circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="red" /></svg>',
    'lat': 20.5858171,
    'lon': -100.3888608,
    'color': 0x066cc,
    'visible': True,
    'alpha': 1.0,
    'size': 0.25,
    'size_scale_min': 0.25,
    'size_scale_max': 0.5,
    'data': { 
        'foo1': 'bar', 
        'foo2': 'baz' 
    }
    'tooltip': 'This is the tooltip text.'
}

Dictionary keys​

icon_id​

Kind: Marker dictionary key
Type: str

Arbitrary identifier for a custom icon. Mandatory when using the MarkerIconMethod.CUSTOM icon method.

icon_image​

Kind: Marker dictionary key
Type: str

SVG markup of a custom icon. Mandatory when using the MarkerIconMethod.CUSTOM icon method.

lat​

Kind: Marker dictionary key
Type: float

Marker's latitude. This key is mandatory.

lon​

Kind: Marker dictionary key
Type: float

Marker's longitude. This key is mandatory.

color​

Kind: Marker dictionary key
Type: int

Marker's color in hex format. Must be a hex integer between 0x000000 and 0xffffff, inclusive. Mandatory when using the MarkerColorMethod.CUSTOM color method.

visible​

Kind: Marker dictionary key
Type: bool

If False, the marker is hidden under the MarkerVisibilityMethod.CUSTOM visibility method. This key is mandatory when that visibility method is used.

alpha​

Kind: Marker dictionary key
Type: float

Marker's alpha (transparency) value. Must be a number between 0 and 1, inclusive. Mandatory when using the MarkerAlphaMethod.CUSTOM alpha method.

size​

Kind: Marker dictionary key
Type: float

Marker's size. Must be either 0 or a positive float. Mandatory when using the MarkerSizeMethod.CUSTOM size method.

size_scale_min​

Kind: Marker dictionary key
Type: float

Lower bound of the marker size for a custom marker icon.

Mandatory when combining the MarkerIconMethod.CUSTOM icon method with the MarkerSizeMethod.SCALE size method.

size_scale_max​

Kind: Marker dictionary key
Type: float

Upper bound of the marker size for a custom marker icon.

Mandatory when combining the MarkerIconMethod.CUSTOM icon method with the MarkerSizeMethod.SCALE size method.

data​

Kind: Marker dictionary key
Type: dict

Optional. Use it to store arbitrary data inside the node.

tooltip​

Kind: Marker dictionary key
Type: str

Text to display in the marker's tooltip.

Mandatory when the enable_tooltips marker option is set to True.