The Handle class represents the handles of the ravel, that allow the
axes to be manipulated. It is a reference class, so not something that
can be independently created, but rather set to refer to the different
handles of a ravel.
- Usage:
-
var handle=ravel.handle;
handle.get(i);
- Properties:
-
- sliceLabels
- A SortedVector of the slice labels along the handle.
- Methods:
-
- get(i)
- sets the handle to refer to handle i, which should be in
the range 0..ravel.numHandles().
- x(), y()
- coordinates of the handle tip.
- getReductionOp()
- returns the reduction that is applied when the
handle is collapsed. The returned value is an enum type called
Module.ReductionOp. Values are represented by static properties of
that class, eg Module.ReductionOp.sum, and can be used in comparison
operators or in case labels of a switch statement.
- setReductionOp(op)
- Sets the reductionOp attribute. op is one of
the values of the Module.ReductionOp enum. After this call, the
handle is left in a collapsed state.
- getDescription()
- returns the axis label of this handle
- setDescription(axisName)
- sets the axis label of this handle
- reductionDescription()
- if the handle is collapsed, returns an
English language description of the reduction operation - eg “sum of
countries", otherwise is equivalent to getDescription().
- getSliceIndex()
- returns the position along the axis where the
slicer control is position.
- setSliceIndex(idx)
- sets the position of the slicer control
- getSliceMin()
- returns the index of the minimum slice, when
filtering is in effect
- setSliceMin(idx)
- sets the minimum slice index
- getSliceMin()
- returns the index of the maximum slice, when
filtering is in effect
- setSliceMin(idx)
- sets the maximum slice index
- sliceLabel()
- returns the label at the current slicer
control. Equivalent to sliceLabelAt(getSliceIndex()).
- sliceLabelAt(idx)
- returns the label at index idx, given the
current sort order.
- minSliceLabel()
- equivalent to sliceLabelAt(getSliceMin())
- maxSliceLabel()
- equivalent to sliceLabelAt(getSliceMax())
- collapse()
- return whether the handle is collapsed
- toggleCollapsed()
- toggles the collapsed state of the handle
- getDisplayFilterCaliper()
- returns whether filtering has been
enabled or not.
- setDisplayFilterCaliper(filter)
- enable or disable filtering
depending on whether filter is true or false.
- setSlicer(label)
- sets the slicer to the position where label is
found. If label is not a sliceLabel, then nothing happens. If the
slice labels are not unique, then the action is indeterminate
- mask()
- returns an array of boolean values. If a mask[i] is
true, then no data items corresponding to slice i exist in the
data.
- getHandleState()
- returns a JSON string representing the state
of the handle.
- setHandleState(state)
- sets the handle's state according to the
JSON string state.
Ravelation Pty Ldt
