jMod Documentation

Namespace: jMod

jMod

Version:
  • 0.0.18
Author:
  • jgjake2
Tutorials:

Classes

FileSelector

Namespaces

API
Config
Element
Events
jQueryExtensions
Modal
Notification
Settings
Tooltip
Update

Members

staticjMod.build_timestring

Date of build

staticjMod.build_typestring

Current build type (beta|release)

staticjMod.debugboolean

Is debug mode enabled

staticjMod.Loadingobject

List of loading states for jMod
Properties:
Name Type Description
DOMLoaded boolean
CSSAdded boolean
documentComplete boolean
jModReady boolean
Complete boolean

staticjMod.SendMessage

Function for sending and receiving data from a remote host function SendMessage

staticjMod.versionstring

Current API version

Methods

staticjMod.deleteValue(key)

F:/Projects/jMod/main/bin/jMod.full.js, line 4391
Delete a value from the default storage engine (see Storage configuration)
Name Type Description
key string name to be deleted
See:

staticjMod.Element(2)(data, data2)

F:/Projects/jMod/main/bin/jMod.full.js, line 2340
Name Type Description
data string | object (string) Command to execute | (object) options for new element
data2 * optional Arguments for command

staticjMod.extend(arg1, arg2, arg3)

F:/Projects/jMod/main/bin/jMod.full.js, line 969
Copy all the properties of one object onto another. If only a single object is given, the properties are copied onto the jMod object.
This version of extend is designed to handle scope and permission issues by cloning the object into the correct scope when an error occurs.
Based on jQuery.extend
Name Type Description
arg1 boolean | object (boolean) make deep copy, (object) target object if multiple object arguments exist, (object) object to copy onto jMod object if it is the only input
arg2 object optional Object to copy to target (if arg1 is object) or target object (if arg1 is boolean and arg3 exists) or object to copy onto jMod object
arg3 object optional repeatable Object to copy onto target object
Author:
  • jQuery

staticjMod.extendp(arg1, arg2, arg3)

F:/Projects/jMod/main/bin/jMod.full.js, line 1057
Same as jMod.extend except arrays are preserved. So if both target[x] and input[x] are arrays, instead of being overwritten, all the elements of input[x] are appended to target[x].
Based on jQuery.extend
Name Type Description
arg1 boolean | object (boolean) make deep copy, (object) target object if multiple object arguments exist, (object) object to copy onto jMod object if it is the only input
arg2 object optional Object to copy to target (if arg1 is object) or target object (if arg1 is boolean and arg3 exists) or object to copy onto jMod object
arg3 object optional repeatable Object to copy onto target object
Author:
  • jQuery
See:

staticjMod.getJSON(key, def)

F:/Projects/jMod/main/bin/jMod.full.js, line 4355
Get a JSON object from the default storage engine (see Storage configuration)
Name Type Description
key string name
def object optional default value to return if key does not exist
See:

staticjMod.getValue(key, def)

F:/Projects/jMod/main/bin/jMod.full.js, line 4319
Get a value from the default storage engine (see Storage configuration)
Name Type Description
key string name
def string | boolean | number optional default value to return if key does not exist
See:
F:/Projects/jMod/main/bin/jMod.full.js, line 6777
Name Type Description
data string | object (string) Command to execute | (object) options for new modal to display
data2 object | boolean optional (object) Arguments for command | (boolean) show new modal immediately

staticjMod.Notification(2)(data, data2)

F:/Projects/jMod/main/bin/jMod.full.js, line 5767
Name Type Description
data string | object Command to execute or notification data
data2 * optional repeatable
See:

staticjMod.RealTypeOf(_obj){string}

F:/Projects/jMod/main/bin/jMod.full.js, line 880
Determine the real type of an object.
Designed to handle scope and permission issues by cloning the object into the correct scope when an error occurs.
Name Type Description
_obj object
Returns:
Type Description
string undefined, object, map, number, nan, null, date, invaliddate, array, regex

staticjMod.setJSON(key, value)

F:/Projects/jMod/main/bin/jMod.full.js, line 4373
Set an object in the default storage engine (see Storage configuration)
Name Type Description
key string name
value string | boolean | number optional value to be set
See:

staticjMod.Settings(2)(data, data2)

F:/Projects/jMod/main/bin/jMod.full.js, line 7267
Name Type Description
data string | object (string) Command to execute | (object) options for new settings modal
data2 object | boolean optional (object) Arguments for command | (boolean) show new settings modal immediately

staticjMod.setValue(key, value)

F:/Projects/jMod/main/bin/jMod.full.js, line 4337
Set a value in the default storage engine (see Storage configuration)
Name Type Description
key string name
value string | boolean | number optional value to be set
See: