Class InspectorComponent<T>

Base inspector component. You can extend this class and just use the currentObj and/or currentType members in your template for a simple setup, or your subclass can manage its own more complicated state. This class will invoke reset() when there is no selected object, and refresh when an object is selected.

Type Parameters

  • T extends Base = Base

Methods

afterUpdate refresh reset

Properties

context? currentObj currentObjectType currentType showCloseButton surfaceId

Methods

afterUpdate

  • afterUpdate(surface): void

  • Invoked after an inspector update. You can override this method to update your UI if you need to.

    Parameters

    • surface: Surface

    Returns void

refresh

  • refresh(obj): void

  • The base implementation of this method sets the current object type from objectType, and it also sets the current type to be the type of obj. You can override this method to implement more sophisticated scenarios.

    Parameters

    • obj: Base

    Returns void

reset

  • reset(): void

  • The base implementation of this method sets the current type and current object type to be an empty string. You can override this method to implement more sophisticated scenarios.

    Returns void

Properties

Optionalcontext

context?: Record<string, any> = {}

Optional context for shared data for inspector templates.

currentObj

currentObj: T

The object that is currently being inspected.

currentObjectType

currentObjectType: string = ''

The objectType of the current object - Group, Node, Edge or Port

currentType

currentType: string = ''

By default, this is the type of the current object. You can override refresh to implement more sophisticated scenarios.

showCloseButton

showCloseButton: boolean

Whether or not to show a close button. Defaults to false.

surfaceId

surfaceId: string = DEFAULT_ANGULAR_SURFACE_ID

ID of the Surface to attach to. Uses the default surface ID if you do not provide one.

Settings

Member Visibility

On This Page

Methods
Properties
Version :