Struct stdweb::web::html_element::CanvasElement

pub struct CanvasElement(_);

The HTML <canvas> element provides an empty graphic zone on which specific JavaScript APIs can draw (such as Canvas 2D or WebGL).

(JavaScript docs)

Methods

impl CanvasElement

pub fn height(&self) -> u32

Returns a positive integer reflecting the height HTML attribute of the element interpreted in CSS pixels. When the attribute is not specified, or if it is set to an invalid value, like a negative, the default value of 150 is used.

(JavaScript docs)

pub fn set_height(&self, value: u32)

Sets a positive integer reflecting the height HTML attribute of the element interpreted in CSS pixels. When the attribute is not specified, or if it is set to an invalid value, like a negative, the default value of 150 is used.

(JavaScript docs)

pub fn width(&self) -> u32

Returns a positive integer reflecting the width HTML attribute of the element interpreted in CSS pixels. When the attribute is not specified, or if it is set to an invalid value, like a negative, the default value of 300 is used.

(JavaScript docs)

pub fn set_width(&self, value: u32)

Sets a positive integer reflecting the width HTML attribute of the element interpreted in CSS pixels. When the attribute is not specified, or if it is set to an invalid value, like a negative, the default value of 300 is used.

(JavaScript docs)

pub fn get_context<T: RenderingContext>(&self) -> Result<T, T::Error>

Returns a drawing context on the canvas, or None if the context identifier is not supported.

(JavaScript docs)

pub fn to_data_url(
    &self,
    mime_type: Option<&str>,
    quality: Option<f64>
) -> Result<String, TODO>

Returns a data URI containing a representation of the image in the format specified by the type parameter (defaults to PNG). The returned image is in a resolution of 96 dpi.

(JavaScript docs)

pub fn to_blob<F: FnOnce(Blob) + 'static>(
    &self,
    f: F,
    mime_type: Option<&str>,
    quality: Option<f64>
) -> Result<(), TODO>

Creates a Blob object representing the image contained in the canvas; this file may be cached on the disk or stored in memory at the discretion of the user agent.

(JavaScript docs)

Trait Implementations

impl JsSerialize for CanvasElement

impl TryFrom<EventTarget> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: EventTarget) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Node> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Node) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Element> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HtmlElement> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: HtmlElement) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CanvasElement> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: CanvasElement) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Reference> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for CanvasElement

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl InstanceOf for CanvasElement

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl ReferenceType for CanvasElement

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!

impl IEventTarget for CanvasElement

fn add_event_listener<T, F>(&self, listener: F) -> EventListenerHandle where
    T: ConcreteEvent,
    F: FnMut(T) + 'static, 

Adds given event handler to the list of event listeners for the specified EventTarget on which it's called.

fn dispatch_event<T: IEvent>(&self, event: &T) -> Result<bool, TODO>

Dispatches an Event at this EventTarget, invoking the affected event listeners in the appropriate order.

impl INode for CanvasElement

fn as_node(&self) -> &Node

Casts a reference to this object into a reference to a Node.

fn append_child<T: INode>(&self, child: &T)

Adds a node to the end of the list of children of a specified parent node.

fn remove_child<T: INode>(&self, child: &T) -> Result<Node, NotFoundError>

Removes a child node from the DOM.

fn clone_node(&self, kind: CloneKind) -> Result<Self, TODO>

Returns a duplicate of the node on which this method was called.

fn contains<T: INode>(&self, node: &T) -> bool

Checks whenever a given node is a descendant of this one or not.

fn insert_before<T: INode, U: INode>(
    &self,
    new_node: &T,
    reference_node: &U
) -> Result<Node, InsertNodeError>

Inserts the specified node before the reference node as a child of the current node.

fn replace_child<T: INode, U: INode>(
    &self,
    new_child: &T,
    old_child: &U
) -> Result<Node, InsertNodeError>

Replaces one hild node of the specified node with another.

fn parent_node(&self) -> Option<Node>

Returns the parent of this node in the DOM tree.

fn first_child(&self) -> Option<Node>

Returns the node's first child in the tree, or None if the node is childless.

fn last_child(&self) -> Option<Node>

Returns the node's last child in the tree, or None if the node is childless.

fn next_sibling(&self) -> Option<Node>

Returns the node's next sibling in the tree, or None if there isn't such a node.

fn node_name(&self) -> String

Returns the name of the node.

fn node_type(&self) -> NodeType

Returns the type of the node.

fn node_value(&self) -> Option<String>

Returns the value of the node.

fn set_node_value(&self, value: Option<&str>)

Sets the value of the node.

fn owner_document(&self) -> Option<Document>

Returns the Document that this node belongs to.

fn parent_element(&self) -> Option<Element>

Returns an Element that is the parent of this node. Returns null if the node has no parent or the parent is not an Element.

fn previous_sibling(&self) -> Option<Node>

Returns the node's previous sibling in the tree, or None if there isn't such a node.

fn text_content(&self) -> Option<String>

A property which represents the text content of a node and its descendants.

fn set_text_content(&self, text: &str)

Sets the text content of this node; calling thil removes all of node's children and replaces them with a single text node with the given value.

fn child_nodes(&self) -> NodeList

Returns a live collection of child nodes of this node.

fn base_uri(&self) -> String

Gets the base URL.

fn has_child_nodes(&self) -> bool

Returns whether this node has children nodes.

fn is_default_namespace(&self, namespace: &str) -> bool

Determines whether the given namespace is the default namespace of this node.

fn is_equal_node<T: INode>(&self, node: &T) -> bool

Tests whether this node is equal to another node. Two nodes are equal if they have the same type, defining characteristics, matching attributes, and so on.

fn is_same_node<T: INode>(&self, node: &T) -> bool

Test whether two Node references are the same.

fn lookup_prefix(&self, namespace: &str) -> Option<String>

Returns the prefix for the given namespace URI, if present.

fn lookup_namespace_uri(&self, prefix: &str) -> Option<String>

Returns the namespace URI for the given prefix.

fn normalize(&self)

Merges any adjacent text nodes and removes empty text nodes under this node.

impl IElement for CanvasElement

fn namespace_uri(&self) -> Option<String>

The Element.namespaceURI read-only property returns the namespace URI of the element, or null if the element is not in a namespace.

fn class_list(&self) -> TokenList

The Element.classList is a read-only property which returns a live TokenList collection of the class attributes of the element.

fn has_attribute(&self, name: &str) -> bool

The Element.hasAttribute() method returns a Boolean value indicating whether the specified element has the specified attribute or not.

fn get_attribute(&self, name: &str) -> Option<String>

Element.getAttribute() returns the value of a specified attribute on the element. If the given attribute does not exist, the value returned will either be null or "" (the empty string);

fn set_attribute(
    &self,
    name: &str,
    value: &str
) -> Result<(), InvalidCharacterError>

Sets the value of an attribute on the specified element. If the attribute already exists, the value is updated; otherwise a new attribute is added with the specified name and value.

fn scroll_top(&self) -> f64

Gets the the number of pixels that an element's content is scrolled vertically.

fn set_scroll_top(&self, value: f64)

Sets the the number of pixels that an element's content is scrolled vertically.

fn scroll_left(&self) -> f64

Gets the the number of pixels that an element's content is scrolled to the left.

fn set_scroll_left(&self, value: f64)

Sets the the number of pixels that an element's content is scrolled to the left.

fn get_attribute_names(&self) -> Vec<String>

Element.getAttributeNames() returns the attribute names of the element as an Array of strings. If the element has no attributes it returns an empty array.

fn remove_attribute(&self, name: &str)

Element.removeAttribute removes an attribute from the specified element.

fn has_attributes(&self) -> bool

The Element.hasAttributes() method returns Boolean value, indicating if the current element has any attributes or not.

fn closest(&self, selectors: &str) -> Result<Option<Element>, SyntaxError>

Returns the closest ancestor of the element (or the element itself) which matches the selectors given in parameter. If there isn't such an ancestor, it returns None.

fn set_pointer_capture(&self, pointer_id: i32) -> Result<(), InvalidPointerId>

Designates a specific element as the capture target of future pointer events.

fn release_pointer_capture(
    &self,
    pointer_id: i32
) -> Result<(), InvalidPointerId>

Releases pointer capture that was previously set for a specific pointer

fn has_pointer_capture(&self, pointer_id: i32) -> bool

Returns a boolean indicating if the element has captured the specified pointer

fn insert_adjacent_html(
    &self,
    position: InsertPosition,
    html: &str
) -> Result<(), InsertAdjacentError>

Insert nodes from HTML fragment into specified position.

fn insert_html_before(&self, html: &str) -> Result<(), InsertAdjacentError>

Insert nodes from HTML fragment before element.

fn prepend_html(&self, html: &str) -> Result<(), InsertAdjacentError>

Insert nodes from HTML fragment as the first children of the element.

fn append_html(&self, html: &str) -> Result<(), InsertAdjacentError>

Insert nodes from HTML fragment as the last children of the element.

fn insert_html_after(&self, html: &str) -> Result<(), InsertAdjacentError>

Insert nodes from HTML fragment after element.

fn slot(&self) -> String

The slot property of the Element interface returns the name of the shadow DOM slot the element is inserted in.

fn attach_shadow(
    &self,
    mode: ShadowRootMode
) -> Result<ShadowRoot, AttachShadowError>

Attach a shadow DOM tree to the specified element and returns a reference to its ShadowRoot. It returns a shadow root if successfully attached or None if the element cannot be attached.

fn shadow_root(&self) -> Option<ShadowRoot>

Returns the shadow root of the current element or None.

impl IHtmlElement for CanvasElement

fn focus(&self)

Sets focus on the specified element, if it can be focused.

fn blur(&self)

Removes keyboard focus from the current element.

fn dataset(&self) -> StringMap

Allows access, both in reading and writing, to all of the custom data attributes (data-*) set on the element, either in HTML or in the DOM.

fn get_bounding_client_rect(&self) -> Rect

Returns the size of an element and its position relative to the viewport. (JavaScript docs)

fn offset_width(&self) -> i32

Returns the layout width of an element. Typically, an element's offsetWidth is a measurement which includes the element borders, the element horizontal padding, the element vertical scrollbar (if present, if rendered) and the element CSS width.

fn offset_height(&self) -> i32

Returns the height of the element including vertical padding and borders, as an integer.

fn inner_text(&self) -> String

A property which represents the "rendered" text content of a node and its descendants. It approximates the text the user would get if they highlighted the contents of the element with the cursor and then copied to the clipboard.

impl AsRef<Reference> for CanvasElement

fn as_ref(&self) -> &Reference

Performs the conversion.

impl From<CanvasElement> for EventTarget

fn from(value: CanvasElement) -> Self

Performs the conversion.

impl From<CanvasElement> for Node

fn from(value: CanvasElement) -> Self

Performs the conversion.

impl From<CanvasElement> for Element

fn from(value: CanvasElement) -> Self

Performs the conversion.

impl From<CanvasElement> for HtmlElement

fn from(value: CanvasElement) -> Self

Performs the conversion.

impl From<CanvasElement> for Reference

fn from(value: CanvasElement) -> Self

Performs the conversion.

impl Clone for CanvasElement

fn clone(&self) -> CanvasElement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for CanvasElement

impl PartialEq<CanvasElement> for CanvasElement

fn eq(&self, other: &CanvasElement) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CanvasElement) -> bool

This method tests for !=.

impl Debug for CanvasElement

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

Formats the value using the given formatter.