Class: RelativeRect

Defined in: livelink.clients/livelink.js/sources/rendering/surfaces/Rect.ts:134

Extends

• Rect

Constructors

Constructor

new RelativeRect(__namedParameters: {
  left?: number;
  top?: number;
  right?: number;
  bottom?: number;
  width?: number;
  height?: number;
}): RelativeRect;

Defined in: livelink.clients/livelink.js/sources/rendering/surfaces/Rect.ts:189

Parameters

Parameter	Type
__namedParameters	{ left?: number; top?: number; right?: number; bottom?: number; width?: number; height?: number; }
__namedParameters.left?	number
__namedParameters.top?	number
__namedParameters.right?	number
__namedParameters.bottom?	number
__namedParameters.width?	number
__namedParameters.height?	number

Returns

RelativeRect

Overrides

Rect.constructor

Properties

Property	Modifier	Type	Description	Inherited from
left	readonly	number	-	Rect.left
top	readonly	number	-	Rect.top
right	readonly	number	-	Rect.right
bottom	readonly	number	-	Rect.bottom
width	readonly	number	-	Rect.width
height	readonly	number	-	Rect.height
default	readonly	RelativeRect	Default relative rect that covers the whole area.	-

Methods

from_dom_elements()

static from_dom_elements(params: {
  element: HTMLElement;
  parent: HTMLElement;
}): RelativeRect;

Defined in: livelink.clients/livelink.js/sources/rendering/surfaces/Rect.ts:155

Creates a relative rect from the given DOM elements. It calculates the relative position and size of the element inside the parent element.

Parameters

Parameter	Type	Description
params	{ element: HTMLElement; parent: HTMLElement; }	-
params.element	HTMLElement	The element to get the relative rect from.
params.parent	HTMLElement	The parent element of the element.

Returns

RelativeRect

The relative rect.

Throws

• If the element has an invalid size.

Throws

• If the element is not contained into its parent bounds.