Struct Renderer 

pub struct Renderer { /* private fields */ }

Base class for vector renderers.

This is the base class that all vector renderers inherit from. Inherits from Layer and provides common functionality for rendering vector graphics. This is equivalent to L.Renderer in JavaScript Leaflet.

Inheritance hierarchy: Evented -> Layer -> Renderer

Methods from Deref<Target = Layer>

pub fn add_to(&self, map: &Map) -> Layer

addTo

pub fn add_to_layer_group(&self, layerGroup: &LayerGroup) -> Layer

addTo

pub fn remove(&self) -> Layer

pub fn remove_from(&self, map: &Map) -> Layer

pub fn remove_from_layer_group(&self, map: &LayerGroup) -> Layer

pub fn get_pane(&self) -> HtmlElement

pub fn get_attribution(&self) -> String

pub fn bind_popup(&self, content: &Popup) -> Layer

bindPopup

pub fn bind_popup_with_options( &self, content: &JsValue, options: &JsValue, ) -> Layer

bindPopup

pub fn unbind_popup(&self) -> Layer

unbindPopup

pub fn open_popup(&self) -> Layer

openPopup

pub fn open_popup_with_lat_lng(&self, lat_lng: &LatLng) -> Layer

openPopup

pub fn close_popup(&self) -> Layer

closePopup

pub fn toggle_popup(&self) -> Layer

togglePopup

pub fn is_popup_open(&self) -> bool

isPopupOpen

pub fn set_popup_content(&self, content: &JsValue) -> Layer

setPopupContent

pub fn get_popup(&self) -> Popup

getPopup

pub fn bind_tooltip(&self, tooltip: &Tooltip) -> Layer

bindTooltip

pub fn bind_tooltip_with_content( &self, content: &JsValue, options: &JsValue, ) -> Layer

pub fn unbind_tooltip(&self) -> Layer

unbindTooltip

pub fn open_tooltip(&self, lat_lng: &LatLng) -> Layer

openTooltip

pub fn close_tooltip(&self) -> Layer

closeTooltip

pub fn toggle_tooltip(&self) -> Layer

toggleTooltip

pub fn is_tooltip_open(&self) -> bool

isTooltipOpen

pub fn set_tooltip_content(&self, content: &JsValue) -> Layer

setTooltipContent

pub fn get_tooltip(&self) -> Tooltip

getTooltip

Methods from Deref<Target = Evented>

pub fn on(&self, kind: &str, handler: &JsValue) -> Evented

Creates a new Evented object.

on

pub fn off(&self, kind: &str, handler: &JsValue) -> Evented

Removes an event listener.

off

pub fn off_by_name(&self, kind: &str) -> Evented

pub fn off_all(&self) -> Evented

Removes all event listeners.

off

pub fn fire( &self, kind: &str, data: &Object, propagate: Option<bool>, ) -> Evented

Emits an event.

fire

pub fn listens(&self, kind: &str, propagate: Option<bool>) -> bool

Returns true if the event has listeners.

listens

pub fn once(&self, kind: &str, handler: &JsValue) -> Evented

Returns true if the event has listeners.

once

pub fn add_event_parent(&self, other: &Evented) -> Evented

Returns true if the event has listeners.

addEventParent

pub fn remove_event_parent(&self, other: &Evented) -> Evented

Returns true if the event has listeners.

‘removeEventParent’

pub fn add_event_listener( &self, kind: &str, handler: &Closure<dyn Fn(JsValue)>, ) -> Evented

Returns true if the event has listeners.

addEventListener

pub fn remove_event_listener( &self, kind: &str, handler: &Closure<dyn Fn(JsValue)>, ) -> Evented

Returns true if the event has listeners.

removeEventListener

pub fn clear_all_event_listeners(&self) -> Evented

Clears all event listeners.

clearAllEventListeners

pub fn add_one_time_event_listener( &self, kind: &str, handler: &Closure<dyn Fn(JsValue)>, ) -> Evented

Adds a one time event listener.

addOneTimeEventListener

pub fn fire_event( &self, kind: &str, data: &Object, propagate: Option<bool>, ) -> Evented

Fires an event.

fireEvent

pub fn has_event_listeners(&self, kind: &str, propagate: Option<bool>) -> bool

Returns true if the event has listeners.

hasEventListeners

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Renderer

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Layer> for Renderer

fn as_ref(&self) -> &Layer

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Renderer> for Canvas

fn as_ref(&self) -> &Renderer

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Renderer> for Renderer

fn as_ref(&self) -> &Renderer

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Renderer> for Svg

fn as_ref(&self) -> &Renderer

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Renderer

fn clone(&self) -> Renderer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Renderer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Renderer

type Target = Layer

The resulting type after dereferencing.

fn deref(&self) -> &Layer

Dereferences the value.

impl From<Canvas> for Renderer

fn from(obj: Canvas) -> Renderer

Converts to this type from the input type.

impl From<JsValue> for Renderer

fn from(obj: JsValue) -> Renderer

Converts to this type from the input type.

impl From<Renderer> for JsValue

fn from(obj: Renderer) -> JsValue

Converts to this type from the input type.

impl From<Renderer> for Layer

fn from(obj: Renderer) -> Layer

Converts to this type from the input type.

impl From<Svg> for Renderer

fn from(obj: Svg) -> Renderer

Converts to this type from the input type.

impl FromWasmAbi for Renderer

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Renderer

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for Renderer

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Renderer

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for Renderer

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Renderer

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Renderer

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a Renderer

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for Renderer

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Renderer

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Renderer>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Renderer

fn describe()