API Docs for: 2.0.20133.2
Show:

ui.UIInfo Class

Defined in: src\internal\ui\uiInfo.ts:8
Module: UI

UIInfo class which describes the details about a UI component

Example:

// UIInfo used to render a UI component as an IFRAME
var iframeUIInfo = {
    type: sdk.ui.HostType.IFRAME,
    containerSelector: "#iframe-container",
    accessibilityTitle: "My awesome component"
};

// UIInfo used to render a UI component as a popup
var popupUIInfo = {
    type: sdk.ui.HostType.POPUP,
    width: 600,
    height: 800
};

Properties

containerSelector

String

Defined in src\internal\ui\uiInfo.ts:37

Iframe container selector. Applicable when type is ui.HostType.IFRAME

containerSelector

String

Defined in src\internal\ui\uiInfo.ts:43

Iframe title value for accessibility. Applicable when type is ui.HostType.IFRAME

height

Number

Defined in src\internal\ui\uiInfo.ts:55

Height of the popup window. Applicable when type is ui.HostType.POPUP

type

String

Defined in src\internal\ui\uiInfo.ts:31

A value from ui.HostType

width

Number

Defined in src\internal\ui\uiInfo.ts:49

Width of the popup window. Applicable when type is ui.HostType.POPUP