Extends
Members
(static) selector :string
- Source:
Type:
- string
(readonly) downloadButtonHtml :Element
- Source:
- Inherited From:
Returns a HTML document fragment for a download button.
Type:
- Element
(readonly) originalInputValue :*
- Source:
- Overrides:
Obtains the value from the original form control the widget is instantiated on. This form control is often hidden by the widget.
Type:
- *
(readonly) props :object
- Source:
- Inherited From:
Returns widget properties. May need to be extended.
Type:
- object
(readonly) resetButtonHtml :Element
- Source:
- Inherited From:
Returns a HTML document fragment for a reset button.
Type:
- Element
value :string
- Source:
- Overrides:
Type:
- string
Methods
_addFunctionality(widget)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
widget |
object | the widget element |
_addMarkup(img) → {Promise}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
img |
Element | the image element |
Returns:
the widget element
- Type
- Promise
_getInput(id) → {Element}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
id |
string | the option ID |
Returns:
input element with matching ID
- Type
- Element
_getProps() → {object}
- Source:
- Inherited From:
Not meant to be overridden, but could be. Recommend to extend get props()
instead.
Returns:
props object
- Type
- object
_init()
- Source:
- Overrides:
Meant to be overridden, but automatically called.
_isSvgDoc(data) → {boolean}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
data |
object | an object |
Returns:
whether provided object is an SVG document
- Type
- boolean
_removeUnmatchedIds(svg) → {Element}
- Source:
Removes id attributes from unmatched path elements in order to prevent hover effect (and click listener).
Parameters:
Name | Type | Description |
---|---|---|
svg |
Element | SVG element |
Returns:
cleaned up SVG
- Type
- Element
_setChangeHandler()
- Source:
Handles change listener
_setHoverHandler()
- Source:
Handles hover listener
_setPageHandler()
- Source:
Handles page flip of page in which the widget is placed.
_setSvgClickHandler()
- Source:
Handles SVG click listener
_showSvgNotFoundError(err)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
err |
Error | error message |
_updateImage()
- Source:
Updates 'selected' attributes in SVG Always update the map after the value has changed in the original input elements
disable()
- Source:
- Overrides:
Disables widget
enable()
- Source:
- Overrides:
Enables widget
update()
- Source:
- Overrides:
Updates widget image