Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CvFormProps

Hierarchy

Index

Properties

Properties

Optional barcodeScanComponentRenderer

barcodeScanComponentRenderer: function

A function responsible for rendering a child component of sdk type {BarcodeScanContext}. It should accept the following params:

param

The sdk {BarcodeScanContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (barcodeScanContext: BarcodeScanContext, stateChangeListener: function, index: number): __type

Optional calendarComponentRenderer

calendarComponentRenderer: function

A function responsible for rendering a child component of sdk type {CalendarContext}. It should accept the following params:

param

The sdk {CalendarContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (calendarContext: CalendarContext, stateChangeListener: function, index: number): __type

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 childFormComponentRenderer

childFormComponentRenderer: function

A function responsible for rendering a child component of sdk type {FormContext}. It should accept the following params:

param

The sdk {FormContext} for this child Form

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (formContext: FormContext, stateChangeListener: function, index: number): __type

Optional detailsComponentRenderer

detailsComponentRenderer: function

A function responsible for rendering a child component of sdk type {DetailsContext}. It should accept the following params:

param

The sdk {DetailsContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (detailsContext: DetailsContext, stateChangeListener: function, index: number): __type

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 formContext

formContext: FormContext

The sdk {FormContext} to use for this form panel. If not provided, the CvScopeContext will be upwardly traversed to attempt to find a matching instance.

Optional formRenderer

formRenderer: function

A function responsible for rendering the 'layout' of the entire form. It should accept the following params:

param

The current CvContext. The cvContext.scopeCtx.scopeObj will be the sdk {FormContext}

param

The array of child components to rendered by the Form

Type declaration

    • (cvContext: CvContext, childComponents: Array<ReactElement<any>>): __type

    • Parameters

      • cvContext: CvContext
      • childComponents: Array<ReactElement<any>>

      Returns __type

Optional geoFixComponentRenderer

geoFixComponentRenderer: function

A function responsible for rendering a child component of sdk type {GeoFixContext}. It should accept the following params:

param

The sdk {GeoFixContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (geoFixContext: GeoFixContext, stateChangeListener: function, index: number): __type

Optional geoLocationComponentRenderer

geoLocationComponentRenderer: function

A function responsible for rendering a child component of sdk type {GeoLocationContext}. It should accept the following params:

param

The sdk {GeoLocationContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (geoLocationContext: GeoLocationContext, stateChangeListener: function, index: number): __type

Optional graphComponentRenderer

graphComponentRenderer: function

A function responsible for rendering a child component of sdk type {GraphContext}. It should accept the following params:

param

The sdk {GraphContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (graphContext: GraphContext, stateChangeListener: function, index: number): __type

Optional imagePickerComponentRenderer

imagePickerComponentRenderer: function

A function responsible for rendering a child component of sdk type {ImagePickerContext}. It should accept the following params:

param

The sdk {ImagePickerContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (imagePickerContext: ImagePickerContext, stateChangeListener: function, index: number): __type

Optional listComponentRenderer

listComponentRenderer: function

A function responsible for rendering a child component of sdk type {ListContext}. It should accept the following params:

param

The sdk {ListContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (listContext: ListContext, stateChangeListener: function, index: number): __type

Optional mapComponentRenderer

mapComponentRenderer: function

A function responsible for rendering a child component of sdk type {MapContext}. It should accept the following params:

param

The sdk {MapContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (mapContext: MapContext, stateChangeListener: function, index: number): __type

Optional printMarkupComponentRenderer

printMarkupComponentRenderer: function

A function responsible for rendering a child component of sdk type {PrintMarkupContext}. It should accept the following params:

param

The sdk {PrintMarkupContext} for this child pane

param

Any state change events should be broadcast (or passed through) to this listener

Type declaration

    • (printMarkupContext: PrintMarkupContext, stateChangeListener: function, index: number): __type

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 stateChangeListeners

stateChangeListeners: Array<function>

An array of CvListeners Any state change events will broadcast to these listeners

Generated using TypeDoc