Class VirtualNode

constructor

• new VirtualNode(): VirtualNode

• Returns VirtualNode

[ELEMENT_SYMBOL]

childNodes

classList

containingSlot

dataset

ownerShadowRoot

parentIndex

parentNode

slotIndex

slotNodes

Static isElement

$$

• get $$(): null | GeneralBackendElement

• Returns null | GeneralBackendElement

attributes

• get attributes(): {
      name: string;
      value: unknown;
  }[]

• Returns {
      name: string;
      value: unknown;
  }[]

class

• get class(): string

• Returns string

• set class(classNames): void

• Parameters

  • classNames: string

  Returns void

id

• get id(): string

• Returns string

• set id(x): void

• Parameters

  • x: unknown

  Returns void

slot

• get slot(): string

• Returns string

• set slot(x): void

• Parameters

  • x: string

  Returns void

style

• get style(): string

• Returns string

• set style(styleText): void

• Parameters

  • styleText: string

  Returns void

addListener

• addListener(name, func, options?): void

• Add an event listener on the element

  Parameters

  • name: string
  • func: EventListener<unknown>
  • Optional options: EventListenerOptions

  Returns void

appendChild

• appendChild(child): void

• Parameters

  • child: Node

  Returns void

asElement

• asElement(): glassEasel.Element

• Cast a node to an element (native node, virtual node, or component node)

  Returns null if the element is not a text node.

  Returns glassEasel.Element

asGeneralComponent

• asGeneralComponent(): null | glassEasel.GeneralComponent

• Cast an element to a general component

  Returns null if the element is not a component

  Returns null | glassEasel.GeneralComponent

asInstanceOf

• asInstanceOf<UData, UProperty, UMethod>(componentDefinition): null | ComponentInstance<UData, UProperty, UMethod, Empty>

• Cast an element to the instance of the specified component

  Returns null if the element is not the instance of the specified component.

  Type Parameters

  • UData extends DataList
  • UProperty extends PropertyList
  • UMethod extends MethodList

  Parameters

  • componentDefinition: glassEasel.ComponentDefinition<UData, UProperty, UMethod>

  Returns null | ComponentInstance<UData, UProperty, UMethod, Empty>

asNativeNode

• asNativeNode(): null | NativeNode

• Cast an element to a native node

  Returns null if the element is not a native node.

  Returns null | NativeNode

asShadowRoot

• asShadowRoot(): null | ShadowRoot

• Cast an element to a shadow root

  Returns null if the element is not a shadow root.

  Returns null | ShadowRoot

asTextNode

• asTextNode(): null

• Cast a node to a text node

  Returns null if the element is not a text node.

  Returns null

asVirtualNode

• asVirtualNode(): null | VirtualNode

• Cast an element to a virtual node

  Returns null if the element is not a virtual node.

  Returns null | VirtualNode

cancelDestroyBackendElementOnDetach

• cancelDestroyBackendElementOnDetach(): void

• Cancel the destroy scheduling of the backend element

  Returns void

  Deprecated

  Use cancelDestroyBackendElementOnRemoval instead.

cancelDestroyBackendElementOnRemoval

• cancelDestroyBackendElementOnRemoval(): void

• Cancel the destroy scheduling of the backend element

  Returns void

collectMarks

• collectMarks(): {
      [name: string]: unknown;
  }

• Collect the marks on the element

  The marks includes the marks on ancestors (in shadow tree) of the element. If multiple marks on different elements shares the same name, the mark value on the child-most element is accepted.

  Returns {
      [name: string]: unknown;
  }

  • [name: string]: unknown

createIntersectionObserver

• createIntersectionObserver(relativeElement, relativeElementMargin, thresholds, listener): null | Observer

• Create an intersection observer

  The relativeElement is the element to calculate intersection with ( null for the viewport). The relativeElementMargin is the margins of the relativeElement . The thresholds is a list of intersection ratios to trigger the listener . The listener always triggers once immediately after this call.

  Parameters

  • relativeElement: null | glassEasel.Element
  • relativeElementMargin: string
  • thresholds: number[]
  • listener: null | ((res) => void)

  Returns null | Observer

destroyBackendElement

• destroyBackendElement(): void

• Destroy the backend element

  It only destroy the backend element of the element itself.

  Returns void

destroyBackendElementOnDetach

• destroyBackendElementOnDetach(): void

• Destroy the backend element when removed from any parent element

  Returns void

  Deprecated

  Use destroyBackendElementOnRemoval instead.

destroyBackendElementOnRemoval

• destroyBackendElementOnRemoval(): void

• Destroy the backend element when removed from any parent element

  Returns void

destroyBackendElementOnSubtree

• destroyBackendElementOnSubtree(): void

• Destroy backend element for the whole subtree.

  It will destroy backend elements for the whole subtree (shadow tree) recursively. If a backend element for a component is destroyed, any backend element in the shadow tree of the component will also be destroyed.

  Returns void

dispatchEvent

• dispatchEvent(ev): void

• Trigger an event with specified event object on the element

  Parameters

  • ev: Event<unknown>

  Returns void

forEachComposedChild

• forEachComposedChild(f): boolean

• Iterate composed child nodes (including virtual nodes)

  if f returns false then the iteration is interrupted. Returns true if that happens.

  Parameters

  • f: ((node) => boolean | void)
    • • (node): boolean | void

      • Parameters

        • node: Node

        Returns boolean | void

  Returns boolean

forEachNonVirtualComposedChild

• forEachNonVirtualComposedChild(f): boolean

• Iterate non-virtual composed child nodes

  if f returns false then the iteration is interrupted. Returns true if that happens.

  Parameters

  • f: ((node) => boolean | void)
    • • (node): boolean | void

      • Parameters

        • node: Node

        Returns boolean | void

  Returns boolean

getAttribute

• getAttribute(name): unknown

• Get an attribute value ( null if not set or removed)

  Parameters

  • name: string

  Returns unknown

getBackendContext

• getBackendContext(): null | GeneralBackendContext

• Get the backend context

  Returns null | GeneralBackendContext

getBackendElement

• getBackendElement(): null | GeneralBackendElement

• Get the backend element

  Returns null | GeneralBackendElement

getBackendMode

• getBackendMode(): glassEasel.BackendMode

• Get the backend mode

  Returns glassEasel.BackendMode

getBoundingClientRect

• getBoundingClientRect(cb): void

• Get the bounding client rect

  Return zero values when the backend element is invalid or it does not have layout information.

  Parameters

  • cb: ((res) => void)
    • • (res): void

      • Parameters

        • res: glassEasel.BoundingClientRect

        Returns void

  Returns void

getComposedChildren

• getComposedChildren(): Node[]

• Get the composed children

  This method always returns a new array. It is convenient but less performant. For better performance, consider using forEachComposedChild .

  Returns Node[]

getComposedParent

• getComposedParent(): null | glassEasel.Element

• Get composed parent (including virtual nodes)

  Returns null | glassEasel.Element

getContext

• getContext(cb): void

• Get an interactive context

  Parameters

  • cb: ((res) => void)
    • • (res): void

      • Parameters

        • res: unknown

        Returns void

  Returns void

getListeners

• getListeners(): Record<string, (EventListenerOptions & {
      listener: EventListener<unknown>;
  })[]>

• Returns Record<string, (EventListenerOptions & {
      listener: EventListener<unknown>;
  })[]>

getNodeStyleSegments

• getNodeStyleSegments(): string[]

• Returns string[]

getScrollOffset

• getScrollOffset(cb): void

• Get the bounding client rect

  Return zero values when the backend element is invalid or it does not have layout information.

  Parameters

  • cb: ((res) => void)
    • • (res): void

      • Parameters

        • res: glassEasel.ScrollOffset

        Returns void

  Returns void

insertBefore

• insertBefore(child, before?): void

• Parameters

  • child: Node
  • Optional before: Node

  Returns void

insertChildAt

• insertChildAt(child, index): void

• Parameters

  • child: Node
  • index: number

  Returns void

insertChildren

• insertChildren(children, index): void

• Parameters

  • children: Node[]
  • index: number

  Returns void

isInheritSlots

• isInheritSlots(): boolean

• Get whether the slot-inherit mode is set or not

  Returns boolean

isVirtual

• isVirtual(): boolean

• Get whether the node is virtual or not

  Returns boolean

iterateComposedChild

• iterateComposedChild(): Generator<Node, void, void>

• Iterate composed child nodes (including virtual nodes)

  if f returns false then the iteration is interrupted. Returns true if that happens.

  Returns Generator<Node, void, void>

matchSelector

• matchSelector(selectorStr, target): boolean

• Test whether the target in this subtree matches the selector

  Parameters

  • selectorStr: string | ParsedSelector
  • target: glassEasel.Element

  Returns boolean

querySelector

• querySelector(selectorStr): null | glassEasel.Element

• Select the first descendant which matches the selector

  Parameters

  • selectorStr: string | ParsedSelector

  Returns null | glassEasel.Element

querySelectorAll

• querySelectorAll(selectorStr): glassEasel.Element[]

• Select all descendants which matches the selector

  Parameters

  • selectorStr: string | ParsedSelector

  Returns glassEasel.Element[]

removeAttribute

• removeAttribute(name): void

• Remove an attribute

  Parameters

  • name: string

  Returns void

removeChild

• removeChild(child): void

• Parameters

  • child: Node

  Returns void

removeChildAt

• removeChildAt(index): void

• Parameters

  • index: number

  Returns void

removeChildren

• removeChildren(index, count): void

• Parameters

  • index: number
  • count: number

  Returns void

removeListener

• removeListener(name, func, options?): void

• Remove an event listener on the element

  Parameters

  • name: string
  • func: EventListener<unknown>
  • Optional options: EventListenerOptions

  Returns void

replaceChild

• replaceChild(child, relChild): void

• Parameters

  • child: Node
  • relChild: Node

  Returns void

replaceChildAt

• replaceChildAt(child, index): void

• Parameters

  • child: Node
  • index: number

  Returns void

selfReplaceWith

• selfReplaceWith(replaceWith): void

• Parameters

  • replaceWith: glassEasel.Element

  Returns void

setAttribute

• setAttribute(name, value): void

• Set an attribute value

  Parameters

  • name: string
  • value: unknown

  Returns void

setDataset

• setDataset(name, value): void

• Set a dataset on the element

  Parameters

  • name: string
  • value: unknown

  Returns void

setMark

• setMark(name, value): void

• Set a mark on the element

  Parameters

  • name: string
  • value: unknown

  Returns void

setNodeClass

• setNodeClass(classNames, index?): void

• Set the node class

  Although this method accepts string[], it contains a deprecated behavior (see setNodeClassList).

  Parameters

  • classNames: string
  • Optional index: StyleSegmentIndex

  Returns void
• setNodeClass(classNames, index?): void

• Parameters

  • classNames: string[]
  • Optional index: StyleSegmentIndex

  Returns void

  Deprecated

setNodeClassList

• setNodeClassList(classNames, index?): void

• Toggle the node class

  Parameters

  • classNames: string[]
  • Optional index: StyleSegmentIndex

  Returns void

setNodeStyle

• setNodeStyle(styleSegment, index?): void

• Set the node style

  Parameters

  • styleSegment: string
  • Optional index: StyleSegmentIndex

  Returns void

toggleNodeClass

• toggleNodeClass(classNames, force?, index?): void

• Toggle the node class

  Parameters

  • classNames: string
  • Optional force: boolean
  • Optional index: StyleSegmentIndex

  Returns void

triggerEvent

• triggerEvent(name, detail?, options?): void

• Trigger an event on the element

  Parameters

  • name: string
  • Optional detail: unknown
  • Optional options: EventOptions

  Returns void

updateAttribute

• updateAttribute(name, value): void

• Update an attribute value

  Parameters

  • name: string
  • value: unknown

  Returns void

Static _$spliceSlotNodes

• _$spliceSlotNodes(slot, before, deleteCount, insertion): void

• Parameters

  • slot: glassEasel.Element
  • before: number
  • deleteCount: number
  • insertion: undefined | Node[]

  Returns void

Static _$updateContainingSlot

• _$updateContainingSlot(node, containingSlot): void

• Parameters

  • node: Node
  • containingSlot: undefined | null | glassEasel.Element

  Returns void

Static forEachNodeInSlot

• forEachNodeInSlot(node, f): boolean

• Iterate elements with their slots (slots-inherited nodes included)

  Parameters

  • node: Node
  • f: ((node, slot) => boolean | void)
    • • (node, slot): boolean | void

      • Parameters

        • node: Node
        • slot: undefined | null | glassEasel.Element

        Returns boolean | void

  Returns boolean

Static forEachNodeInSpecificSlot

• forEachNodeInSpecificSlot(node, slot, f): boolean

• Iterate elements in specified slot (slots-inherited nodes included)

  Parameters

  • node: Node
  • slot: undefined | null | glassEasel.Element
  • f: ((node) => boolean | void)
    • • (node): boolean | void

      • Parameters

        • node: Node

        Returns boolean | void

  Returns boolean

Static forEachSlotContentInSlot

• forEachSlotContentInSlot(node, f): boolean

• Iterate elements with their slots (slots-inherited nodes NOT included)

  Parameters

  • node: Node
  • f: ((node, slot) => boolean | void)
    • • (node, slot): boolean | void

      • Parameters

        • node: Node
        • slot: undefined | null | glassEasel.Element

        Returns boolean | void

  Returns boolean

Static forEachSlotContentInSpecificSlot

• forEachSlotContentInSpecificSlot(node, slot, f): boolean

• Iterate elements in specified slot (slots-inherited nodes NOT included)

  Parameters

  • node: Node
  • slot: undefined | null | glassEasel.Element
  • f: ((node) => boolean | void)
    • • (node): boolean | void

      • Parameters

        • node: Node

        Returns boolean | void

  Returns boolean

Static getInheritSlots

• getInheritSlots(element): boolean

• Get whether the slot-inherit mode is set or not

  Parameters

  • element: glassEasel.Element

  Returns boolean

Static getSlotElement

• getSlotElement(node): null | glassEasel.Element

• Get the binding slot of specific node

  Parameters

  • node: Node

  Returns null | glassEasel.Element

Static getSlotName

• getSlotName(element): undefined | string

• Get the slot name of the element

  Parameters

  • element: glassEasel.Element

  Returns undefined | string

Static hasSubtreeMutationObservers

• hasSubtreeMutationObservers(node): boolean

• Get whether a node has any subtree MutationObserver attached to it

  If there is, then tree update may have more performance impact.

  Parameters

  • node: glassEasel.Element

  Returns boolean

Static insertChildReassign

• insertChildReassign(shadowParent, child, oldSlot, newSlot, ideaPosIndex): void

• Parameters

  • shadowParent: glassEasel.Element
  • child: Node
  • oldSlot: null | glassEasel.Element
  • newSlot: null | glassEasel.Element
  • ideaPosIndex: number

  Returns void

Static isAttached

• isAttached(element): boolean

• Check the element is attached or not

  Parameters

  • element: glassEasel.Element

  Returns boolean

Static matchSelector

• matchSelector(selectorStr, target): boolean

• Test whether the target matches the selector

  Parameters

  • selectorStr: string | ParsedSelector
  • target: glassEasel.Element

  Returns boolean

Static parseSelector

• parseSelector(str): ParsedSelector

• Parse a selector string so that it can be used multiple queries

  Parameters

  • str: string

  Returns ParsedSelector

Static pretendAttached

• pretendAttached(element): void

• Make the element looks like attached.

  If the element will never be attached to backend or it has no backend element at all, this can be used to trigger attached life-time.

  Parameters

  • element: glassEasel.Element

  Returns void

Static pretendDetached

• pretendDetached(element): void

• Make the element looks like detached.

  This can be used to trigger detached life-time without remove the element in the backend.

  Parameters

  • element: glassEasel.Element

  Returns void

Static replaceDocumentElement

• replaceDocumentElement(element, targetParent, targetNode): void

• Attach the element into the backend, swapping out a placeholder element in the backend.

  The element must not be a child node of another element, must not be attached before, and must not have a ownerShadowRoot . The element targetParent and targetNode must be in the same backend context. The element replaces the targetNode in the targetParent .

  Parameters

  • element: glassEasel.Element
  • targetParent: GeneralBackendElement
  • targetNode: GeneralBackendElement

  Returns void

Static setInheritSlots

• setInheritSlots(element): void

• Set the virtual node to slot-inherit mode

  In slot-inherit mode of an element, the child nodes of the element will be treated as siblings and can have different target slot.

  Parameters

  • element: glassEasel.Element

  Returns void

Static setSlotElement

• setSlotElement(node, slot): void

• Set the binding slot of specific node

  Necessary if node belongs to a dynamic slot, which cannot be identified by slot name.

  Parameters

  • node: Node
  • slot: null | glassEasel.Element

  Returns void

Static setSlotName

• setSlotName(element, name?): void

• Set the slot name of the element

  Once this method is called for an element , it will be treated as a slot which can contain child nodes in composed tree. This method should not be used in components, otherwise the slot content will always be dangled.

  Parameters

  • element: glassEasel.Element
  • Optional name: string

  Returns void