Indicators

Indicators

new Indicators(optionsopt)

Source:
Properties:
Name Type Attributes Default Description
options.indicator_class Object <optional>
 Indicator

the class to derive new Indicators from. Has to be a subclass of Indicator.
options.connectionview ConnectionView

The ConnectionView data model.
options.batch Boolean <optional>
 true

Disable batch connection rectangle.
options.min_distance Number <optional>

Minimum distance the user has to drag in order to display the batch rectangle.
options.has_deselect_all Number <optional>

Batch can deselect all connections.
options.has_deselect_diagonal Number <optional>

Batch can deselect diagonal connections.
options.has_select_diagonal Number <optional>

Batch can select diagonal connections.

Indicators is an area inside Matrix containing a matrix of Indicators displaying and managing connections.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 { }

An object containing initial options.

Extends

Members

_batch :HTMLDiv

Source:

The rectangle to indicate batch selection/deselection. Has class .aux-batch.

Type:
  • HTMLDiv

_scroller :HTMLDiv

Source:

The container for hiding the scroll bar. Has class .aux-scroller.

Type:
  • HTMLDiv

buttons :Container

Source:

The container holding the buttons for batch connection management. Has class .aux-batchbuttons.

Type:

cancel :Button

Source:

The button for hiding the rectangle. Has class .aux-cancel.

Type:

deselect_all :Button

Source:

The button for disconnecting all. Has class .aux-deselectall.

Type:

deselect_diagonal :Button

Source:

The button for disconnecting diagonally. Has class .aux-deselectdiagonal.

Type:

element :HTMLDivElement

Source:
Inherited From:

The main DIV element. Has class .aux-container

Type:
  • HTMLDivElement

select_diagonal :Button

Source:

The button for connecting diagonally. Has class .aux-selectdiagonal.

Type:

Methods

hide()

Source:
Inherited From:

Starts the transition of the visible to false.

hideChild(child)

Source:
Inherited From:

Switches the hidden state of a child to hidden. The argument is either the child index or the child itself.

Parameters:
Name Type Description
child Object | integer

Child or its index.

isChildHidden(child) → {boolean}

Source:
Inherited From:

Returns true if the given child is currently marked as hidden in this container.

Parameters:
Name Type Description
child number | Widget
Returns:
Type
boolean

scrollLeftTo(position)

Source:

Scroll the indicators area to this horizontal (left) position.

Parameters:
Name Type Description
position Integer

the position in pixels to scroll to.

scrollTopTo(position)

Source:

Scroll the indicators area to this vertical (top) position.

Parameters:
Name Type Description
position Integer

the position in pixels to scroll to.

show()

Source:
Inherited From:

Starts the transition of the visible to true.

showChild(child)

Source:
Inherited From:

Switches the hidden state of a child to shown. The argument is either the child index or the child itself.

Parameters:
Name Type Description
child Object | integer

Child or its index.

toggleChild(child)

Source:
Inherited From:

Toggles the hidden state of a child. The argument is either the child index or the child itself.

Parameters:
Name Type Description
child Object | integer

Child or its index.

Events

scrollChanged

Source:

Is fired on scrolling the area.

Parameters:
Name Type Description
scroll_top Integer

The scroll position from top.
scroll_left Integer

The scroll position from left.