Source

Defined in: core/source/source.ts:62

A Source represents an object of an Item that is used on the stage. Manipulating Source specific properties would render changes to all items linked to that source.

Basic Usage

var xjs = require('xjs');
var Scene = xjs.Scene

xjs.ready()
   .then(Scene.getById(1))
   .then(function(scene) {
   scene.getSources().then(function(sources) {
   return sources[0].setCustomName('Custom Name');
   })
})

All methods marked as Chainable resolve with the original Source instance. This allows you to perform sequential operations correctly: *

var xjs = require('xjs');
var Source = xjs.Source;

xjs.ready()
   .then(Source.getCurrentSource)
   .then(function(source){
    //Manipulate source here
    return source.setName('New Name');
 }).then(function(source){
    return source.setKeepLoaded(true)
 }).then(function(source){
    // set more source properties here
 })

Extended by

Implements

ISource

Constructors

Constructor

new Source(props?): Source

Defined in: core/source/source.ts:75

Parameters

props?

Returns

Source

Properties

getCustomName

getCustomName: () => Promise<string>

Defined in: core/source/source.ts:291

See: #core/ISource#getCustomName getCustomName

Returns

Promise<string>

Implementation of

ISource.getCustomName

getId

getId: () => Promise<string>

Defined in: core/source/source.ts:316

See: #core/ISource#getId getId

Returns

Promise<string>

Implementation of

ISource.getId

getItemList

getItemList: () => Promise<Item[]>

Defined in: core/source/source.ts:321

See: #core/ISource#getItemList getItemList

Returns

Promise<Item[]>

Implementation of

ISource.getItemList

getKeepLoaded

getKeepLoaded: () => Promise<boolean>

Defined in: core/source/source.ts:306

See: #core/ISource#getKeepLoaded getKeepLoaded

Returns

Promise<boolean>

Implementation of

ISource.getKeepLoaded

getName

getName: () => Promise<string>

Defined in: core/source/source.ts:281

See: #core/ISource#getName getName

Returns

Promise<string>

Implementation of

ISource.getName

getType

getType: () => Promise<ItemTypes>

Defined in: core/source/source.ts:331

See: #core/ISource#getType getType

Returns

Promise<ItemTypes>

Implementation of

ISource.getType

getValue

getValue: () => Promise<string | XML>

Defined in: core/source/source.ts:296

See: #core/ISource#getValue getValue

Returns

Promise<string | XML>

Implementation of

ISource.getValue

refresh

refresh: () => Promise<Source>

Defined in: core/source/source.ts:326

See: #core/ISource#refresh refresh

Returns

Promise<Source>

Implementation of

ISource.refresh

setCustomName

setCustomName: () => Promise<Source>

Defined in: core/source/source.ts:286

See: #core/ISource#setCustomName setCustomName

Returns

Promise<Source>

Implementation of

ISource.setCustomName

setKeepLoaded

setKeepLoaded: (value) => Promise<Source>

Defined in: core/source/source.ts:311

See: #core/ISource#setKeepLoaded setKeepLoaded

Parameters

value

boolean

Returns

Promise<Source>

Implementation of

ISource.setKeepLoaded

setName

setName: (value) => Promise<Source>

Defined in: core/source/source.ts:276

See: #core/ISource#setName setName

Parameters

value

string

Returns

Promise<Source>

Implementation of

ISource.setName

setValue

setValue: (value) => Promise<Source>

Defined in: core/source/source.ts:301

See: #core/ISource#setValue setValue

Parameters

value

string | XML

Returns

Promise<Source>

Implementation of

ISource.setValue

Methods

getAllSources()

static getAllSources(): Promise<Source[]>

Defined in: core/source/source.ts:220

return: Promise<Source[]>

Get all unique Source from every scene. Total number of Sources returned may be less than total number of items on all the scenes due to Linked items only having a single Source.

Usage

xjs.Source.getAllSources().then(function(sources) {
  for(var i = 0 ; i < sources.length ; i++) {
     if(sources[i] instanceof xjs.HtmlSource) {
       // Manipulate HTML Source here
     }
   }
})

Returns

Promise<Source[]>

getCurrentSource()

static getCurrentSource(): Promise<Source>

Defined in: core/source/source.ts:108

return: Promise

Get the current source (when function is called by sources), or the source that was right-clicked to open the source properties window (when function is called from the source properties window)

Usage

xjs.Source.getCurrentSource().then(function(source) {
  // This will fetch the current source (the plugin)
}).catch(function(err) {
  // Handle the error here. Errors would only occur
  // if we try to execute this method on Extension plugins
});

Returns

Promise<Source>

getItemList()

static getItemList(): Promise<Item[]>

Defined in: core/source/source.ts:167

return: Promise<Item[]>

Get the item List of the current Source. The item list is a list of items linked to a single Source.

Usage

xjs.Source.getItemList()
.then(function(items) {
  // This will fetch the item list of the current Source
  for (var i = 0 ; i < items.length ; i++) {
    // Manipulate each item here
  }
});

This is just the shorter way of getting items that are linked to a single source. See the long version below:

xjs.Source.getCurrentSource()
.then(source.getItemList)
.then(function(items) {
// Manipulate the items here
})

Returns

Promise<Item[]>