API Docs for: 3.8.0
Show:

Plugin.Align Class

Defined in: node/js/align-plugin.js:11
Module: align-plugin

Node plugin which can be used to align a node with another node, region, or the viewport.

Item Index

Methods

Methods

center

(
  • region
)

Defined in node/js/align-plugin.js:123

Aligns the center of a node to the center of another node or region.

Parameters:

  • region Node | | HTMLElement | | Object

    optional The node or region to align with. Defaults to the viewport region. the window is resized. If centering to viewport, this defaults to true, otherwise default is false.

destroy

()

Defined in node/js/align-plugin.js:136

Removes the resize handler, if any. This is called automatically when unplugged from the host node.

to

(
  • region
  • regionPoint
  • point
  • resize
)

Defined in node/js/align-plugin.js:25

Aligns node with a point on another node or region. Possible alignment points are:

tl
top left
tr
top right
bl
bottom left
br
bottom right
tc
top center
bc
bottom center
rc
right center
lc
left center
cc
center center

Parameters:

  • region String | | Node | | HTMLElement | | Object

    The node or region to align with. Defaults to the viewport region.

  • regionPoint String

    The point of the region to align with.

  • point String

    The point of the node aligned to the region.

  • resize Boolean

    Whether or not the node should re-align when the window is resized. Defaults to false.