module:nmodule/driver/rc/wb/mgr/DriverMgr

module:nmodule/driver/rc/wb/mgr/DriverMgr

new (require("nmodule/driver/rc/wb/mgr/DriverMgr"))()

Description:

  • API Status: Development

    DriverMgr constructor. Contains functionality for working with components
    within a driver network.

    There is usually no reason to extend this directly; extend DeviceMgr or
    PointMgr instead.

Source:
See:
Extends:
  • module:nmodule/webEditors/rc/wb/mgr/Manager
Parameters:
Name Type Attributes Description
params.keyName String <optional>

the key name used for lexicon entries for this view.
params.moduleName String <optional>

the module name used for lexicon entries for this view.
params.subscriptionDepth Number <optional>

the depth to subscribe the component tree.
params.subscriptionFilter module:nmodule/webEditors/rc/wb/util/subscriptionUtil~SubscriptionFilter <optional>

Starting in Niagara 4.13, if the optional subscriptionFilter function is provided, it will be called for each
potentially subscribable BComponent with its current depth. By returning true only for the desired components,
the subscription will subscribe to what is needed.
params.subscribeCallback module:nmodule/webEditors/rc/wb/util/subscriptionUtil~SubscribeCallback <optional>

Starting in Niagara 4.13, if the optional subscribeCallback function is provided, it will receive a callback when a component is subscribed.
This can allow you to add additional subscriptions outside the normal depth and filter results.
params.folderType String | Type <optional>

optional parameter indicating the folder type
used for the manager view. This will be used by the NewFolder command.
params.editableTypes Array.<(Type|String)> <optional>

specifies which types of values can be
edited in the database table. If omitted, the Edit command will not be enabled.
params.getComponentStatus function <optional>

to enable status
coloring of values in the database table, provide a function to be used to get a Status
instance for each one.

Extends

  • module:nmodule/webEditors/rc/wb/mgr/Manager

Methods

buildMainTableCell(column, row, dom) → {Promise}

Description:

  • Override of the base manager's build cell function.

Source:
Parameters:
Name Type Description
column module:nmodule/webEditors/rc/wb/table/model/Column

The column for the cell
row module:nmodule/webEditors/rc/wb/table/model/Row

The row for the cell
dom JQuery
Returns:
Type
Promise

componentAdded(parent, child)

Description:

  • Function called when a new component is added. If the
    component is a folder and the all descendants command is selected,
    we want to subscribe to that folder to the correct depth.

Source:
Parameters:
Name Type Description
parent baja.Component
child baja.Component

componentChanged(comp, prop)

Description:

  • Function called when a property of one of the row's subjects or descendants
    changes. This is used to update the table when, for example, a property
    on a point's proxy extension is changed.

Source:
Parameters:
Name Type Description
comp baja.Component

The component notifying the changed property.
prop baja.Property

The property that changed

componentRemoved(value)

Description:

  • Function called when a subscribed component is removed. If the
    component was a folder and the all descendants command is selected,
    we want to unsubscribe to that folder.

Source:
Parameters:
Name Type Description
value baja.Component

componentRenamed(comp)

Description:

  • Function called when the depth subscriber notifies a renamed component. This will
    try to emit a 'changed' event on the component source.

Source:
Parameters:
Name Type Description
comp

doDestroy() → {*}

Description:

  • Destroy the widget. This will clean up the event handler we have attached
    for listening to descendant changes.

Source:
Returns:
Type
*

doLoad(comp) → {Promise}

Description:

  • Load the widget from the component. This will hook up the event handlers to the
    depth subscriber used by this type.

Source:
Parameters:
Name Type Description
comp baja.Component
Returns:
Type
Promise

finishMainTableRow(row, dom)

Description:

  • Overrides the basic manager #finishMainTableRow function with some extra css information
    specified on the dom for the table row.

Source:
Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row

a table row instance
dom JQuery

getSubscriptionDepth() → {Number}

Description:

  • Get the configured component subscription depth for the driver manager.
    This value is specified by the 'subscriptionDepth' parameter property
    in the constructor.

Source:
Returns:
Type
Number

onMainTableDblClicked(event, subjects) → {Promise|*}

Description:

  • Provides the default implementation of the call back function for double-click of rows.
    In the callback we'll look at the row's subject; if the row being clicked is of an editable
    type, then the edit command action can be invoked. Otherwise, if the point is a folder, the
    double click action will be to do a hyperlink to that folder's ord.

Source:
Since:
  • Niagara 4.14
Parameters:
Name Type Description
event JQuery.Event

the double click event
subjects Array.<*>

the selected subject of the table being clicked
Returns:
Type
Promise | *

onTableSelectionChanged(selectedSubjects) → {Promise|*}

Description:

  • This provides the default function of enabling or disabling the edit command based on what
    is currently selected in the main table. We typically won't enable the edit command if a
    folder is included in the current selection.

Source:
Since:
  • Niagara 4.14
Parameters:
Name Type Description
selectedSubjects Object

an object that holds the array of the selected subjects from the tables
supported by the manager view.

Properties
Name Type Description
mainTableSelection Array.<*>

the current selected subjects
in the main table.
learnTableSelection Array.<*> | undefined

the current selected subjects
in the learn or discovery table. This will be undefined if Manager does not support a learn
table or the getLearnTable() function returns undefined.
Returns:
Type
Promise | *