Class: View

Represents all the metadata of the form viewer components.

Extended by

• BuilderView
• BuilderView

Implements

• IView

Constructors

Constructor

new View(models): View

Creates an instance of the View.

Parameters

models

Model<any>[] = []

the components metadata.

Returns

View

Accessors

viewerWrappers

Get Signature

get viewerWrappers(): FormViewerWrapper[]

Retrieves the viewer wrappers array.

Returns

FormViewerWrapper[]

the viewer wrappers array.

Retrieves the viewer wrappers array.

Implementation of

IView.viewerWrappers

Methods

all()

all(): Model<any>[]

Returns

Model<any>[]

all component metadata for the form viewer.

Implementation of

IView.all

---

define()

define(model): void

Parameters

model

Model

Returns

void

Inherit Doc

Implementation of

IView.define

---

filterModels()

filterModels(predicate): Model<any>[]

Parameters

predicate

(model) => boolean

the filter function.

Returns

Model<any>[]

the array of component metadata filtered using the predicate function.

Implementation of

IView.filterModels

---

find()

find(type): Model<any> | undefined

Parameters

type

string

the component type.

Returns

Model<any> | undefined

the component metadata for the form viewer for the specified type or undefined.

Implementation of

IView.find

---

get()

get(type): Model<any>

Parameters

type

string

the component type.

Returns

Model<any>

the component metadata for the form viewer for the specified type.

Implementation of

IView.get

---

getCssLoaders()

getCssLoaders(biDi): CssLoaderFunction[]

Parameters

biDi

BiDi

the BiDi object for which to retrieve the CSS loaders.

Returns

CssLoaderFunction[]

the array containing the CSS loaders for the specified BiDi.

Implementation of

IView.getCssLoaders

---

withCssLoader()

withCssLoader(cssLoaderType, loader): View

Parameters

cssLoaderType

CssLoaderType

the BiDi layout type, either 'common', 'ltr', or 'rtl'.

loader

CssLoaderFunction

the function that returns a Promise to load CSS or other required localization resources, optionally returning a cleanup function to be called on unmount.

Returns

View

the View instance.

Implementation of

IView.withCssLoader

---

withViewerWrapper()

withViewerWrapper(wrapper): View

Parameters

wrapper

FormViewerWrapper

the viewer wrapper to be added. The wrapper is a component that wraps the form viewer.

Returns

View

the View instance.

Implementation of

IView.withViewerWrapper

---

create()

static create(models): View

Static wrapper for the View constructor.

Parameters

models

Model<any>[]

the components metadata.

Returns

View

the View instance.