Skip to content
This repository has been archived by the owner on Jul 13, 2021. It is now read-only.

Latest commit

 

History

History
33 lines (21 loc) · 1.26 KB

hyper-cube.md

File metadata and controls

33 lines (21 loc) · 1.26 KB

Halyard.HyperCube

new Halyard.HyperCube( hyperCubeLayout[, options] )

A hyper cube is the representation of a hyper cube layout made up by a table/tables. If the hyper cube layout contains dual fields each dual field will have a map table associated.

let hyperCube = new Halyard.HyperCube(qHyperCube, "Car Makers");

The first parameter is the hyper cube layout, and the second parameter is the options JSON or the hyper cube name.

hyper cube layout

The hyper cube layout needs to have data in qDataPages. Only hyper cubes with qMode equals S for DATA_MODE_STRAIGHT is supported. Example qHyperCube

options

Optional parameter. Can be either the hyper cube name as a String, or the following structure:

Property Type Description
name String The name of the table
section String The name of the script section. If left empty the script is appended to the previous script section

An example of using options:

let hyperCube = new Halyard.HyperCube(qHyperCube, { name: 'Data', section: 'Data (HyperCube)' });

getItems()

Returns the items (Halyard.Table) needed to load the hyper cube layout and the options provided.