baja

Classes

AbsTime

Action

ActionProperty

AsyncCursor

BaseBajaObj

BatchResolve

Blob

Complex

Component

ComponentSpace

Cursor

Date

DaysOfWeeksBits

DefaultSimple

Dimension

Double

DynamicEnum

Enum

EnumRange

EnumSet

Facets

FacetsMap

FilterCursor

Flags

Float

Format

FrozenEnum

Host

Icon

Integer

LinkCheck

LocalHost

Long

NameList

NameMap

NavContainer

NavNode

NavNodeContainer

Object

Ord

OrdList

OrdQueryList

OrdScheme

Permissions

PermissionsMap

Property

RelTime

Simple

Singleton

Slot

SlotPath

SlotScheme

Status

Struct

Subscriber

SyncCursor

Time

TimeZone

TimeZoneDatabase

Topic

Unit

UnitDatabase

Value

ViewQuery

VirtualComponent

VirtualComponentSpace

VirtualGateway

VirtualPath

VirtualScheme

Namespaces

bson

clock

coll

comm

event

file

nav

registry

transfer

Members

(static, readonly) TimeFormat :Number

Description:

• Date and Time formatting.

Source:

• baja/obj/TimeFormat.js, line 19

See:

• baja.AbsTime#toDateTimeString
• baja.Time#toTimeString

Properties:

Type:

• Number

(static) stackTraceLimit :Number

Description:

• Limits the length of stack traces printed by baja.error.

Source:

• sys.js, line 333

Default Value:

• 20

Type:

• Number

(static, constant) version :String

Description:

• BajaScript's version number (maj.min.build.patch).

Source:

• sys.js, line 156

Default Value:

• 2.0.0.0

Type:

• String

Methods

(static) $(typeSpec) → {baja.Value}

Description:

• Return an instance from the Type.

  When creating an instance of a Type, this method should always be
  used by preference.

  At first this 'dollar' function looks a bit strange. However, much
  like other popular JavaScript libraries, this function has been
  reserved for the most commonly used part of BajaScript: creating
  instances of BajaScript Objects.

Source:

• sys.js, line 1349

See:

• Type#getInstance
• baja.Simple#make

Examples

// Create an instance of a NumericWritable Control Component...
  var v = baja.$("control:NumericWritable");

Please note, if the Type information is invalid or hasn't been imported into BajaScript, this will throw an Error. Please use baja.importTypes to import Type information into BajaScript.

  baja.importTypes({
    typeSpecs: ["control:NumericWritable"]
  })
    .then(function () {
      var v = baja.$("control:NumericWritable");
    });

  //or use the RequireJS plugin:

  require(['baja!control:NumericWritable'], function () {
    var v = baja.$("control:NumericWritable");
  });

Create a Complex instance, using an object literal to specify its slot values.

var user = baja.$('baja:User', {
  fullName: 'Santa Claus',
  email: 'kringlek@north.pohl'
});

Parameters:

Throws:

if the given type spec could not be found

Type

Error

Returns:

Type

baja.Value

(static) Marker()

Description:

• A marker value is used primarily with the tagging API in order to represent the
  presence of a named tag that has no meaningful value. That is, the tag itself is
  sufficient to convey meaning.

Source:

• baja/obj/Marker.js, line 35

(static) StatusValue()

Description:

• Represents a baja:StatusValue in BajaScript.

Source:

• baja/obj/StatusValue.js, line 33

(static) callSuper(methodNameopt, instance, argsopt)

Description:

• Call the instance's super method.

Source:

• baja/sys/inherit.js, line 59

Parameters:

Returns:

(static) callbackify(callbacksopt, defaultOkopt, defaultFailopt)

Description:

• Ensure that a callback object literal exists and has ok and fail callbacks

  • default them to baja.ok and baja.fail,
    respectively, if they do not exist.

Source:

• sys.js, line 392

Parameters:

(static) clearOut()

Description:

• Attempt to clear BajaScript's debug output.

Source:

• sys.js, line 196

Returns:

(static) error(e)

Description:

• Print an error message in BajaScript's debug output. In IE/Safari the
  length of the stack trace will be limited to 20 records - you can
  change this by setting baja.stackTraceLimit.

  By default, this method calls baja.printError using
  baja.outln as the printer function.

Source:

• sys.js, line 293

Parameters:

Returns:

(static) fail(erropt)

Description:

• The global default fail callback function.

  Throughout BajaScript there are places where network calls may be
  made. In one of these cases, a developer has the option of specifying
  a 'fail' callback. If the fail callback isn't specified by the
  developer, it will default back to this function.

Source:

• sys.js, line 351

See:

• baja.ok

Parameters:

(static) findCtor(typeSpec) → {function}

Description:

• Find a Type's Constructor and return it. If the Type hasn't been
  Properly loaded then return null.

Source:

• sys.js, line 1675

Parameters:

Returns:

Type

function

(static) getLanguage() → {String}

Description:

• Returns language code for the user.

Source:

• sys.js, line 1170

Returns:

Type

String

(static) getTimeFormatPattern() → {String}

Description:

• Return the user's default time format pattern.

Source:

• sys.js, line 1188

Returns:

Type

String

(static) getUnitConversion() → {number}

Description:

• Return the user's configured unit conversion.

Source:

• sys.js, line 1196

Returns:

Type

number

(static) getUserHome() → {baja.Ord}

Description:

• Return the user home.

Source:

• sys.js, line 1179

Returns:

Type

baja.Ord

(static) getUserName() → {String}

Description:

• Returns the user name the user is currently logged in with. Note that
  it is not SlotPath-escaped; remember to escape it if retrieving the
  user from the UserService by slot name.

Source:

• sys.js, line 1161

Returns:

Type

String

(static) hasType(obj, typeopt) → {Boolean}

Description:

• Test an Object to see if it's a Baja Object and has the 'getType' function.

  Please note: this test excludes objects that may extend
  baja.Slot.

Source:

• sys.js, line 503

Parameters:

Returns:

Type

Boolean

(static) importTypes(obj) → {Promise.<Array.<Type>>}

Description:

• Load the Type and Contract information for the given TypeSpecs.

  A TypeSpec is a String in the format of moduleName:typeName in
  Niagara.

  This method may perform a network call if one of the TypeSpecs can't
  be found locally in the Registry or if a Contract needs to be
  retrieved.

  If a number of network calls is expected to be made then a
  Batch object can be passed into this method
  along with a callback. The network call will then be 'batched'
  accordingly.

  If the types for a given Web Application are known upfront then
  please specify them in baja.start instead.

Source:

• sys.js, line 1581

See:

• baja.start

Example

The method can be invoked with an array of TypeSpecs or an object literal.

  baja.importTypes(["control:NumericWritable", "control:BooleanWritable"]);

  // ...or via an Object Literal to specify further options...

  baja.importTypes({
    typeSpecs: ["control:NumericWritable", "control:BooleanWritable"],
    batch: batch // If specified, network calls are batched into this object
  })
    .then(function (types) {
      baja.outln('imported all types: ' + types.join());
    })
    .catch(function (errObj) {
      baja.error('some types failed to import');
      Object.keys(errObj).forEach(function (typeSpec) {
        baja.error(typeSpec + ' failed because: ' + errObj[typeSpec]);
      });
    });

Parameters:

Returns:

Type

Promise.<Array.<Type>>

(static) isLogClientErrorsInServer() → {Boolean}

Description:

• Return true if any client Errors are also being logged in the Server.

  Please note, since BOX and HTTP Errors are technically from the Server,
  these do not constitute as client Errors.

Source:

• sys.js, line 1208

Returns:

Type

Boolean

(static) isOffline() → {Boolean}

Description:

• Return true if BajaScript is running in offline mode.

Source:

• sys.js, line 889

Returns:

Type

Boolean

(static) isStarted() → {Boolean}

Description:

• Return true if BajaScript has started.

Source:

• sys.js, line 862

Returns:

Type

Boolean

(static) isStopped() → {Boolean}

Description:

• Return true if BajaScript has stopped.

Source:

• sys.js, line 871

Returns:

Type

Boolean

(static) isStopping() → {Boolean}

Description:

• Return true if BajaScript has stopped or is in the process of stopping.

Source:

• sys.js, line 880

Returns:

Type

Boolean

(static) iterate()

Description:

• A iteration general utility method that performs the given function on every JavaScript
  property in the given cursor or Javascript array. This function can be called
  with a variety of parameter configurations.

  iterate() is compatible with arrays, but not with
  arguments objects - pass in
  Array.prototype.slice.call(arguments) instead.

  In the last case with the doIterate and
  getNext functions, doIterate performs the
  iterative action on the object, and getNext returns the
  next object to iterate (this will be passed directly back into
  doIterate). This is handy for walking up prototype chains,
  supertype chains, component hierarchies, etc.

  In all cases, if the function being executed ever returns a value
  other than undefined, iteration will be stopped at that
  point and iterate() will return that value.

  For invocations of iterate() that include start or end
  indexes, note that start indexes are inclusive and end indexes are
  exclusive (e.g. iterate(2, 5, function (i) { baja.outln(i); })
  would print 2,3,4).

Source:

• baja/sys/bajaUtils.js, line 317

Example

baja.iterate(array, function (arrayElement, arrayIndex))

baja.iterate(array, startIndex, function (arrayElement, arrayIndex))

baja.iterate(array, startIndex, endIndex, function (arrayElement, arrayIndex))

baja.iterate(numberOfTimesToIterate, function (index))

baja.iterate(iterationStartIndex, iterationEndIndex, function (index))

baja.iterate(object, function (objectJsProperty, objectJsPropertyName))

baja.iterate(object, function doIterate(object), function getNext(object))

Returns:

(static) lex(obj) → {module:nmodule/js/rc/lex/lex|Promise.<module:nmodule/js/rc/lex/lex>}

Description:

• Returns a Lexicon Object for a given module. The locale will be
  whatever the current user is set to.

  Please note, if BajaScript has Web Storage enabled, the Lexicon
  will be permanently cached.

  If the argument is just a String, no network call will be made.
  Instead, an attempt will be made to see if the Lexicon is cached
  locally. If available, it's returned. If not then an Error will be
  thrown. If you are not certain whether the lexicon is already loaded,
  it's recommended to use a callback.

  Please note, this method is now deprecated. Please use the lex module
  instead.

Source:

• sys.js, line 580

Deprecated:

• Please use Lexicon JS instead.

See:

• {module:nmodule/js/rc/lex/lex}
• baja.request

Example

// Get a value from a Lexicon. An asynchronous network call will be
  // made if the Lexicon isn't available locally. Note that this form
  // is safe to use whether the lexicon is already loaded or not.
  baja.lex({
    module: "bajaui"
  })
    .then(function (lex) {
      lex.get("dialog.ok");

      //now that the lexicon is loaded, baja.lex("bajaui") will
      //succeed from here on out.
    });

  // Get a value from a Lexicon. This will throw an error if the lexicon
  // was not already loaded via a network call as above.
  baja.lex("bajaui").get("dialog.ok");

Parameters:

Throws:

if looking up a Lexicon by name, but the Lexicon has
not yet been loaded

Type

Error

Returns:

Type

module:nmodule/js/rc/lex/lex | Promise.<module:nmodule/js/rc/lex/lex>

(static) lt(typeSpec) → {Type}

Description:

• Returns a Type. The Type must have already been imported first, via a
  call to baja.importTypes or using a baja! RequireJS import. If the
  type has not yet been loaded, null will be returned.

Source:

• sys.js, line 1661

See:

• baja.importTypes

Example

// Ensure the Type information is locally available.
  baja.importTypes({
    typeSpecs: ["foo:Boo"]
  })
    .then(function () {
      var type = baja.lt("foo:Boo");
    });

Parameters:

Returns:

Type

Type

(static) mixin(Ctor, mixin) → {function}

Description:

• Apply a Mix-In to the Constructor/Object.

  The Constructor passed in is extended then the MixIn function is
  invoked so that it can add to the newly extended object's prototype
  chain.

  This method can be invoked via a call to baja.subclass.

Source:

• baja/sys/inherit.js, line 81

Parameters:

Returns:

Type

function

(static) noop()

Description:

• A function that does nothing (noop = no-operation).

Source:

• sys.js, line 375

(static) ok()

Description:

• The global default ok callback function.

  Throughout BajaScript there are places where network calls may be
  made. In one of these cases, a developer has the option of specifying
  an 'ok' callback. If the ok callback isn't specifed by the developer,
  it will default back to this function.

Source:

• sys.js, line 367

See:

• baja.fail

(static) outln(msg)

Description:

• Print a message to BajaScript's debug output followed by a newline.
  By default just looks for a bajaJsPrint global function and
  passes the message to that.

Source:

• sys.js, line 179

Parameters:

Returns:

(static) preStop(func)

Description:

• Add a function to be invoked just before BajaScript is stopped.

  If BajaScript has already stopped, the function will be invoked
  immediately.

Source:

• sys.js, line 930

Parameters:

(static) rpc(ord, methodNameopt) → {Promise}

Description:

• Make an RPC call to a method on the Server that implements the
  Java 'NiagaraRpc' annotation.

  Any extra arguments passed in will be encoded in raw JSON and passed up
  to the Server. If one of those arguments is a 'baja.comm.Batch', the
  call will be batched accordingly.

Source:

• sys.js, line 638

Parameters:

Returns:

Type

Promise

(static) runAsync(fn)

Description:

• Run the specified Function asynchronously.

Source:

• sys.js, line 617

Parameters:

(static) save()

Description:

• Save BajaScript's Registry Storage. This is automatically called when
  BajaScript stops.

Source:

• sys.js, line 1057

(static) start(objopt)

Description:

• Start BajaScript.

  This must be called to start BajaScript. This will make a network
  call to create a Session that starts BajaScript. It's recommended to
  call this as soon as possible.

Source:

• sys.js, line 996

See:

• baja.started
• baja.save
• baja.preStop
• baja.stop

Example

This method takes a started function or an object literal.

  baja.start(function () {
    // Called once BajaScript has started.
  });

  //...or this can be invoked via an Object Literal...

  baja.start({
    started: function () {
      // Called when BajaScript has started. We're ready to rock and roll at this point!
    },
    commFail: function () {
      // Called when the BajaScript communications engine completely fails
    },
    typeSpecs: ["control:BooleanWritable", "control:NumericWritable"] // Types and Contracts we want imported 
                                                                      // upfront before our Web App loads
  });

Parameters:

(static) started(func)

Description:

• Add a function to be invoked once BajaScript has started.

  If BajaScript has already started, the function will be invoked
  immediately.

Source:

• sys.js, line 901

Parameters:

(static) stop(objopt)

Description:

• Stop BajaScript.

  This method should be called when the page running BajaScript is
  unloaded. This will make a network call to stop BajaScript's session.

Source:

• sys.js, line 1097

See:

• baja.start
• baja.started
• baja.preStop

Example

This method takes a stopped function or an object literal.

  baja.stop(function () {
    // Called once stop has completed
  });
  
  //...or this can be invoked via an Object Literal...
  
  baja.stop({
    stopped: function () {
      // Called once stop has completed 
    }
  });

Parameters:

(static) subclass(Ctor, SuperCtor, mixInopt) → {function}

Description:

• Extends an Object by setting up the prototype chain.

  This method can have a Function or Object passed in as the SuperCtor argument.
  If SuperCtor Function is passed in, 'new' will be called on it to create an Object.
  The new Object will then be set on the target Function's prototype.

Source:

• baja/sys/inherit.js, line 14

See:

• baja.mixin

Parameters:

Returns:

Type

function

(static) throttle(func, obj) → {function}

Description:

• A general utility method that tries to prevents a function from running
  more often than the specified interval. Due to the vagaries of Javascript
  time management you may see the occasional drop of a few milliseconds but
  on the whole execution of the given function should not be permitted more
  than once in the specified interval.

  If the function is called before the interval is up, it will still be
  executed once the remainder of the interval elapses - it will not be
  cancelled.

  However, if the function is called multiple times before the
  interval has elapsed, only the last function call will execute -
  calls prior to that one will be cancelled.

  The function passed in will be run asynchronously via
  setTimeout(), so if you wish to process the results of the
  function call, you must do so via callback.

Source:

• sys.js, line 436

Parameters:

Returns:

Type

function

(static) unescapeXml(stropt) → {String}

Description:

• Unescape Xml characters out of a string.
  Here are some unescape examples:

  • '&lt;' to <
  • '&gt;' to >
  • '&amp;' to &
  • '&apos;' to '
  • '&quot;' to "
  • '&#x20ac;' to €

Source:

• baja/sys/bajaUtils.js, line 417

Parameters:

Returns:

Type

String