Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CvWorkbenchProps

Hierarchy

Index

Properties

Optional appWinDef

appWinDef: AppWinDef

The sdk {AppWinDef} from which to retrieve the workbench by the given workbenchId Should not be used if the 'workbench' property is provided

Optional catavolt

catavolt: AppContext

The Catavolt SDK entry point, an instance of the sdk {AppContext} which is always available to components. A singleton instance is used by the underlying components to interact with the sdk.

Optional eventRegistry

eventRegistry: CvEventRegistry

The CvEventRegistry handles decoupled communication between components. Any component may subscribe to and publish CvEvents. See also CvListener and CvEventType

Optional renderer

renderer: function

Allows for a component's rendering logic to be overridden and completely customized. The first argument, the CvContext, exposes the CvScopeContext which provides the relevant SDK object for use by the renderer. CvScopeContext.scopeObj will always be an SDK object exposing the data related to the current component.

Type declaration

    • (cvContext: CvContext, callbackObj?: any): __type
    • Parameters

      • cvContext: CvContext
      • Optional callbackObj: any

      Returns __type

Optional workbench

workbench: Workbench

The sdk {Workbench} to display

Optional workbenchId

workbenchId: string

The workbench id to display Should not be used if the 'workbench' property is provided

Generated using TypeDoc