Struct html_tags::Area

pub struct Area<'life> {

    pub accesskey: Option<&'life str>,
    pub alt: Option<&'life str>,
    pub autocapitalize: Option<&'life str>,
    pub autofocus: Option<bool>,
    pub class: Option<&'life str>,
    pub contenteditable: Option<&'life str>,
    pub contextmenu: Option<&'life str>,
    pub coords: Option<&'life str>,
    pub data: Option<BTreeMap<&'life str, &'life str>>,
    pub dir: Option<&'life str>,
    pub download: Option<&'life str>,
    pub draggable: Option<&'life str>,
    pub enterkeyhint: Option<&'life str>,
    pub exportparts: Option<&'life str>,
    pub hidden: Option<bool>,
    pub href: Option<&'life str>,
    pub hreflang: Option<&'life str>,
    pub id: Option<&'life str>,
    pub inert: Option<&'life str>,
    pub inputmode: Option<&'life str>,
    pub is: Option<&'life str>,
    pub ping: Option<&'life str>,
    pub referrerpolicy: Option<&'life str>,
    pub rel: Option<&'life str>,
    pub shape: Option<&'life str>,
    pub target: Option<&'life str>,
    pub extra: BTreeMap<&'life str, &'life str>,
}

The <area> HTML element defines an area inside an image map that has predefined clickable areas. An image map allows geometric areas on an image to be associated with hypertext links.

This element is used only within a <map> element.

More information: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/area

Fields

accesskey: Option<&'life str>

Provides a hint for generating a keyboard shortcut for the current element. This attribute consists of a space-separated list of characters. The browser should use the first one that exists on the computer keyboard layout.

alt: Option<&'life str>

A text string alternative to display on browsers that do not display images. The text should be phrased so that it presents the user with the same kind of choice as the image would offer when displayed without the alternative text. This attribute is required only if the href attribute is used.

autocapitalize: Option<&'life str>

Controls whether and how text input is automatically capitalized as it is entered/edited by the user. It can have the following values:

• off or none, no autocapitalization is applied (all letters default to lowercase)
• on or sentences, the first letter of each sentence defaults to a capital letter; all other letters default to lowercase
• words, the first letter of each word defaults to a capital letter; all other letters default to lowercase
• characters, all letters should default to uppercase

autofocus: Option<bool>

Indicates that an element is to be focused on page load, or as soon as the <dialog> it is part of is displayed. This attribute is a boolean, initially false.

class: Option<&'life str>

A space-separated list of the classes of the element. Classes allow CSS and JavaScript to select and access specific elements via the class selectors or functions like the method Document.getElementsByClassName().

contenteditable: Option<&'life str>

An enumerated attribute indicating if the element should be editable by the user. If so, the browser modifies its widget to allow editing. The attribute must take one of the following values:

• true or the empty string, which indicates that the element must be editable;
• false, which indicates that the element must not be editable.

contextmenu: Option<&'life str>

The id of a <menu> to use as the contextual menu for this element.

coords: Option<&'life str>

The coords attribute details the coordinates of the shape attribute in size, shape, and placement of an <area>. This attribute must not be used if shape is set to default.

• rect: the value is x1,y1,x2,y2. The value specifies the coordinates of the top-left and bottom-right corner of the rectangle. For example, in <area shape="rect" coords="0,0,253,27" href="#" target="_blank" alt="Mozilla"> the coordinates are 0,0 and 253,27, indicating the top-left and bottom-right corners of the rectangle, respectively.
• circle: the value is x,y,radius. Value specifies the coordinates of the circle center and the radius. For example: <area shape="circle" coords="130,136,60" href="#" target="_blank" alt="MDN">
• poly: the value is x1,y1,x2,y2,..,xn,yn. Value specifies the coordinates of the edges of the polygon. If the first and last coordinate pairs are not the same, the browser will add the last coordinate pair to close the polygon

The values are numbers of CSS pixels.

data: Option<BTreeMap<&'life str, &'life str>>

Forms a class of attributes, called custom data attributes, that allow proprietary information to be exchanged between the HTML and its DOM representation that may be used by scripts. All such custom data are available via the HTMLElement interface of the element the attribute is set on. The HTMLElement.dataset property gives access to them.

dir: Option<&'life str>

An enumerated attribute indicating the directionality of the element's text. It can have the following values:

• ltr, which means left to right and is to be used for languages that are written from the left to the right (like English);
• rtl, which means right to left and is to be used for languages that are written from the right to the left (like Arabic);
• auto, which lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then it applies that directionality to the whole element.

download: Option<&'life str>

This attribute, if present, indicates that the author intends the hyperlink to be used for downloading a resource. See <a> for a full description of the download attribute.

draggable: Option<&'life str>

An enumerated attribute indicating whether the element can be dragged, using the Drag and Drop API. It can have the following values:

• true, which indicates that the element may be dragged
• false, which indicates that the element may not be dragged.

enterkeyhint: Option<&'life str>

Hints what action label (or icon) to present for the enter key on virtual keyboards.

exportparts: Option<&'life str>

Used to transitively export shadow parts from a nested shadow tree into a containing light tree.

hidden: Option<bool>

An enumerated attribute indicating that the element is not yet, or is no longer, relevant. For example, it can be used to hide elements of the page that can't be used until the login process has been completed. The browser won't render such elements. This attribute must not be used to hide content that could legitimately be shown.

href: Option<&'life str>

The hyperlink target for the area. Its value is a valid URL. This attribute may be omitted; if so, the <area> element does not represent a hyperlink.

hreflang: Option<&'life str>

Indicates the language of the linked resource. Allowed values are defined by RFC 5646: Tags for Identifying Languages (also known as BCP 47). Use this attribute only if the href attribute is present.

id: Option<&'life str>

Defines a unique identifier (ID) which must be unique in the whole document. Its purpose is to identify the element when linking (using a fragment identifier), scripting, or styling (with CSS).

inert: Option<&'life str>

A boolean value that makes the browser disregard user input events for the element. Useful when click events are present.

inputmode: Option<&'life str>

Provides a hint to browsers about the type of virtual keyboard configuration to use when editing this element or its contents. Used primarily on <input> elements, but is usable on any element while in contenteditable mode.

is: Option<&'life str>

Allows you to specify that a standard HTML element should behave like a registered custom built-in element (see Using custom elements for more details).

ping: Option<&'life str>

Contains a space-separated list of URLs to which, when the hyperlink is followed, POST requests with the body PING will be sent by the browser (in the background). Typically used for tracking.

referrerpolicy: Option<&'life str>

A string indicating which referrer to use when fetching the resource:

• no-referrer: The Referer header will not be sent.
• no-referrer-when-downgrade: The Referer header will not be sent to origins without TLS (HTTPS).
• origin: The sent referrer will be limited to the origin of the referring page: its scheme, host, and port.
• origin-when-cross-origin: The referrer sent to other origins will be limited to the scheme, the host, and the port. Navigations on the same origin will still include the path.
• same-origin: A referrer will be sent for same origin, but cross-origin requests will contain no referrer information.
• strict-origin: Only send the origin of the document as the referrer when the protocol security level stays the same (HTTPS→HTTPS), but don't send it to a less secure destination (HTTPS→HTTP).
• strict-origin-when-cross-origin (default): Send a full URL when performing a same-origin request, only send the origin when the protocol security level stays the same (HTTPS→HTTPS), and send no header to a less secure destination (HTTPS→HTTP).
• unsafe-url: The referrer will include the origin and the path (but not the fragment, password, or username). This value is unsafe, because it leaks origins and paths from TLS-protected resources to insecure origins.

rel: Option<&'life str>

For anchors containing the href attribute, this attribute specifies the relationship of the target object to the link object. The value is a space-separated list of link types. The values and their semantics will be registered by some authority that might have meaning to the document author. The default relationship, if no other is given, is void. Use this attribute only if the href attribute is present.

shape: Option<&'life str>

The shape of the associated hot spot. The specifications for HTML defines the values rect, which defines a rectangular region; circle, which defines a circular region; poly, which defines a polygon; and default, which indicates the entire region beyond any defined shapes.

target: Option<&'life str>

A keyword or author-defined name of the browsing context to display the linked resource. The following keywords have special meanings:

• _self (default): Show the resource in the current browsing context.
• _blank: Show the resource in a new, unnamed browsing context.
• _parent: Show the resource in the parent browsing context of the current one, if the current page is inside a frame. If there is no parent, acts the same as _self.
• _top: Show the resource in the topmost browsing context (the browsing context that is an ancestor of the current one and has no parent). If there is no parent, acts the same as _self.

Use this attribute only if the href attribute is present.

Note: Setting target="_blank" on <area> elements implicitly provides the same rel behavior as setting rel="noopener" which does not set window.opener. See browser compatibility for support status.

extra: BTreeMap<&'life str, &'life str>

The extra attributes of the element. This is a map of attribute names to their values. The attribute names are in lowercase.

Trait Implementations

impl<'life> Clone for Area<'life>

fn clone(&self) -> Area<'life>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'life> Debug for Area<'life>

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

Formats the value using the given formatter.

impl<'life> Default for Area<'life>

fn default() -> Area<'life>

Returns the “default value” for a type.

impl<'life> Ord for Area<'life>

fn cmp(&self, other: &Area<'life>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'life> PartialEq<Area<'life>> for Area<'life>

fn eq(&self, other: &Area<'life>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'life> PartialOrd<Area<'life>> for Area<'life>

fn partial_cmp(&self, other: &Area<'life>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'life> Eq for Area<'life>

impl<'life> StructuralEq for Area<'life>

impl<'life> StructuralPartialEq for Area<'life>