Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CvGraphicalWorkbenchProps

Hierarchy

  • CvProps
    • CvGraphicalWorkbenchProps

Index

Properties

Optional actionListeners

actionListeners: Array<function>

Register to receive {@link CvEvent}s of type {@link CvActionFiredResult}

Optional appWinDef

appWinDef: AppWinDef

The sdk {AppWinDef} from which to retrieve the workbenches

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 {@link CvEventRegistry} handles decoupled communication between components. Any component may subscribe to and publish {@link CvEvent}s. See also {@link CvListener} and {@link CvEventType}

Optional launchListeners

launchListeners: Array<function>

Register to receive {@link CvEvent}s of type {@link CvNavigationResult}

Optional numCols

numCols: number

Number of columns to use for the workbench launcher display

Optional renderer

renderer: function

Allows for a component's rendering logic to be overridden and completely customized. The first argument, the {@link CvContext}, exposes the {@link CvScopeContext} which provides the relevant SDK object for use by the renderer. {@link 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 selectionProvider

selectionProvider: CvValueProvider<Workbench>

A workbench selection provider, to which this component will 'listen' and display workbench selection changes

Optional workbench

workbench: Workbench

The workbench to show Should not be used if the workbenchId property is provided

Optional workbenchId

workbenchId: string

The workbench id of the workbench to show. Should not be used if the workbench property is provided

Generated using TypeDoc