"
},
"example": [
"\n let route = new Route('/games/{gameName}/:level:/', this.method, this);\n console.log( route.match('/games/asteroids/2/') );"
],
"class": "Route",
"module": "StructureJS",
"submodule": "model"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 18,
"description": "A reference to the EventDispatcher object.",
"itemtype": "property",
"name": "_eventDispatcher",
"type": "{EventDispatcher}",
"access": "private",
"tagname": "",
"static": 1,
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 28,
"description": "A flag to determine if this class has already been initialized.",
"itemtype": "property",
"name": "_initialized",
"type": "{boolean}",
"access": "private",
"tagname": "",
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 42,
"description": "Returns the online status of the browser. The property returns a boolean value, with true for being online and false for being offline.",
"example": [
"\n NetworkMonitor.connected();"
],
"itemtype": "method",
"name": "connected",
"return": {
"description": "",
"type": "Boolean"
},
"static": 1,
"access": "public",
"tagname": "",
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 58,
"description": "Returns if the status type ('online' or 'offline') if computer or device is connected to the internet.",
"example": [
"\n NetworkMonitor.getStatus();"
],
"itemtype": "method",
"name": "getStatus",
"return": {
"description": "Returns 'online' or 'offline'.",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 74,
"description": "Registers an event listener object with an NetworkMonitor object so that the listener receives notification of an event.",
"example": [
"\n NetworkMonitor.addEventListener(NetworkMonitorEvent.STATUS, this._handlerMethod, this);\n _handlerMethod(event) {\n console.log(event.status, event.connected);\n }"
],
"itemtype": "method",
"name": "addEventListener",
"params": [
{
"name": "type",
"description": "The type of event.",
"type": "String"
},
{
"name": "callback",
"description": "The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing, as this example shows.",
"type": "Function"
},
{
"name": "scope",
"description": "Binds the scope to a particular object (scope is basically what \"this\" refers to in your function). This can be very useful in JavaScript because scope isn't generally maintained.",
"type": "Any"
},
{
"name": "priority",
"description": "Influences the order in which the listeners are called. Listeners with lower priorities are called after ones with higher priorities.",
"type": "Int",
"optional": true,
"optdefault": "0"
}
],
"static": 1,
"access": "public",
"tagname": "",
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 96,
"description": "Removes a specified listener from the NetworkMonitor object.",
"example": [
"\n NetworkMonitor.removeEventListener(NetworkMonitorEvent.STATUS, this._handlerMethod, this);\n _handlerMethod(event) {\n console.log(event.status, event.connected);\n }"
],
"itemtype": "method",
"name": "removeEventListener",
"params": [
{
"name": "type",
"description": "The type of event.",
"type": "String"
},
{
"name": "callback",
"description": "The listener object to remove.",
"type": "Function"
},
{
"name": "scope",
"description": "The scope of the listener object to be removed.\nTo keep things consistent this parameter is required.",
"type": "Any"
}
],
"static": 1,
"access": "public",
"tagname": "",
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 116,
"description": "Adds the necessary event listeners to listen for the 'online' and 'offline' events.",
"itemtype": "method",
"name": "_start",
"static": 1,
"access": "private",
"tagname": "",
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 138,
"description": "An event handler method when the native Window 'online' and 'offline' events are triggered.",
"itemtype": "method",
"name": "_onNetworkMonitorEvent",
"params": [
{
"name": "event",
"description": ""
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/net/NetworkMonitor.ts",
"line": 154,
"description": "Dispatches an event within the NetworkMonitorEvent object.
",
"itemtype": "method",
"name": "_dispatchEvent",
"params": [
{
"name": "event",
"description": "The Event object that is dispatched into the event flow. You can create custom events, the only requirement is all events must\nextend the {{#crossLink \"NetworkMonitorEvent\"}}{{/crossLink}}.",
"type": "NetworkMonitorEvent"
}
],
"static": 1,
"access": "private",
"tagname": "",
"class": "NetworkMonitor",
"module": "StructureJS"
},
{
"file": "ts/plugin/jquery.eventListener.ts",
"line": 3,
"description": "A bind polyfill for browsers that don't support the bind method.",
"class": "ApplicationCacheService",
"module": "StructureJS"
},
{
"file": "ts/plugin/jquery.eventListener.ts",
"line": 36,
"description": "Generates a hash string from the string being passed in. In this case it is a function that is casted as string value.",
"params": [
{
"name": "str",
"description": ""
}
],
"return": {
"description": "",
"type": "String"
},
"class": "ApplicationCacheService",
"module": "StructureJS"
},
{
"file": "ts/plugin/jquery.eventListener.ts",
"line": 62,
"description": "The jQuery addEventListener plugin",
"class": "ApplicationCacheService",
"module": "StructureJS"
},
{
"file": "ts/plugin/jquery.eventListener.ts",
"line": 99,
"description": "The jQuery removeEventListener plugin",
"class": "ApplicationCacheService",
"module": "StructureJS"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 17,
"description": "A reference to the applicationCache property on the window object.",
"itemtype": "property",
"name": "_appCache",
"type": "{ApplicationCache}",
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 27,
"description": "A reference to the EventDispatcher object.",
"itemtype": "property",
"name": "_eventDispatcher",
"type": "{EventDispatcher}",
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 37,
"description": "The isEnabled property is used to keep track of the enabled state.",
"itemtype": "property",
"name": "isEnabled",
"type": "{boolean}",
"default": "false",
"access": "public",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 53,
"overridden": "BaseObject.enable",
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 76,
"overridden": "BaseObject.disable",
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 124,
"description": "The resources listed in the manifest have been fully downloaded, and the application is\nnow cached locally.",
"itemtype": "method",
"name": "_onCached",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 139,
"description": "The browser is checking for an update, or is attempting to download\nthe cache manifest for the first time. This is always the first event\nin the sequence.",
"itemtype": "method",
"name": "_onChecking",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 155,
"description": "The browser has started to download the cache manifest, either for the\nfirst time or because changes have been detected.",
"itemtype": "method",
"name": "_onDownloading",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 170,
"description": "An error occurred at some point - this could be caused by a number of things. This will\nalways be the last event in the sequence.",
"itemtype": "method",
"name": "_onError",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 185,
"description": "The cache manifest hadn't changed.",
"itemtype": "method",
"name": "_onNoUpdate",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 199,
"description": "The cache manifest file could not be found, indicating that the cache is no longer needed.\nThe application cache is being deleted.",
"itemtype": "method",
"name": "_onObsolete",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 214,
"description": "The browser had downloaded and cached an asset. This is fired once for\nevery file that is downloaded (including the current page which is cached implicitly).",
"itemtype": "method",
"name": "_onProgress",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 229,
"description": "The resources listed in the manifest have been newly re-downloaded, and the script can\nuse swapCache() to switch to the new cache.",
"itemtype": "method",
"name": "_onUpdateReady",
"params": [
{
"name": "event",
"description": "The native browser event from the DOMApplicationCache.",
"type": "DOMApplicationCacheEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 244,
"description": "Registers an event listener object with an ApplicationCacheService object so that the listener receives notification of an event.",
"itemtype": "method",
"name": "addEventListener",
"params": [
{
"name": "type",
"description": "The type of event.",
"type": "String"
},
{
"name": "callback",
"description": "The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing, as this example shows. @example function(event:Event):void",
"type": "Function"
},
{
"name": "scope",
"description": "Binds the scope to a particular object (scope is basically what \"this\" refers to in your function). This can be very useful in JavaScript because scope isn't generally maintained.",
"type": "Any"
},
{
"name": "priority",
"description": "Influences the order in which the listeners are called. Listeners with lower priorities are called after ones with higher priorities.",
"type": "Int",
"optional": true,
"optdefault": "0"
}
],
"static": 1,
"example": [
"\n ApplicationCacheService.addEventListener(ApplicationCacheEvent.UPDATE_READY, this._handlerMethod, this);\n _handlerMethod(event) {\n console.log(event.target + \" sent the event.\");\n }"
],
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 264,
"description": "Removes a specified listener from the ApplicationCacheService object.",
"itemtype": "method",
"name": "removeEventListener",
"params": [
{
"name": "type",
"description": "The type of event.",
"type": "String"
},
{
"name": "callback",
"description": "The listener object to remove.",
"type": "Function"
},
{
"name": "scope",
"description": "The scope of the listener object to be removed. This was added because it was need for the {{#crossLink \"ApplicationCacheService\"}}{{/crossLink}} class.\nTo keep things consistent this parameter is required.",
"type": "Any"
}
],
"static": 1,
"example": [
"\n ApplicationCacheService.removeEventListener(ApplicationCacheEvent.UPDATE_READY, this._handlerMethod, this);\n _handlerMethod(event) {\n console.log(event.target + \" sent the event.\");\n }"
],
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/ApplicationCacheService.ts",
"line": 284,
"description": "Dispatches an event within the ApplicationCacheService object.
",
"itemtype": "method",
"name": "dispatchEvent",
"params": [
{
"name": "event",
"description": "The Event object that is dispatched into the event flow. You can create custom events, the only requirement is all events must\nextend the {{#crossLink \"ApplicationCacheEvent\"}}{{/crossLink}}.",
"type": "ApplicationCacheEvent"
}
],
"static": 1,
"example": [
"\n let event = new ApplicationCacheEvent(ApplicationCacheEvent.UPDATE_READY);\n ApplicationCacheService.dispatchEvent(event);\n\n // Here is a common inline event being dispatched\n ApplicationCacheService.dispatchEvent(new ApplicationCacheEvent(ApplicationCacheEvent.UPDATE_READY));"
],
"class": "ApplicationCacheService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 58,
"description": "Current user namespace. The namespace is optional.",
"itemtype": "property",
"name": "_namespace",
"type": "{string}",
"default": "defaultNamespace",
"optional": 1,
"access": "protected",
"tagname": "",
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 69,
"description": "A reference to window.localStorage for faster access.",
"itemtype": "property",
"name": "_localStorage",
"type": "{Storage}",
"access": "protected",
"tagname": "",
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 95,
"description": "Set storage namespace",
"itemtype": "method",
"name": "setNamespace",
"params": [
{
"name": "namespace",
"description": ""
}
],
"return": {
"description": "",
"type": "String"
},
"example": [
"\n this._localStorageController.setNamespace('myNamespace~');"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 109,
"description": "Get storage namespace",
"itemtype": "method",
"name": "getNamespace",
"return": {
"description": "",
"type": "String"
},
"example": [
"\n const currentSetNamespace = this._localStorageController.getNamespace();"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 122,
"description": "Add a key/value pair to localStorage.",
"itemtype": "method",
"name": "set",
"params": [
{
"name": "key",
"description": "",
"type": "String"
},
{
"name": "data",
"description": "",
"type": "Object"
},
{
"name": "useNamespace",
"description": "",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n this._localStorageController.set('someName', { value: 'something'});\n\n // If you set a namespace you would pass 'true' into the third parameter.\n this._localStorageController.set('someName', { value: 'something'}, true);"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 161,
"description": "Retrieves the current value associated with the Local Storage key.",
"itemtype": "method",
"name": "get",
"params": [
{
"name": "key",
"description": "",
"type": "String"
},
{
"name": "useNamespace",
"description": "",
"type": "String",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "",
"type": "Any"
},
"example": [
"\n this._localStorageController.setNamespace('myNamespace~');"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 195,
"description": "Returns all items in local storage as an Object with key and value properties or\nreturns all items with a certain namespace.",
"itemtype": "method",
"name": "getAll",
"params": [
{
"name": "namespace",
"description": "The namespace that is used to items.",
"type": "String",
"optional": true,
"optdefault": "null"
}
],
"return": {
"description": "",
"type": "Array"
},
"example": [
"\n this._localStorageController.getAll();\n this._localStorageController.getAll('myNamespace~');"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 228,
"description": "Deletes a key/value pair from the Local Storage collection.",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "key",
"description": "",
"type": "String"
},
{
"name": "useNamespace",
"description": "",
"type": "String",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n this._localStorageController.remove('someName');\n\n // If you set a namespace you would pass 'true' into the second parameter.\n this._localStorageController.remove('someName', true);"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 259,
"description": "Returns the number of items storage in local storage.",
"itemtype": "method",
"name": "getLength",
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n const numberOfItemsInLocalStorage = this._localStorageController.getLength();"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 272,
"description": "Returns the size of the Local Storage.",
"itemtype": "method",
"name": "getSize",
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n const sizeOfLocalStorage = this._localStorageController.getSize();"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 285,
"description": "Removes all key/value pairs from the Local Storage area.",
"itemtype": "method",
"name": "removeAll",
"params": [
{
"name": "namespace",
"description": "",
"type": "String",
"optional": true,
"optdefault": "null"
}
],
"example": [
"\n this._localStorageController.removeAll();\n this._localStorageController.removeAll('myNamespace~');"
],
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 303,
"itemtype": "method",
"name": "_onLocalStorageEvent",
"params": [
{
"name": "event",
"description": "The native browser event for Web Storage.",
"type": "StorageEvent"
}
],
"access": "protected",
"tagname": "",
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/LocalStorageService.ts",
"line": 313,
"description": "Deletes all key/value pairs with a certain namespace.",
"itemtype": "method",
"name": "removeItemsWithNamespace",
"params": [
{
"name": "namespace",
"description": "",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "LocalStorageService",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 19,
"description": "A reference to the browser Window Object.",
"itemtype": "property",
"name": "_window",
"type": "{Window}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 29,
"description": "A list of the added Route objects.",
"itemtype": "property",
"name": "_routes",
"type": "{Array}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 39,
"description": "TODO: YUIDoc_comment",
"itemtype": "property",
"name": "_validators",
"type": "{Array}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 49,
"description": "TODO: YUIDoc_comment",
"itemtype": "property",
"name": "_validatorFunc",
"type": "{Function}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 59,
"description": "A reference to default route object.",
"itemtype": "property",
"name": "_defaultRoute",
"type": "{Route}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 69,
"description": "A reference to the hash change event that was sent from the Window Object.",
"itemtype": "property",
"name": "_hashChangeEvent",
"type": "{any}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 79,
"description": "A reference to the current {{#crossLink \"RouterEvent\"}}{{/crossLink}} that was triggered.",
"itemtype": "property",
"name": "_currentRoute",
"type": "{RouterEvent}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 89,
"description": "A reference to the last state object this {{#crossLink \"Router\"}}{{/crossLink}} creates when this\nusing the HTML5 History API.",
"itemtype": "property",
"name": "_lastHistoryState",
"type": "{RouterEvent}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 100,
"description": "Determines if the {{#crossLink \"Router\"}}{{/crossLink}} should use hash or history routing.",
"itemtype": "property",
"name": "forceHashRouting",
"type": "{boolean}",
"default": "false",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.forceHashRouting = true;"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 113,
"description": "Determines if the Router class is enabled or disabled.",
"itemtype": "property",
"name": "isEnabled",
"type": "{boolean}",
"readonly": "",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // Read only.\n console.log(Router.isEnabled);"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 127,
"description": "The **Router.useDeepLinking** property tells the Router class weather it should change the hash url or not.\nBy **default** this property is set to **true**. If you set the property to **false** and using the **Router.navigateTo**\nmethod the hash url will not change. This can be useful if you are making an application or game and you don't want the user\nto know how to jump to other sections directly. See the **Router.{{#crossLink \"Router/allowManualDeepLinking:property\"}}{{/crossLink}}** to fully change the Router class\nfrom relying on the hash url to an internal state service.",
"itemtype": "property",
"name": "useDeepLinking",
"type": "{boolean}",
"default": "true",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.useDeepLinking = true;"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 144,
"description": "The **Router.allowManualDeepLinking** property tells the Router class weather it should check for route matches if the\nhash url changes in the browser. This property only works if the **Router. {{#crossLink \"Router/useDeepLinking:property\"}}{{/crossLink}}** is set to **false**.\nThis is useful if want to use your added routes but don't want any external forces trigger your routes.\n\nTypically what I do for games is during development/testing I allow the hash url to change the states so testers can jump\nto sections or levels easily but then when it is ready for production I set the property to **false** so users cannot jump\naround if they figure out the url schema.",
"itemtype": "property",
"name": "allowManualDeepLinking",
"type": "{boolean}",
"default": "true",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.useDeepLinking = false;\n Router.allowManualDeepLinking = false;"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 164,
"description": "The **Router.forceSlash** property tells the Router class if the **Router.{{#crossLink \"Router/navigateTo:method\"}}{{/crossLink}}** method is called to\nmake sure the hash url has a forward slash after the **#** character like this **#/**.",
"itemtype": "property",
"name": "forceSlash",
"type": "{boolean}",
"default": "false",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // To turn on forcing the forward slash\n Router.forceSlash = true;\n\n // If forceSlash is set to true it will change the url from #contact/bob/ to #/contact/bob/\n // when using the navigateTo method."
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 182,
"description": "The **Router.allowMultipleMatches** property tells the Router class if it should trigger one or all routes that match a route pattern.",
"itemtype": "property",
"name": "allowMultipleMatches",
"type": "{boolean}",
"default": "true",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // Only allow the first route matched to be triggered.\n Router.allowMultipleMatches = false;"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 201,
"description": "The **Router.add** method allows you to listen for route patterns to be matched. When a match is found the callback will be executed passing a {{#crossLink \"RouterEvent\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "routePattern",
"description": "The string pattern you want to have match, which can be any of the following combinations {}, ::, *, ?, ''. See the examples below for more details.",
"type": "String"
},
{
"name": "callback",
"description": "The function that should be executed when a request matches the routePattern. It will receive a {{#crossLink \"RouterEvent\"}}{{/crossLink}} object.",
"type": "Function"
},
{
"name": "callbackScope",
"description": "The scope of the callback function that should be executed.",
"type": "Any"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // Example of adding a route listener and the function callback below.\n Router.add('/games/{gameName}/:level:/', this._method, this);\n\n // The above route listener would match the below url:\n // www.site.com/#/games/asteroids/2/\n\n // The Call back receives a RouterEvent object.\n _onRouteHandler(routerEvent) {\n console.log(routerEvent.params);\n }\n\nRoute Pattern Options:\n----------------------\n**:optional:** The two colons **::** means a part of the hash url is optional for the match. The text between can be anything you want it to be.\n\n Router.add('/contact/:name:/', this._method, this);\n\n // Will match one of the following:\n // www.site.com/#/contact/\n // www.site.com/#/contact/heather/\n // www.site.com/#/contact/john/\n\n\n**{required}** The two curly brackets **{}** means a part of the hash url is required for the match. The text between can be anything you want it to be.\n\n Router.add('/product/{productName}/', this._method, this);\n\n // Will match one of the following:\n // www.site.com/#/product/shoes/\n // www.site.com/#/product/jackets/\n\n\n**\\*** The asterisk character means it will match all or part of part the hash url.\n\n Router.add('*', this._method, this);\n\n // Will match one of the following:\n // www.site.com/#/anything/\n // www.site.com/#/matches/any/hash/url/\n // www.site.com/#/really/it/matches/any/and/all/hash/urls/\n\n\n**?** The question mark character means it will match a query string for the hash url.\n\n Router.add('?', this._method, this);\n\n // Will match one of the following:\n // www.site.com/#/?one=1&two=2&three=3\n // www.site.com/#?one=1&two=2&three=3\n\n\n**''** The empty string means it will match when there are no hash url.\n\n Router.add('', this._method, this);\n Router.add('/', this._method, this);\n\n // Will match one of the following:\n // www.site.com/\n // www.site.com/#/\n\n\nOther possible combinations but not limited too:\n\n Router.add('/games/{gameName}/:level:/', this._method1, this);\n Router.add('/{category}/blog/', this._method2, this);\n Router.add('/home/?', this._method3, this);\n Router.add('/about/*', this._method4, this);\n"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 289,
"description": "The **Router.remove** method will remove one of the added routes.",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "routePattern",
"description": "Must be the same string pattern you pasted into the {{#crossLink \"Router/add:method\"}}{{/crossLink}} method.",
"type": "String"
},
{
"name": "callback",
"description": "Must be the same function you pasted into the {{#crossLink \"Router/add:method\"}}{{/crossLink}} method.",
"type": "Function"
},
{
"name": "callbackScope",
"description": "Must be the same scope off the callback pattern you pasted into the {{#crossLink \"Router/add:method\"}}{{/crossLink}} method.",
"type": "Any"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // Example of adding a route listener.\n Router.add('/games/{gameName}/:level:/', this._method, this);\n\n // Example of removing the same added route listener above.\n Router.remove('/games/{gameName}/:level:/', this._method, this);"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 319,
"description": "The **Router.addDefault** method is meant to trigger a callback function if there are no route matches are found.",
"itemtype": "method",
"name": "addDefault",
"params": [
{
"name": "callback",
"description": "",
"type": "Function"
},
{
"name": "callbackScope",
"description": "",
"type": "Any"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.addDefault(this._noRoutesFoundHandler, this);"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 335,
"description": "The **Router.removeDefault** method will remove the default callback that was added by the **Router.addDefault** method.",
"itemtype": "method",
"name": "removeDefault",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.removeDefault();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 349,
"description": "Gets the current hash url minus the # or #! symbol(s).",
"itemtype": "method",
"name": "getHash",
"access": "public",
"tagname": "",
"static": 1,
"return": {
"description": "Returns current hash url minus the # or #! symbol(s).",
"type": "String"
},
"example": [
"\n let str = Router.getHash();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 367,
"description": "The **Router.enable** method will allow the Router class to listen for the hashchange event. By default the Router class is enabled.",
"itemtype": "method",
"name": "enable",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.enable();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 397,
"description": "The **Router.disable** method will stop the Router class from listening for the hashchange event.",
"itemtype": "method",
"name": "disable",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.disable();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 427,
"description": "The **Router.start** method is meant to trigger or check the hash url on page load.\nEither you can call this method after you add all your routers or after all data is loaded.\nIt is recommend you only call this once per page or application instantiation.",
"itemtype": "method",
"name": "start",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // Example of adding routes and calling the start method.\n Router.add('/games/{gameName}/:level:/', this._method1, this);\n Router.add('/{category}/blog/', this._method2, this);\n\n Router.start();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 453,
"description": "The **Router.navigateTo** method allows you to change the hash url and to trigger a route\nthat matches the string value. The second parameter is **silent** and is **false** by\ndefault. This allows you to update the hash url without causing a route callback to be\nexecuted.",
"itemtype": "method",
"name": "navigateTo",
"params": [
{
"name": "route",
"description": "",
"type": "String"
},
{
"name": "silent",
"description": "",
"type": "Boolean",
"optional": true,
"optdefault": "false"
},
{
"name": "disableHistory",
"description": "",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // This will update the hash url and trigger the matching route.\n Router.navigateTo('/games/asteroids/2/');\n\n // This will update the hash url but will not trigger the matching route.\n Router.navigateTo('/games/asteroids/2/', true);\n\n // This will not update the hash url but will trigger the matching route.\n Router.navigateTo('/games/asteroids/2/', true, true);"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 539,
"description": "The **Router.clear** will remove all route's and the default route from the Router class.",
"itemtype": "method",
"name": "clear",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.clear();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 555,
"description": "The **Router.destroy** method will null out all references to other objects in the Router class.",
"itemtype": "method",
"name": "destroy",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.destroy();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 572,
"description": "A simple helper method to create a url route from an unlimited number of arguments.",
"itemtype": "method",
"name": "buildRoute",
"params": [
{
"name": "...rest",
"description": "",
"type": "...rest"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n const someProperty = 'api/endpoint';\n const queryObject = {type: 'car', name: encodeURIComponent('Telsa Motors')};\n\n Router.buildRoute(someProperty, 'path', 7, queryObject);\n\n //Creates 'api/endpoint/path/7?type=car&name=Telsa%20Motors'"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 613,
"description": "Returns the current router event that was last triggered.",
"itemtype": "method",
"name": "getCurrentRoute",
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.getCurrentRoute();"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 627,
"description": "TODO: YUIDoc_comment",
"itemtype": "method",
"name": "validate",
"params": [
{
"name": "func",
"description": "The function you wanted called if the validation failed.",
"type": "Function"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Router.validate((routerEvent, next) => {\n const allowRouteChange = this._someMethodCheck();\n\n if (allowRouteChange == false) {\n next(() => {\n // Do something here.\n // For example you can call Router.navigateTo to change the route.\n });\n } else {\n next();\n }\n });"
],
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 653,
"description": "This method will be called if the Window object dispatches a HashChangeEvent.\nThis method will not be called if the Router is disabled.",
"itemtype": "method",
"name": "_onHashChange",
"params": [
{
"name": "event",
"description": "",
"type": "HashChangeEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 676,
"description": "This method will be called if the Window object dispatches a popstate event.\nThis method will not be called if the Router is disabled.",
"itemtype": "method",
"name": "_onHistoryChange",
"params": [
{
"name": "event",
"description": "",
"type": "HashChangeEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 717,
"description": "The method is responsible for check if one of the routes matches the string value passed in.",
"itemtype": "method",
"name": "_changeRoute",
"params": [
{
"name": "hash",
"description": "",
"type": "String"
}
],
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/service/Router.ts",
"line": 837,
"description": "TODO: YUIDoc_comment",
"itemtype": "method",
"name": "_allowRouteChange",
"access": "private",
"tagname": "",
"static": 1,
"class": "Router",
"module": "StructureJS",
"submodule": "controller"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 16,
"description": "A reference to the EventDispatcher object.",
"itemtype": "property",
"name": "_eventDispatcher",
"type": "{EventDispatcher}",
"access": "private",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 26,
"description": "A reference to the browser window object.",
"itemtype": "property",
"name": "_window",
"type": "{Window}",
"access": "private",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 36,
"description": "A reference to the getComputedStyle method.",
"itemtype": "property",
"name": "_styleDeclaration",
"type": "{any}",
"access": "private",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 46,
"description": "TODO: YUIDoc_comment",
"itemtype": "property",
"name": "_onBreakpointChangeHandler",
"type": "{any}",
"access": "private",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 56,
"description": "The delay in milliseconds for the Util.{{#crossLink \"Util/debounce:method\"}}{{/crossLink}} method that dispatches\nthe BaseEvent.RESIZE event to get the your browser breakpoints. See {{#crossLink \"BrowserUtil/getBreakpoint:method\"}}{{/crossLink}}.",
"itemtype": "property",
"name": "debounceDelay",
"type": "{number}",
"default": "250",
"access": "public",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 68,
"description": "The isEnabled property is used to keep track of the enabled state of listening for Breakpoint changes.",
"itemtype": "property",
"name": "isEnabled",
"type": "{boolean}",
"access": "public",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 83,
"description": "Dispatches a breakpoint event.",
"itemtype": "method",
"name": "enable",
"access": "public",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 103,
"overridden": "EventDispatcher.disable",
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 118,
"description": "Returns the name of the browser.",
"itemtype": "method",
"name": "browserName",
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.browserName();\n // 'Chrome'"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 134,
"description": "Returns the version of the browser.",
"itemtype": "method",
"name": "browserVersion",
"params": [
{
"name": "majorVersion",
"description": "",
"type": "Boolean",
"optional": true,
"optdefault": "true"
}
],
"return": {
"description": "",
"type": "Number|string"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.browserVersion();\n // 39\n\n BrowserUtil.browserVersion(false);\n // '39.0.2171.99'"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 163,
"description": "Gets the browser name a user agent.",
"itemtype": "method",
"name": "getBrowser",
"access": "public",
"tagname": "",
"return": {
"description": "",
"type": "Array."
},
"static": 1,
"example": [
"\n BrowserUtil.getBrowser();\n // [\"Chrome\", \"39.0.2171.99\"]"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 191,
"description": "Determines if the device OS is Android.",
"itemtype": "method",
"name": "isAndroid",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.isAndroid();\n // false"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 207,
"description": "Determines if the device OS is Android.",
"itemtype": "method",
"name": "isBlackBerry",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.isBlackBerry();\n // false"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 223,
"description": "Determines if the device OS is IOS.",
"itemtype": "method",
"name": "isIOS",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.isIOS();\n // false"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 239,
"description": "Determines if the device OS is Opera Mini.",
"itemtype": "method",
"name": "isOperaMini",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.isOperaMini();\n // false"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 255,
"description": "Determines if the device OS is IE Mobile.",
"itemtype": "method",
"name": "isIEMobile",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.isIEMobile();\n // false"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 271,
"description": "Determines if the it is run on a mobile or desktop device.",
"itemtype": "method",
"name": "isMobile",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.isMobile();\n // false"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 287,
"description": "Determines if the browser can you Browser History push states.",
"itemtype": "method",
"name": "hasBrowserHistory",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.hasBrowserHistory();\n // true"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 303,
"description": "Determines if the browser can you Local Storage.",
"itemtype": "method",
"name": "hasLocalStorage",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.hasLocalStorage();\n // true"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 326,
"description": "Determines if the browser can you Session Storage.",
"itemtype": "method",
"name": "hasSessionStorage",
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n BrowserUtil.hasSessionStorage();\n // true"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 349,
"description": "Get the current breakpoint from the style sheets. You must add a body:after property with a specific content\nin each of your style sheets for this functionality to work.",
"itemtype": "method",
"name": "getBreakpoint",
"return": {
"description": "The string value of the current style sheet.",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n // For each of your different style sheets add something like below:\n // screen_lg.css\n body:after {\n content: 'screen_lg'; width: 1px; height: 1px; padding: 0; margin: -1px; border: 0; position: absolute; clip: rect(0 0 0 0); overflow: hidden;\n }\n // screen_sm.css\n body:after {\n content: 'screen_sm'; width: 1px; height: 1px; padding: 0; margin: -1px; border: 0; position: absolute; clip: rect(0 0 0 0); overflow: hidden;\n }\n\n BrowserUtil.getBreakpoint();\n // 'screen_lg'\n\n // Add a listener to get notified when the browser is resized:\n BrowserUtil.addEventListener(BaseEvent.RESIZE, this._onBreakpointChange, this);\n ...\n _onBreakpointChange(baseEvent) {\n console.log(baseEvent.data);\n // 'screen_sm'\n }"
],
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 384,
"description": "TODO: YUIDoc_comment",
"itemtype": "method",
"name": "addEventListener",
"access": "public",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 397,
"description": "TODO: YUIDoc_comment",
"itemtype": "method",
"name": "removeEventListener",
"access": "public",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 409,
"description": "TODO: YUIDoc_comment",
"itemtype": "method",
"name": "dispatchEvent",
"access": "public",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BrowserUtil.ts",
"line": 431,
"description": "Dispatches a breakpoint event.",
"itemtype": "method",
"name": "_onBreakpointChange",
"access": "private",
"tagname": "",
"static": 1,
"class": "BrowserUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 21,
"description": "A collection to store all the IDataStore's.",
"itemtype": "property",
"name": "_dataStores",
"type": "{Collection}",
"access": "protected",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 30,
"description": "The total number of items that have been loaded.",
"itemtype": "property",
"name": "_totalComplete",
"type": "{number}",
"access": "protected",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 39,
"description": "A queue of IDataStore's that need to be loaded still.",
"itemtype": "property",
"name": "_queue",
"type": "{Array<{key:any, value:any}>}",
"access": "protected",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 48,
"description": "Set the maximum number of simultaneous connections (default is 3).",
"itemtype": "property",
"name": "maxConnections",
"type": "[number=3]",
"access": "public",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 64,
"description": "Helper method to add IDataStore's.",
"itemtype": "method",
"name": "addFile",
"params": [
{
"name": "dataStore",
"description": "",
"type": "IDataStore"
},
{
"name": "key",
"description": "[string=null]"
}
],
"access": "public",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 87,
"description": "Helper method to get IDataStore's.",
"itemtype": "method",
"name": "getFile",
"params": [
{
"name": "key",
"description": "",
"type": "String"
}
],
"access": "public",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 100,
"description": "Helper method to start the loading process.",
"itemtype": "method",
"name": "start",
"access": "public",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 124,
"description": "Helper method to stop/clear the loader.",
"itemtype": "method",
"name": "clear",
"access": "public",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 146,
"description": "Event handler method called every time a IDataStore's is completely loaded.",
"itemtype": "method",
"name": "_onComplete",
"params": [
{
"name": "event",
"description": "",
"type": "LoaderEvent"
}
],
"access": "protected",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/BulkLoader.ts",
"line": 179,
"description": "Event handler method called once all IDataStore's are completely loaded.",
"itemtype": "method",
"name": "_onLoadComplete",
"access": "protected",
"tagname": "",
"class": "BulkLoader",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ComponentFactory.ts",
"line": 22,
"description": "Takes a jQuery object that has one or more elements in it and passes a single jQuery element into the constructor of the class that is also being passed in.",
"itemtype": "method",
"name": "create",
"params": [
{
"name": "$element",
"description": "One or more jQuery referenced DOM elements.",
"type": "JQuery"
},
{
"name": "ComponentClass",
"description": "The class that you want instantiated.",
"type": "Any"
},
{
"name": "scope",
"description": "This scope (parent object) is needed to instantiate the component/view with the use of the {{#crossLink \"DisplayObjectContainer/addChild:method\"}}{{/crossLink}} method.",
"type": "DisplayObjectContainer",
"optional": true,
"optdefault": "null"
}
],
"return": {
"description": "Returns a list of instantiated components/views so you can manage them within the Class that created them.",
"type": "Array."
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ComponentFactory.create($('.js-list'), SomeClass, this);"
],
"class": "ComponentFactory",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ComponentFactory.ts",
"line": 73,
"description": "Helper method to create the component.",
"itemtype": "method",
"name": "_createComponent",
"access": "private",
"tagname": "",
"class": "ComponentFactory",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/DateUtil.ts",
"line": 12,
"description": "A list of day names.",
"itemtype": "property",
"name": "LONG_DAY_LABELS",
"type": "[Array=['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']]",
"access": "public",
"tagname": "",
"static": 1,
"final": 1,
"example": [
"\n DateUtil.LONG_DAY_LABELS[1];\n // 'Monday'"
],
"class": "DateUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/DateUtil.ts",
"line": 26,
"description": "A list of short day names",
"itemtype": "property",
"name": "SHORT_DAY_LABELS",
"type": "[Array=['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']]",
"access": "public",
"tagname": "",
"static": 1,
"final": 1,
"example": [
"\n DateUtil.SHORT_DAY_LABELS[1];\n // 'Mon'"
],
"class": "DateUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/DateUtil.ts",
"line": 40,
"description": "A list of month names.",
"itemtype": "property",
"name": "LONG_MONTH_LABELS",
"type": "[Array=['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']]",
"access": "public",
"tagname": "",
"static": 1,
"final": 1,
"example": [
"\n DateUtil.LONG_MONTH_LABELS[1];\n // 'February'"
],
"class": "DateUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/DateUtil.ts",
"line": 54,
"description": "A list of short month names.",
"itemtype": "property",
"name": "SHORT_MONTH_LABELS",
"type": "[Array=['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']]",
"access": "public",
"tagname": "",
"final": 1,
"example": [
"\n DateUtil.SHORT_MONTH_LABELS[1];\n // 'Feb'"
],
"class": "DateUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/DateUtil.ts",
"line": 72,
"description": "Returns the suffix of a given day.",
"itemtype": "method",
"name": "getDaySuffix",
"params": [
{
"name": "today",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n DateUtil.getDaySuffix(1);\n // 'st'\n\n DateUtil.getDaySuffix(2);\n // 'nd'\n\n DateUtil.getDaySuffix(3);\n // 'rd'\n\n DateUtil.getDaySuffix(4);\n // 'th'"
],
"class": "DateUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 17,
"description": "Returns a number constrained between min and max.",
"itemtype": "method",
"name": "constrain",
"params": [
{
"name": "num",
"description": "",
"type": "Number"
},
{
"name": "min",
"description": "",
"type": "Number"
},
{
"name": "max",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.constrain(12, 3, 20);\n // 12\n\n MathUtil.constrain(22, 3, 20);\n // 20\n\n MathUtil.constrain(0, 3, 20);\n // 3"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 49,
"description": "Returns a random number between min and max.",
"itemtype": "method",
"name": "randomRange",
"params": [
{
"name": "min",
"description": "",
"type": "Number"
},
{
"name": "max",
"description": "",
"type": "Number"
},
{
"name": "wholeNumber",
"description": "",
"type": "Number",
"optional": true,
"optdefault": "true"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 72,
"description": "Returns the percentage of a number in a given range.\nExample: num = 15 range 10 to 20 // outputs 0.5",
"itemtype": "method",
"name": "rangeToPercent",
"params": [
{
"name": "num",
"description": "",
"type": "Number"
},
{
"name": "min",
"description": "",
"type": "Number"
},
{
"name": "max",
"description": "",
"type": "Number"
},
{
"name": "constrainMin",
"description": "Returns 0 if num < min.",
"type": "Boolean"
},
{
"name": "constrainMax",
"description": "Returns 1 if num > max.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.rangeToPercent(15, 10, 20);\n // 0.5"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 101,
"description": "Returns the number that corresponds to the percentage in a given range.\nExample: percent = 0.5 range 10 to 20 // outputs 15",
"itemtype": "method",
"name": "percentToRange",
"params": [
{
"name": "percent",
"description": "",
"type": "Number"
},
{
"name": "min",
"description": "",
"type": "Number"
},
{
"name": "max",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.percentToRange(0.5, 10, 20);\n // 15"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 120,
"description": "Re-maps a number from one range to another. The output is the same as inputing the result of rangeToPercent() numbero percentToRange().\nExample: num = 10, min1 = 0, max1 = 100, min2 = 0, max2 = 50 // outputs 5",
"itemtype": "method",
"name": "map",
"params": [
{
"name": "num",
"description": "",
"type": "Number"
},
{
"name": "min1",
"description": "",
"type": "Number"
},
{
"name": "max1",
"description": "",
"type": "Number"
},
{
"name": "min2",
"description": "",
"type": "Number"
},
{
"name": "max2",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.map(10, 0, 100, 0, 50);\n // 5"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 156,
"description": "Converts radians to degrees.",
"itemtype": "method",
"name": "radiansToDegrees",
"params": [
{
"name": "radians",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.radiansToDegrees(1.5707963267948966);\n // 90\n\n MathUtil.radiansToDegrees(3.141592653589793);\n // 180"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 175,
"description": "Converts degrees to radians.",
"itemtype": "method",
"name": "degreesToRadians",
"params": [
{
"name": "degrees",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.degreesToRadians(90);\n // 1.5707963267948966\n\n MathUtil.degreesToRadians(180);\n // 3.141592653589793"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 194,
"description": "Returns 1 if the value is >= 0. Returns -1 if the value is < 0.",
"itemtype": "method",
"name": "sign",
"params": [
{
"name": "num",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.sign(23);\n // 1\n\n MathUtil.sign(-23);\n // -1"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 216,
"description": "Check if number is positive (zero is positive).",
"itemtype": "method",
"name": "isPositive",
"params": [
{
"name": "num",
"description": "The number.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n MathUtil.isPositive(23);\n // true\n\n MathUtil.isPositive(-23);\n // false"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 234,
"description": "Check if number is negative.",
"itemtype": "method",
"name": "isNegative",
"params": [
{
"name": "num",
"description": "The",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n MathUtil.isNegative(23);\n // false\n\n MathUtil.isNegative(-23);\n // true"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 252,
"description": "Check if number is odd (convert to Integer if necessary).",
"itemtype": "method",
"name": "isOdd",
"params": [
{
"name": "num",
"description": "The number.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n MathUtil.isOdd(2);\n // false\n\n MathUtil.isOdd(3);\n // true"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 272,
"description": "Check if number is even (convert to Integer if necessary).",
"itemtype": "method",
"name": "isEven",
"params": [
{
"name": "num",
"description": "The number.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n MathUtil.isEven(2);\n // true\n\n MathUtil.isEven(3);\n // false"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 292,
"description": "Check if number is Prime (divisible only by itself and one).",
"itemtype": "method",
"name": "isPrime",
"params": [
{
"name": "num",
"description": "The number.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n MathUtil.isPrime(4);\n // false\n\n MathUtil.isPrime(5);\n // true"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 323,
"description": "Calculate the factorial of the integer.",
"itemtype": "method",
"name": "factorial",
"params": [
{
"name": "num",
"description": "The number.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.factorial(5);\n // 120\n\n MathUtil.factorial(9);\n // 362880"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MathUtil.ts",
"line": 352,
"description": "Return an array of divisors of the integer.",
"itemtype": "method",
"name": "getDivisors",
"params": [
{
"name": "num",
"description": "The number.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Array."
},
"example": [
"\n"
],
"class": "MathUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MerchantUtil.ts",
"line": 71,
"description": "Encode a credit card number as a string and encode all digits except the last digitsShown.",
"itemtype": "method",
"name": "encodeCreditCardNumber",
"params": [
{
"name": "strNumber",
"description": "The credit card number as string.",
"type": "String"
},
{
"name": "digitsShown",
"description": "Display this many digits at the end of the card number for security purposes.",
"type": "Number",
"optional": true,
"optdefault": "4"
},
{
"name": "encodeChar",
"description": "Optional encoding character to use instead of default '*'.",
"type": "String",
"optional": true,
"optdefault": "*"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n MerchantUtil.encodeCreditCardNumber('4556106734384949');\n // ************4949\n\n MerchantUtil.encodeCreditCardNumber('4556106734384949', 5, 'x');\n // xxxxxxxxxxx84949"
],
"class": "MerchantUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MerchantUtil.ts",
"line": 102,
"description": "Returns a credit card provider name from the credit card number passed in.",
"itemtype": "method",
"name": "getCreditCardProvider",
"params": [
{
"name": "cardNumber",
"description": "",
"type": "String|number"
}
],
"return": {
"description": "",
"type": "String"
},
"example": [
"\n MerchantUtil.getCreditCardProvider(\"4\");\n MerchantUtil.getCreditCardProvider(\"4556106734384949\");\n // visa\n\n MerchantUtil.getCreditCardProvider(\"5428070016026573\");\n // mastercard"
],
"class": "MerchantUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MerchantUtil.ts",
"line": 137,
"description": "Validate a credit card's expiration date.",
"itemtype": "method",
"name": "isValidExpirationDate",
"params": [
{
"name": "month",
"description": "",
"type": "Number"
},
{
"name": "year",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"example": [
"\n MerchantUtil.isValidExDate(11, 2010);\n // false"
],
"class": "MerchantUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MerchantUtil.ts",
"line": 160,
"description": "Determines if credit card is valid",
"itemtype": "method",
"name": "isCreditCard",
"params": [
{
"name": "cardNumber",
"description": "The credit card number.",
"type": "String|number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n MerchantUtil.isCreditCard('4556106734384949');\n // true"
],
"class": "MerchantUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MerchantUtil.ts",
"line": 182,
"description": "https://davidwalsh.name/validate-credit-cards",
"itemtype": "method",
"name": "_validateStructure",
"params": [
{
"name": "cardNumber",
"description": "",
"type": "String|number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "MerchantUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MerchantUtil.ts",
"line": 206,
"description": "Determines if credit card is valid using the Luhn formula.\nhttps://gist.github.com/ShirtlessKirk/2134376",
"itemtype": "method",
"name": "_validateCreditCard",
"params": [
{
"name": "cardNumber",
"description": "",
"type": "String|number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "MerchantUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/MerchantUtil.ts",
"line": 232,
"itemtype": "method",
"name": "_updateRanges",
"access": "protected",
"tagname": "",
"class": "MerchantUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 17,
"description": "Converts bytes into megabytes.",
"itemtype": "method",
"name": "bytesToMegabytes",
"params": [
{
"name": "bytes",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 33,
"description": "Converts centimeters into inches.",
"itemtype": "method",
"name": "centimeterToInch",
"params": [
{
"name": "cm",
"description": "",
"type": "Number"
}
],
"access": "public",
"tagname": "",
"static": 1,
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n NumberUtil.centimeterToInch(1);\n // 0.3937"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 50,
"description": "Converts inches into centimeters.",
"itemtype": "method",
"name": "inchToCentimeter",
"params": [
{
"name": "inch",
"description": "",
"type": "Number"
}
],
"access": "public",
"tagname": "",
"static": 1,
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n NumberUtil.inchToCentimeter(1);\n // 2.54"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 67,
"description": "Converts feet into meters.",
"itemtype": "method",
"name": "feetToMeter",
"params": [
{
"name": "feet",
"description": "",
"type": "Number"
}
],
"access": "public",
"tagname": "",
"static": 1,
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n NumberUtil.feetToMeter(1);\n // 0.3048\n"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 85,
"description": "Converts seconds into hour, minutes, seconds.",
"itemtype": "method",
"name": "convertToHHMMSS",
"params": [
{
"name": "seconds",
"description": "",
"type": "Number"
},
{
"name": "showHours",
"description": "[boolean=true] By default if the time does not pass one hour it will show 00:05:34. Pass false to display the time as 05:34 until it gets pass one hour and then it will show 01:00:00"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n NumberUtil.convertToHHMMSS(33333);\n // '09:15:33'"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 119,
"description": "Formats a number from 0-9 to display with 2 digits.",
"itemtype": "method",
"name": "doubleDigitFormat",
"params": [
{
"name": "num",
"description": "",
"type": "Number"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n NumberUtil.doubleDigitFormat(0);\n // '00'\n\n NumberUtil.doubleDigitFormat(5);\n // '05'\n\n NumberUtil.doubleDigitFormat(9);\n // '09'"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 146,
"description": "Formats a currency string as a number.",
"itemtype": "method",
"name": "unformatUnit",
"params": [
{
"name": "value",
"description": "The string currency that you want converted into a number.",
"type": "String"
}
],
"return": {
"description": "Returns the number value of the currency string.",
"type": "Number"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n NumberUtil.unformatUnit('$1,234,567.89');\n // 1234567.89\n\n NumberUtil.unformatUnit('1.234.567,89 €');\n // 1234567.89\n\n NumberUtil.unformatUnit('$-123,456,789.99');\n // -123456789.99"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 188,
"description": "Formats a number as a currency string.",
"itemtype": "method",
"name": "formatUnit",
"params": [
{
"name": "value",
"description": "The number value you want formatted.",
"type": "Number"
},
{
"name": "decimalPlacement",
"description": "How many decimal placements you want to show.",
"type": "Number",
"optional": true,
"optdefault": "2"
},
{
"name": "decimalSeparator",
"description": "The character you want to use as the thousands separator.",
"type": "String",
"optional": true,
"optdefault": "'.'"
},
{
"name": "thousandsSeparator",
"description": "The character you want to use as the thousands separator.",
"type": "String",
"optional": true,
"optdefault": "','"
},
{
"name": "currencySymbol",
"description": "The symbol you would like to add.",
"type": "String",
"optional": true,
"optdefault": "''"
},
{
"name": "currencySymbolPlacement",
"description": "The placement of the symbol. Use 0 to place in front or 1 to place at the end.",
"type": "Number",
"optional": true,
"optdefault": "0"
}
],
"return": {
"description": "Returns the formatted currency.",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n NumberUtil.formatUnit(1234567.89, 2, \".\", \",\", \"$\", 0);\n // '$1,234,567.89'\n\n NumberUtil.formatUnit(12341234.56, 2, \"*\", \",\", \" €\", 1);\n // '12,341,234*56 €'\n\n NumberUtil.formatUnit(-1900.24, 1);\n // '-1,900.2'"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 244,
"description": "Convert Fahrenheit to Celsius.",
"itemtype": "method",
"name": "fahrenheitToCelsius",
"params": [
{
"name": "fahrenheit",
"description": "The fahrenheit value.",
"type": "Number"
},
{
"name": "decimals",
"description": "The number of decimals.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.fahrenheitToCelsius(32);\n // 0\n\n MathUtil.fahrenheitToCelsius(212);\n // 100"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/NumberUtil.ts",
"line": 280,
"description": "Convert Celsius to Fahrenheit.",
"itemtype": "method",
"name": "celsiusToFahrenheit",
"params": [
{
"name": "celsius",
"description": "The celsius value.",
"type": "Number"
},
{
"name": "decimals",
"description": "The number of decimals.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"example": [
"\n MathUtil.celsiusToFahrenheit(0);\n // 32\n\n MathUtil.celsiusToFahrenheit(100);\n // 212"
],
"class": "NumberUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 17,
"description": "Gets the extension name off the string being passed in.",
"itemtype": "method",
"name": "getExtension",
"params": [
{
"name": "filename",
"description": "",
"type": "String"
},
{
"name": "withDot",
"description": "If you want the period to be included in the extension name.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.getExtension('file.exe');\n // 'exe'\n\n StringUtil.getExtension('file.exe', true);\n // '.exe'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 39,
"description": "Converts a string to a sentence case string.",
"itemtype": "method",
"name": "toSentence",
"params": [
{
"name": "str",
"description": "",
"type": "String"
},
{
"name": "separator",
"description": "Can be any string you want to use as a separator.",
"type": "String",
"optional": true
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.toSentence(\"liveDown_by-the.River\");\n // 'live down by the river'\n\n StringUtil.toSentence(\"liveDown_by-the.River\", '-');\n // 'live-down-by-the-river'\n\n StringUtil.toSentence(\"liveDown_by-the.River\", '_');\n // 'live_down_by_the_river'\n\n StringUtil.toSentence(\"liveDown_by-the.River\", '/');\n // 'live/down/by/the/river'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 80,
"description": "Converts a string to a camel case string.",
"itemtype": "method",
"name": "toCamelCase",
"params": [
{
"name": "str",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.toCamelCase(\"liveDown_by-the.River\");\n // 'liveDownByTheRiver'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 102,
"description": "Converts a hyphen string to a pascal case string.",
"itemtype": "method",
"name": "toPascalCase",
"params": [
{
"name": "str",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.toPascalCase(\"liveDown_by-the.River\");\n // 'LiveDownByTheRiver'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 125,
"description": "Converts a string to a constant case string.",
"itemtype": "method",
"name": "toConstantCase",
"params": [
{
"name": "str",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.toConstantCase(\"liveDown_by-the.River\");\n // 'LIVE_DOWN_BY_THE_RIVER'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 143,
"description": "Creates a universally unique identifier.",
"itemtype": "method",
"name": "createUUID",
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.createUUID();\n // 'a95d7134-3342-4001-bcea-cc0371b70dec'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 166,
"description": "Converts a query string to an object.",
"itemtype": "method",
"name": "queryStringToObject",
"params": [
{
"name": "queryString",
"description": "",
"type": "String"
},
{
"name": "useParseFloat",
"description": "If true converts strings to numbers.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "",
"type": "Object|Null"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.queryStringToObject('?name=Robert&age=23&gender=male');\n // {name: 'Robert', age: '23', gender: 'male'}\n\n StringUtil.queryStringToObject('?name=Robert&age=23&gender=male', true);\n // {name: 'Robert', age: 23, gender: 'male'}"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 208,
"description": "Converts a query string to an object.",
"itemtype": "method",
"name": "toQueryString",
"params": [
{
"name": "obj",
"description": "",
"type": "Object"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.toQueryString({name: 'Robert', age: '23', gender: 'male'});\n // name=Robert&age=23&gender=male'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 234,
"description": "Remove all whitespace from the string passed in.",
"itemtype": "method",
"name": "removeAllWhitespace",
"params": [
{
"name": "str",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n let str = ' a b c d e f g ';\n StringUtil.removeAllWhitespace(str);\n // 'abcdefg'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 252,
"description": "Remove leading and trailing whitespace.",
"itemtype": "method",
"name": "removeLeadingTrailingWhitespace",
"params": [
{
"name": "str",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n let str = ' a b c d e f g ';\n StringUtil.removeLeadingTrailingWhitespace(str);\n // 'a b c d e f g'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 270,
"itemtype": "method",
"name": "truncate",
"params": [
{
"name": "text",
"description": "",
"type": "String"
},
{
"name": "length",
"description": "",
"type": "Int"
},
{
"name": "indicator",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.truncate('Robert is cool and he likes bruschetta.', 14));\n // 'Robert is cool...'\n StringUtil.truncate('Robert is cool and he likes bruschetta.', 14, '!!!'));\n // 'Robert is cool!!!'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 298,
"description": "Replaces each format item in a specified string with the text equivalent of a corresponding object's value.",
"itemtype": "method",
"name": "format",
"return": {
"description": "",
"type": "String"
},
"params": [
{
"name": "str",
"description": "",
"type": "String"
},
{
"name": "...rest",
"description": "",
"type": "Array."
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n StringUtil.format('Robert is {0}. Very {0} and {1}!', 'cool', 'smart');\n // 'Robert is cool. Very cool and smart!'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/StringUtil.ts",
"line": 324,
"description": "Updates a value in the query string by its key name.",
"itemtype": "method",
"name": "paramReplace",
"params": [
{
"name": "queryString",
"description": ""
},
{
"name": "name",
"description": ""
},
{
"name": "value",
"description": ""
}
],
"return": {
"description": "",
"type": "String|void"
},
"example": [
"\n StringUtil.paramReplace('?name=Robert&age=23&gender=male', 'gender', 'female');\n // '?name=Robert&age=23&gender=female'"
],
"class": "StringUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/TemplateFactory.ts",
"line": 16,
"description": "A constant value for using Underscore or Lodash templates.",
"itemtype": "property",
"name": "UNDERSCORE",
"type": "{string}",
"access": "public",
"tagname": "",
"final": 1,
"static": 1,
"class": "TemplateFactory",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/TemplateFactory.ts",
"line": 27,
"description": "A constant value for using Handlebars templates. This is the default template engine.",
"itemtype": "property",
"name": "HANDLEBARS",
"type": "{string}",
"access": "public",
"tagname": "",
"final": 1,
"static": 1,
"class": "TemplateFactory",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/TemplateFactory.ts",
"line": 38,
"description": "Sets the template engine type for this TemplateFactory class. The default is TemplateFactory.HANDLEBARS",
"itemtype": "property",
"name": "templateEngine",
"type": "{string}",
"default": "TemplateFactory.HANDLEBARS",
"access": "public",
"tagname": "",
"static": 1,
"class": "TemplateFactory",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/TemplateFactory.ts",
"line": 49,
"description": "The global namespace for pre-compiled templates.",
"itemtype": "property",
"name": "templateNamespace",
"type": "{string}",
"default": "'JST'",
"access": "public",
"tagname": "",
"static": 1,
"class": "TemplateFactory",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/TemplateFactory.ts",
"line": 65,
"description": "Creates a template.",
"itemtype": "method",
"name": "create",
"params": [
{
"name": "templatePath",
"description": "",
"type": "Any"
},
{
"name": "data",
"description": "",
"optional": true,
"optdefault": "any"
}
],
"return": {
"description": "",
"type": "String"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n TemplateFactory.create('templateName', {some: 'data'});"
],
"class": "TemplateFactory",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 19,
"description": "A reference to the setInterval object.",
"itemtype": "property",
"name": "_timer",
"type": "{Function}",
"access": "protected",
"tagname": "",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 28,
"description": "The total number of times the timer has fired since it started at zero. If the timer has been reset, only the fires since the reset are counted.",
"itemtype": "property",
"name": "currentCount",
"type": "{int}",
"access": "protected",
"tagname": "",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 37,
"description": "The delay, in milliseconds, between timer events. If you set the delay interval while the timer is running, the timer will restart at the same repeatCount iteration.\nNote: A delay lower than 20 milliseconds is not recommended.",
"itemtype": "property",
"name": "delay",
"type": "{number}",
"access": "protected",
"tagname": "",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 47,
"description": "The total number of times the timer is set to run. If the repeat count is set to 0, the timer continues indefinitely. If the repeat count is nonzero, the timer runs the specified number of times. If repeatCount is set to a total that is the same or less then currentCount the timer stops and will not fire again.",
"itemtype": "property",
"name": "repeatCount",
"type": "{int}",
"access": "protected",
"tagname": "",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 56,
"description": "The timer's current state; true if the timer is running, otherwise false.",
"itemtype": "property",
"name": "running",
"type": "{boolean}",
"readonly": "",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 74,
"description": "Returns the total number of times the timer has fired since it started at zero.",
"itemtype": "method",
"name": "getCurrentCount",
"return": {
"description": "The total number of times the timer has fired since it started at zero.",
"type": "Number"
},
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 85,
"description": "Returns the delay time in milliseconds.",
"itemtype": "method",
"name": "getDelay",
"return": {
"description": "Returns the delay time in milliseconds.",
"type": "Number"
},
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 96,
"description": "Sets the delay, in milliseconds, between timer events.",
"itemtype": "method",
"name": "setDelay",
"params": [
{
"name": "value",
"description": "",
"type": "Number"
}
],
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 111,
"description": "Returns the total number of times the timer is set to run.",
"itemtype": "method",
"name": "getRepeatCount",
"return": {
"description": "Returns the total number of times the timer is set to run.",
"type": "Number"
},
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 122,
"description": "Set the total number of times the timer is set to run. If the repeat count is set to 0, the timer continues indefinitely. If the repeat count is nonzero, the timer runs the specified number of times. If repeatCount is set to a total that is the same or less then currentCount the timer stops and will not fire again.",
"itemtype": "method",
"name": "setRepeatCount",
"params": [
{
"name": "value",
"description": "",
"type": "Number"
}
],
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 138,
"description": "Stops the timer, if it is running, and sets the currentCount property back to 0, like the reset button of a stopwatch.",
"itemtype": "method",
"name": "reset",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 151,
"description": "Starts the timer, if it is not already running.",
"itemtype": "method",
"name": "start",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 173,
"description": "Stops the timer.",
"itemtype": "method",
"name": "stop",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 186,
"itemtype": "method",
"name": "_decrementCounter",
"access": "protected",
"tagname": "",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Timer.ts",
"line": 210,
"overridden": "EventDispatcher.destroy",
"class": "Timer",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 12,
"description": "Keeps track of the count for the uniqueId method.",
"itemtype": "property",
"name": "_idCounter",
"type": "{int}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 27,
"description": "Generates a unique ID. If a prefix is passed in, the value will be appended to it.",
"itemtype": "method",
"name": "uniqueId",
"params": [
{
"name": "prefix",
"description": "The string value used for the prefix.",
"type": "String",
"optional": true
}
],
"return": {
"description": "Returns the unique identifier.",
"type": "Init|string"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n let property = Util.uniqueId();\n // 1\n\n let property = Util.uniqueId('prefixName_');\n // prefixName_1"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 56,
"description": "Removes a list of properties from an object.",
"itemtype": "method",
"name": "deletePropertyFromObject",
"params": [
{
"name": "object",
"description": "The object you want to remove properties from.",
"type": "Object"
},
{
"name": "value",
"description": "A property name or an array of property names you want to remove from the object.",
"type": "string|Array."
}
],
"return": {
"description": "Returns the object passed in without the removed the properties.",
"type": "Any"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n let obj = { name: 'Robert', gender: 'male', phone: '555-555-5555' }\n\n Util.deletePropertyFromObject(obj, ['phone', 'gender']);\n\n // { name: 'Robert' }"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 100,
"description": "Renames a property name on an object.",
"itemtype": "method",
"name": "renamePropertyOnObject",
"params": [
{
"name": "object",
"description": "The object you want to rename properties from.",
"type": "Object"
},
{
"name": "oldName",
"description": "",
"type": "String"
},
{
"name": "newName",
"description": "",
"type": "String"
}
],
"return": {
"description": "Returns the object passed in renamed properties.",
"type": "Any"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n let obj = { name: 'Robert', gender: 'male', phone: '555-555-5555' }\n\n Util.renamePropertyOnObject(obj, 'gender', 'sex');\n\n // { name: 'Robert', sex: 'male', phone: '555-555-5555' }"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 129,
"description": "Makes a clone of an object.",
"itemtype": "method",
"name": "clone",
"params": [
{
"name": "obj",
"description": "The object you to clone.",
"type": "Object"
}
],
"return": {
"description": "Returns a clone object of the one passed in.",
"type": "Any"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n let cloneOfObject = Util.clone(obj);"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 190,
"description": "Converts a string or number to a boolean.",
"itemtype": "method",
"name": "toBoolean",
"params": [
{
"name": "strNum",
"description": "",
"type": "String|number"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Util.toBoolean(\"TRUE\");\n // true\n\n Util.toBoolean(0);\n // false\n\n Util.toBoolean(undefined);\n // false"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 215,
"description": "Returns the name of the function/object passed in.",
"itemtype": "method",
"name": "getName",
"params": [
{
"name": "classObject",
"description": "",
"type": "Any"
}
],
"return": {
"description": "Returns the name of the function or object.",
"type": "String"
},
"static": 1,
"example": [
"\n let someClass = new SomeClass();\n Util.getName(someClass); // 'SomeClass'\n\n Util.getName(function Test(){}); // 'Test'\n Util.getName(function (){}); // 'anonymous'"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 257,
"description": "Creates and returns a new debounced version of the passed function which will postpone its execution until after\nwait milliseconds have elapsed since the last time it was invoked.",
"itemtype": "method",
"name": "debounce",
"params": [
{
"name": "callback",
"description": "The function that should be executed.",
"type": "Function"
},
{
"name": "wait",
"description": "Milliseconds to elapsed before invoking the callback.",
"type": "Number"
},
{
"name": "immediate",
"description": "Pass true for the immediate parameter to cause debounce to trigger the function on the leading instead of the trailing edge of the wait interval. Useful in circumstances like preventing accidental double-clicks on a \"submit\" button from firing a second time.",
"type": "Boolean"
},
{
"name": "callbackScope",
"description": "The scope of the callback function that should be executed.",
"type": "Any"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n Util.debounce(this._onBreakpointChange, 250, false, this);"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 311,
"description": "TODO: YUIDoc_comment",
"itemtype": "method",
"name": "applyMixins",
"params": [
{
"name": "derivedCtor",
"description": "",
"type": "Any"
},
{
"name": "baseCtors",
"description": "",
"type": "Any"
}
],
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n\n class Flies {\n fly() {\n alert('Is it a bird? Is it a plane?');\n }\n }\n\n class Climbs {\n climb() {\n alert('My spider-sense is tingling.');\n }\n }\n\n class HorseflyWoman implements Climbs, Flies {\n climb: () => void;\n fly: () => void;\n }\n\n Util.applyMixins(HorseflyWoman, [Climbs, Flies]);"
],
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/Util.ts",
"line": 349,
"description": "Returns a new array with duplicates removed.",
"itemtype": "method",
"name": "unique",
"params": [
{
"name": "list",
"description": "The array you want to use to generate the unique array.",
"type": "Array."
}
],
"return": {
"description": "Returns a new array list of unique items.",
"type": "Array"
},
"access": "protected",
"tagname": "",
"class": "Util",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ValidationUtil.ts",
"line": 17,
"description": "Determines if the String passed has a length.",
"itemtype": "method",
"name": "isEmpty",
"params": [
{
"name": "value",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ValidationUtil.isEmpty('sometext');\n // false"
],
"class": "ValidationUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ValidationUtil.ts",
"line": 37,
"description": "Determines if the two values passed in are the same.",
"itemtype": "method",
"name": "isMatch",
"params": [
{
"name": "value1",
"description": "",
"type": "Any"
},
{
"name": "value2",
"description": "",
"type": "Any"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ValidationUtil.isMatch('one@email.com', 'two@email.com');\n // false"
],
"class": "ValidationUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ValidationUtil.ts",
"line": 55,
"description": "Determines if the String passed in is a valid email address.",
"itemtype": "method",
"name": "isValidEmailAddress",
"params": [
{
"name": "email",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ValidationUtil.isValidEmailAddress('someemail@address.com');\n // true"
],
"class": "ValidationUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ValidationUtil.ts",
"line": 73,
"description": "Determines if the String passed in is a phone number.",
"itemtype": "method",
"name": "isValidPhoneNumber",
"params": [
{
"name": "phoneNumber",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ValidationUtil.isValidPhoneNumber('123 456 7899');\n // true"
],
"class": "ValidationUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ValidationUtil.ts",
"line": 91,
"description": "Determines if the String passed in is a zip code.",
"itemtype": "method",
"name": "isZipCode",
"params": [
{
"name": "zipCode",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ValidationUtil.isZipCode('55067 4434');\n // true"
],
"class": "ValidationUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ValidationUtil.ts",
"line": 109,
"description": "Determines if the String passed in is a postal code.",
"itemtype": "method",
"name": "isPostalCode",
"params": [
{
"name": "postalCode",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ValidationUtil.isPostalCode('p8n3h3');\n // true"
],
"class": "ValidationUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/util/ValidationUtil.ts",
"line": 127,
"description": "Determines if the String passed in is a Social Security Number.",
"itemtype": "method",
"name": "isSocialSecurityNumber",
"params": [
{
"name": "ssn",
"description": "",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "public",
"tagname": "",
"static": 1,
"example": [
"\n ValidationUtil.isSocialSecurityNumber('178051120');\n // true"
],
"class": "ValidationUtil",
"module": "StructureJS",
"submodule": "util"
},
{
"file": "ts/BaseObject.ts",
"line": 15,
"description": "The sjsId (StructureJS ID) is a unique identifier automatically assigned to most StructureJS objects upon instantiation.",
"itemtype": "property",
"name": "sjsId",
"type": "{int}",
"default": "null",
"writeonce": "",
"readonly": "",
"access": "public",
"tagname": "",
"class": "BaseObject",
"module": "StructureJS",
"submodule": "core"
},
{
"file": "ts/BaseObject.ts",
"line": 32,
"description": "Returns the fully qualified class name of an object.",
"itemtype": "method",
"name": "getQualifiedClassName",
"return": {
"description": "Returns the class name.",
"type": "String"
},
"access": "public",
"tagname": "",
"example": [
"\n let someClass = new SomeClass();\n someClass.getQualifiedClassName();\n\n // SomeClass"
],
"class": "BaseObject",
"module": "StructureJS",
"submodule": "core"
},
{
"file": "ts/BaseObject.ts",
"line": 49,
"description": "The purpose of the destroy method is to make an object ready for garbage collection. This\nshould be thought of as a one way function. Once destroy is called no further methods should be\ncalled on the object or properties accessed. It is the responsibility of those who implement this\nfunction to stop all running Timers, all running Sounds, and take any other steps necessary to make an\nobject eligible for garbage collection.\n\nBy default the destroy method will null out all properties of the class automatically. You should call destroy\non other objects before calling the super.",
"itemtype": "method",
"name": "destroy",
"return": {
"description": "",
"type": "Void"
},
"access": "public",
"tagname": "",
"example": [
"\n destroy() {\n this.disable();\n\n this._childInstance.destroy();\n\n super.destroy();\n }"
],
"class": "BaseObject",
"module": "StructureJS",
"submodule": "core"
},
{
"file": "ts/ObjectManager.ts",
"line": 17,
"description": "The isEnabled property is used to keep track of the enabled state of the object.",
"itemtype": "property",
"name": "isEnabled",
"type": "{boolean}",
"default": "false",
"access": "public",
"tagname": "",
"class": "ObjectManager",
"module": "StructureJS",
"submodule": "core"
},
{
"file": "ts/ObjectManager.ts",
"line": 32,
"description": "The enable method is responsible for enabling event listeners and/or children of the containing objects.",
"itemtype": "method",
"name": "enable",
"access": "public",
"tagname": "",
"chainable": 1,
"example": [
"\n enable() {\n if (this.isEnabled === true) { return; }\n\n this._childInstance.addEventListener(BaseEvent.CHANGE, this.handlerMethod, this);\n this._childInstance.enable();\n\n super.enable();\n }"
],
"class": "ObjectManager",
"module": "StructureJS",
"submodule": "core"
},
{
"file": "ts/ObjectManager.ts",
"line": 60,
"description": "The disable method is responsible for disabling event listeners and/or children of the containing objects.",
"itemtype": "method",
"name": "disable",
"access": "public",
"tagname": "",
"chainable": 1,
"example": [
"\n disable() {\n if (this.isEnabled === false) { return; }\n\n this._childInstance.removeEventListener(BaseEvent.CHANGE, this.handlerMethod, this);\n this._childInstance.disable();\n\n super.disable();\n }"
],
"class": "ObjectManager",
"module": "StructureJS",
"submodule": "core"
}
],
"warnings": [
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:19"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:31"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:56"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:81"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:110"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:139"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:153"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:161"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:191"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/CanvasElement.ts:201"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DOMElement.ts:199"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/DOMElement.ts:293"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DOMElement.ts:293"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/DOMElement.ts:423"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/DOMElement.ts:469"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/DOMElement.ts:483"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DOMElement.ts:491"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DOMElement.ts:530"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DOMElement.ts:567"
},
{
"message": "unknown tag: override",
"line": " ts/display/DOMElement.ts:567"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DOMElement.ts:615"
},
{
"message": "unknown tag: override",
"line": " ts/display/DOMElement.ts:615"
},
{
"message": "unknown tag: overridden",
"line": " ts/display/DOMElement.ts:638"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObject.ts:184"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObject.ts:201"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObject.ts:215"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:52"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:81"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:109"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:136"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:156"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:175"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:200"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:213"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:226"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/display/DisplayObjectContainer.ts:238"
},
{
"message": "unknown tag: override",
"line": " ts/display/DisplayObjectContainer.ts:238"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/event/BaseEvent.ts:443"
},
{
"message": "unknown tag: hide",
"line": " ts/event/EventDispatcher.ts:133"
},
{
"message": "unknown tag: overridden",
"line": " ts/event/EventDispatcher.ts:338"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/BaseModel.ts:216"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/BaseModel.ts:231"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/BaseModel.ts:265"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/Collection.ts:382"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/Collection.ts:399"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/Collection.ts:428"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/Route.ts:114"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/model/Route.ts:145"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/net/NetworkMonitor.ts:42"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/net/NetworkMonitor.ts:58"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/plugin/jquery.eventListener.ts:36"
},
{
"message": "unknown tag: overridden",
"line": " ts/service/ApplicationCacheService.ts:53"
},
{
"message": "unknown tag: overridden",
"line": " ts/service/ApplicationCacheService.ts:76"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/service/LocalStorageService.ts:95"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/service/LocalStorageService.ts:109"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/service/LocalStorageService.ts:161"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/service/LocalStorageService.ts:259"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/service/LocalStorageService.ts:272"
},
{
"message": "unknown tag: overridden",
"line": " ts/util/BrowserUtil.ts:103"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:191"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:207"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:223"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:239"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:255"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:271"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:287"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:303"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:326"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/BrowserUtil.ts:349"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/DateUtil.ts:72"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/MerchantUtil.ts:71"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/MerchantUtil.ts:102"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/MerchantUtil.ts:137"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/MerchantUtil.ts:160"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:17"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:33"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:50"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:67"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:85"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:119"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:146"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/NumberUtil.ts:188"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:17"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:39"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:80"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:102"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:125"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:143"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:166"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:234"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:252"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:270"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:298"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/StringUtil.ts:324"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/TemplateFactory.ts:65"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Timer.ts:74"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Timer.ts:85"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Timer.ts:111"
},
{
"message": "unknown tag: overridden",
"line": " ts/util/Timer.ts:210"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Util.ts:27"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Util.ts:56"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Util.ts:100"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Util.ts:129"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Util.ts:190"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/Util.ts:215"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/ValidationUtil.ts:17"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/ValidationUtil.ts:37"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/ValidationUtil.ts:55"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/ValidationUtil.ts:73"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/ValidationUtil.ts:91"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/ValidationUtil.ts:109"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/util/ValidationUtil.ts:127"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " ts/BaseObject.ts:32"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:19"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:31"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:56"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:81"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:110"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:139"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:153"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:161"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:191"
},
{
"message": "Missing item type",
"line": " ts/display/CanvasElement.ts:201"
},
{
"message": "Missing item type",
"line": " ts/display/DOMElement.ts:423"
},
{
"message": "Missing item type",
"line": " ts/display/DOMElement.ts:469"
},
{
"message": "Missing item type",
"line": " ts/display/DOMElement.ts:483"
},
{
"message": "Missing item type",
"line": " ts/display/DOMElement.ts:638"
},
{
"message": "Missing item type\nThe setSize method sets the bounds within which the containing DisplayObject would like that component to lay itself out.",
"line": " ts/display/DisplayObject.ts:215"
},
{
"message": "Missing item type",
"line": " ts/event/EventDispatcher.ts:338"
},
{
"message": "Missing item type\nA bind polyfill for browsers that don't support the bind method.",
"line": " ts/plugin/jquery.eventListener.ts:3"
},
{
"message": "Missing item type\nGenerates a hash string from the string being passed in. In this case it is a function that is casted as string value.",
"line": " ts/plugin/jquery.eventListener.ts:36"
},
{
"message": "Missing item type\nThe jQuery addEventListener plugin",
"line": " ts/plugin/jquery.eventListener.ts:62"
},
{
"message": "Missing item type\nThe jQuery removeEventListener plugin",
"line": " ts/plugin/jquery.eventListener.ts:99"
},
{
"message": "Missing item type",
"line": " ts/service/ApplicationCacheService.ts:53"
},
{
"message": "Missing item type",
"line": " ts/service/ApplicationCacheService.ts:76"
},
{
"message": "Missing item type",
"line": " ts/util/BrowserUtil.ts:103"
},
{
"message": "Missing item type",
"line": " ts/util/Timer.ts:210"
}
]
}