Home
User Guide
APIs
Custom Plug-in API
EMBED Object Functions
This topic introduces a set of methods that plug-in developers can use to create their own custom plugins.

Release Notes
Getting Started with Operations Hub
User Guide
- Overview
- Operations Hub (New Layout)
- Applications
- Entities
- Queries
- Plug-ins
- Events
- Email Templates
- Parameters
- Users
- Roles
- Administration
- Data Sources
- Pages
- Navigation
- Explorer
- Themes
- Settings
- Widgets
- General Reference
- APIs
  - Operations Hub M2M Device RESTful APIs
  - Operations Hub REST APIs for Integration
  - Operations Hub REST APIs for App, Group, and Page Permissions
  - Message Queuing Telemetry Transport (MQTT) APIs
  - Custom Plug-in API
    - EMBED Object Functions
      This topic introduces a set of methods that plug-in developers can use to create their own custom plugins.
    - EMBED.getComponent ()
      This method retrieves a JSON object, which contains information about the current instance of a plug-in.
    - EMBED.getRootElement ()
      This method retrieves a jQuery object, which represents the root HTML element of the current instance of a plug-in.
    - EMBED.getTheme ()
      This method retrieves a JSON object, which contains information about the current theme applied to Operations Hub.
    - EMBED.getStyle ()
      This method retrieves a string, which contains information about the styles that are currently being used by the application.
    - EMBED.executeAction
      This method executes a specific action (as defined by id in the manifest).
    - EMBED.getPageData
      This method retrieves all sources of data available on the page, including information about any inputs, outputs, query names, etc.
    - EMBED.fieldTypeIsQuery
      Passing in a data source field from your component, will return if the data source configured is of type Query.
    - EMBED.fieldTypeIsGlobal
      Passing in a data source field from your component, will return if the data source configured is of type Global.
    - EMBED.fieldTypeIsFormula
      Passing in a data source field from your component, will return if the data source configured is of type Formula.
    - EMBED.getGlobalData
      This method retrieves the current value of an Operations Hub global variable.
    - EMBED.getFormulaData
      This method retrieves the current value of an Operations Hub Formula.
    - EMBED.subscribeFieldToFormulaChange
      This method creates a subscription to a data source of Formula type.
    - EMBED.subscribeFieldToGlobalChange (field, callback)
      This method creates a subscription to a data source of Global type.
    - EMBED.subscribeFieldToQueryChange (field, callback)
      This method creates a subscription to a data source of Query type.
    - EMBED.getQueryOutput (field)
      Provided an input field, will return a list of all the outputs of the query, in an array of JSON objects.
    - EMBED.submitTarget (field, value)
      This method sends data from your plug-in back to an Operations Hub data target.
    - EMBED.registerNavChanged (id, callback)
      This method provides a callback, which informs the plug-in that the page is closing/changing.
    - EMBED.subscribeToScreenSizeChange (id, callback)
      This method creates a subscription, which will trigger a callback whenever the Operations Hub runtime detects a screen size change (such as resizing the browser).
- Troubleshooting

EMBED Object Functions

This topic introduces a set of methods that plug-in developers can use to create their own custom plugins.

Proficy Operations Hub includes a JavaScript API, which allows developers to create custom controls that can be imported into the application. These custom controls can interact with any data that is available within Operations Hub. The API provides access to end-user configurable settings and bi-directional data transfer.

Core Functionality

Useful for basic operations across the application:

Themes and Styles

Help to customize the look and feel of the user interface:

Actions/Commands

EMBED.executeAction

Page Information

EMBED.getPageData

Data Access

Useful for working with the data source and data target fields:

Navigation

EMBED.registerNavChanged (id, callback)

Miscellaneous

EMBED.subscribeToScreenSizeChange (id, callback)