FlexContainer
Defined in: ui/FlexContainer.ts:34
Extends
Section titled “Extends”_FlexContainer
Type Parameters
Section titled “Type Parameters”T extends Application = Application
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FlexContainer<
T>(config):FlexContainer<T>
Defined in: ui/FlexContainer.ts:38
Parameters
Section titled “Parameters”config
Section titled “config”Partial<FlexContainerConfig> = {}
Returns
Section titled “Returns”FlexContainer<T>
Overrides
Section titled “Overrides”_FlexContainer.constructor
Properties
Section titled “Properties”add:
object
Defined in: mixins/factory/Factory.ts:6
animatedSprite()
Section titled “animatedSprite()”animatedSprite: (
props?) =>AnimatedSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<AnimatedSpriteProps>
Returns
Section titled “Returns”bitmapText()
Section titled “bitmapText()”bitmapText: (
props?) =>BitmapText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”BitmapText
button()
Section titled “button()”button: (
props?) =>Button
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ButtonProps>
Returns
Section titled “Returns”container()
Section titled “container()”container: (
props?) =>Container<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ContainerProps>
Returns
Section titled “Returns”Container<Application<DataSchema, ActionContext, Action, Renderer>>
existing()
Section titled “existing()”existing: <
TEntity>(entity,props?) =>TEntity
Type Parameters
Section titled “Type Parameters”TEntity
Section titled “TEntity”TEntity
Parameters
Section titled “Parameters”entity
Section titled “entity”TEntity
props?
Section titled “props?”Partial<ExistingProps>
Returns
Section titled “Returns”TEntity
flexContainer()
Section titled “flexContainer()”flexContainer: (
props?) =>FlexContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<FlexContainerProps>
Returns
Section titled “Returns”FlexContainer
graphics()
Section titled “graphics()”graphics: (
props?) =>Graphics
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<GraphicsProps>
Returns
Section titled “Returns”Graphics
htmlText()
Section titled “htmlText()”htmlText: (
props?) =>HTMLText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<HTMLTextProps>
Returns
Section titled “Returns”HTMLText
particleContainer()
Section titled “particleContainer()”particleContainer: (
props?) =>ParticleContainer<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ParticleContainerProps>
Returns
Section titled “Returns”ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>
spine()
Section titled “spine()”spine: (
props?) =>Spine
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”spineAnimation()
Section titled “spineAnimation()”spineAnimation: <
ANames,A>(props?) =>SpineAnimation<ANames,A>
Type Parameters
Section titled “Type Parameters”ANames
Section titled “ANames”ANames extends string = string
A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”SpineAnimation<ANames, A>
sprite()
Section titled “sprite()”sprite: (
props?) =>Sprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpriteProps>
Returns
Section titled “Returns”Sprite
text()
Section titled “text()”text: (
props?) =>Text
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”Text
texture()
Section titled “texture()”texture: (
props?) =>Texture=resolveTexture
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextureProps>
Returns
Section titled “Returns”Texture
tilingSprite()
Section titled “tilingSprite()”tilingSprite: (
props?) =>TilingSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TilingSpriteProps>
Returns
Section titled “Returns”TilingSprite
toaster()
Section titled “toaster()”toaster: (
toasterConfig?,defaultToastConfig) =>Toaster
Parameters
Section titled “Parameters”toasterConfig?
Section titled “toasterConfig?”Partial<ToasterConfig>
defaultToastConfig?
Section titled “defaultToastConfig?”Partial<ToastConfig> = {}
Returns
Section titled “Returns”uiCanvas()
Section titled “uiCanvas()”uiCanvas: (
props?) =>UICanvas
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<UICanvasFactoryProps>
Returns
Section titled “Returns”svg(
props):Svg
Parameters
Section titled “Parameters”WithRequiredProps<SvgProps, "ctx">
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_FlexContainer.add
config
Section titled “config”config:
Partial<FlexContainerConfig>
Defined in: ui/FlexContainer.ts:36
make:
object
Defined in: mixins/factory/Factory.ts:7
animatedSprite()
Section titled “animatedSprite()”animatedSprite: (
props?) =>AnimatedSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<AnimatedSpriteProps>
Returns
Section titled “Returns”bitmapText()
Section titled “bitmapText()”bitmapText: (
props?) =>BitmapText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”BitmapText
button()
Section titled “button()”button: (
props?) =>Button
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ButtonProps>
Returns
Section titled “Returns”container()
Section titled “container()”container: (
props?) =>Container<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ContainerProps>
Returns
Section titled “Returns”Container<Application<DataSchema, ActionContext, Action, Renderer>>
existing()
Section titled “existing()”existing: <
TEntity>(entity,props?) =>TEntity
Type Parameters
Section titled “Type Parameters”TEntity
Section titled “TEntity”TEntity
Parameters
Section titled “Parameters”entity
Section titled “entity”TEntity
props?
Section titled “props?”Partial<ExistingProps>
Returns
Section titled “Returns”TEntity
flexContainer()
Section titled “flexContainer()”flexContainer: (
props?) =>FlexContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<FlexContainerProps>
Returns
Section titled “Returns”FlexContainer
graphics()
Section titled “graphics()”graphics: (
props?) =>Graphics
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<GraphicsProps>
Returns
Section titled “Returns”Graphics
htmlText()
Section titled “htmlText()”htmlText: (
props?) =>HTMLText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<HTMLTextProps>
Returns
Section titled “Returns”HTMLText
particleContainer()
Section titled “particleContainer()”particleContainer: (
props?) =>ParticleContainer<Application<DataSchema,ActionContext,Action,Renderer>>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ParticleContainerProps>
Returns
Section titled “Returns”ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>
spine()
Section titled “spine()”spine: (
props?) =>Spine
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”spineAnimation()
Section titled “spineAnimation()”spineAnimation: <
ANames,A>(props?) =>SpineAnimation<ANames,A>
Type Parameters
Section titled “Type Parameters”ANames
Section titled “ANames”ANames extends string = string
A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”SpineAnimation<ANames, A>
sprite()
Section titled “sprite()”sprite: (
props?) =>Sprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpriteProps>
Returns
Section titled “Returns”Sprite
text()
Section titled “text()”text: (
props?) =>Text
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”Text
texture()
Section titled “texture()”texture: (
props?) =>Texture=resolveTexture
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextureProps>
Returns
Section titled “Returns”Texture
tilingSprite()
Section titled “tilingSprite()”tilingSprite: (
props?) =>TilingSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TilingSpriteProps>
Returns
Section titled “Returns”TilingSprite
toaster()
Section titled “toaster()”toaster: (
toasterConfig?,defaultToastConfig) =>Toaster
Parameters
Section titled “Parameters”toasterConfig?
Section titled “toasterConfig?”Partial<ToasterConfig>
defaultToastConfig?
Section titled “defaultToastConfig?”Partial<ToastConfig> = {}
Returns
Section titled “Returns”uiCanvas()
Section titled “uiCanvas()”uiCanvas: (
props?) =>UICanvas
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<UICanvasFactoryProps>
Returns
Section titled “Returns”svg(
props):Svg
Parameters
Section titled “Parameters”WithRequiredProps<SvgProps, "ctx">
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_FlexContainer.make
onLayoutComplete
Section titled “onLayoutComplete”onLayoutComplete:
Signal<() =>void>
Defined in: ui/FlexContainer.ts:35
signalConnections
Section titled “signalConnections”signalConnections:
SignalConnections
Defined in: mixins/signals.ts:9
Inherited from
Section titled “Inherited from”_FlexContainer.signalConnections
Accessors
Section titled “Accessors”alignItems
Section titled “alignItems”Get Signature
Section titled “Get Signature”get alignItems():
AlignItems
Defined in: ui/FlexContainer.ts:144
Returns
Section titled “Returns”Set Signature
Section titled “Set Signature”set alignItems(
value):void
Defined in: ui/FlexContainer.ts:148
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Get Signature
Section titled “Get Signature”get app():
T
Defined in: ui/FlexContainer.ts:112
Returns
Section titled “Returns”T
flexDirection
Section titled “flexDirection”Get Signature
Section titled “Get Signature”get flexDirection():
FlexDirection
Defined in: ui/FlexContainer.ts:135
Returns
Section titled “Returns”Set Signature
Section titled “Set Signature”set flexDirection(
value):void
Defined in: ui/FlexContainer.ts:139
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
flexWrap
Section titled “flexWrap”Get Signature
Section titled “Get Signature”get flexWrap():
FlexWrap
Defined in: ui/FlexContainer.ts:126
Returns
Section titled “Returns”Set Signature
Section titled “Set Signature”set flexWrap(
value):void
Defined in: ui/FlexContainer.ts:130
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Get Signature
Section titled “Get Signature”get gap():
number
Defined in: ui/FlexContainer.ts:117
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set gap(
value):void
Defined in: ui/FlexContainer.ts:121
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
justifyContent
Section titled “justifyContent”Get Signature
Section titled “Get Signature”get justifyContent():
JustifyContent
Defined in: ui/FlexContainer.ts:153
Returns
Section titled “Returns”Set Signature
Section titled “Set Signature”set justifyContent(
value):void
Defined in: ui/FlexContainer.ts:157
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
layoutHeight
Section titled “layoutHeight”Get Signature
Section titled “Get Signature”get layoutHeight():
SizeNumber
Defined in: ui/FlexContainer.ts:189
Returns
Section titled “Returns”Set Signature
Section titled “Set Signature”set layoutHeight(
height):void
Defined in: ui/FlexContainer.ts:193
Parameters
Section titled “Parameters”height
Section titled “height”Returns
Section titled “Returns”void
layoutWidth
Section titled “layoutWidth”Get Signature
Section titled “Get Signature”get layoutWidth():
SizeNumber
Defined in: ui/FlexContainer.ts:180
Returns
Section titled “Returns”Set Signature
Section titled “Set Signature”set layoutWidth(
width):void
Defined in: ui/FlexContainer.ts:184
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Get Signature
Section titled “Get Signature”get size():
object
Defined in: ui/FlexContainer.ts:162
Returns
Section titled “Returns”object
height
Section titled “height”height:
SizeNumber
width:
SizeNumber
Set Signature
Section titled “Set Signature”set size(
size):void
Defined in: ui/FlexContainer.ts:169
Parameters
Section titled “Parameters”SizeNumber | { height: SizeNumber; width: SizeNumber; } | [SizeNumber, SizeNumber]
Returns
Section titled “Returns”void
Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: mixins/signals.ts:13
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_FlexContainer.addSignalConnection
connectAction()
Section titled “connectAction()”connectAction(…
args):void
Defined in: mixins/signals.ts:15
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_FlexContainer.connectAction
connectSignal()
Section titled “connectSignal()”connectSignal(…
args):void
Defined in: mixins/signals.ts:14
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_FlexContainer.connectSignal
destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/FlexContainer.ts:198
Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy.
Returns
Section titled “Returns”void
Example
Section titled “Example”container.destroy();container.destroy(true);container.destroy({ children: true });container.destroy({ children: true, texture: true, textureSource: true });Overrides
Section titled “Overrides”_FlexContainer.destroy
updateLayout()
Section titled “updateLayout()”updateLayout():
void
Defined in: ui/FlexContainer.ts:106
Returns
Section titled “Returns”void