iSourceHtml
Defined in: core/source/ihtml.ts:302
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new iSourceHtml():
iSourceHtml
Returns
Section titled “Returns”iSourceHtml
Methods
Section titled “Methods”call()
Section titled “call()”call(
func,arg):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:322
param: (func: string, arg: string)
return: Promise<ISourceHtml>Allow this item to call a pre-exposed function within the HTML Item
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”enableBrowser60FPS()
Section titled “enableBrowser60FPS()”enableBrowser60FPS(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:473
param: Promise
return: Promise<ISourceHtml>Enable or disable browser source to render up to a maximum of 60FPS
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”ISourceHtml.enableBrowser60FPS
enableBrowserJS()
Section titled “enableBrowserJS()”enableBrowserJS(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:769
param: (value: boolean)
return: Promise<ISourceHtml>Enables or disables execution of the set BrowserJs upon load. Note that disabling this will require item to be refreshed in order to remove any BrowserJS previously executed.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”enableBrowserTransparency()
Section titled “enableBrowserTransparency()”enableBrowserTransparency(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:434
param: Promise
return: Promise<ISourceHtml>Enable or disable transparency of CEF browser
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”ISourceHtml.enableBrowserTransparency
enableCustomCSS()
Section titled “enableCustomCSS()”enableCustomCSS(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:984
param: (value: boolean)
return: Promise
Enables or disables application of custom CSS to the document
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”enableReloadOnSceneEnter()
Section titled “enableReloadOnSceneEnter()”enableReloadOnSceneEnter(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:1173
param: (value: boolean)
return: Promise
Enables or disables refresh of source upon entering a scene containing an item of it (via setVisible)
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”ISourceHtml.enableReloadOnSceneEnter
enableReloadOnShow()
Section titled “enableReloadOnShow()”enableReloadOnShow(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:1134
param: (value: boolean)
return: Promise
Enables or disables refresh of source upon showing (via setVisible)
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”ISourceHtml.enableReloadOnShow
getAllowRightClick()
Section titled “getAllowRightClick()”getAllowRightClick():
Promise<boolean>
Defined in: core/source/ihtml.ts:554
return: Promise
Check if right click events are sent to the item or not.
item.getAllowRightClick().then(function(isRightClickAllowed) { // The rest of your code here});Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceHtml.getAllowRightClick
getBrowserCustomSize()
Section titled “getBrowserCustomSize()”getBrowserCustomSize():
Promise<Rectangle>
Defined in: core/source/ihtml.ts:495
return: Promise
Gets the custom browser window size (in pixels) for the item, if set, regardless of its layout on the mixer. Returns a (0, 0) Rectangle if no custom size has been set.
See also: #util/Rectangle Util/Rectangle
Returns
Section titled “Returns”Promise<Rectangle>
Implementation of
Section titled “Implementation of”ISourceHtml.getBrowserCustomSize
getBrowserJS()
Section titled “getBrowserJS()”getBrowserJS():
Promise<string>
Defined in: core/source/ihtml.ts:593
return: Promise
Gets the javascript commands to be executed on item upon load
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”getBrowserLoadStatus()
Section titled “getBrowserLoadStatus()”getBrowserLoadStatus():
Promise<string>
Defined in: core/source/ihtml.ts:1092
return: Promise
Gets the load status of the html May return as any of the following:
- ‘LOADED’ -> HTML is already loaded
- ‘NOT LOADED’ -> HTML is not yet loaded
- ‘LOAD ERROR’ -> Error in loading HTML
- ‘UNKNOWN’ -> URL used is invalid or when status is checked right after adding new HTML source
- ‘UNAVAILABLE’ -> Method for getting load status is unavailable for the XBC version
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”ISourceHtml.getBrowserLoadStatus
getCustomCSS()
Section titled “getCustomCSS()”getCustomCSS():
Promise<string>
Defined in: core/source/ihtml.ts:854
return: Promise
Gets the custom CSS applied to the document upon loading
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”getPolicyStringFunction()
Section titled “getPolicyStringFunction()”getPolicyStringFunction(
customCSS):string
Defined in: core/source/ihtml.ts:619
Parameters
Section titled “Parameters”customCSS
Section titled “customCSS”string
Returns
Section titled “Returns”string
getURL()
Section titled “getURL()”getURL():
Promise<string>
Defined in: core/source/ihtml.ts:344
return: Promise
Gets the URL of this webpage item.
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”isBrowser60FPS()
Section titled “isBrowser60FPS()”isBrowser60FPS():
Promise<boolean>
Defined in: core/source/ihtml.ts:454
return: Promise
Check if browser can render up to a maximum of 60FPS
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”isBrowserJSEnabled()
Section titled “isBrowserJSEnabled()”isBrowserJSEnabled():
Promise<boolean>
Defined in: core/source/ihtml.ts:743
return: Promise
Gets if BrowserJS is enabled and executed on load
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceHtml.isBrowserJSEnabled
isBrowserOptimized()
Section titled “isBrowserOptimized()”isBrowserOptimized():
Promise<boolean>
Defined in: core/source/ihtml.ts:1073
return: Promise
Gets if browser instance is optimized via surface sharing
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceHtml.isBrowserOptimized
isBrowserTransparent()
Section titled “isBrowserTransparent()”isBrowserTransparent():
Promise<boolean>
Defined in: core/source/ihtml.ts:415
return: Promise
Check if browser is rendered transparent
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceHtml.isBrowserTransparent
isCustomCSSEnabled()
Section titled “isCustomCSSEnabled()”isCustomCSSEnabled():
Promise<boolean>
Defined in: core/source/ihtml.ts:958
return: Promise
Gets if custom CSS is enabled and applied to the document on load
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceHtml.isCustomCSSEnabled
isReloadOnSceneEnterEnabled()
Section titled “isReloadOnSceneEnterEnabled()”isReloadOnSceneEnterEnabled():
Promise<boolean>
Defined in: core/source/ihtml.ts:1154
return: Promise
Gets if source will refresh upon entering a scene containing an item of it (via setVisible)
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceHtml.isReloadOnSceneEnterEnabled
isReloadOnShowEnabled()
Section titled “isReloadOnShowEnabled()”isReloadOnShowEnabled():
Promise<boolean>
Defined in: core/source/ihtml.ts:1115
return: Promise
Gets if source will refresh upon showing (via setVisible)
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceHtml.isReloadOnShowEnabled
isSourceAvailable()
Section titled “isSourceAvailable()”isSourceAvailable():
Promise<boolean>
Defined in: core/source/ihtml.ts:1193
return: Promise
Check if file used as source is available
item.isSourceAvailable().then(function(isAvail) { // The rest of your code here});Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”setAllowRightClick()
Section titled “setAllowRightClick()”setAllowRightClick(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:573
param: (value:boolean)
return: Promise<ISourceHtml>Allow or disallow right click events to be sent to the item. Note that
you can only catch right click events using mouseup/mousedown
Chainable
item.setAllowRightClick(true).then(function(item) { // Promise resolves with the same Item instance});Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”ISourceHtml.setAllowRightClick
setBrowserCustomSize()
Section titled “setBrowserCustomSize()”setBrowserCustomSize(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:524
param: Promise
return: Promise<ISourceHtml>Sets the custom browser window size for the item regardless of its layout on the mixer
Chainable.
See also: #util/Rectangle Util/Rectangle
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”ISourceHtml.setBrowserCustomSize
setBrowserJS()
Section titled “setBrowserJS()”setBrowserJS(
value,refresh?):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:666
param: (js: string, refresh: boolean = false)
return: Promise
Sets the javascript commands to be executed on item right upon setting and on load. Optionally set second parameter to true to refresh item (needed to clean previously executed JS code.)
Chainable.
Parameters
Section titled “Parameters”string
refresh?
Section titled “refresh?”boolean = false
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”setCustomCSS()
Section titled “setCustomCSS()”setCustomCSS(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:880
param: (value: string)
return: Promise<ISourceHtml>Sets the custom CSS to be applied to the document upon loading
Chainable.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<iSourceHtml>
Implementation of
Section titled “Implementation of”setURL()
Section titled “setURL()”setURL(
value):Promise<iSourceHtml>
Defined in: core/source/ihtml.ts:375
param: (url: string)
return: Promise<ISourceHtml>Sets the URL of this webpage item.
Chainable.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<iSourceHtml>