Namespace LABKEY
Namespace used to encapsulate LabKey core API and utilities.
Defined in: labkey.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
<static> |
LABKEY.container
A collection of properties related to the "current" LabKey Server container scope.
|
<static> |
LABKEY.contextPath
|
<static> |
LABKEY.DataRegions
The DataRegion class allows you to interact with LabKey grids,
including querying and modifying selection state, filters, and more.
|
<static> |
LABKEY.Visualization
|
Method Attributes | Method Name and Description |
---|---|
<static> |
LABKEY.getModuleContext(moduleName)
|
<static> |
LABKEY.getModuleProperty(moduleName, property)
|
<static> |
LABKEY.requiresCss(file)
Loads a CSS file from the server.
|
<static> |
LABKEY.requiresExt3(immediate, callback, scope)
This can be added to any LABKEY page in order to load ExtJS 3.
|
<static> |
LABKEY.requiresExt3ClientAPI(immediate, callback, scope)
This can be added to any LABKEY page in order to load the LabKey ExtJS 3 Client API.
|
<static> |
LABKEY.requiresExt4ClientAPI(immediate, callback, scope)
This can be added to any LABKEY page in order to load the LabKey ExtJS 4 Client API.
|
<static> |
LABKEY.requiresExt4Sandbox(immediate, callback, scope)
This can be added to any LABKEY page in order to load ExtJS 4.
|
<static> |
LABKEY.requiresScript(file, callback, scope, inOrder)
Loads JavaScript file(s) from the server.
|
Field Detail
<static>
LABKEY.container
A collection of properties related to the "current" LabKey Server container scope.
The properties are as follows:
- formats: Java formatting strings as set in /admin-projectSettings.view
- dateFormat: The display format for dates
- dateTimeFormat: The display format for date-times
- numberFormat: The display format for numbers
<static>
LABKEY.contextPath
<static>
LABKEY.DataRegions
The DataRegion class allows you to interact with LabKey grids,
including querying and modifying selection state, filters, and more.
<static>
LABKEY.Visualization
Defined in: Visualization.js.
- Deprecated:
- Use LABKEY.Query.Visualization
Method Detail
<static>
{Object}
LABKEY.getModuleContext(moduleName)
- Parameters:
- {String} moduleName
- The name of the module
- Returns:
- {Object} The context object for this module. The current view must have specifically requested the context for this module in its view XML
<static>
{String}
LABKEY.getModuleProperty(moduleName, property)
- Parameters:
- {String} moduleName
- The name of the module
- {String} property
- The property name to return
- Returns:
- {String} The value of the module property. Will return null if the property has not been set.
<static>
LABKEY.requiresCss(file)
Loads a CSS file from the server.
<script type="text/javascript"> LABKEY.requiresCss("myModule/myFile.css"); </script>
- Parameters:
- {(string|string[])} file
- - The path of the CSS file to load
<static>
LABKEY.requiresExt3(immediate, callback, scope)
This can be added to any LABKEY page in order to load ExtJS 3. This is the preferred method to declare Ext3 usage
from wiki pages. For HTML or JSP pages defined in a module, see our documentation on declaration of client dependencies.
<script type="text/javascript"> LABKEY.requiresExt3(true, function() { Ext.onReady(function() { // Ext 3 is loaded and ready }); }); </script>
- Parameters:
- {boolean} immediate Optional, Default: true
- - True to load the script immediately; false will defer script loading until the page has been downloaded.
- {requireCallback} callback Optional
- - Callback for when all dependencies are loaded.
- {Object} scope Optional
- - Scope of callback.
<static>
LABKEY.requiresExt3ClientAPI(immediate, callback, scope)
This can be added to any LABKEY page in order to load the LabKey ExtJS 3 Client API.
<script type="text/javascript"> LABKEY.requiresExt3ClientAPI(true, function() { // your code here }); </script>
- Parameters:
- {boolean} immediate Optional, Default: true
- - True to load the script immediately; false will defer script loading until the page has been downloaded.
- {requireCallback} callback Optional
- - Callback for when all dependencies are loaded.
- {Object} scope Optional
- - Scope of callback.
<static>
LABKEY.requiresExt4ClientAPI(immediate, callback, scope)
This can be added to any LABKEY page in order to load the LabKey ExtJS 4 Client API. This primarily
consists of a set of utility methods LABKEY.ext4.Util and an extended Ext.data.Store LABKEY.ext4.data.Store.
It will load ExtJS 4 as a dependency.
<script type="text/javascript"> LABKEY.requiresExt4ClientAPI(true, function() { // your code here }); </script>
- Parameters:
- {boolean} immediate Optional, Default: true
- - True to load the script immediately; false will defer script loading until the page has been downloaded.
- {requireCallback} callback Optional
- - Callback for when all dependencies are loaded.
- {Object} scope Optional
- - Scope of callback.
<static>
LABKEY.requiresExt4Sandbox(immediate, callback, scope)
This can be added to any LABKEY page in order to load ExtJS 4. This is the preferred method to declare Ext4 usage
from wiki pages. For HTML or JSP pages defined in a module, see our documentation on declaration of client dependencies.
<script type="text/javascript"> LABKEY.requiresExt4Sandbox(true, function() { Ext4.onReady(function(){ // Ext4 is loaded and ready }); }); </script>
- Parameters:
- {boolean} immediate Optional, Default: true
- - True to load the script immediately; false will defer script loading until the page has been downloaded.
- {requireCallback} callback Optional
- - Callback for when all dependencies are loaded.
- {Object} scope Optional
- - Scope of callback.
<static>
LABKEY.requiresScript(file, callback, scope, inOrder)
Loads JavaScript file(s) from the server.
<script type="text/javascript"> LABKEY.requiresScript("myModule/myScript.js", true, function() { // your script is loaded }); </script>
- Parameters:
- {(string|string[])} file
- - A file or Array of files to load.
- {Function} callback Optional
- - Callback for when all dependencies are loaded.
- {Object} scope Optional
- - Scope of callback.
- {boolean} inOrder Optional, Default: false
- - True to load the scripts in the order they are passed in. Default is false.