About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface INodeContext

An interface which declares methods for accessing the context of a node.

Since

2.0

interface INodeContext {
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    GetAncestor<T extends DocumentNode>(
        typeT: TypeRefParam<T>,
    ): null | JsType<T>;
    GetService<T>(typeT: TypeRefParam<T>): null | JsType<T>;
    IsDescendantOf(node: DocumentNode): boolean;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
}

Hierarchy (View Summary)

IInterfaceBase
- INodeContext

Index

Methods

Default capability

GetAncestor GetService IsDescendantOf

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from IInterfaceBase.Cast

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from IInterfaceBase.TryCast

Default capability

GetAncestor

GetAncestor<T extends DocumentNode>(typeT: TypeRefParam<T>): null | JsType<T>
Returns the closest ancestor node of type T, or null if no such ancestor is found.
Type Parameters
- T extends DocumentNode
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns null | JsType<T>
The closest ancestor node.

Since
2.0

GetService

GetService<T>(typeT: TypeRefParam<T>): null | JsType<T>
Gets the service object of the specified type.
Type Parameters
- T
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns null | JsType<T>
An object of type T, or null if no service of type T was found.

Since
2.0

IsDescendantOf

IsDescendantOf(node: DocumentNode): boolean
Determines whether this instance is a descendant of the specified node. Note: A node is not considered a descendant of itself.
Parameters
- node: DocumentNode
  The potential ancestor node.
Returns boolean
true if this instance is a descendant of the specified node; otherwise, false.

Since
2.0