Map#

class geodesic.mapping.base.Map(**kwargs)[source]#

Light wrapper on top of an ipyleaflet.Map

A basic map with some basic initialization.

Attributes

attribution_control

A boolean (True, False) trait.

basemap

A trait type representing a Union type.

bottom

A float trait.

bounce_at_zoom_limits

A boolean (True, False) trait.

bounds

An instance of a Python tuple.

bounds_polygon

An instance of a Python tuple.

box_zoom

A boolean (True, False) trait.

center

An instance of a Python list.

close_popup_on_click

A boolean (True, False) trait.

comm

A trait which allows any value.

controls

An instance of a Python tuple.

cross_validation_lock

A contextmanager for running a block with our cross validation lock set to True.

crs

An instance of a Python dict.

default_style

An instance trait which coerces a dict to an instance.

double_click_zoom

A boolean (True, False) trait.

dragging

A boolean (True, False) trait.

dragging_style

An instance trait which coerces a dict to an instance.

east

A float trait.

fullscreen

A boolean (True, False) trait.

inertia

A boolean (True, False) trait.

inertia_deceleration

An int trait.

inertia_max_speed

An int trait.

interpolation

A trait for unicode strings.

keyboard

A boolean (True, False) trait.

keyboard_pan_offset

An int trait.

keyboard_zoom_offset

An int trait.

keys

The traits which are synced.

layers

An instance of a Python tuple.

layout

An instance trait which coerces a dict to an instance.

left

A float trait.

log

A trait whose value must be an instance of a specified class.

max_zoom

A casting version of the float trait.

min_zoom

A casting version of the float trait.

model_id

Gets the model id of this widget.

modisdate

A trait for unicode strings.

north

A float trait.

observe_attribution_control

observe_zoom_control

options

An instance of a Python list.

panes

An instance of a Python dict.

pixel_bounds

An instance of a Python tuple.

prefer_canvas

A boolean (True, False) trait.

right

A float trait.

scroll_wheel_zoom

A boolean (True, False) trait.

south

A float trait.

style

An instance trait which coerces a dict to an instance.

tabbable

Is widget tabbable?

tap

A boolean (True, False) trait.

tap_tolerance

An int trait.

tooltip

A tooltip caption.

top

A float trait.

touch_zoom

A boolean (True, False) trait.

west

A float trait.

widget_types

widgets

window_url

A trait for unicode strings.

world_copy_jump

A boolean (True, False) trait.

zoom

A casting version of the float trait.

zoom_animation_threshold

An int trait.

zoom_control

A boolean (True, False) trait.

zoom_delta

A casting version of the float trait.

zoom_snap

A casting version of the float trait.

Methods

add(item[, index])

Add an item on the map: either a layer or a control.

add_class(className)

Adds a class to the top level element of the widget.

add_control(control)

Add a control on the map.

add_feature_collection(layer_name, ...[, ...])

add a feature colleciton to the map.

add_layer(layer)

Add a layer on the map.

add_traits(**traits)

Dynamically add trait attributes to the Widget.

blur()

Blur the widget.

class_own_trait_events(name)

Get a dict of all event handlers defined on this class, not a parent.

class_own_traits(**metadata)

Get a dict of all the traitlets defined on this class, not a parent.

class_trait_names(**metadata)

Get a list of all the names of this class' traits.

class_traits(**metadata)

Get a dict of all the traits of this class.

clear()

Clear all layers and controls.

clear_controls()

Remove all controls from the map.

clear_layers()

Remove all layers from the map.

close()

Close method.

close_all()

fit_bounds(bounds)

Sets a map view that contains the given geographical bounds with the maximum zoom level possible.

focus()

Focus on the widget.

get_manager_state([drop_defaults, widgets])

Returns the full state for a widget manager for embedding

get_state([key, drop_defaults])

Gets the widget state, or a piece of it.

get_view_spec()

handle_comm_opened(comm, msg)

Static method, called when a widget is constructed.

handle_control_comm_opened(comm, msg)

Class method, called when the comm-open message on the "jupyter.widget.control" comm channel is received

has_trait(name)

Returns True if the object has a trait with the specified name.

hold_sync()

Hold syncing any state until the outermost context manager exits

hold_trait_notifications()

Context manager for bundling trait change notifications and cross validation.

interact(**kwargs)

notify_change(change)

Called when a property has changed.

observe(handler[, names, type])

Setup a handler to be called when a trait changes.

on_interaction(callback[, remove])

on_msg(callback[, remove])

(Un)Register a custom msg receive callback.

on_trait_change([handler, name, remove])

DEPRECATED: Setup a handler to be called when a trait changes.

on_widget_constructed(callback)

Registers a callback to be called when a widget is constructed.

open()

Open a comm to the frontend if one isn't already open.

remove(item)

Remove an item from the map : either a layer or a control.

remove_class(className)

Removes a class from the top level element of the widget.

remove_control(control)

Remove a control from the map.

remove_layer(rm_layer)

Remove a layer from the map.

save(outfile, **kwargs)

Save the Map to an .html file.

send(content[, buffers])

Sends a custom msg to the widget model in the front-end.

send_state([key])

Sends the widget state, or a piece of it, to the front-end, if it exists.

set_state(sync_data)

Called when a state is received from the front-end.

set_trait(name, value)

Forcibly sets trait attribute, including read-only attributes.

setup_instance(**kwargs)

substitute(old, new)

Replace an item (layer or control) with another one on the map.

substitute_layer(old, new)

Replace a layer with another one on the map.

trait_defaults(*names, **metadata)

Return a trait's default value or a dictionary of them

trait_events([name])

Get a dict of all the event handlers of this class.

trait_has_value(name)

Returns True if the specified trait has a value.

trait_metadata(traitname, key[, default])

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this class' traits.

trait_values(**metadata)

A dict of trait names and their values.

traits(**metadata)

Get a dict of all the traits of this class.

unobserve(handler[, names, type])

Remove a trait change handler.

unobserve_all([name])

Remove trait change handlers of any type for the specified name.