Mirror Engine API

---

Mirror Engine API / LayoutChildComponent

Class: LayoutChildComponent

A LayoutChildComponent enables the Entity to control the sizing applied to it by its parent LayoutGroupComponent.

Extends

• Component

Properties

entity

entity: Entity

The Entity that this Component is attached to.

Inherited from

Component.entity

---

system

system: ComponentSystem

The ComponentSystem used to create this Component.

Inherited from

Component.system

enabled

Get Signature

get enabled(): boolean

Gets the enabled state of the component.

Returns

boolean

Set Signature

set enabled(arg: boolean): void

Sets the enabled state of the component.

Parameters

arg

boolean

Returns

void

Inherited from

Component.enabled

---

excludeFromLayout

Get Signature

get excludeFromLayout(): boolean

Gets whether the child will be excluded from all layout calculations.

Returns

boolean

Set Signature

set excludeFromLayout(value: boolean): void

Sets whether the child will be excluded from all layout calculations.

Parameters

value

boolean

Returns

void

---

fitHeightProportion

Get Signature

get fitHeightProportion(): number

Gets the amount of additional vertical space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation.

Returns

number

Set Signature

set fitHeightProportion(value: number): void

Sets the amount of additional vertical space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation. This is specified as a proportion, taking into account the proportion values of other siblings.

Parameters

value

number

Returns

void

---

fitWidthProportion

Get Signature

get fitWidthProportion(): number

Gets the amount of additional horizontal space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation.

Returns

number

Set Signature

set fitWidthProportion(value: number): void

Sets the amount of additional horizontal space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation. This is specified as a proportion, taking into account the proportion values of other siblings.

Parameters

value

number

Returns

void

---

maxHeight

Get Signature

get maxHeight(): null | number

Gets the maximum height the element should be rendered at.

Returns

null | number

Set Signature

set maxHeight(value: null | number): void

Sets the maximum height the element should be rendered at.

Parameters

value

null | number

Returns

void

---

maxWidth

Get Signature

get maxWidth(): null | number

Gets the maximum width the element should be rendered at.

Returns

null | number

Set Signature

set maxWidth(value: null | number): void

Sets the maximum width the element should be rendered at.

Parameters

value

null | number

Returns

void

---

minHeight

Get Signature

get minHeight(): number

Gets the minimum height the element should be rendered at.

Returns

number

Set Signature

set minHeight(value: number): void

Sets the minimum height the element should be rendered at.

Parameters

value

number

Returns

void

---

minWidth

Get Signature

get minWidth(): number

Gets the minimum width the element should be rendered at.

Returns

number

Set Signature

set minWidth(value: number): void

Sets the minimum width the element should be rendered at.

Parameters

value

number

Returns

void

Methods

fire()

fire(
   name: string,
   arg1?: any,
   arg2?: any,
   arg3?: any,
   arg4?: any,
   arg5?: any,
   arg6?: any,
   arg7?: any,
   arg8?: any): EventHandler

Fire an event, all additional arguments are passed on to the event listener.

Parameters

name

string

Name of event to fire.

arg1?

any

First argument that is passed to the event handler.

arg2?

any

Second argument that is passed to the event handler.

arg3?

any

Third argument that is passed to the event handler.

arg4?

any

Fourth argument that is passed to the event handler.

arg5?

any

Fifth argument that is passed to the event handler.

arg6?

any

Sixth argument that is passed to the event handler.

arg7?

any

Seventh argument that is passed to the event handler.

arg8?

any

Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

Example

obj.fire('test', 'This is the message')

Inherited from

Component.fire

---

hasEvent()

hasEvent(name: string): boolean

Test if there are any handlers bound to an event name.

Parameters

name

string

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

Example

obj.on('test', () => {}) // bind an event to 'test'
obj.hasEvent('test') // returns true
obj.hasEvent('hello') // returns false

Inherited from

Component.hasEvent

---

off()

off(
   name?: string,
   callback?: HandleEventCallback,
   scope?: any): EventHandler

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

Parameters

name?

string

Name of the event to unbind.

callback?

HandleEventCallback

Function to be unbound.

scope?

any

Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

Example

const handler = () => {}
obj.on('test', handler)

obj.off() // Removes all events
obj.off('test') // Removes all events called 'test'
obj.off('test', handler) // Removes all handler functions, called 'test'
obj.off('test', handler, this) // Removes all handler functions, called 'test' with scope this

Inherited from

Component.off

---

on()

on(
   name: string,
   callback: HandleEventCallback,
   scope?: any): EventHandle

Attach an event handler to an event.

Parameters

name

string

Name of the event to bind the callback to.

callback

HandleEventCallback

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scope?

any = ...

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandle

Can be used for removing event in the future.

Examples

obj.on('test', (a, b) => {
  console.log(a + b)
})
obj.fire('test', 1, 2) // prints 3 to the console

const evt = obj.on('test', (a, b) => {
  console.log(a + b)
})
// some time later
evt.off()

Inherited from

Component.on

---

once()

once(
   name: string,
   callback: HandleEventCallback,
   scope?: any): EventHandle

Attach an event handler to an event. This handler will be removed after being fired once.

Parameters

name

string

Name of the event to bind the callback to.

callback

HandleEventCallback

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scope?

any = ...

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandle

• can be used for removing event in the future.

Example

obj.once('test', (a, b) => {
  console.log(a + b)
})
obj.fire('test', 1, 2) // prints 3 to the console
obj.fire('test', 1, 2) // not going to get handled

Inherited from

Component.once