Class DomRectSerializer

Hierarchy

SerializerBase<DOMRect, SerializedData>
- DomRectSerializer

Index

Constructors

constructor

new DomRectSerializer(domElement?: false | HTMLIFrameElement, target?: HTMLElement): DomRectSerializer
Parameters
- domElement: false | HTMLIFrameElement = false
- target: HTMLElement = window.document.body
Returns DomRectSerializer
Overrides SerializerBase.constructor
- Defined in src/serializer/DomRectSerializer.ts:30

Accessors

classToSerialize

get classToSerialize(): {
    prototype: DOMRect;
    fromRect(other?: DOMRectInit): DOMRect;
    new (x?: number, y?: number, width?: number, height?: number): DOMRect;
}
Getter to overload which return the Class to serialize

Abstract

Returns
Class object to serialize

Returns {
    prototype: DOMRect;
    fromRect(other?: DOMRectInit): DOMRect;
    new (x?: number, y?: number, width?: number, height?: number): DOMRect;
}
- - new (x?: number, y?: number, width?: number, height?: number): DOMRect
  - Parameters
    - Optional x: number
    - Optional y: number
    - Optional width: number
    - Optional height: number
    Returns DOMRect
- prototype: DOMRect
- fromRect:function
  - fromRect(other?: DOMRectInit): DOMRect
  - Parameters
    - Optional other: DOMRectInit
    Returns DOMRect
    - Defined in node_modules/typescript/lib/lib.dom.d.ts:4174
Overrides SerializerBase.classToSerialize
- Defined in src/serializer/DomRectSerializer.ts:39

Methods

serialize

serialize(clientRect: DOMRect): {
    left: number;
    top: number;
    width: number;
    height: number;
}
Method to implement for serialize an object (which match the classToSerialize) (reverse operation of deserialize)

Abstract

Returns
Return a standard serialized object
Parameters
- clientRect: DOMRect
  
  Object to serialize
Returns {
    left: number;
    top: number;
    width: number;
    height: number;
}
- left: number
- top: number
- width: number
- height: number
Overrides SerializerBase.serialize
- Defined in src/serializer/DomRectSerializer.ts:43

deserialize

deserialize(clientRect: SerializedData): DOMRect
Method to implement for deserialize an object (reverse operation of serialize)

Abstract

Returns
The deserialized object
Parameters
- clientRect: SerializedData
  
  The object to deserialize
Returns DOMRect
Overrides SerializerBase.deserialize
- Defined in src/serializer/DomRectSerializer.ts:54

`Private` _serializeXY

_serializeXY(xLeft: number, yTop: number): {
x: number;
y: number;
}
Parameters
- xLeft: number
- yTop: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in src/serializer/DomRectSerializer.ts:67

`Private` _deserializeXY

_deserializeXY(xLeft: number, yTop: number): {
x: number;
y: number;
}
Parameters
- xLeft: number
- yTop: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in src/serializer/DomRectSerializer.ts:97

Properties

`Private` _domElement

_domElement: false | HTMLIFrameElement

`Private` _target

_target: HTMLElement

Class DomRectSerializer

Hierarchy

Index

Constructors

Accessors

Methods

Properties

Constructors

constructor

Parameters

domElement: false | HTMLIFrameElement = false

target: HTMLElement = window.document.body

Returns DomRectSerializer

Accessors

classToSerialize

Abstract

Returns

Returns { prototype: DOMRect; fromRect(other?: DOMRectInit): DOMRect; new (x?: number, y?: number, width?: number, height?: number): DOMRect; }

Parameters

Optional x: number

Optional y: number

Optional width: number

Optional height: number

Returns DOMRect

prototype: DOMRect

fromRect:function

Parameters

Optional other: DOMRectInit

Returns DOMRect

Methods

serialize

Abstract

Returns

Parameters

clientRect: DOMRect

Returns { left: number; top: number; width: number; height: number; }

left: number

top: number

width: number

height: number

deserialize

Abstract

Returns

Parameters

clientRect: SerializedData

Returns DOMRect

Private _serializeXY

Parameters

xLeft: number

yTop: number

Returns { x: number; y: number; }

x: number

y: number

Private _deserializeXY

Parameters

xLeft: number

yTop: number

Returns { x: number; y: number; }

x: number

y: number

Properties

Private _domElement

Private _target

Settings

Member Visibility

Theme

Returns {
prototype: DOMRect;
fromRect(other?: DOMRectInit): DOMRect;
new (x?: number, y?: number, width?: number, height?: number): DOMRect;
}

`Optional` x: number

`Optional` y: number

`Optional` width: number

`Optional` height: number

`Optional` other: DOMRectInit

Returns {
left: number;
top: number;
width: number;
height: number;
}

`Private` _serializeXY

Returns {
x: number;
y: number;
}

`Private` _deserializeXY

Returns {
x: number;
y: number;
}

`Private` _domElement

`Private` _target