dash (version 0.9.4)

htmlArea: Area component

Description

Area is a wrapper for the <area> HTML5 element. For detailed attribute info see: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/area

Usage

htmlArea(children=NULL, id=NULL, n_clicks=NULL,
n_clicks_timestamp=NULL, key=NULL, role=NULL, alt=NULL,
coords=NULL, download=NULL, href=NULL, hrefLang=NULL,
media=NULL, referrerPolicy=NULL, rel=NULL, shape=NULL,
target=NULL, accessKey=NULL, className=NULL,
contentEditable=NULL, contextMenu=NULL, dir=NULL,
draggable=NULL, hidden=NULL, lang=NULL, spellCheck=NULL,
style=NULL, tabIndex=NULL, title=NULL, loading_state=NULL,
...)

Arguments

children

A list of or a singular dash component, string or number. The children of this component

id

Character. The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app.

n_clicks

Numeric. An integer that represents the number of times that this element has been clicked on.

n_clicks_timestamp

Numeric. An integer that represents the time (in ms since 1970) at which n_clicks changed. This can be used to tell which button was changed most recently.

key

Character. A unique identifier for the component, used to improve performance by React.js while rendering components See https://reactjs.org/docs/lists-and-keys.html for more info

role

Character. The ARIA role attribute

alt

Character. Alternative text in case an image can't be displayed.

coords

Character. A set of values specifying the coordinates of the hot-spot region.

download

Character. Indicates that the hyperlink is to be used for downloading a resource.

href

Character. The URL of a linked resource.

hrefLang

Character. Specifies the language of the linked resource.

media

Character. Specifies a hint of the media for which the linked resource was designed.

referrerPolicy

Character. Specifies which referrer is sent when fetching the resource.

rel

Character. Specifies the relationship of the target object to the link object.

shape

Character.

target

Character. Specifies where to open the linked document (in the case of an <a> element) or where to display the response received (in the case of a <form> element)

accessKey

Character. Keyboard shortcut to activate or add focus to the element.

className

Character. Often used with CSS to style elements with common properties.

contentEditable

Character. Indicates whether the element's content is editable.

contextMenu

Character. Defines the ID of a <menu> element which will serve as the element's context menu.

dir

Character. Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)

draggable

Character. Defines whether the element can be dragged.

hidden

A value equal to: 'hidden', 'hidden' | logical. Prevents rendering of given element, while keeping child elements, e.g. script elements, active.

lang

Character. Defines the language used in the element.

spellCheck

Character. Indicates whether spell checking is allowed for the element.

style

Named list. Defines CSS styles which will override styles previously set.

tabIndex

Character. Overrides the browser's default tab order and follows the one specified instead.

title

Character. Text to be displayed in a tooltip when hovering over the element.

loading_state

Lists containing elements 'is_loading', 'prop_name', 'component_name'. those elements have the following types: - is_loading (logical; optional): determines if the component is loading or not - prop_name (character; optional): holds which property is loading - component_name (character; optional): holds the name of the component that is loading. Object that holds the loading state object coming from dash-renderer

...

wildcards allowed have the form: `'data-*', 'aria-*'`

Value

named list of JSON elements corresponding to React.js properties and their values

Examples

# NOT RUN {
# The URL below has been chunked to comply with CRAN
# requirements; the use of file.path is optional and not required
# for this component.
if (interactive()) {
  library(dash)

  app$layout(
    htmlDiv(list(
      htmlImg(src = file.path('https://upload.wikimedia.org',
              'wikipedia/commons/0/0c',
              'PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg',
              fsep = '/'),
              useMap = '#image-map'),
      htmlMapEl(list(
        htmlArea(target='_blank',
                alt='Deimos',
                title='Deimos',
                href='https://en.wikipedia.org/wiki/Deimos_(moon)',
                coords='5,114,32,147',
                shape='rect'),
        htmlArea(target='_blank',
                alt='Phobos',
                title='Phobos',
                href='https://en.wikipedia.org/wiki/Phobos_(moon)',
                coords='113,196,32,103',
                shape='rect'),
        htmlArea(target='_blank',
                alt='Moon',
                title='Moon',
                href='https://en.wikipedia.org/wiki/Moon',
                coords='127,285,294,1',
                shape='rect')
        ),
        name = 'image-map'
      ),
      htmlDiv(children = 'Click on the image to visit a Wikipedia article',
              id = 'object-name')
      )
    )
  )

  app$run_server()
}
# }