bajaui

Module: nmodule/bajaui/rc/model/UxModel

API Status: Development

Methods

<static> make(obj)

Parameters:
Name Type Description
obj object
Properties
Name Type Argument Description
name string <optional>

the name of the widget represented by this
UxModel. This will be automatically set on child nodes; a parent-less
root widget may have no name or a name arbitrarily chosen.
type function

the Type of the widget to create
properties object <optional>

an object literal of the widget's
properties
kids Array.<(object|module:nmodule/bajaui/rc/model/UxModel)> <optional>

objects
describing the widget's children
bindings Array.<module:nmodule/bajaui/rc/binding/IValueProvider> <optional>

bindings
to propagate data updates to the widget (these will be assigned to a
BindingList)
Returns:
Type
Promise.<module:nmodule/bajaui/rc/model/UxModel>

get(path)

Parameters:
Name Type Description
path string | Array.<string>
Returns:

the UxModel
kid by the given name. If an array of names are given, will follow the
path down through the UxModel structure.

Type
module:nmodule/bajaui/rc/model/UxModel | undefined

getBindingList()

Returns:
Type
module:nmodule/bajaui/rc/model/BindingList

getKids()

Returns:

UxModel
instances for this widget's children

Type
Array.<module:nmodule/bajaui/rc/model/UxModel>

getProperties()

Returns:

object literal describing this widget's properties

Type
object

getType()

Returns:

constructor for the widget to create

Type
function

getValue()

Returns:

the value to be loaded into this widget

Type
* | null

toSpandrel(params)

Produce a spandrel config object that represents this Ux element as
rendered in the DOM. The value property will always be this, as the
UxModel will be loaded into the spandrel widget as the value.

Remember that the spandrel data will contain any bindings present in
the model as well! Beware of simply passing back toSpandrel() results
from the UxModel passed to your render function - you may get duplicate
bindings. toSpandrel() is typically more appropriate for calling on
kids.

Parameters:
Name Type Description
params object | string | function

parameters used for generating the
spandrel data; can also be dom passed directly as a string or
function

Properties
Name Type Argument Description
dom string | function

the DOM element into which to render
this element. Can be a function that receives an object with
properties, which are the properties of this Ux element, to be used to
generate the DOM
kids Array.<object> | function <optional>

You can specify the kids
property of the spandrel config directly. Alternately, this can be a
function that receives each UxModel in getKids(), and returns
kid.toSpandrel() or a spandrel object of your choosing.
Returns:

an object fit to be passed as a spandrel argument

Type
object