Class: DataLayout

DataLayout

This class provides the data set returned from BIPS reports along with convenient methods for accessing the data.

new DataLayout(oJSDataLayoutCube)

Parameters:
Name Type Description
oJSDataLayoutCube Object The DataLayout JSON object provided by the server.

Methods

getEdgeExtent(ePhysicalEdge) → {number}

Retrieves the edge extent for the requested EdgeType. The edge extent is also the slice count.
Parameters:
Name Type Description
ePhysicalEdge datashapes.Phisical The EdgeType
Returns:
The slice count
Type
number

getLayerCount(ePhysicalEdge) → {number}

Retrieves the layer count for the requested EdgeType.
Parameters:
Name Type Description
ePhysicalEdge datashapes.Phisical The EdgeType
Returns:
The layer count
Type
number

getLayerMetadata(ePhysicalEdge, nLayer, eLayerMetadata) → {Object}

This function returns the metadata requested for a particular edge and layer.
Parameters:
Name Type Description
ePhysicalEdge datashapes.Phisical The edge
nLayer integer The layer
eLayerMetadata data.LayerMetadata the enum for the Layer Metadata to find
Returns:
the layer metadata requested or NULL if it does not exist
Type
Object