Hylograph.Interaction.Coordinated

data InteractionTrigger

What triggered the interaction

All components in a group receive the same trigger and respond based on their relationship to the triggering element/region.

Constructors

• HoverTrigger String
• BrushTrigger BoundingBox
• SelectionTrigger (Set String)
• FocusTrigger (Maybe String)
• ClearTrigger

Instances

• Eq InteractionTrigger
• Show InteractionTrigger

type BoundingBox = { x0 :: Number, x1 :: Number, y0 :: Number, y1 :: Number }

Bounding box for brush selections

Coordinates are in the local coordinate system of the visualization.

emptyBox :: BoundingBox

Empty bounding box (for clearing brush)

data InteractionState

How an element responds to the current interaction

CSS classes are applied based on state:

• Primary → .coord-primary
• Related → .coord-related
• Selected → .coord-selected
• Dimmed → .coord-dimmed
• Neutral → no class change

Constructors

• Primary
• Related
• Selected
• Dimmed
• Neutral

Instances

• Eq InteractionState
• Ord InteractionState
• Show InteractionState

isHighlighted :: InteractionState -> Boolean

Check if state represents any kind of highlighting

isSelected :: InteractionState -> Boolean

Check if state represents selection

type CoordinatedConfig datum = { group :: Maybe String, identify :: datum -> String, position :: Maybe (datum -> { x :: Number, y :: Number }), respond :: InteractionTrigger -> datum -> InteractionState }

Configuration for coordinated interaction behavior

The respond function is called for every element when any interaction occurs. It should be pure and fast since it runs on every hover/brush.

simpleHover :: forall datum. (datum -> String) -> CoordinatedConfig datum

Simple hover-only configuration

Elements are Primary when hovered, Dimmed when something else is hovered, Neutral when nothing is hovered.

withBrush :: forall datum. (datum -> { x :: Number, y :: Number }) -> CoordinatedConfig datum -> CoordinatedConfig datum

Add brush support to a configuration

Elements inside the brush region become Selected.

withSelection :: forall datum. CoordinatedConfig datum -> CoordinatedConfig datum

Add discrete selection support to a configuration

Elements whose ID is in the selection set become Selected.

data CoordinatedHandle

Handle for managing coordinated interaction registration

Use to unregister when component unmounts.

registerCoordinated :: forall datum. Element -> CoordinatedConfig datum -> Effect (Effect Unit)

Register an element for coordinated interactions

Returns an Effect that unregisters the element when called.

unregister <- registerCoordinated element config
-- Later, on unmount:
unregister

emitTrigger :: Maybe String -> InteractionTrigger -> Effect Unit

Emit a trigger to all elements in a group

Used by brush handlers to dispatch brush regions.

clearInteractions :: Maybe String -> Effect Unit

Clear all interaction state in a group

mkHoverTrigger :: String -> InteractionTrigger

Create a HoverTrigger

mkBrushTrigger :: BoundingBox -> InteractionTrigger

Create a BrushTrigger

mkClearTrigger :: InteractionTrigger

Create a ClearTrigger

mkFocusTrigger :: Maybe String -> InteractionTrigger

Create a FocusTrigger

pointInBox :: { x :: Number, y :: Number } -> BoundingBox -> Boolean

Test if a point is inside a bounding box

boxesOverlap :: BoundingBox -> BoundingBox -> Boolean

Test if two bounding boxes overlap