National Oceanic and
Atmospheric Administration
United States Department of Commerce

LASUI JSDoc

Last modified: Mon, 04/03/2017 - 17:29
JSDoc for the LAS User Interface class

LASUI


Class LASUI

Object
 |
 +--LASUI
class LASUI

Defined in LASUI.js


Constructor Summary
LASUI ()
The LASUI class


Method Summary
void autoUpdate(<object> evt)
Event handler for the auto update toggle checkbox
void collapse(<object> obj)
Method to collapse a tree node
void collapseRootNodes(<object> evt)
Event handler to collapse all root nodes in the tree
void createCategoryTreeNode(<object> node, <integer> i, <string> id)
Sub method to create category tree node and add it to the DOM
void createVariableTreeNode(<object> node, <integer> i)
Sub method to create variable tree node and add it to the DOM parameters:
void displayCoords(<object> XYSelect)
Method to update the xy constraints textboxes
void expand(<object> obj)
Method to expand a tree node
void getCategory(parentNode, <integer> i)
Method to query the server for a category
void getGrid(<string> dataset, <string> variable)
Method to query the server for the available grids
void getOperations(<string> dataset, <string> variable, <string> view)
Method to query the server for a category
void getOptions(<string> optiondef)
Method to query the server for an options object and pass json response to setOptionList
void getViews(<string> dataset,<string> variable)
Method to query the server for a list of allowed views
void handleDateChange(evt)
Event handler called on date widget/menu changes
void handleDateRangeChange(evt)
Event handler called on date range widget/menu changes
void handleDepthChange(<object> evt)
Event handler called on depth widget/menu changes
void handleDepthRangeChange(<object> evt)
Event handler called on depth widget/menu changes
void initMap(<object> mapid)
initMap() Method to initialize the mapwidget
void initTConstraint(<string> mode)
Initialize an T grid control
void initTree(<string> anchorId)
Method to initialize the control tree
void initUI()
initUI() Method to initialize the user interface.
void initXConstraint(<string> mode)
Initialize an X grid control
void initXYSelect()
Initialize the XY select widget to the grid
void initYConstraint(<string> mode)
Initialize an Y grid control
void initZConstraint(<string> mode)
Initialize an Z grid control
void makeRequest()
Put together and submit an LAS request
void onafterdraw(<object> evt)
Event handler to be attached to the MapWidget onafterdraw function
void selectCategory(<object> evt)
Event handler for category selection, bind to category DOM object events.
void setCategoryTreeNode(<string> strJson, <object> node, <string> id)
Method to load a UI category tree node from a json response
void setCategoryTreeSubNode(<string> node, <integer> i, <string> id)
Sub method to load a UI category or variable tree node from a json response
void setDataset(dataset)
Method to set the active dataset and call getGrid if appropriate
void setGrid(<string> strJson)
Method to evaluate a getGrid response and call getViews
void setMaxX(<object> evt)
Event handler for the max X constraint textbox
void setMaxY(<object> evt)
Event handler for the max Y constraint textbox
void setMinX(<object> evt)
Event handler for the min X constraint textbox
void setMinY(<object> evt)
Event handler for the min Y constraint textbox
void setOperation(<object> evt)
Event handler to set the operation
void setOperationLINode(<string> id, <string> name)
Method to create an operation radio button and add it to the operations tree node.
void setOperationList(<string> strJson)
Method to populate the list of avialable operations from a json response from the server
void setOption(<object> evt)
Event handler to respond to option changes
void setOptionList(<object> strJson)
Method to create an option list in the tree and add it to the DOM
void setOptionTRNode(<string> id)
Method to create an option tree node and add it to the DOM
void setVariable(<object> evt)
Event handler for variable selection, bind to variable DOM object events.
void setView(<object> evt)
Event handler to set the view, bind to view DOM object events.
void setViewList(<string> strJson)
Update the views list with the allowed views
void setViewNode(<string> id, <string> name)
Method to add a view radio button to the tree
void showDebugWindow()
Method to turn on floating debugger window.
void updateConstraints()
Update the 4D Constraints selectors


Constructor Detail

LASUI

LASUI()
    The LASUI class

Method Detail


autoUpdate

void autoUpdate(<object> evt)
    Event handler for the auto update toggle checkbox
    Parameters:
      evt - The event object

collapse

void collapse(<object> obj)
    Method to collapse a tree node
    Parameters:
      obj - Object reference in this.refs

collapseRootNodes

void collapseRootNodes(<object> evt)
    Event handler to collapse all root nodes in the tree
    Parameters:
      evt - The event object
      arguments - Arguements added with function.prototype.bindAsEventListener
      this -- the LASUI context
      node -- tree nod reference in this.refs

createCategoryTreeNode

void createCategoryTreeNode(<object> node, <integer> i, <string> id)
    Sub method to create category tree node and add it to the DOM
    Parameters:
      node - parent node in this.refs
      i - index of the childnode to be set
      id - a category id

createVariableTreeNode

void createVariableTreeNode(<object> node, <integer> i)
    Sub method to create variable tree node and add it to the DOM parameters:
    Parameters:
      node - parent node in this.refs
      i - index of the variable node within the category/dataset

displayCoords

void displayCoords(<object> XYSelect)
    Method to update the xy constraints textboxes
    Parameters:
      XYSelect - A MapWidget object

expand

void expand(<object> obj)
    Method to expand a tree node
    Parameters:
      obj - Object reference in this.refs

getCategory

void getCategory(parentNode, <integer> i)
    Method to query the server for a category
    Parameters:
      i - index of the child category to retrieve
      node - parent node in this.refs

getGrid

void getGrid(<string> dataset, <string> variable)
    Method to query the server for the available grids
    Parameters:
      dataset - A dataset id
      variable - A variable id within the dataset

getOperations

void getOperations(<string> dataset, <string> variable, <string> view)
    Method to query the server for a category
    Parameters:
      dataset - The selected dataset id
      variable - The selected variable id
      view - The selected view id

getOptions

void getOptions(<string> optiondef)
    Method to query the server for an options object and pass json response to setOptionList
    Parameters:
      optiondef - Id of the option set to query the server for.

getViews

void getViews(<string> dataset,<string> variable)
    Method to query the server for a list of allowed views
    Parameters:
      dataset - A dataset id
      variable - A variable id

handleDateChange

void handleDateChange(evt)
    Event handler called on date widget/menu changes

handleDateRangeChange

void handleDateRangeChange(evt)
    Event handler called on date range widget/menu changes

handleDepthChange

void handleDepthChange(<object> evt)
    Event handler called on depth widget/menu changes
    Parameters:
      evt - The event object

handleDepthRangeChange

void handleDepthRangeChange(<object> evt)
    Event handler called on depth widget/menu changes
    Parameters:
      evt - The event object

initMap

void initMap(<object> mapid)
    initMap() Method to initialize the mapwidget
    Parameters:
      mapid - The id of the map container object in the DOM

initTConstraint

void initTConstraint(<string> mode)
    Initialize an T grid control
    Parameters:
      mode - The axis mode. "range" or "point"

initTree

void initTree(<string> anchorId)
    Method to initialize the control tree
    Parameters:
      anchorId - the id of the page element to build the tree inside.

initUI

void initUI()
    initUI() Method to initialize the user interface.

initXConstraint

void initXConstraint(<string> mode)
    Initialize an X grid control
    Parameters:
      mode - The axis mode. "range" or "point"

initXYSelect

void initXYSelect()
    Initialize the XY select widget to the grid

initYConstraint

void initYConstraint(<string> mode)
    Initialize an Y grid control
    Parameters:
      mode - The axis mode. "range" or "point"

initZConstraint

void initZConstraint(<string> mode)
    Initialize an Z grid control
    Parameters:
      mode - The axis mode. "range" or "point"

makeRequest

void makeRequest()
    Put together and submit an LAS request

onafterdraw

void onafterdraw(<object> evt)
    Event handler to be attached to the MapWidget onafterdraw function
    Parameters:
      evt - The event object

selectCategory

void selectCategory(<object> evt)
    Event handler for category selection, bind to category DOM object events.
    Parameters:
      evt - The event object
      arguments - arguments added using function.prototype.bindAsEventListener
      this -- the context this function is run in
      parentNode -- parent node in this.refs
      i -- index of the category within the parentNode

setCategoryTreeNode

void setCategoryTreeNode(<string> strJson, <object> node, <string> id)
    Method to load a UI category tree node from a json response
    Parameters:
      strJson - a json string compatible with LASGetCategoriesResponse
      node - a parent node in this.refs
      id - the id of the category or dataset to be created

setCategoryTreeSubNode

void setCategoryTreeSubNode(<string> node, <integer> i, <string> id)
    Sub method to load a UI category or variable tree node from a json response
    Parameters:
      node - parent node in this.refs
      i - index of the childnode to be set
      id - a category id

setDataset

void setDataset(dataset)
    Method to set the active dataset and call getGrid if appropriate

setGrid

void setGrid(<string> strJson)
    Method to evaluate a getGrid response and call getViews
    Parameters:
      strJson - A json string compatible with LASGetGridResponse.js

setMaxX

void setMaxX(<object> evt)
    Event handler for the max X constraint textbox
    Parameters:
      evt - The event object

setMaxY

void setMaxY(<object> evt)
    Event handler for the max Y constraint textbox
    Parameters:
      evt - The event object

setMinX

void setMinX(<object> evt)
    Event handler for the min X constraint textbox
    Parameters:
      evt - The event object

setMinY

void setMinY(<object> evt)
    Event handler for the min Y constraint textbox
    Parameters:
      evt - The event object

setOperation

void setOperation(<object> evt)
    Event handler to set the operation
    Parameters:
      evt - The event object

setOperationLINode

void setOperationLINode(<string> id, <string> name)
    Method to create an operation radio button and add it to the operations tree node.
    Parameters:
      id - The operation id
      name - The name of the operation

setOperationList

void setOperationList(<string> strJson)
    Method to populate the list of avialable operations from a json response from the server
    Parameters:
      strJson - A json string compatibe with the LASGetOperationsResponse class

setOption

void setOption(<object> evt)
    Event handler to respond to option changes
    Parameters:
      evt - The event object
      arguments - Arguments added with function.prototype.bindAsEventListener
      this -- context
      id -- option id

setOptionList

void setOptionList(<object> strJson)
    Method to create an option list in the tree and add it to the DOM
    Parameters:
      strJson - A json response compatible with LASGetOptionsResponse.js

setOptionTRNode

void setOptionTRNode(<string> id)
    Method to create an option tree node and add it to the DOM
    Parameters:
      id - An option id

setVariable

void setVariable(<object> evt)
    Event handler for variable selection, bind to variable DOM object events.
    Parameters:
      evt - The event object
      arguments - Arguments added using function.prototype.bindAseventListener
      this -- context setVariable is being run in
      dataset -- a LASGetCategoriesReponse dataset object
      i -- index the variable within the category or dataset

setView

void setView(<object> evt)
    Event handler to set the view, bind to view DOM object events.
    Parameters:
      evt - The event object
      arguments - Arguments added using function.prototype.bindAseventListener
      this -- the context setView is being called in
      view -- a view id

setViewList

void setViewList(<string> strJson)
    Update the views list with the allowed views
    Parameters:
      strJson - A string compatible with LASGetViewsResposne.js

setViewNode

void setViewNode(<string> id, <string> name)
    Method to add a view radio button to the tree
    Parameters:
      id - A view id
      name - A view name

showDebugWindow

void showDebugWindow()
    Method to turn on floating debugger window.

updateConstraints

void updateConstraints()
    Update the 4D Constraints selectors


Overview File Class Tree Index Help
PREV CLASS NEXT CLASS FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Documentation generated by JSDoc on Tue Sep 4 15:26:57 2007