PoolSplitter class (Swimlane)

PoolSplitter(oOpts)

new PoolSplitter(oOpts)

Creates a PoolSplitter object that represents a splitter within the pool. The lanes and phases of the pools are treated as splitters.

The PoolSplitter class includes the following members:

  • pool {Pool}, indicates the owner pool
  • index {number}, specifies the index of the splitter
  • caption {string}, defines the caption of the splitter
  • size {number}, indicates the size of the splitter or null if the [size] flag is missing
  • shape {string}, specifies the shape to be applied on the splitter

The PoolSplitter class includes the following additional members:

lanes {object}, defines the pool's lanes (pool's oLanes reference)
or
phases {object}, defines the pool's phases (pool's oPhases reference)

Parameters:
Name Type Description
oOpts object Indicates the options of the splitter as an object of {pool,caption,size,shape,index,lanes} or {pool,caption,size,shape,index,phases} type
PoolSplitter

Methods

GetCaption() → {string}

The GetCaption() method gets the caption of the splitter (lane or phase).
Since:
  • 1.8
Returns:
Returns the caption of the splitter.
Type
string
GetCaption

GetIndex() → {number}

The GetIndex() method gets the index of the splitter (lane or phase).
Since:
  • 1.8
Returns:
Returns the index of the splitter.
Type
number
GetIndex

GetShape() → {any}

The GetShape() method gets the shape of the splitter (lane or phase).
Since:
  • 1.8
Returns:
Returns the shape of the splitter.
Type
any
GetShape

GetSize() → {number}

The GetSize() method gets the size of the splitter (lane's height or phase's width).
Since:
  • 1.8
Returns:
Returns the lane's height or phase's width.
Type
number
GetSize

SetCaption(value)

The GetCaption() method sets the caption of the splitter (lane or phase).
Parameters:
Name Type Description
value string Indicates the caption of the splitter
Since:
  • 1.8
SetCaption

SetShape(value)

The SetShape() method sets the shape of the splitter (lane or phase).
Parameters:
Name Type Description
value string Specifies the shape to apply on lane or phase
Since:
  • 1.8
SetShape

SetSize(value)

The SetSize() method sets the size of the splitter (lane's height or phase's width).
Parameters:
Name Type Description
value string Specifies the lane's height or phase's width
Since:
  • 1.8
SetSize