Interface EditObjectPageBindings

Component bindings to configure a page viewer for editing an existing object.

interface EditObjectPageBindings {
    bindingsType: EditObject;
    containerClass?: string;
    docId: string;
    docType: string;
    enableSheets?: boolean;
    eventName: EDIT;
    fitToContainerHeight?: boolean;
    onChange?: ((change: PageDataChange | PageModeChange) => void);
    onDirty?: ((isDirty: boolean) => void);
    pageClass?: string;
    pageModel?: PageModel;
    setApi?: ((api: PageViewerApi) => void);
    showToolbar?: boolean;
    templateUuid?: string;
}

Hierarchy (view full)

Properties

bindingsType containerClass? docId docType enableSheets? eventName fitToContainerHeight? onChange? onDirty? pageClass? pageModel? setApi? showToolbar? templateUuid?

Properties

bindingsType

bindingsType: EditObject

OptionalcontainerClass

containerClass?: string

Assign the given CSS classes to the page viewer's container. This element encompasses the main document view and the toolbar.

docId

docId: string

Object ID

docType

docType: string

Entity type of the object.

OptionalenableSheets

enableSheets?: boolean

Enable the workspace and insight tabs to be rendered.

eventName

eventName: EDIT

Page context to use.

OptionalfitToContainerHeight

fitToContainerHeight?: boolean

If true, the page viewer will fill its parent element's height.

OptionalonChange

onChange?: ((change: PageDataChange | PageModeChange) => void)

A callback that is called when the pageModel's mode or data changes.

OptionalonDirty

onDirty?: ((isDirty: boolean) => void)

A callback that is called when the page viewer dirty state changes.

OptionalpageClass

pageClass?: string

Assign the given CSS classes to the page viewer's main section. This element displays the main document, excluding toolbar.

OptionalpageModel

pageModel?: PageModel

Optionally provide a pageModel using window.sas.vi.pageModel.createFromObject. The pageModel type must match docType. The docType and docId are used to fetch the document page, and pageModel.data is set using the field values from this response. The pageModel can be used to inspect current data and validity, but the reference to this model will be broken if a new template is loaded due to a mode transition or other condition. Prefer using setApi and onChange to interact with the page.

OptionalsetApi

setApi?: ((api: PageViewerApi) => void)

A callback that is called when the page viewer is initialized. It provides an API that can be used to check the page viewer state and save the document.

OptionalshowToolbar

showToolbar?: boolean

Show the page toolbar. This contains the toolbar actions associated with the object's entity type.

OptionaltemplateUuid

templateUuid?: string

Use the given page template by UUID regardless of page context.

Settings

Member Visibility

On This Page

Properties