Readonly
accessReadonly
assignedReadonly
ATTRIBUTE_Readonly
attributesReadonly
attributeReadonly
baseReturns node's node document's document base URL.
Readonly
CDATA_node is a CDATASection node.
Readonly
childReadonly
childReturns the children.
Readonly
childrenReturns the child elements.
Readonly
classAllows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Returns the value of element's class content attribute. Can be set to change it.
Readonly
clientReadonly
clientReadonly
clientReadonly
clientReadonly
COMMENT_node is a Comment node.
Readonly
datasetReadonly
DOCUMENT_node is a DocumentFragment node.
Readonly
DOCUMENT_node is a document.
Readonly
DOCUMENT_Set when other is a descendant of node.
Readonly
DOCUMENT_Set when other is an ancestor of node.
Readonly
DOCUMENT_Set when node and other are not in the same tree.
Readonly
DOCUMENT_Set when other is following node.
Readonly
DOCUMENT_Readonly
DOCUMENT_Set when other is preceding node.
Readonly
DOCUMENT_node is a doctype.
Readonly
ELEMENT_node is an element.
Readonly
ENTITY_Readonly
ENTITY_Readonly
firstReturns the first child.
Readonly
firstReturns the first child that is an element, and null otherwise.
Returns the value of element's id content attribute. Can be set to change it.
Readonly
isReturns true if node is connected and false otherwise.
Readonly
isReadonly
lastReturns the last child.
Readonly
lastReturns the last child that is an element, and null otherwise.
Readonly
localReturns the local name.
Readonly
namespaceReturns the namespace.
Readonly
nextReturns the first following sibling that is an element, and null otherwise.
Readonly
nextReturns the next sibling.
Readonly
nodeReturns a string appropriate for the type of node.
Readonly
nodeReturns the type of node.
Optional
nonceReadonly
NOTATION_Readonly
offsetReadonly
offsetReadonly
offsetReadonly
offsetReadonly
offsetFires when the user aborts the download.
Fires when the object loses the input focus.
Occurs when playback is possible, but would require further buffering.
Fires when the contents of the object or selection have changed.
Fires when the user clicks the left mouse button on the object
Fires when the user clicks the right mouse button in the client area, opening the context menu.
Fires when the user double-clicks the object.
Fires on the source object continuously during a drag operation.
Fires on the source object when the user releases the mouse at the close of a drag operation.
Fires on the target element when the user drags the object to a valid drop target.
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Fires on the target element continuously while the user drags the object over a valid drop target.
Fires on the source object when the user starts to drag a text selection or selected object.
Occurs when the duration attribute is updated.
Occurs when the media element is reset to its initial state.
Occurs when the end of playback is reached.
Fires when an error occurs during object loading.
Fires when the object receives focus.
Fires when the user presses a key.
Fires when the user presses an alphanumeric key.
Fires when the user releases a key.
Fires immediately after the browser loads the object.
Occurs when media data is loaded at the current playback position.
Occurs when the duration and dimensions of the media have been determined.
Occurs when Internet Explorer begins looking for media data.
Fires when the user clicks the object with either mouse button.
Fires when the user moves the mouse over the object.
Fires when the user moves the mouse pointer outside the boundaries of the object.
Fires when the user moves the mouse pointer into the object.
Fires when the user releases a mouse button while the mouse is over the object.
Occurs when playback is paused.
Occurs when the play method is requested.
Occurs when the audio or video has started playing.
Occurs to indicate progress while downloading media data.
Occurs when the playback rate is increased or decreased.
Fires when the user resets a form.
Fires when the user repositions the scroll box in the scroll bar on the object.
Occurs when the seek operation ends.
Occurs when the current playback position is moved.
Fires when the current selection changes.
Occurs when the download has stopped.
Occurs if the load operation has been intentionally halted.
Occurs to indicate the current playback position.
Optional
ontouchcancelOptional
ontouchendOptional
ontouchmoveOptional
ontouchstartOccurs when the volume is changed, or playback is muted or unmuted.
Occurs when playback stops because the next frame of a video resource is not available.
Readonly
ownerReturns the node document. Returns null for documents.
Readonly
parentReturns the parent element.
Readonly
parentReturns the parent.
Readonly
partReadonly
prefixReturns the namespace prefix.
Readonly
previousReturns the first preceding sibling that is an element, and null otherwise.
Readonly
previousReturns the previous sibling.
Readonly
PROCESSING_node is a ProcessingInstruction node.
Readonly
scrollReadonly
scrollReadonly
shadowReturns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Returns the value of element's slot content attribute. Can be set to change it.
Readonly
styleReadonly
tagReturns the HTML-uppercased qualified name.
Readonly
TEXT_node is a Text node.
The named column labels, if desired. Named columns behave differently
in drag/drop mode than unnamed columns, having replace/swap behavior
rather than insert. If provided, the length of config_column_names
must be >= min_config_columns
, as this is assumed by the drag/drop
logic.
The minimum number of columns required for this plugin to operate. This mostly affects drag/drop and column remove button behavior, preventing the use from applying configs which violate this min.
While this option can technically be undefined
(as in the case of
@finos/perspective-viewer-datagrid
), doing so currently has nearly
identical behavior to 1.
The name for this plugin, which is used as both it's unique key for use
as a parameter for the plugin
field of a ViewerConfig
, and as the
display name for this plugin in the <perspective-viewer>
UI.
The load priority of the plugin. If the plugin shares priority with another, the first to load has a higher priority.
A larger number has a higher priority.
The plugin with the highest priority will be loaded by default by the Perspective viewer.
If you would like to instead begin with a lower priority plugin, choose it explicitly with
a HTMLPerspectiveViewerPluginElement.restore
call.
Select mode determines how column add/remove buttons behave for this
plugin. "select"
mode exclusively selects the added column, removing
other columns. "toggle"
mode toggles the column on or off (dependent
on column state), leaving existing columns alone.
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Creates a shadow root for element and returns it.
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Given a column's grouping (determined by indexing it in plugin.config_column_names
)
and its view type, determines whether or not to render column styles in the settings sidebar.
Implementing this function and column_style_config
allows the plugin to interface with the viewer's column configuration API.
Optional
options: CheckVisibilityOptionsReturns a copy of node. If deep is true, the copy also includes the node's descendants.
Optional
deep: booleanDetermines which column configuration controls are populated in the viewer.
Corresponds to the data the plugin will recieve on save.
Implementing this function and can_render_column_styles
allows the plugin to interface with the viewer's column configuration API.
Returns a bitmask indicating the position of other relative to node.
Returns true if other is an inclusive descendant of node, and false otherwise.
Free any resources acquired by this plugin and prepare to be deleted.
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Render this plugin using the provided View
. While there is no
provision to cancel a render in progress per se, calling a method on
a View
which has been deleted will throw an exception.
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.
Returns the qualified names of all element's attributes. Can contain duplicates.
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Returns true if element has an attribute whose namespace is namespace and local name is localName.
Returns true if element has attributes, and false otherwise.
Returns whether node has children.
Returns whether node and otherNode have the same properties.
Returns true if matching selectors against element's root yields element, and false otherwise.
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Removes node.
Removes element's first attribute whose qualified name is qualifiedName.
Removes element's attribute whose namespace is namespace and local name is localName.
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Displays element fullscreen and resolves promise when done.
When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.
Optional
options: FullscreenOptionsLike update()
, but for when the dimensions of the plugin have changed
and the underlying data has not.
Restore this plugin to a state previously returned by save()
.
Notify the plugin that the style environment has changed. Useful for
plugins which read CSS styles via window.getComputedStyle()
.
Save this plugin's state to a JSON-serializable value. While this value
can be anything, it should work reciprocally with restore()
to return
this plugin's renderer to the same state, though potentially with a
different View
.
save()
should be used for user-persistent settings that are
data-agnostic, so the user can have persistent view during refresh or
reload. For example, @finos/perspective-viewer-d3fc
uses
plugin_config
to remember the user-repositionable legend coordinates.
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.
Returns true if qualifiedName is now present, and false otherwise.
Optional
force: boolean
The
<perspective-viewer-plugin>
element, the default perspective plugin which is registered and activated automcatically when a<perspective-viewer>
is loaded without plugins. While you will not typically instantiate this class directly, it is simple enough to function as a good "default" plugin implementation which can be extended to create custom plugins.Example
No Inherit Doc