@finos/perspective-viewer
    Preparing search index...

    Class HTMLPerspectiveViewerPluginElement

    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.

    class MyPlugin extends customElements.get("perspective-viewer-plugin") {
    // Custom plugin overrides
    }

    Hierarchy

    • HTMLElement
      • HTMLPerspectiveViewerPluginElement

    Implements

    Index

    Constructors

    Properties

    accessKey accessKeyLabel ariaAtomic ariaAutoComplete ariaBusy ariaChecked ariaColCount ariaColIndex ariaColSpan ariaCurrent ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText assignedSlot ATTRIBUTE_NODE attributes attributeStyleMap autocapitalize autofocus baseURI CDATA_SECTION_NODE childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth COMMENT_NODE contentEditable dataset dir DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE draggable ELEMENT_NODE enterKeyHint ENTITY_NODE ENTITY_REFERENCE_NODE firstChild firstElementChild hidden id inert innerHTML innerText inputMode isConnected isContentEditable lang lastChild lastElementChild localName namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue nonce? NOTATION_NODE offsetHeight offsetLeft offsetParent offsetTop offsetWidth onabort onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata onfullscreenchange onfullscreenerror ongotpointercapture oninput oninvalid onkeydown onkeypress onkeyup onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onprogress onratechange onreset onresize onscroll onscrollend onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel outerHTML outerText ownerDocument parentElement parentNode part popover prefix previousElementSibling previousSibling PROCESSING_INSTRUCTION_NODE role scrollHeight scrollLeft scrollTop scrollWidth shadowRoot slot spellcheck style tabIndex tagName TEXT_NODE textContent title translate

    Accessors

    Methods

    Constructors

    Properties

    accessKey: string
    accessKeyLabel: string
    ariaAtomic: null | string
    ariaAutoComplete: null | string
    ariaBusy: null | string
    ariaChecked: null | string
    ariaColCount: null | string
    ariaColIndex: null | string
    ariaColSpan: null | string
    ariaCurrent: null | string
    ariaDisabled: null | string
    ariaExpanded: null | string
    ariaHasPopup: null | string
    ariaHidden: null | string
    ariaInvalid: null | string
    ariaKeyShortcuts: null | string
    ariaLabel: null | string
    ariaLevel: null | string
    ariaLive: null | string
    ariaModal: null | string
    ariaMultiLine: null | string
    ariaMultiSelectable: null | string
    ariaOrientation: null | string
    ariaPlaceholder: null | string
    ariaPosInSet: null | string
    ariaPressed: null | string
    ariaReadOnly: null | string
    ariaRequired: null | string
    ariaRoleDescription: null | string
    ariaRowCount: null | string
    ariaRowIndex: null | string
    ariaRowSpan: null | string
    ariaSelected: null | string
    ariaSetSize: null | string
    ariaSort: null | string
    ariaValueMax: null | string
    ariaValueMin: null | string
    ariaValueNow: null | string
    ariaValueText: null | string
    assignedSlot: null | HTMLSlotElement
    ATTRIBUTE_NODE: 2
    attributes: NamedNodeMap
    attributeStyleMap: StylePropertyMap
    autocapitalize: string
    autofocus: boolean
    baseURI: string

    Returns node's node document's document base URL.

    MDN Reference

    CDATA_SECTION_NODE: 4

    node is a CDATASection node.

    childElementCount: number
    childNodes: NodeListOf<ChildNode>

    Returns the children.

    MDN Reference

    children: HTMLCollection

    Returns the child elements.

    MDN Reference

    classList: DOMTokenList

    Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

    MDN Reference

    className: string

    Returns the value of element's class content attribute. Can be set to change it.

    MDN Reference

    clientHeight: number
    clientLeft: number
    clientTop: number
    clientWidth: number
    COMMENT_NODE: 8

    node is a Comment node.

    contentEditable: string
    dataset: DOMStringMap
    dir: string
    DOCUMENT_FRAGMENT_NODE: 11

    node is a DocumentFragment node.

    DOCUMENT_NODE: 9

    node is a document.

    DOCUMENT_POSITION_CONTAINED_BY: 16

    Set when other is a descendant of node.

    DOCUMENT_POSITION_CONTAINS: 8

    Set when other is an ancestor of node.

    DOCUMENT_POSITION_DISCONNECTED: 1

    Set when node and other are not in the same tree.

    DOCUMENT_POSITION_FOLLOWING: 4

    Set when other is following node.

    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
    DOCUMENT_POSITION_PRECEDING: 2

    Set when other is preceding node.

    DOCUMENT_TYPE_NODE: 10

    node is a doctype.

    draggable: boolean
    ELEMENT_NODE: 1

    node is an element.

    enterKeyHint: string
    ENTITY_NODE: 6
    ENTITY_REFERENCE_NODE: 5
    firstChild: null | ChildNode

    Returns the first child.

    MDN Reference

    firstElementChild: null | Element

    Returns the first child that is an element, and null otherwise.

    MDN Reference

    hidden: boolean
    id: string

    Returns the value of element's id content attribute. Can be set to change it.

    MDN Reference

    inert: boolean
    innerHTML: string
    innerText: string
    inputMode: string
    isConnected: boolean

    Returns true if node is connected and false otherwise.

    MDN Reference

    isContentEditable: boolean
    lang: string
    lastChild: null | ChildNode

    Returns the last child.

    MDN Reference

    lastElementChild: null | Element

    Returns the last child that is an element, and null otherwise.

    MDN Reference

    localName: string

    Returns the local name.

    MDN Reference

    namespaceURI: null | string

    Returns the namespace.

    MDN Reference

    nextElementSibling: null | Element

    Returns the first following sibling that is an element, and null otherwise.

    MDN Reference

    nextSibling: null | ChildNode

    Returns the next sibling.

    MDN Reference

    nodeName: string

    Returns a string appropriate for the type of node.

    MDN Reference

    nodeType: number

    Returns the type of node.

    MDN Reference

    nodeValue: null | string
    nonce?: string
    NOTATION_NODE: 12
    offsetHeight: number
    offsetLeft: number
    offsetParent: null | Element
    offsetTop: number
    offsetWidth: number
    onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)

    Fires when the user aborts the download.

    The event.

    MDN Reference

    onanimationcancel:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
    onanimationend: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
    onanimationiteration:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
    onanimationstart:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
    onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
    onbeforeinput: null | ((this: GlobalEventHandlers, ev: InputEvent) => any)
    onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

    Fires when the object loses the input focus.

    The focus event.

    MDN Reference

    oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any)
    oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when playback is possible, but would require further buffering.

    The event.

    MDN Reference

    oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any)
    onchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Fires when the contents of the object or selection have changed.

    The event.

    MDN Reference

    onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user clicks the left mouse button on the object

    The mouse event.

    MDN Reference

    onclose: null | ((this: GlobalEventHandlers, ev: Event) => any)
    oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user clicks the right mouse button in the client area, opening the context menu.

    The mouse event.

    MDN Reference

    oncopy: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
    oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any)
    oncut: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
    ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user double-clicks the object.

    The mouse event.

    MDN Reference

    ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

    Fires on the source object continuously during a drag operation.

    The event.

    MDN Reference

    ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

    Fires on the source object when the user releases the mouse at the close of a drag operation.

    The event.

    MDN Reference

    ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

    Fires on the target element when the user drags the object to a valid drop target.

    The drag event.

    MDN Reference

    ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

    Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

    The drag event.

    MDN Reference

    ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

    Fires on the target element continuously while the user drags the object over a valid drop target.

    The event.

    MDN Reference

    ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

    Fires on the source object when the user starts to drag a text selection or selected object.

    The event.

    MDN Reference

    ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)
    ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the duration attribute is updated.

    The event.

    MDN Reference

    onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the media element is reset to its initial state.

    The event.

    MDN Reference

    onended: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the end of playback is reached.

    The event

    MDN Reference

    onerror: OnErrorEventHandler

    Fires when an error occurs during object loading.

    The event.

    MDN Reference

    onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

    Fires when the object receives focus.

    The event.

    MDN Reference

    onformdata: null | ((this: GlobalEventHandlers, ev: FormDataEvent) => any)
    onfullscreenchange: null | ((this: Element, ev: Event) => any)
    onfullscreenerror: null | ((this: Element, ev: Event) => any)
    ongotpointercapture:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    oninput: null | ((this: GlobalEventHandlers, ev: Event) => any)
    oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any)
    onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

    Fires when the user presses a key.

    The keyboard event

    MDN Reference

    onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

    Fires when the user presses an alphanumeric key.

    The event.

    MDN Reference

    onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

    Fires when the user releases a key.

    The keyboard event

    MDN Reference

    onload: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Fires immediately after the browser loads the object.

    The event.

    MDN Reference

    onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when media data is loaded at the current playback position.

    The event.

    MDN Reference

    onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the duration and dimensions of the media have been determined.

    The event.

    MDN Reference

    onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when Internet Explorer begins looking for media data.

    The event.

    MDN Reference

    onlostpointercapture:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user clicks the object with either mouse button.

    The mouse event.

    MDN Reference

    onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
    onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
    onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user moves the mouse over the object.

    The mouse event.

    MDN Reference

    onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user moves the mouse pointer outside the boundaries of the object.

    The mouse event.

    MDN Reference

    onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user moves the mouse pointer into the object.

    The mouse event.

    MDN Reference

    onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

    Fires when the user releases a mouse button while the mouse is over the object.

    The mouse event.

    MDN Reference

    onpaste: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
    onpause: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when playback is paused.

    The event.

    MDN Reference

    onplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the play method is requested.

    The event.

    MDN Reference

    onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the audio or video has started playing.

    The event.

    MDN Reference

    onpointercancel: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onpointerdown: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onpointerenter: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onpointerleave: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onpointermove: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onpointerover: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
    onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent) => any)

    Occurs to indicate progress while downloading media data.

    The event.

    MDN Reference

    onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the playback rate is increased or decreased.

    The event.

    MDN Reference

    onreset: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Fires when the user resets a form.

    The event.

    MDN Reference

    onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)
    onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Fires when the user repositions the scroll box in the scroll bar on the object.

    The event.

    MDN Reference

    onscrollend: null | ((this: GlobalEventHandlers, ev: Event) => any)
    onsecuritypolicyviolation:
        | null
        | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any)
    onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the seek operation ends.

    The event.

    MDN Reference

    onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the current playback position is moved.

    The event.

    MDN Reference

    onselect: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Fires when the current selection changes.

    The event.

    MDN Reference

    onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any)
    onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any)
    onslotchange: null | ((this: GlobalEventHandlers, ev: Event) => any)
    onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the download has stopped.

    The event.

    MDN Reference

    onsubmit: null | ((this: GlobalEventHandlers, ev: SubmitEvent) => any)
    onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs if the load operation has been intentionally halted.

    The event.

    MDN Reference

    ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs to indicate the current playback position.

    The event.

    MDN Reference

    ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any)
    ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
    ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
    ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
    ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
    ontransitioncancel:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
    ontransitionend:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
    ontransitionrun:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
    ontransitionstart:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
    onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when the volume is changed, or playback is muted or unmuted.

    The event.

    MDN Reference

    onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any)

    Occurs when playback stops because the next frame of a video resource is not available.

    The event.

    MDN Reference

    onwebkitanimationend: null | ((this: GlobalEventHandlers, ev: Event) => any)

    This is a legacy alias of onanimationend.

    MDN Reference

    onwebkitanimationiteration:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any)

    This is a legacy alias of onanimationiteration.

    MDN Reference

    onwebkitanimationstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

    This is a legacy alias of onanimationstart.

    MDN Reference

    onwebkittransitionend: null | ((this: GlobalEventHandlers, ev: Event) => any)

    This is a legacy alias of ontransitionend.

    MDN Reference

    onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any)
    outerHTML: string
    outerText: string
    ownerDocument: Document

    Returns the node document. Returns null for documents.

    MDN Reference

    parentElement: null | HTMLElement

    Returns the parent element.

    MDN Reference

    parentNode: null | ParentNode

    Returns the parent.

    MDN Reference

    part: DOMTokenList
    popover: null | string
    prefix: null | string

    Returns the namespace prefix.

    MDN Reference

    previousElementSibling: null | Element

    Returns the first preceding sibling that is an element, and null otherwise.

    MDN Reference

    previousSibling: null | ChildNode

    Returns the previous sibling.

    MDN Reference

    PROCESSING_INSTRUCTION_NODE: 7

    node is a ProcessingInstruction node.

    role: null | string
    scrollHeight: number
    scrollLeft: number
    scrollTop: number
    scrollWidth: number
    shadowRoot: null | ShadowRoot

    Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

    MDN Reference

    slot: string

    Returns the value of element's slot content attribute. Can be set to change it.

    MDN Reference

    spellcheck: boolean
    style: CSSStyleDeclaration
    tabIndex: number
    tagName: string

    Returns the HTML-uppercased qualified name.

    MDN Reference

    TEXT_NODE: 3

    node is a Text node.

    textContent: null | string
    title: string
    translate: boolean

    Accessors

    • get config_column_names(): undefined | string[]

      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.

      Returns undefined | string[]

    • get min_config_columns(): undefined | number

      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.

      Returns undefined | number

    • get name(): string

      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.

      Returns string

    • get priority(): number

      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.

      Returns number

    • get select_mode(): "toggle" | "select"

      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.

      Returns "toggle" | "select"

    Methods

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • type: K
      • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • 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.

      MDN Reference

      Parameters

      • ...nodes: (string | Node)[]

      Returns void

    • Parameters

      • keyframes: null | PropertyIndexedKeyframes | Keyframe[]
      • Optionaloptions: number | KeyframeAnimationOptions

      Returns Animation

    • 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.

      MDN Reference

      Parameters

      • ...nodes: (string | Node)[]

      Returns void

    • Type Parameters

      • T extends Node

      Parameters

      • node: T

      Returns T

    • Returns ElementInternals

    • Creates a shadow root for element and returns it.

      MDN Reference

      Parameters

      • init: ShadowRootInit

      Returns ShadowRoot

    • 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.

      MDN Reference

      Parameters

      • ...nodes: (string | Node)[]

      Returns void

    • Returns void

    • 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.

      Returns boolean

    • Parameters

      • Optionaloptions: CheckVisibilityOptions

      Returns boolean

    • Clear this plugin, though it is up to the discretion of the plugin author to determine what this means. Defaults to resetting this element's innerHTML, so be sure to override if you want custom behavior.

      Returns Promise<void>

      async clear(): Promise<void> {
      this.innerHTML = "";
      }
    • Returns void

    • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

      MDN Reference

      Parameters

      • Optionaldeep: boolean

      Returns Node

    • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

      MDN Reference

      Type Parameters

      • K extends keyof HTMLElementTagNameMap

      Parameters

      • selector: K

      Returns null | HTMLElementTagNameMap[K]

    • Type Parameters

      • K extends keyof SVGElementTagNameMap

      Parameters

      • selector: K

      Returns null | SVGElementTagNameMap[K]

    • Type Parameters

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • selector: K

      Returns null | MathMLElementTagNameMap[K]

    • Type Parameters

      • E extends Element = Element

      Parameters

      • selectors: string

      Returns null | E

    • Returns a bitmask indicating the position of other relative to node.

      MDN Reference

      Parameters

      • other: Node

      Returns number

    • Returns StylePropertyMapReadOnly

    • Returns true if other is an inclusive descendant of node, and false otherwise.

      MDN Reference

      Parameters

      • other: null | Node

      Returns boolean

    • 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.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • 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.

      Parameters

      • view: View

      Returns Promise<void>

      async draw(view: perspective.View): Promise<void> {
      const csv = await view.to_csv();
      this.innerHTML = `<pre>${csv}</pre>`;
      }
    • Parameters

      • Optionaloptions: FocusOptions

      Returns void

    • Parameters

      • Optionaloptions: GetAnimationsOptions

      Returns Animation[]

    • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns null | string

    • Returns the qualified names of all element's attributes. Can contain duplicates.

      MDN Reference

      Returns string[]

    • Parameters

      • qualifiedName: string

      Returns null | Attr

    • Parameters

      • namespace: null | string
      • localName: string

      Returns null | Attr

    • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

      MDN Reference

      Parameters

      • namespace: null | string
      • localName: string

      Returns null | string

    • Returns DOMRect

    • Returns DOMRectList

    • 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.

      MDN Reference

      Parameters

      • classNames: string

      Returns HTMLCollectionOf<Element>

    • Type Parameters

      • K extends keyof HTMLElementTagNameMap

      Parameters

      • qualifiedName: K

      Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof SVGElementTagNameMap

      Parameters

      • qualifiedName: K

      Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • qualifiedName: K

      Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof HTMLElementDeprecatedTagNameMap

      Parameters

      • qualifiedName: K

      Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    • Parameters

      • qualifiedName: string

      Returns HTMLCollectionOf<Element>

    • Parameters

      • namespaceURI: "http://www.w3.org/1999/xhtml"
      • localName: string

      Returns HTMLCollectionOf<HTMLElement>

    • Parameters

      • namespaceURI: "http://www.w3.org/2000/svg"
      • localName: string

      Returns HTMLCollectionOf<SVGElement>

    • Parameters

      • namespaceURI: "http://www.w3.org/1998/Math/MathML"
      • localName: string

      Returns HTMLCollectionOf<MathMLElement>

    • Parameters

      • namespace: null | string
      • localName: string

      Returns HTMLCollectionOf<Element>

    • Returns node's root.

      MDN Reference

      Parameters

      • Optionaloptions: GetRootNodeOptions

      Returns Node

    • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns boolean

    • Returns true if element has an attribute whose namespace is namespace and local name is localName.

      MDN Reference

      Parameters

      • namespace: null | string
      • localName: string

      Returns boolean

    • Returns true if element has attributes, and false otherwise.

      MDN Reference

      Returns boolean

    • Returns whether node has children.

      MDN Reference

      Returns boolean

    • Parameters

      • pointerId: number

      Returns boolean

    • Returns void

    • Parameters

      • where: InsertPosition
      • element: Element

      Returns null | Element

    • Parameters

      • position: InsertPosition
      • text: string

      Returns void

    • Parameters

      • where: InsertPosition
      • data: string

      Returns void

    • Type Parameters

      • T extends Node

      Parameters

      • node: T
      • child: null | Node

      Returns T

    • Parameters

      • namespace: null | string

      Returns boolean

    • Returns whether node and otherNode have the same properties.

      MDN Reference

      Parameters

      • otherNode: null | Node

      Returns boolean

    • Parameters

      • otherNode: null | Node

      Returns boolean

    • Parameters

      • prefix: null | string

      Returns null | string

    • Parameters

      • namespace: null | string

      Returns null | string

    • Returns true if matching selectors against element's root yields element, and false otherwise.

      MDN Reference

      Parameters

      • selectors: string

      Returns boolean

    • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

      MDN Reference

      Returns void

    • 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.

      MDN Reference

      Parameters

      • ...nodes: (string | Node)[]

      Returns void

    • Returns the first element that is a descendant of node that matches selectors.

      MDN Reference

      Type Parameters

      • K extends keyof HTMLElementTagNameMap

      Parameters

      • selectors: K

      Returns null | HTMLElementTagNameMap[K]

    • Type Parameters

      • K extends keyof SVGElementTagNameMap

      Parameters

      • selectors: K

      Returns null | SVGElementTagNameMap[K]

    • Type Parameters

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • selectors: K

      Returns null | MathMLElementTagNameMap[K]

    • Type Parameters

      • K extends keyof HTMLElementDeprecatedTagNameMap

      Parameters

      • selectors: K

      Returns null | HTMLElementDeprecatedTagNameMap[K]

    • Type Parameters

      • E extends Element = Element

      Parameters

      • selectors: string

      Returns null | E

    • Returns all element descendants of node that match selectors.

      MDN Reference

      Type Parameters

      • K extends keyof HTMLElementTagNameMap

      Parameters

      • selectors: K

      Returns NodeListOf<HTMLElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof SVGElementTagNameMap

      Parameters

      • selectors: K

      Returns NodeListOf<SVGElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof MathMLElementTagNameMap

      Parameters

      • selectors: K

      Returns NodeListOf<MathMLElementTagNameMap[K]>

    • Type Parameters

      • K extends keyof HTMLElementDeprecatedTagNameMap

      Parameters

      • selectors: K

      Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    • Type Parameters

      • E extends Element = Element

      Parameters

      • selectors: string

      Returns NodeListOf<E>

    • Parameters

      • pointerId: number

      Returns void

    • Removes node.

      MDN Reference

      Returns void

    • Removes element's first attribute whose qualified name is qualifiedName.

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns void

    • Parameters

      • attr: Attr

      Returns Attr

    • Removes element's attribute whose namespace is namespace and local name is localName.

      MDN Reference

      Parameters

      • namespace: null | string
      • localName: string

      Returns void

    • Type Parameters

      • T extends Node

      Parameters

      • child: T

      Returns T

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • type: K
      • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Type Parameters

      • T extends Node

      Parameters

      • node: Node
      • child: T

      Returns T

    • 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.

      MDN Reference

      Parameters

      • ...nodes: (string | Node)[]

      Returns void

    • 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.

      MDN Reference

      Parameters

      • ...nodes: (string | Node)[]

      Returns void

    • 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.

      MDN Reference

      Parameters

      • Optionaloptions: FullscreenOptions

      Returns Promise<void>

    • Returns void

    • 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.

      Returns Promise<any>

    • Parameters

      • Optionaloptions: ScrollToOptions

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Parameters

      • Optionaloptions: ScrollToOptions

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Parameters

      • Optionalarg: boolean | ScrollIntoViewOptions

      Returns void

    • Parameters

      • Optionaloptions: ScrollToOptions

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

      MDN Reference

      Parameters

      • qualifiedName: string
      • value: string

      Returns void

    • Parameters

      • attr: Attr

      Returns null | Attr

    • Parameters

      • attr: Attr

      Returns null | Attr

    • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

      MDN Reference

      Parameters

      • namespace: null | string
      • qualifiedName: string
      • value: string

      Returns void

    • Parameters

      • pointerId: number

      Returns void

    • Returns void

    • 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.

      MDN Reference

      Parameters

      • qualifiedName: string
      • Optionalforce: boolean

      Returns boolean

    • Parameters

      • Optionalforce: boolean

      Returns void

    • Draw under the assumption that the ViewConfig has not changed since the previous call to draw(), but the underlying data has. Defaults to dispatch to draw().

      Parameters

      • view: View

      Returns Promise<void>

      async update(view: perspective.View): Promise<void> {
      return this.draw(view);
      }
    • Parameters

      • selectors: string

      Returns boolean

      This is a legacy alias of matches.

      MDN Reference