Show:

ia.InteractionGroup Class

Defined in: ia\InteractionGroup.js:50
Module: ia

Organizes interactions between different components.

Constructor

ia.InteractionGroup

()

Defined in ia\InteractionGroup.js:50

Methods

_dispatchInteractionEvent

(
  • eventType
)
private

Defined in ia\InteractionGroup.js:333

Dispatches an interaction event.

Parameters:

  • eventType String

    An ia.ItemEvent type.

_itemEventHandler

(
  • event
)
private

Defined in ia\InteractionGroup.js:304

Handles item events.

Parameters:

  • event ia.ItemEvent

    An ia.ItemEvent dispatched by a component.

_onLegendClassEvent

(
  • event
  • item
)
private

Defined in ia\InteractionGroup.js:357

Updates the legend class components.

Parameters:

  • event ia.ItemEvent

    An ia.ItemEvent dispatched by a component.

  • item Object

    An item.

_updateComponents

(
  • event
  • item
)
private

Defined in ia\InteractionGroup.js:438

Updates the components

Parameters:

  • event ia.ItemEvent

    An ia.ItemEvent dispatched by a component.

  • item Object

    An item.

_updateLegendClassComponents

(
  • event
  • item
)
private

Defined in ia\InteractionGroup.js:403

Updates the legend class components

Parameters:

  • event ia.ItemEvent

    An ia.ItemEvent dispatched by a component.

  • item Object

    An item.

addComponent

(
  • component
)

Defined in ia\InteractionGroup.js:89

Adds a component to the group.

Parameters:

  • component Object

    The component to add.

clearHighlight

()

Defined in ia\InteractionGroup.js:139

Clears the highlight.

clearSelection

(
  • id
)

Defined in ia\InteractionGroup.js:250

Selects the id.

Parameters:

  • id String

    The id.

clearSelection

()

Defined in ia\InteractionGroup.js:226

Clears the selection.

getComponents

() Object

Defined in ia\InteractionGroup.js:78

Gets the list of components.

Returns:

Object: An array of components.

getHighlight

() String

Defined in ia\InteractionGroup.js:128

Returns the highlighted id.

Returns:

String: The id.

getSelection

() String

Defined in ia\InteractionGroup.js:183

Returns the selected ids as an array.

Returns:

String: The list of ids.

removeComponent

(
  • component
)

Defined in ia\InteractionGroup.js:113

Removes a component from the group.

Parameters:

  • component Object

    The component to remove.

setHighlight

(
  • id
)

Defined in ia\InteractionGroup.js:161

Highlight the id.

Parameters:

  • id String

    The id.

setSelection

(
  • s
)

Defined in ia\InteractionGroup.js:194

Sets the selected ids as an array.

Parameters:

  • s String

    An array of ids.

unselect

(
  • id
)

Defined in ia\InteractionGroup.js:277

Unselects the id.

Parameters:

  • id String

    The id.

Properties

selectionMode

String

Defined in ia\InteractionGroup.js:69

Selection mode.

Default: "multiple"