goog.positioning

Provided By	`goog.positioning`

Returns the corner opposite the given one horizontally and vertically.

Parameters

`corner`	`goog.positioning.Corner`
	The popup corner used to flip.

Returns

goog.positioning.Corner

The opposite corner horizontally and vertically.

VIEW SOURCE

Returns the corner opposite the given one horizontally.

Parameters

`corner`	`goog.positioning.Corner`
	The popup corner used to flip.

Returns

goog.positioning.Corner

The opposite corner horizontally.

VIEW SOURCE

Returns the corner opposite the given one vertically.

Parameters

`corner`	`goog.positioning.Corner`
	The popup corner used to flip.

Returns

goog.positioning.Corner

The opposite corner vertically.

VIEW SOURCE

Returns an absolute corner (top/bottom left/right) given an absolute or relative (top/bottom start/end) corner and the direction of an element. Absolute corners remain unchanged.

Parameters

`element`	`(Element\|null)`
	DOM element to test for RTL direction.
`corner`	`goog.positioning.Corner`
	The popup corner used for positioning.

Returns

goog.positioning.Corner

Effective corner.

VIEW SOURCE

Calculates the page offset of the given element's offsetParent. This value can be used to translate any x- and y-offset relative to the page to an offset relative to the offsetParent, which can then be used directly with as position coordinate for positionWithCoordinate.

Parameters

`movableElement`	`Element`
	The element to calculate.

Returns

goog.math.Coordinate

The page offset, may be (0, 0).

VIEW SOURCE

Computes the position for an element to be placed on-screen at the specified coordinates. Returns an object containing both the resulting rectangle, and the overflow status bitmap.

Parameters

`absolutePos`	`goog.math.Coordinate`
	The coordinate to position the element at.
`elementSize`	`goog.math.Size`
	The size of the element to be positioned.
`elementCorner`	`goog.positioning.Corner`
	The corner of the movableElement that that should be positioned.
`opt_margin`	`(goog.math.Box\|null)=`
	A margin specified in pixels. After the normal positioning algorithm is applied and any offset, the margin is then applied. Positive coordinates move the popup away from the spot it was positioned towards its center. Negative coordinates move it towards the spot it was positioned away from its center.
`opt_viewport`	`(goog.math.Box\|null)=`
	Box object describing the dimensions of the viewport. Required if opt_overflow is specified.
`opt_overflow`	`(number\|null)=`
	Overflow handling mode. Defaults to IGNORE if not specified, goog.positioning.Overflow.

Returns

{rect: goog.math.Rect, status: goog.positioning.OverflowStatus}

Object containing the computed position and status bitmap.

VIEW SOURCE

Positions a movable element relative to an anchor element. The caller specifies the corners that should touch. This functions then moves the movable element accordingly.

Parameters

`anchorElement`	`(Element\|null)`
	The element that is the anchor for where the movable element should position itself.
`anchorElementCorner`	`goog.positioning.Corner`
	The corner of the anchorElement for positioning the movable element.
`movableElement`	`(Element\|null)`
	The element to move.
`movableElementCorner`	`goog.positioning.Corner`
	The corner of the movableElement that that should be positioned adjacent to the anchor element.
`opt_offset`	`(goog.math.Coordinate\|null)=`
	An offset specified in pixels. After the normal positioning algorithm is applied, the offset is then applied. Positive coordinates move the popup closer to the center of the anchor element. Negative coordinates move the popup away from the center of the anchor element.
`opt_margin`	`(goog.math.Box\|null)=`
	A margin specified in pixels. After the normal positioning algorithm is applied and any offset, the margin is then applied. Positive coordinates move the popup away from the spot it was positioned towards its center. Negative coordinates move it towards the spot it was positioned away from its center.
`opt_overflow`	`(number\|null)=`
	Overflow handling mode. Defaults to IGNORE if not specified. Bitmap, goog.positioning.Overflow.
`opt_preferredSize`	`(goog.math.Size\|null)=`
	The preferred size of the movableElement.
`opt_viewport`	`(goog.math.Box\|null)=`
	Box object describing the dimensions of the viewport. The viewport is specified relative to offsetParent of `movableElement`. In other words, the viewport can be thought of as describing a "position: absolute" element contained in the offsetParent. It defaults to visible area of nearest scrollable ancestor of `movableElement` (see `goog.style.getVisibleRectForElement`).

Returns

goog.positioning.OverflowStatus

Status bitmap, goog.positioning.OverflowStatus.

VIEW SOURCE

Positions the specified corner of the movable element at the specified coordinate.

Parameters

`absolutePos`	`(goog.math.Coordinate\|null)`
	The coordinate to position the element at.
`movableElement`	`(Element\|null)`
	The element to be positioned.
`movableElementCorner`	`goog.positioning.Corner`
	The corner of the movableElement that that should be positioned.
`opt_margin`	`(goog.math.Box\|null)=`
	A margin specified in pixels. After the normal positioning algorithm is applied and any offset, the margin is then applied. Positive coordinates move the popup away from the spot it was positioned towards its center. Negative coordinates move it towards the spot it was positioned away from its center.
`opt_viewport`	`(goog.math.Box\|null)=`
	Box object describing the dimensions of the viewport. Required if opt_overflow is specified.
`opt_overflow`	`(number\|null)=`
	Overflow handling mode. Defaults to IGNORE if not specified, goog.positioning.Overflow.
`opt_preferredSize`	`(goog.math.Size\|null)=`
	The preferred size of the movableElement. Defaults to the current size.

Returns

goog.positioning.OverflowStatus

Status bitmap.

VIEW SOURCE

goog.positioning

Functions

flipCorner( `corner` ) `→` `goog.positioning.Corner`

flipCornerHorizontal( `corner` ) `→` `goog.positioning.Corner`

flipCornerVertical( `corner` ) `→` `goog.positioning.Corner`

getEffectiveCorner( `element`, `corner` ) `→` `goog.positioning.Corner`

getOffsetParentPageOffset( `movableElement` ) `→` `goog.math.Coordinate`

getPositionAtCoordinate( `absolutePos`, `elementSize`, `elementCorner`, `opt_margin`, `opt_viewport`, `opt_overflow` ) `→` `{rect: goog.math.Rect, status: goog.positioning.OverflowStatus}`

positionAtAnchor( `anchorElement`, `anchorElementCorner`, `movableElement`, `movableElementCorner`, `opt_offset`, `opt_margin`, `opt_overflow`, `opt_preferredSize`, `opt_viewport` ) `→` `goog.positioning.OverflowStatus`

positionAtCoordinate( `absolutePos`, `movableElement`, `movableElementCorner`, `opt_margin`, `opt_viewport`, `opt_overflow`, `opt_preferredSize` ) `→` `goog.positioning.OverflowStatus`

Classes

Enumerations

goog.positioning

Functions

flipCorner( corner ) → goog.positioning.Corner

flipCornerHorizontal( corner ) → goog.positioning.Corner

flipCornerVertical( corner ) → goog.positioning.Corner

getEffectiveCorner( element, corner ) → goog.positioning.Corner

getOffsetParentPageOffset( movableElement ) → goog.math.Coordinate

getPositionAtCoordinate( absolutePos, elementSize, elementCorner, opt_margin, opt_viewport, opt_overflow ) → {rect: goog.math.Rect, status: goog.positioning.OverflowStatus}

positionAtAnchor( anchorElement, anchorElementCorner, movableElement, movableElementCorner, opt_offset, opt_margin, opt_overflow, opt_preferredSize, opt_viewport ) → goog.positioning.OverflowStatus

positionAtCoordinate( absolutePos, movableElement, movableElementCorner, opt_margin, opt_viewport, opt_overflow, opt_preferredSize ) → goog.positioning.OverflowStatus

Classes

Enumerations

flipCorner( `corner` ) `→` `goog.positioning.Corner`

flipCornerHorizontal( `corner` ) `→` `goog.positioning.Corner`

flipCornerVertical( `corner` ) `→` `goog.positioning.Corner`

getEffectiveCorner( `element`, `corner` ) `→` `goog.positioning.Corner`

getOffsetParentPageOffset( `movableElement` ) `→` `goog.math.Coordinate`

getPositionAtCoordinate( `absolutePos`, `elementSize`, `elementCorner`, `opt_margin`, `opt_viewport`, `opt_overflow` ) `→` `{rect: goog.math.Rect, status: goog.positioning.OverflowStatus}`

positionAtAnchor( `anchorElement`, `anchorElementCorner`, `movableElement`, `movableElementCorner`, `opt_offset`, `opt_margin`, `opt_overflow`, `opt_preferredSize`, `opt_viewport` ) `→` `goog.positioning.OverflowStatus`

positionAtCoordinate( `absolutePos`, `movableElement`, `movableElementCorner`, `opt_margin`, `opt_viewport`, `opt_overflow`, `opt_preferredSize` ) `→` `goog.positioning.OverflowStatus`