Javascript API 7.x

Namespace: action

bu. action

This namespace contains definitions for generic actions. An action is an object that encapsulates the operations executed by a control when is interacted or by a viewer when it is interacted. Special cases of actions can include others that execute operations when a workspace is interacted.

By separating the user interface (controls) from the operations executed (actions) the API offers a more modular way of integrate all the pieces in a web app. For example, an action could respond to events triggered by different controls as far as the events are the same, avoiding the need to write the same code in when different controls are used.

Source:
bu/actions/action.jsdoc

Classes

Action
Attribution
DebugGrid
DebugMode
Language
Login
Logout
ProgressLabel
SyncAction
TimeSelect
WorkspaceAction

Type Definitions

ActionOptions

Options for bu.action.Action.

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.
viewer bu.Viewer | undefined

The viewer this action is tied to.
Source:
bu/typedefs.js

AttributionOptions

Options for bu.action.Attribution.

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.
viewer bu.Viewer | undefined

The viewer this action is tied to.
autoCollapsibleMinWidth boolean | undefined

The min width under which the control will be shown as collapsible.
Source:
bu/typedefs.js

LoginOptions

Options for bu.action.Login.

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.
viewer bu.Viewer | undefined

The viewer this action is tied to.
loginSuccessFn function | undefined

The function that will be executed if login is successful. Any function receiving one parameter: a bu.UserData object containing user data.
Source:
bu/typedefs.js

SyncActionOptions

Options for bu.action.WorkspaceAction.

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.
viewer bu.Viewer | undefined

The viewer this action is tied to.
workspace bu.Workspace | undefined

The workspace this action is tied to.
type bu.SyncType | undefined

Type of syncing.
syncedViewIndex number | undefined

The view index of the synced viewer.
Source:
bu/typedefs.js

WorkspaceActionOptions

Options for bu.action.WorkspaceAction

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.
viewer bu.Viewer | undefined

The viewer this action is tied to.
workspace bu.Workspace | undefined

The workspace this action is tied to.
Source:
bu/typedefs.js