National Oceanic and
Atmospheric Administration
United States Department of Commerce

LASGetGridResponse JSDoc

Last modified: Mon, 04/03/2017 - 17:28
API for the LASGetGridResponse javascript component.

Class LASGetGridResponse

Object
 |
 +--LASGetGridResponse
class LASGetGridResponse

This is the basic LASGetGridResponse class.
Defined in LASGetGridResponse.js


Field Summary
Object response
LAS Grid object returned by the getGrid.do request.


Constructor Summary
LASGetGridResponse (response)
Constructs a new LASGetGridResponse object.
The LASGetGridResponse object contains all the information returned from a getGrid.do request to the LAS product server .


Method Summary
object getAxis(<string> axis)
Returns the specified axis object, OR null if the specified axis doesn't exist in the grid.
int getDelta(<string> axis)
Returns the delta value of an <arange> associated with a particular axis of the grid OR null if the axis has a (<v> array) or if the axis doesn't exist in the grid.
string getDisplayType(axis)
Returns the "dispay_type" associated with a particular axis of the grid OR null if the "display_type" is not found or the axis doesn't exist in the grid.
string getHi(<string> axis)
Returns the hi value of an <arange> associated with a particular axis of the grid OR the first value associated with the last element of a Menu array (<v> array) OR null if the axis doesn't exist in the grid.
string getID(axis)
Returns the ID associated with a particular axis of the grid OR null if the axis doesn't exist in the grid.

Possible return values include

  • menu -- use MenuWidget
  • widget -- use DateuWidget
string getLo(<string> axis)
Returns the lo value of an <arange> associated with a particular axis of the grid OR the first value associated with the first element of a Menu array (<v> array) OR null if the axis doesn't exist in the grid.
object getMenu(axis)
Returns a Menu object of name:value pairs if such a menu exists for the specified axis OR null if no menu object is found or if the axis doesn't exist in the grid.
string getRenderFormat(axis)
Returns the "render_format" associated with a particular axis of the grid OR null if the "render_format is not found or the axis doesn't exist in the grid.
int getSize(<string> axis)
Returns the size of an <arange> associated with a particular axis of the grid OR the length of a Menu array (<v> array) OR null if the axis doesn't exist in the grid.
string getUnits(axis)
Returns the units associated with a particular axis of the grid OR null if the axis doesn't exist in the grid.
Boolean hasArange(<string> axis)
Returns Boolean True if the specified axis has an <arange> element.
Boolean hasAxis(<string> axis)
Returns Boolean True if the specified axis exists in the grid.
Boolean hasMenu(<string> axis)
Returns Boolean True if the specified axis has a <v> element.


Field Detail

response

Object response
    LAS Grid object returned by the getGrid.do request.

Constructor Detail


LASGetGridResponse

LASGetGridResponse(response)
    Constructs a new LASGetGridResponse object.
    The LASGetGridResponse object contains all the information returned from a getGrid.do request to the LAS product server . An XML representation of the JSON object returned by the LAS product server would look like this: 
 <t>?
 <t/>
 <units/>

 <name/>
 <ID/>
 <display_type/>
 <v>[
 <option/>+
 ]</v>
 </t>

 <x>?
 <units/>
 <ID/>
 <arange>
 <start/>
 <step/>

 <size/>
 <name/>
 <ID/>
 </arange>
 </x>?
 <y>?
 <units/>

 <ID/>
 <arange>
 <start/>
 <step/>
 <size/>
 <name/>

 <ID/>
 </arange>
 </y>?
 <z>?
 <units/>
 <ID/>
 <arange>

 <start/>
 <step/>
 <size/>
 <name/>
 <ID/>
 </arange>

 </z>?
    Parameters:
      JSONObject - instantiated from JSON serialization of the getGrid.do response
    Returns:
      A new LASGetGridResponse object

Method Detail


getAxis

object getAxis(<string> axis)
    Returns the specified axis object, OR null if the specified axis doesn't exist in the grid.
    Parameters:
      axis - axis of interest
    Returns:
      object if the element is present, null otherwise.

getDelta

int getDelta(<string> axis)
    Returns the delta value of an <arange> associated with a particular axis of the grid OR null if the axis has a (<v> array) or if the axis doesn't exist in the grid.
    Parameters:
      axis - axis of interest
    Returns:
      delta delta value associated with this axis

getDisplayType

string getDisplayType(axis)
    Returns the "dispay_type" associated with a particular axis of the grid OR null if the "display_type" is not found or the axis doesn't exist in the grid.
    Returns:
      display_type the type of UI widget to be displayed

getHi

string getHi(<string> axis)
    Returns the hi value of an <arange> associated with a particular axis of the grid OR the first value associated with the last element of a Menu array (<v> array) OR null if the axis doesn't exist in the grid.
    Parameters:
      axis - axis of interest
    Returns:
      hi hi value associated with this axis

getID

string getID(axis)
    Returns the ID associated with a particular axis of the grid OR null if the axis doesn't exist in the grid.

    Possible return values include

    • menu -- use MenuWidget
    • widget -- use DateuWidget
    Returns:
      ID the ID associated with a particular axis of the grid

getLo

string getLo(<string> axis)
    Returns the lo value of an <arange> associated with a particular axis of the grid OR the first value associated with the first element of a Menu array (<v> array) OR null if the axis doesn't exist in the grid.
    Parameters:
      axis - axis of interest
    Returns:
      lo lo value associated with this axis

getMenu

object getMenu(axis)
    Returns a Menu object of name:value pairs if such a menu exists for the specified axis OR null if no menu object is found or if the axis doesn't exist in the grid.
    Returns:
      Menu menu object to be used with MenuWidget.js

getRenderFormat

string getRenderFormat(axis)
    Returns the "render_format" associated with a particular axis of the grid OR null if the "render_format is not found or the axis doesn't exist in the grid.
    Returns:
      display_type the type of UI widget to be displayed

getSize

int getSize(<string> axis)
    Returns the size of an <arange> associated with a particular axis of the grid OR the length of a Menu array (<v> array) OR null if the axis doesn't exist in the grid.
    Parameters:
      axis - axis of interest
    Returns:
      lo lo value associated with this axis

getUnits

string getUnits(axis)
    Returns the units associated with a particular axis of the grid OR null if the axis doesn't exist in the grid.
    Returns:
      units the units associated with a particular axis of the grid

hasArange

Boolean hasArange(<string> axis)
    Returns Boolean True if the specified axis has an <arange> element.
    Parameters:
      axis - axis of interest
    Returns:
      value True if the <arange> element is present.

hasAxis

Boolean hasAxis(<string> axis)
    Returns Boolean True if the specified axis exists in the grid.
    Parameters:
      axis - axis of interest
    Returns:
      value True if the <arange> element is present.

hasMenu

Boolean hasMenu(<string> axis)
    Returns Boolean True if the specified axis has a <v> element.
    Parameters:
      axis - axis of interest
    Returns:
      value True if the <v> element is present.