Rectangle

How much to add to the x position.

How much to add to the y position.

How much to add to the width.

How much to add to the height.

Alignment specification.

The Widget or element or Rectangle to align to.

Arguments to inflate. Specify as a number to inflate the target rectangle by that many pixels, or as an array of inflate values for each edge.

The [width, height] of the anchor pointer when in top position. The width is the baseline length, and the height is the height of the arrow. If passed, the anchor position will be calculated to be at the centre of the overlap of the two aligned edges and returned in the anchor property of the resulting Rectangle:

{
    edge: 'top',         // or 'right' or 'bottom' or 'left'
    x/y: offset          // dimension to translate and value to translate by.
}

an { x: n, y: n } anchor translation to be used if the requested alignment succeeds without violating constraints. If a fallback alignment is used, the anchor will be centered in the overlap of the aligned edges as usual.

True to allow this to overlap the target.

The edge alignment specification string, specifying two points to bring together.

Each point is described by an edge initial (t for top edge, b for bottom edge etc) followed by a percentage along that edge.

So the form would be [trblc][n]-[trblc][n]. The n is the percentage offset along that edge which defines the alignment point. This is not valid for alignment point c which means the center point.

For example t0-b0' would align this Rectangle's top left corner with the bottom left corner of the target`.

The Widget or Element or Rectangle to constrain to. If the requested alignment cannot be constrained (it will first shrink the resulting Rectangle according to the minWidth and minHeight properties of this rectangle), then it will try aligning at other edges (honouring the axisLock option), and pick the fallback alignment which results in the shortest translation.

Specify as a truthy value to fall back to aligning against the opposite edge first if the requested alignment cannot be constrained into the constrainTo option. If specified as 'flexible', then fallback will continue searching for solutions on the remaining two sides.

When aligning edge-to-edge, match the length of the aligned-to edge of the target.

Setting this value to 'min' means that the resulting aligned Rectangle will grow to the size of the aligned-to edge if it is smaller, but will not shrink to match the aligned-to edge.

This is only honored when axisLock is enabled and alignment succeeds on the requested axis. If not aligning edge-to-edge, matchSize matches both dimensions of the target.

The 'x' and 'y' offset values to create an extra margin round the target to offset the aligned widget further from the target. May be configured as -ve to move the aligned widget towards the target - for example producing the effect of the anchor pointer piercing the target.

The amount of pixels to pad from the constrainTo target, either a single value, or an array of values in CSS edge order.

Pass as true if this is being used in an RTL environment, and aligning 0% to 100% along a horizontal edge must proceed from right to left.

The element to calculate the Rectangle for.

Optionally, a parent element in whose space to calculate the Rectangle.

Use browser viewport based coordinates.

Return the Rectangle within any sticky elements docked at the element edges.

The Rectangle to constrain this Rectangle into if possible.

Pass true to return false, and leave this Rectangle unchanged if constraint could not be achieved.

The Rectangle to test for containment within this Rectangle

The element to calculate the Rectangle for.

Optionally, a parent element in whose space to calculate the Rectangle.

Use browser viewport based coordinates.

The potentially occluding Rectangle(s).

The element (or selector) to calculate the Rectangle for.

Optionally, a parent element (or selector) in whose space to calculate the Rectangle.

Use browser viewport based coordinates.

The element to calculate the Rectangle for.

Optionally, a parent element in whose space to calculate the Rectangle.

The element to calculate the Rectangle for.

Optionally, a parent element in whose space to calculate the Rectangle.

Use browser viewport based coordinates.

The Rectangle to intersect with this.

Specify true to return a boolean value instead of constructing a new Rectangle

true to consider zero-width or zero-hight rectangles as intersecting if coordinates indicate the intersection

The new X position.

The new Y position.

device pixel ratio which defaults to window.devicePixelRatio

The X translation vector.

The Y translation vector.

If an anchor point was specified, this is the point on the aligned Rectangle at the alignment position.

The X coordinate of the anchor point.

The Y coordinate of the anchor point.

The edge on which the anchor point lies.

The final alignment string used after constraint was applied.

The zone number the result was aligned into (0, 1, 2, 3 for top right bottom, left).

The Rectangle the result was constrained into.