/ fm / liveswitch / LayoutFrame

Class: LayoutFrame

fm.liveswitch.LayoutFrame

A layout frame definition, including X/Y coordinates and width/height values.

Table of contents

Constructors

• constructor

Methods

• fmliveswitchLayoutFrameInit
• getClientId
• getDeviceId
• getHeight
• getOrientation
• getTypeString
• getUserId
• getViewId
• getWidth
• getX
• getY
• isEquivalent
• setClientId
• setDeviceId
• setHeight
• setOrientation
• setUserId
• setViewId
• setWidth
• setX
• setY
• toJson
• fromJson
• getScaledFrame
• toJson

Constructors

constructor

+ new LayoutFrame(): LayoutFrame

Returns: LayoutFrame

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:38

+ new LayoutFrame(x: number, y: number, width: number, height: number): LayoutFrame

Initializes a new instance of the [[fm.liveswitch.layoutFrame]] class.

Parameters:

Name	Type	Description
x	number	The X coordinate.
y	number	The Y coordinate.
width	number	The width value.
height	number	The height value.

Returns: LayoutFrame

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:39

Methods

fmliveswitchLayoutFrameInit

▸ PrivatefmliveswitchLayoutFrameInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:31

---

getClientId

▸ getClientId(): string

Gets the client identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:215

---

getDeviceId

▸ getDeviceId(): string

Gets the device identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:227

---

getHeight

▸ getHeight(): number

Gets the height value.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:239

---

getOrientation

▸ getOrientation(): number

Gets the orientation in degrees.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:251

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:9

---

getUserId

▸ getUserId(): string

Gets the user identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:263

---

getViewId

▸ getViewId(): string

Gets the view ID.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:275

---

getWidth

▸ getWidth(): number

Gets the width value.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:287

---

getX

▸ getX(): number

Gets the X coordinate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:299

---

getY

▸ getY(): number

Gets the Y coordinate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:311

---

isEquivalent

▸ isEquivalent(layoutFrame: LayoutFrame): boolean

Determines whether the specified layout frame is equivalent.

Parameters:

Name	Type	Description
layoutFrame	LayoutFrame	The layout frame.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:324

---

setClientId

▸ setClientId(value: string): void

Sets the client identifier.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:336

---

setDeviceId

▸ setDeviceId(value: string): void

Sets the device identifier.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:348

---

setHeight

▸ setHeight(value: number): void

Sets the height value.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:360

---

setOrientation

▸ setOrientation(value: number): void

Sets the orientation in degrees.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:373

---

setUserId

▸ setUserId(value: string): void

Sets the user identifier.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:386

---

setViewId

▸ setViewId(value: string): void

Sets the view ID.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:398

---

setWidth

▸ setWidth(value: number): void

Sets the width value.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:410

---

setX

▸ setX(value: number): void

Sets the X coordinate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:423

---

setY

▸ setY(value: number): void

Sets the Y coordinate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:436

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:449

---

fromJson

▸ StaticfromJson(layoutFrameJson: string): LayoutFrame

Deserializes a layout frame from JSON.

Parameters:

Name	Type	Description
layoutFrameJson	string	The layout frame JSON.

Returns: LayoutFrame

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:79

---

getScaledFrame

▸ StaticgetScaledFrame(scale: LayoutScale, outerWidth: number, outerHeight: number, innerWidth: number, innerHeight: number): LayoutFrame

Gets a scaled frame.

Parameters:

Name	Type	Description
scale	LayoutScale	The scaling algorithm to use.
outerWidth	number	The width of the outer container.
outerHeight	number	The height of the outer container.
innerWidth	number	The width of the inner element.
innerHeight	number	The height of the inner element.

Returns: LayoutFrame

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:127

---

toJson

▸ StatictoJson(layoutFrame: LayoutFrame): string

Serializes a layout frame to JSON.

Parameters:

Name	Type	Description
layoutFrame	LayoutFrame	The layout frame.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/LayoutFrame.ts:188