Class DisplayContainer

Container for dynamically adding, removing, and repositioning objects for display.

Hierarchy

DisplayContainer

Index

Constructors

Accessors

Methods

add addProperties getOptions remove removeAll render applyTransform

Constructors

constructor

new DisplayContainer(): DisplayContainer
Returns DisplayContainer

Accessors

isEmpty

get isEmpty(): boolean
Returns boolean

Methods

add

add(object, options?): IDisplayOptions
Parameters
- object: DisplayChild
- Optional options: IDisplayOptions
Returns IDisplayOptions

addProperties

addProperties(parent): void
Adds all properties of parent annotated with display. The value of each property will be fetched each time this container is rendered, so new values assigned after addProperties is called will always be displayed.
Parameters
- parent: object
  
  Object to search through the properties of.
Returns void

getOptions

getOptions(key): IDisplayOptions
Parameters
- key: string
Returns IDisplayOptions
getOptions(child): IDisplayOptions
Parameters
- child: DisplayChild
Returns IDisplayOptions

remove

remove(object): boolean
Remove the given child object. Returns true if the child was in this container.
Parameters
- object: DisplayChild
  
  Child object to remove.
Returns boolean

removeAll

removeAll(): void
Removes all child objects from this container.

Returns void
removeAll(objects): void
Removes all of the given child objects.
Parameters
- objects: Iterable<DisplayChild>
  
  Iterable of objects to remove.
Returns void

render

render(ctx, parent, views?): IView[]
Parameters
- ctx: RenderContext
- parent: DisplayParent
- Optional views: IView[]
Returns IView[]

`Static` applyTransform

applyTransform(a, b): ITransform
Applies transform a to transform b, returning the result. Neither a nor b are modified.
Parameters
- a: ITransform
  
  Outer transformation.
- b: ITransform
  
  Inner transformation.
Returns ITransform
The combined transformation.
applyTransform(a, b, out): ITransform
Applies transform a to transform b, storing the result in out. Neither a nor b are modified.
Parameters
- a: ITransform
  
  Outer transformation.
- b: ITransform
  
  Inner transformation.
- out: ITransform
  
  Target for the combined transformation.
Returns ITransform
Combined transform out

Generated using TypeDoc