LaneOptions class (Swimlane)

LaneOptions()

new LaneOptions()

The exontrol.Surface.LaneOptions class holds all options a lane can display or own. You can use the OnCreateLane(oLaneOpts) method of exontrol.Swimlane.Pools class to customize the lane's options once the user creates a new lane by drag and drop. The oLaneOpts parameter is an object of exontrol.Surface.LaneOptions type.
Since:
  • 5.2

Members

(static) caption :string

The caption field defines the caption of the lane. You can use the caption field to set the lane's caption once the lane is created by drag and drop.
Type:
  • string
Example
"New Lane" {string}, sets the caption of the lane to "New Lane"
caption

(static) index :number

The index field specifies the index of the lane. The index is read-only.
Type:
  • number
Example
console.log(oLaneOpts.index), displays the index of the lane within the pool
index

(static) lanes :object

The lanes field defines the pool's lanes. The lanes field is read-only.
Type:
  • object
Example
console.log(oLaneOpts.lanes.content), displays all lanes of the pool that owns the lane, including the current lane
lanes

(static) pool :Pool

The pool field indicates the owner pool of the lane. The pool field is read-only.
Type:
Example
console.log(oLaneOpts.pool.Key), displays the key of the pool that owns the lane
pool

(static) shape :any

The shape field specifies the shape to be applied on the lane. You can use the shape field to set the lane's shape once the lane is created by drag and drop.

The shape can be any of the following:

  • {string}, specifies the shape of the lane as a CSS-color, a predefined shape such as "FrameSel" member of exontrol.Shapes
  • {object}, specifies an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type
Type:
  • any
Example
"red" {string}, sets the shape of the lane to red color
"FrameSel" {string}, sets the shape of the lane to "FrameSel"
shape

(static) size :number

The size field indicates the size (in pixels) of the lane or null if the [size] flag is missing. The size field is read-only.
Type:
  • number
size